api/v3/Batch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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  * @throws \API_Exception
  41  * @throws \Civi\API\Exception\UnauthorizedException
  42  */
  43 function civicrm_api3_batch_create($params) {
  44   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Batch');
  45 }
  46
  47 /**
  48  * Adjust Metadata for Create action.
  49  *
  50  * The metadata is used for setting defaults, documentation & validation.
  51  *
  52  * @param array $params
  53  *   Array of parameters determined by getfields.
  54  */
  55 function _civicrm_api3_batch_create_spec(&$params) {
  56   //@todo - the entity table field looks like it is not actually required & should probably be removed (or a description added if
  57   // it is actually required)
  58   $params['entity_table']['api.default'] = "civicrm_batch";
  59   $params['entity_table']['type'] = CRM_Utils_Type::T_STRING;
  60   $params['entity_table']['title'] = 'Batch Entity Table - remove?';
  61   $params['created_id']['api.default'] = 'user_contact_id';
  62   $params['created_date']['api.default'] = 'now';
  63   $params['modified_id']['api.default'] = 'user_contact_id';
  64   $params['modified_date']['api.default'] = 'now';
  65   $params['status_id']['api.required'] = 1;
  66   $params['title']['api.required'] = 1;
  67   $params['status_id']['api.required'] = 1;
  68 }
  69
  70 /**
  71  * Get a Batch.
  72  *
  73  * @param array $params
  74  *
  75  * @return array
  76  *   Array of retrieved batch property values.
  77  */
  78 function civicrm_api3_batch_get($params) {
  79   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  80 }
  81
  82 /**
  83  * Delete a Batch.
  84  *
  85  * @param array $params
  86  *
  87  * @return array
  88  *   Array of deleted values.
  89  * @throws \API_Exception
  90  * @throws \Civi\API\Exception\UnauthorizedException
  91  */
  92 function civicrm_api3_batch_delete($params) {
  93   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  94 }