4b7dce08 |
1 | <?php |
2 | |
3 | /* |
4 | +--------------------------------------------------------------------+ |
5 | | CiviCRM version 4.4 | |
6 | +--------------------------------------------------------------------+ |
7 | | Copyright CiviCRM LLC (c) 2004-2013 | |
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 | * |
35 | * @copyright CiviCRM LLC (c) 2004-2013 |
36 | * |
37 | */ |
38 | |
39 | /** |
40 | * Get CiviCRM Action Schedule details |
41 | * {@getfields action_schedule_create} |
42 | * |
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 |
59 | * |
60 | * {@getfields action_schedule_create} |
61 | */ |
62 | function civicrm_api3_action_schedule_create($params) { |
63 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
64 | } |
65 | |
66 | /** |
67 | * Adjust Metadata for Create action |
68 | * |
69 | * The metadata is used for setting defaults, documentation & validation |
70 | * @param array $params array or parameters determined by getfields |
71 | */ |
72 | function _civicrm_api3_action_schedule_create_spec(&$params) { |
73 | unset($params['version']); |
74 | } |
75 | |
76 | /** |
77 | * delete an existing action_schedule |
78 | * |
79 | * |
80 | * @param array $params (reference) array containing id of the action_schedule |
81 | * to be deleted |
82 | * |
83 | * @return array (referance) returns flag true if successfull, error |
84 | * message otherwise |
85 | * |
86 | * @access public |
87 | */ |
88 | function civicrm_api3_action_schedule_delete($params) { |
89 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
90 | } |