api/v3/Batch.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * File for the CiviCRM APIv3 batch functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Batch
  34  *
  35  */
  36
  37 /**
  38  * Save a Batch
  39  *
  40  * Allowed @params array keys are:
  41  * {@getfields batch_create}
  42  * @example BatchCreate.php
  43  *
  44  * @param array $params
  45  *
  46  * @return array of newly created batch property values.
  47  * @access public
  48  */
  49 function civicrm_api3_batch_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Adjust Metadata for Create action
  55  *
  56  * The metadata is used for setting defaults, documentation & validation
  57  * @param array $params 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 of retrieved batch property values.
  82  * @access public
  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 of deleted values.
  98  * @access public
  99  */
 100 function civicrm_api3_batch_delete($params) {
 101   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 102 }