api/v3/Batch.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  * File for the CiviCRM APIv3 batch functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Batch
  33  *
  34  */
  35
  36 /**
  37  * Save a Batch
  38  *
  39  * Allowed @params array keys are:
  40  * {@getfields batch_create}
  41  * @example BatchCreate.php
  42  *
  43  * @param array $params
  44  *
  45  * @return array
  46  *   Array of newly created batch property values.
  47  */
  48 function civicrm_api3_batch_create($params) {
  49   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  50 }
  51
  52 /**
  53  * Adjust Metadata for Create action
  54  *
  55  * The metadata is used for setting defaults, documentation & validation
  56  * @param array $params
  57  *   Array or parameters determined by getfields.
  58  */
  59 function _civicrm_api3_batch_create_spec(&$params) {
  60   //@todo - the entity table field looks like it is not actually required & should probably be removed (or a description added if
  61   // it is actually required)
  62   $params['entity_table']['api.default'] = "civicrm_batch";
  63   $params['entity_table']['type'] = CRM_Utils_Type::T_STRING;
  64   $params['entity_table']['title'] = 'Batch Entity Table - remove?';
  65
  66   $params['modified_date']['api.default'] = "now";
  67   $params['status_id']['api.required'] = 1;
  68   $params['title']['api.required'] = 1;
  69   $params['status_id']['api.required'] = 1;
  70 }
  71
  72 /**
  73  * Get a Batch
  74  *
  75  * Allowed @params array keys are:
  76  * {@getfields batch_get}
  77  * @example BatchCreate.php
  78  *
  79  * @param array $params
  80  *
  81  * @return array
  82  *   Array of retrieved batch property values.
  83  */
  84 function civicrm_api3_batch_get($params) {
  85   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  86 }
  87
  88 /**
  89  * Delete a Batch
  90  *
  91  * Allowed @params array keys are:
  92  * {@getfields batch_delete}
  93  * @example BatchCreate.php
  94  *
  95  * @param array $params
  96  *
  97  * @return array
  98  *   Array of deleted values.
  99  */
 100 function civicrm_api3_batch_delete($params) {
 101   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 102 }