4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.4 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 for Scheduled Reminders
32 * @package CiviCRM_APIv3
33 * @subpackage API_ActionSchedule
35 * @copyright CiviCRM LLC (c) 2004-2013
40 * Get CiviCRM Action Schedule details
41 * {@getfields action_schedule_create}
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');
49 return civicrm_api3_create_success($actionSchedules, $params, 'action_schedule', 'get', $bao);
54 * Create a new Action Schedule
56 * @param array $params
60 * {@getfields action_schedule_create}
62 function civicrm_api3_action_schedule_create($params) {
63 if (!CRM_Utils_Array
::value('id', $params)) {
64 // an update does not require any mandatory parameters
65 civicrm_api3_verify_one_mandatory($params,
68 'title','mapping_id', 'entity_status', 'entity_value',
74 if (isset($params['id']) && !CRM_Utils_Rule
::integer($params['id'])) {
75 return civicrm_api3_create_error('Invalid value for ID');
78 if (!array_key_exists('name', $params) && !array_key_exists('id', $params)) {
79 $params['name'] = CRM_Utils_String
::munge($params['title']);
82 $actionSchedule = new CRM_Core_BAO_ActionSchedule();
83 $actionSchedule = CRM_Core_BAO_ActionSchedule
::add($params, $ids);
85 $actSchedule = array();
87 _civicrm_api3_object_to_array($actionSchedule, $actSchedule[$actionSchedule->id
]);
89 return civicrm_api3_create_success($actSchedule, $params, 'action_schedule', 'create', $actionSchedule);
93 * Adjust Metadata for Create action
95 * The metadata is used for setting defaults, documentation & validation
96 * @param array $params array or parameters determined by getfields
98 function _civicrm_api3_action_schedule_create_spec(&$params) {
99 unset($params['version']);
103 * delete an existing action_schedule
106 * @param array $params (reference) array containing id of the action_schedule
109 * @return array (referance) returns flag true if successfull, error
114 function civicrm_api3_action_schedule_delete($params) {
115 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);