api/v3/Batch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM Batch records.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Save a Batch.
  20  *
  21  * @param array $params
  22  *
  23  * @return array
  24  * @throws \API_Exception
  25  * @throws \Civi\API\Exception\UnauthorizedException
  26  */
  27 function civicrm_api3_batch_create($params) {
  28   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Batch');
  29 }
  30
  31 /**
  32  * Adjust Metadata for Create action.
  33  *
  34  * The metadata is used for setting defaults, documentation & validation.
  35  *
  36  * @param array $params
  37  *   Array of parameters determined by getfields.
  38  */
  39 function _civicrm_api3_batch_create_spec(&$params) {
  40   //@todo - the entity table field looks like it is not actually required & should probably be removed (or a description added if
  41   // it is actually required)
  42   $params['entity_table']['api.default'] = "civicrm_batch";
  43   $params['entity_table']['type'] = CRM_Utils_Type::T_STRING;
  44   $params['entity_table']['title'] = 'Batch Entity Table - remove?';
  45   $params['created_id']['api.default'] = 'user_contact_id';
  46   $params['created_date']['api.default'] = 'now';
  47   $params['modified_id']['api.default'] = 'user_contact_id';
  48   $params['modified_date']['api.default'] = 'now';
  49   $params['status_id']['api.required'] = 1;
  50   $params['title']['api.required'] = 1;
  51   $params['status_id']['api.required'] = 1;
  52 }
  53
  54 /**
  55  * Get a Batch.
  56  *
  57  * @param array $params
  58  *
  59  * @return array
  60  *   Array of retrieved batch property values.
  61  */
  62 function civicrm_api3_batch_get($params) {
  63   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  64 }
  65
  66 /**
  67  * Delete a Batch.
  68  *
  69  * @param array $params
  70  *
  71  * @return array
  72  *   Array of deleted values.
  73  * @throws \API_Exception
  74  * @throws \Civi\API\Exception\UnauthorizedException
  75  */
  76 function civicrm_api3_batch_delete($params) {
  77   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  78 }