Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
a30c801b | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
a30c801b TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
244bbdd8 | 13 | * This api exposes CiviCRM Batch records. |
6a488035 TO |
14 | * |
15 | * @package CiviCRM_APIv3 | |
6a488035 TO |
16 | */ |
17 | ||
18 | /** | |
61fe4988 | 19 | * Save a Batch. |
6a488035 | 20 | * |
c490a46a | 21 | * @param array $params |
77b97be7 | 22 | * |
a6c01b45 | 23 | * @return array |
58f5a267 | 24 | * @throws \API_Exception |
25 | * @throws \Civi\API\Exception\UnauthorizedException | |
6a488035 TO |
26 | */ |
27 | function civicrm_api3_batch_create($params) { | |
1237d8d7 | 28 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Batch'); |
6a488035 TO |
29 | } |
30 | ||
87a2386c | 31 | /** |
0aa0303c EM |
32 | * Adjust Metadata for Create action. |
33 | * | |
34 | * The metadata is used for setting defaults, documentation & validation. | |
87a2386c | 35 | * |
cf470720 | 36 | * @param array $params |
b081365f | 37 | * Array of parameters determined by getfields. |
87a2386c E |
38 | */ |
39 | function _civicrm_api3_batch_create_spec(&$params) { | |
3d103be7 E |
40 | //@todo - the entity table field looks like it is not actually required & should probably be removed (or a description added if |
41 | // it is actually required) | |
87a2386c | 42 | $params['entity_table']['api.default'] = "civicrm_batch"; |
3d103be7 | 43 | $params['entity_table']['type'] = CRM_Utils_Type::T_STRING; |
dd0f3cee | 44 | $params['entity_table']['title'] = 'Batch Entity Table - remove?'; |
58f5a267 | 45 | $params['created_id']['api.default'] = 'user_contact_id'; |
46 | $params['created_date']['api.default'] = 'now'; | |
47 | $params['modified_id']['api.default'] = 'user_contact_id'; | |
48 | $params['modified_date']['api.default'] = 'now'; | |
87a2386c E |
49 | $params['status_id']['api.required'] = 1; |
50 | $params['title']['api.required'] = 1; | |
51 | $params['status_id']['api.required'] = 1; | |
52 | } | |
53 | ||
6a488035 | 54 | /** |
9d32e6f7 | 55 | * Get a Batch. |
6a488035 | 56 | * |
c490a46a | 57 | * @param array $params |
77b97be7 | 58 | * |
a6c01b45 | 59 | * @return array |
16b10e64 | 60 | * Array of retrieved batch property values. |
6a488035 TO |
61 | */ |
62 | function civicrm_api3_batch_get($params) { | |
63 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
64 | } | |
65 | ||
66 | /** | |
9d32e6f7 | 67 | * Delete a Batch. |
6a488035 | 68 | * |
c490a46a | 69 | * @param array $params |
77b97be7 | 70 | * |
a6c01b45 | 71 | * @return array |
16b10e64 | 72 | * Array of deleted values. |
58f5a267 | 73 | * @throws \API_Exception |
74 | * @throws \Civi\API\Exception\UnauthorizedException | |
6a488035 TO |
75 | */ |
76 | function civicrm_api3_batch_delete($params) { | |
77 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
78 | } |