Commit | Line | Data |
---|---|---|
e790a8cb | 1 | <?php |
2 | ||
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
731a0992 | 5 | | CiviCRM version 4.5 | |
e790a8cb | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
e790a8cb | 8 | +--------------------------------------------------------------------+ |
9 | | This file is a part of CiviCRM. | | |
10 | | | | |
11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
12 | | under the terms of the GNU Affero General Public License | | |
13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
14 | | | | |
15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
18 | | See the GNU Affero General Public License for more details. | | |
19 | | | | |
20 | | You should have received a copy of the GNU Affero General Public | | |
21 | | License and the CiviCRM Licensing Exception along | | |
22 | | with this program; if not, contact CiviCRM LLC | | |
23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
26 | +--------------------------------------------------------------------+ | |
27 | */ | |
28 | ||
29 | /** | |
30 | * File for the CiviCRM APIv3 for Scheduled Reminders | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_ActionSchedule | |
34 | * | |
731a0992 | 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
e790a8cb | 36 | * |
37 | */ | |
38 | ||
39 | /** | |
40 | * Get CiviCRM Action Schedule details | |
41 | * {@getfields action_schedule_create} | |
e8829f77 | 42 | * |
e790a8cb | 43 | */ |
44 | function civicrm_api3_action_schedule_get($params) { | |
45 | $bao = new CRM_Core_BAO_ActionSchedule(); | |
46 | _civicrm_api3_dao_set_filter($bao, $params, true, 'ActionSchedule'); | |
47 | $actionSchedules = _civicrm_api3_dao_to_array($bao, $params, true,'ActionSchedule'); | |
48 | ||
49 | return civicrm_api3_create_success($actionSchedules, $params, 'action_schedule', 'get', $bao); | |
50 | } | |
51 | ||
52 | ||
53 | /** | |
54 | * Create a new Action Schedule | |
55 | * | |
56 | * @param array $params | |
57 | * | |
58 | * @return array | |
e8829f77 | 59 | * |
e790a8cb | 60 | * {@getfields action_schedule_create} |
61 | */ | |
62 | function civicrm_api3_action_schedule_create($params) { | |
a7488080 | 63 | if (empty($params['id'])) { |
f54c2beb | 64 | // an update does not require any mandatory parameters |
65 | civicrm_api3_verify_one_mandatory($params, | |
66 | NULL, | |
67 | array( | |
68 | 'title','mapping_id', 'entity_status', 'entity_value', | |
69 | ) | |
70 | ); | |
71 | } | |
e8829f77 | 72 | |
5bd36193 | 73 | $ids = array(); |
74 | if (isset($params['id']) && !CRM_Utils_Rule::integer($params['id'])) { | |
75 | return civicrm_api3_create_error('Invalid value for ID'); | |
76 | } | |
e8829f77 | 77 | |
a3ceebba | 78 | if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) { |
e8829f77 E |
79 | $params['name'] = CRM_Utils_String::munge($params['title']); |
80 | } | |
81 | ||
5bd36193 | 82 | $actionSchedule = new CRM_Core_BAO_ActionSchedule(); |
83 | $actionSchedule = CRM_Core_BAO_ActionSchedule::add($params, $ids); | |
e8829f77 | 84 | |
5bd36193 | 85 | $actSchedule = array(); |
e8829f77 | 86 | |
5bd36193 | 87 | _civicrm_api3_object_to_array($actionSchedule, $actSchedule[$actionSchedule->id]); |
e8829f77 | 88 | |
5bd36193 | 89 | return civicrm_api3_create_success($actSchedule, $params, 'action_schedule', 'create', $actionSchedule); |
e790a8cb | 90 | } |
91 | ||
92 | /** | |
93 | * Adjust Metadata for Create action | |
94 | * | |
95 | * The metadata is used for setting defaults, documentation & validation | |
96 | * @param array $params array or parameters determined by getfields | |
97 | */ | |
98 | function _civicrm_api3_action_schedule_create_spec(&$params) { | |
99 | unset($params['version']); | |
100 | } | |
101 | ||
102 | /** | |
103 | * delete an existing action_schedule | |
104 | * | |
105 | * | |
106 | * @param array $params (reference) array containing id of the action_schedule | |
107 | * to be deleted | |
108 | * | |
109 | * @return array (referance) returns flag true if successfull, error | |
110 | * message otherwise | |
111 | * | |
112 | * @access public | |
113 | */ | |
114 | function civicrm_api3_action_schedule_delete($params) { | |
115 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
f54c2beb | 116 | } |
117 | ||
118 |