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
  47  *   Array of newly created batch property values.
  48  * @access public
  49  */
  50 function civicrm_api3_batch_create($params) {
  51   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  52 }
  53
  54 /**
  55  * Adjust Metadata for Create action
  56  *
  57  * The metadata is used for setting defaults, documentation & validation
  58  * @param array $params
  59  *   Array or parameters determined by getfields.
  60  */
  61 function _civicrm_api3_batch_create_spec(&$params) {
  62   //@todo - the entity table field looks like it is not actually required & should probably be removed (or a description added if
  63   // it is actually required)
  64   $params['entity_table']['api.default'] = "civicrm_batch";
  65   $params['entity_table']['type'] = CRM_Utils_Type::T_STRING;
  66   $params['entity_table']['title'] = 'Batch Entity Table - remove?';
  67
  68   $params['modified_date']['api.default'] = "now";
  69   $params['status_id']['api.required'] = 1;
  70   $params['title']['api.required'] = 1;
  71   $params['status_id']['api.required'] = 1;
  72 }
  73
  74 /**
  75  * Get a Batch
  76  *
  77  * Allowed @params array keys are:
  78  * {@getfields batch_get}
  79  * @example BatchCreate.php
  80  *
  81  * @param array $params
  82  *
  83  * @return array
  84  *   Array of retrieved batch property values.
  85  * @access public
  86  */
  87 function civicrm_api3_batch_get($params) {
  88   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  89 }
  90
  91 /**
  92  * Delete a Batch
  93  *
  94  * Allowed @params array keys are:
  95  * {@getfields batch_delete}
  96  * @example BatchCreate.php
  97  *
  98  * @param array $params
  99  *
 100  * @return array
 101  *   Array of deleted values.
 102  * @access public
 103  */
 104 function civicrm_api3_batch_delete($params) {
 105   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 106 }