projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| a646bdd2 SB |
1 | <?php |
| 2 | /* | |
| 3 | -------------------------------------------------------------------- | |
| fa938177 | 4 | | CiviCRM version 4.7 | |
| a646bdd2 | 5 | -------------------------------------------------------------------- |
| 1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
| a646bdd2 SB |
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 EntityBatch records. | |
| 30 | * | |
| 31 | * Use this api to add/remove entities from a batch. | |
| 32 | * To create/update/delete the batches themselves, use the Batch api. | |
| 33 | * | |
| 34 | * @package CiviCRM_APIv3 | |
| 35 | */ | |
| 36 | ||
| 37 | /** | |
| 38 | * Get entity batches. | |
| 39 | * | |
| 40 | * @param array $params | |
| 41 | * | |
| 42 | * @return array | |
| 43 | */ | |
| 44 | function civicrm_api3_entity_batch_get($params) { | |
| 45 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 46 | } | |
| 47 | ||
| 48 | /** | |
| 49 | * Adjust Metadata for Create action. | |
| 50 | * | |
| 51 | * The metadata is used for setting defaults, documentation & validation. | |
| 52 | * | |
| 53 | * @param array $params | |
| 54 | * Array of parameters determined by getfields. | |
| 55 | */ | |
| 56 | function _civicrm_api3_entity_batch_create_spec(&$params) { | |
| 57 | $params['entity_id']['api.required'] = 1; | |
| 58 | $params['batch_id']['api.required'] = 1; | |
| 59 | } | |
| 60 | ||
| 61 | /** | |
| 62 | * Create an entity batch. | |
| 63 | * | |
| 64 | * @param array $params | |
| 65 | * | |
| 66 | * @return array | |
| 67 | */ | |
| 68 | function civicrm_api3_entity_batch_create($params) { | |
| 69 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 70 | } | |
| 71 | ||
| 72 | /** | |
| 73 | * Mark entity batch as removed. | |
| 74 | * | |
| 75 | * @param array $params | |
| 76 | * | |
| 77 | * @return array | |
| 78 | */ | |
| 79 | function civicrm_api3_entity_batch_delete($params) { | |
| 80 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 81 | } |