Commit | Line | Data |
---|---|---|
e790a8cb | 1 | <?php |
e790a8cb | 2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
e790a8cb | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
e790a8cb | 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 | */ |
e790a8cb | 27 | |
28 | /** | |
29 | * File for the CiviCRM APIv3 for Scheduled Reminders | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_ActionSchedule | |
33 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
e790a8cb | 35 | */ |
36 | ||
37 | /** | |
61fe4988 EM |
38 | * Get CiviCRM Action Schedule details. |
39 | * | |
d0997921 | 40 | * @param array $params |
61fe4988 | 41 | * |
645ee340 | 42 | * @return array |
e790a8cb | 43 | */ |
44 | function civicrm_api3_action_schedule_get($params) { | |
a01fa90c | 45 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'action_schedule'); |
e790a8cb | 46 | } |
47 | ||
48 | ||
49 | /** | |
50 | * Create a new Action Schedule | |
51 | * | |
52 | * @param array $params | |
53 | * | |
54 | * @return array | |
e8829f77 | 55 | * |
389bcebf | 56 | * {@getfields action_schedule_create} |
e790a8cb | 57 | */ |
58 | function civicrm_api3_action_schedule_create($params) { | |
a01fa90c | 59 | civicrm_api3_verify_one_mandatory($params, NULL, array('start_action_date', 'absolute_date')); |
a3ceebba | 60 | if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) { |
e8829f77 E |
61 | $params['name'] = CRM_Utils_String::munge($params['title']); |
62 | } | |
a01fa90c | 63 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'action_schedule'); |
e790a8cb | 64 | } |
65 | ||
66 | /** | |
0aa0303c EM |
67 | * Adjust Metadata for Create action. |
68 | * | |
69 | * The metadata is used for setting defaults, documentation & validation. | |
e790a8cb | 70 | * |
cf470720 TO |
71 | * @param array $params |
72 | * Array or parameters determined by getfields. | |
e790a8cb | 73 | */ |
74 | function _civicrm_api3_action_schedule_create_spec(&$params) { | |
a01fa90c EM |
75 | $params['title']['api.required'] = TRUE; |
76 | $params['mapping_id']['api.required'] = TRUE; | |
35671d00 | 77 | // $params['entity_status']['api.required'] = TRUE; |
a01fa90c | 78 | $params['entity_value']['api.required'] = TRUE; |
e790a8cb | 79 | } |
80 | ||
81 | /** | |
82 | * delete an existing action_schedule | |
83 | * | |
cf470720 TO |
84 | * @param array $params |
85 | * Array containing id of the action_schedule. | |
7cdbcb16 | 86 | * to be deleted |
e790a8cb | 87 | * |
a6c01b45 | 88 | * @return array |
72b3a70c | 89 | * API result array |
e790a8cb | 90 | * |
e790a8cb | 91 | */ |
92 | function civicrm_api3_action_schedule_delete($params) { | |
93 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
f54c2beb | 94 | } |