api/v3/Batch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * This api exposes CiviCRM Batch records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Save a Batch.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  */
  41 function civicrm_api3_batch_create($params) {
  42   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Batch');
  43 }
  44
  45 /**
  46  * Adjust Metadata for Create action.
  47  *
  48  * The metadata is used for setting defaults, documentation & validation.
  49  *
  50  * @param array $params
  51  *   Array of parameters determined by getfields.
  52  */
  53 function _civicrm_api3_batch_create_spec(&$params) {
  54   //@todo - the entity table field looks like it is not actually required & should probably be removed (or a description added if
  55   // it is actually required)
  56   $params['entity_table']['api.default'] = "civicrm_batch";
  57   $params['entity_table']['type'] = CRM_Utils_Type::T_STRING;
  58   $params['entity_table']['title'] = 'Batch Entity Table - remove?';
  59
  60   $params['modified_date']['api.default'] = "now";
  61   $params['status_id']['api.required'] = 1;
  62   $params['title']['api.required'] = 1;
  63   $params['status_id']['api.required'] = 1;
  64 }
  65
  66 /**
  67  * Get a Batch.
  68  *
  69  * @param array $params
  70  *
  71  * @return array
  72  *   Array of retrieved batch property values.
  73  */
  74 function civicrm_api3_batch_get($params) {
  75   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  76 }
  77
  78 /**
  79  * Delete a Batch.
  80  *
  81  * @param array $params
  82  *
  83  * @return array
  84  *   Array of deleted values.
  85  */
  86 function civicrm_api3_batch_delete($params) {
  87   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  88 }