Commit | Line | Data |
---|---|---|
e790a8cb | 1 | <?php |
e790a8cb | 2 | /* |
3 | +--------------------------------------------------------------------+ | |
a30c801b | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
e790a8cb | 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 | | |
e790a8cb | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
e790a8cb | 11 | |
12 | /** | |
b081365f | 13 | * This api exposes CiviCRM Scheduled Reminders. |
e790a8cb | 14 | * |
15 | * @package CiviCRM_APIv3 | |
e790a8cb | 16 | */ |
17 | ||
18 | /** | |
244bbdd8 | 19 | * Get CiviCRM ActionSchedule details. |
61fe4988 | 20 | * |
d0997921 | 21 | * @param array $params |
61fe4988 | 22 | * |
645ee340 | 23 | * @return array |
00f8641b | 24 | * API result array |
e790a8cb | 25 | */ |
26 | function civicrm_api3_action_schedule_get($params) { | |
244bbdd8 | 27 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule'); |
e790a8cb | 28 | } |
29 | ||
e790a8cb | 30 | /** |
244bbdd8 | 31 | * Create a new ActionSchedule. |
e790a8cb | 32 | * |
33 | * @param array $params | |
34 | * | |
35 | * @return array | |
e790a8cb | 36 | */ |
37 | function civicrm_api3_action_schedule_create($params) { | |
cf8f0fff | 38 | civicrm_api3_verify_one_mandatory($params, NULL, ['start_action_date', 'absolute_date']); |
a3ceebba | 39 | if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) { |
e8829f77 E |
40 | $params['name'] = CRM_Utils_String::munge($params['title']); |
41 | } | |
244bbdd8 | 42 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ActionSchedule'); |
e790a8cb | 43 | } |
44 | ||
45 | /** | |
0aa0303c EM |
46 | * Adjust Metadata for Create action. |
47 | * | |
48 | * The metadata is used for setting defaults, documentation & validation. | |
e790a8cb | 49 | * |
cf470720 | 50 | * @param array $params |
b081365f | 51 | * Array of parameters determined by getfields. |
e790a8cb | 52 | */ |
53 | function _civicrm_api3_action_schedule_create_spec(&$params) { | |
a01fa90c EM |
54 | $params['title']['api.required'] = TRUE; |
55 | $params['mapping_id']['api.required'] = TRUE; | |
a01fa90c | 56 | $params['entity_value']['api.required'] = TRUE; |
e790a8cb | 57 | } |
58 | ||
59 | /** | |
244bbdd8 | 60 | * Delete an existing ActionSchedule. |
e790a8cb | 61 | * |
cf470720 | 62 | * @param array $params |
b081365f | 63 | * Array containing id of the action_schedule to be deleted. |
e790a8cb | 64 | * |
a6c01b45 | 65 | * @return array |
72b3a70c | 66 | * API result array |
e790a8cb | 67 | */ |
68 | function civicrm_api3_action_schedule_delete($params) { | |
69 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
f54c2beb | 70 | } |