Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM Batch records. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
61fe4988 | 35 | * Save a Batch. |
6a488035 | 36 | * |
c490a46a | 37 | * @param array $params |
77b97be7 | 38 | * |
a6c01b45 | 39 | * @return array |
58f5a267 | 40 | * @throws \API_Exception |
41 | * @throws \Civi\API\Exception\UnauthorizedException | |
6a488035 TO |
42 | */ |
43 | function civicrm_api3_batch_create($params) { | |
1237d8d7 | 44 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Batch'); |
6a488035 TO |
45 | } |
46 | ||
87a2386c | 47 | /** |
0aa0303c EM |
48 | * Adjust Metadata for Create action. |
49 | * | |
50 | * The metadata is used for setting defaults, documentation & validation. | |
87a2386c | 51 | * |
cf470720 | 52 | * @param array $params |
b081365f | 53 | * Array of parameters determined by getfields. |
87a2386c E |
54 | */ |
55 | function _civicrm_api3_batch_create_spec(&$params) { | |
3d103be7 E |
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) | |
87a2386c | 58 | $params['entity_table']['api.default'] = "civicrm_batch"; |
3d103be7 | 59 | $params['entity_table']['type'] = CRM_Utils_Type::T_STRING; |
dd0f3cee | 60 | $params['entity_table']['title'] = 'Batch Entity Table - remove?'; |
58f5a267 | 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'; | |
87a2386c E |
65 | $params['status_id']['api.required'] = 1; |
66 | $params['title']['api.required'] = 1; | |
67 | $params['status_id']['api.required'] = 1; | |
68 | } | |
69 | ||
6a488035 | 70 | /** |
9d32e6f7 | 71 | * Get a Batch. |
6a488035 | 72 | * |
c490a46a | 73 | * @param array $params |
77b97be7 | 74 | * |
a6c01b45 | 75 | * @return array |
16b10e64 | 76 | * Array of retrieved batch property values. |
6a488035 TO |
77 | */ |
78 | function civicrm_api3_batch_get($params) { | |
79 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
80 | } | |
81 | ||
82 | /** | |
9d32e6f7 | 83 | * Delete a Batch. |
6a488035 | 84 | * |
c490a46a | 85 | * @param array $params |
77b97be7 | 86 | * |
a6c01b45 | 87 | * @return array |
16b10e64 | 88 | * Array of deleted values. |
58f5a267 | 89 | * @throws \API_Exception |
90 | * @throws \Civi\API\Exception\UnauthorizedException | |
6a488035 TO |
91 | */ |
92 | function civicrm_api3_batch_delete($params) { | |
93 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
94 | } |