Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * File for the CiviCRM APIv3 event functions | |
31 | * | |
32 | * @package CiviCRM_APIv3 | |
33 | * @subpackage API_Event | |
34 | * | |
731a0992 | 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
36 | * @version $Id: Event.php 30964 2010-11-29 09:41:54Z shot $ |
37 | * | |
38 | */ | |
39 | ||
6a488035 TO |
40 | /** |
41 | * Create a Event | |
42 | * | |
43 | * This API is used for creating a Event | |
44 | * | |
cf470720 TO |
45 | * @param array $params |
46 | * Input parameters. | |
16b10e64 | 47 | * Allowed @params array keys are: |
6a488035 TO |
48 | * {@getfields event_create} |
49 | * | |
a6c01b45 | 50 | * @return array |
72b3a70c | 51 | * API result Array. |
6a488035 TO |
52 | */ |
53 | function civicrm_api3_event_create($params) { | |
d8df9906 CW |
54 | civicrm_api3_verify_one_mandatory($params, NULL, array('event_type_id', 'template_id')); |
55 | ||
56 | // Clone event from template | |
57 | if (!empty($params['template_id']) && empty($params['id'])) { | |
58 | $copy = CRM_Event_BAO_Event::copy($params['template_id']); | |
59 | $params['id'] = $copy->id; | |
60 | unset($params['template_id']); | |
d8df9906 | 61 | } |
6a488035 TO |
62 | |
63 | _civicrm_api3_event_create_legacy_support_42($params); | |
b2cdd843 | 64 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Event'); |
6a488035 | 65 | } |
11e09c59 TO |
66 | |
67 | /** | |
6a488035 TO |
68 | * Adjust Metadata for Create action |
69 | * | |
70 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
71 | * @param array $params |
72 | * Array or parameters determined by getfields. | |
6a488035 TO |
73 | */ |
74 | function _civicrm_api3_event_create_spec(&$params) { | |
6a488035 TO |
75 | $params['start_date']['api.required'] = 1; |
76 | $params['title']['api.required'] = 1; | |
77 | $params['is_active']['api.default'] = 1; | |
78 | $params['financial_type_id']['api.aliases'] = array('contribution_type_id'); | |
633430e6 | 79 | $params['is_template']['api.default'] = 0; |
6a488035 | 80 | } |
11e09c59 TO |
81 | |
82 | /** | |
6a488035 TO |
83 | * Support for schema changes made in 4.2 |
84 | * The main purpose of the API is to provide integrators a level of stability not provided by | |
85 | * the core code or schema - this means we have to provide support for api calls (where possible) | |
86 | * across schema changes. | |
d0997921 | 87 | * @param array $params |
6a488035 | 88 | */ |
9b873358 TO |
89 | function _civicrm_api3_event_create_legacy_support_42(&$params) { |
90 | if (!empty($params['payment_processor_id'])) { | |
6a488035 TO |
91 | $params['payment_processor'] = CRM_Core_DAO::VALUE_SEPARATOR . $params['payment_processor_id'] . CRM_Core_DAO::VALUE_SEPARATOR; |
92 | } | |
93 | } | |
94 | ||
95 | /** | |
96 | * Get Event record. | |
97 | * | |
cf470720 | 98 | * @param array $params |
6a488035 | 99 | * |
16b10e64 CW |
100 | * @return array |
101 | * Array of all found event property values. | |
6a488035 TO |
102 | */ |
103 | function civicrm_api3_event_get($params) { | |
104 | ||
105 | //legacy support for $params['return.sort'] | |
a7488080 | 106 | if (!empty($params['return.sort'])) { |
6a488035 TO |
107 | $params['options']['sort'] = $params['return.sort']; |
108 | unset($params['return.sort']); | |
109 | } | |
110 | ||
d8df9906 | 111 | //legacy support for $params['return.offset'] |
a7488080 | 112 | if (!empty($params['return.offset'])) { |
6a488035 TO |
113 | $params['options']['offset'] = $params['return.offset']; |
114 | unset($params['return.offset']); | |
115 | } | |
116 | ||
117 | //legacy support for $params['return.max_results'] | |
a7488080 | 118 | if (!empty($params['return.max_results'])) { |
6a488035 TO |
119 | $params['options']['limit'] = $params['return.max_results']; |
120 | unset($params['return.max_results']); | |
121 | } | |
122 | ||
123 | $eventDAO = new CRM_Event_BAO_Event(); | |
124 | _civicrm_api3_dao_set_filter($eventDAO, $params, TRUE, 'Event'); | |
125 | ||
a7488080 | 126 | if (!empty($params['isCurrent'])) { |
6a488035 TO |
127 | $eventDAO->whereAdd('(start_date >= CURDATE() || end_date >= CURDATE())'); |
128 | } | |
129 | ||
130 | // @todo should replace all this with _civicrm_api3_dao_to_array($bao, $params, FALSE, $entity) - but we still have | |
131 | // the return.is_full to deal with. | |
132 | // NB the std dao_to_array function should only return custom if required. | |
133 | $event = array(); | |
b2cdd843 EM |
134 | $options = _civicrm_api3_get_options_from_params($params); |
135 | ||
6a488035 TO |
136 | $eventDAO->find(); |
137 | while ($eventDAO->fetch()) { | |
138 | $event[$eventDAO->id] = array(); | |
139 | CRM_Core_DAO::storeValues($eventDAO, $event[$eventDAO->id]); | |
a7488080 | 140 | if (!empty($params['return.is_full'])) { |
6a488035 TO |
141 | _civicrm_api3_event_getisfull($event, $eventDAO->id); |
142 | } | |
143 | _civicrm_api3_event_get_legacy_support_42($event, $eventDAO->id); | |
144 | _civicrm_api3_custom_data_get($event[$eventDAO->id], 'Event', $eventDAO->id, NULL, $eventDAO->event_type_id); | |
22e263ad | 145 | if (!empty($options['return'])) { |
b2cdd843 EM |
146 | $event[$eventDAO->id]['price_set_id'] = CRM_Price_BAO_PriceSet::getFor('civicrm_event', $eventDAO->id); |
147 | } | |
6a488035 | 148 | } |
6a488035 TO |
149 | |
150 | return civicrm_api3_create_success($event, $params, 'event', 'get', $eventDAO); | |
151 | } | |
11e09c59 TO |
152 | |
153 | /** | |
6a488035 | 154 | * Adjust Metadata for Get action |
11e09c59 TO |
155 | * |
156 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
157 | * @param array $params |
158 | * Array or parameters determined by getfields. | |
11e09c59 | 159 | */ |
6a488035 TO |
160 | function _civicrm_api3_event_get_spec(&$params) { |
161 | $params['financial_type_id']['api.aliases'] = array('contribution_type_id'); | |
162 | } | |
11e09c59 TO |
163 | |
164 | /** | |
6a488035 TO |
165 | * Support for schema changes made in 4.2 |
166 | * The main purpose of the API is to provide integrators a level of stability not provided by | |
167 | * the core code or schema - this means we have to provide support for api calls (where possible) | |
168 | * across schema changes. | |
645ee340 EM |
169 | * @param $event |
170 | * @param $event_id | |
6a488035 | 171 | */ |
9b873358 TO |
172 | function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) { |
173 | if (!empty($event[$event_id]['payment_processor'])) { | |
35671d00 | 174 | $processors = explode(CRM_Core_DAO::VALUE_SEPARATOR, $event[$event_id]['payment_processor']); |
481a74f4 | 175 | if (count($processors) == 3) { |
6a488035 TO |
176 | $event[$event_id]['payment_processor_id'] = $processors[1]; |
177 | } | |
178 | } | |
179 | } | |
180 | ||
181 | /** | |
182 | * Deletes an existing event | |
183 | * | |
184 | * This API is used for deleting a event | |
185 | * | |
d0997921 | 186 | * @param array $params |
645ee340 | 187 | * @return array |
6a488035 TO |
188 | */ |
189 | function civicrm_api3_event_delete($params) { | |
6a488035 TO |
190 | return CRM_Event_BAO_Event::del($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while deleting event')); |
191 | } | |
192 | /* | |
193 | ||
11e09c59 | 194 | /** |
c490a46a | 195 | * add 'is_full' & 'available_seats' to the return array. (this might be better in the BAO) |
6a488035 TO |
196 | * Default BAO function returns a string if full rather than a Bool - which is more appropriate to a form |
197 | * | |
cf470720 TO |
198 | * @param array $event |
199 | * Return array of the event. | |
200 | * @param int $event_id | |
201 | * Id of the event to be updated. | |
6a488035 TO |
202 | * |
203 | */ | |
aa1b1481 EM |
204 | /** |
205 | * @param $event | |
100fef9d | 206 | * @param int $event_id |
aa1b1481 | 207 | */ |
6a488035 | 208 | function _civicrm_api3_event_getisfull(&$event, $event_id) { |
6a488035 TO |
209 | $eventFullResult = CRM_Event_BAO_Participant::eventFull($event_id, 1); |
210 | if (!empty($eventFullResult) && is_int($eventFullResult)) { | |
211 | $event[$event_id]['available_places'] = $eventFullResult; | |
212 | } | |
213 | else { | |
214 | $event[$event_id]['available_places'] = 0; | |
215 | } | |
216 | $event[$event_id]['is_full'] = $event[$event_id]['available_places'] == 0 ? 1 : 0; | |
217 | } | |
218 | ||
9c7c6a00 CW |
219 | |
220 | /** | |
37fa58b0 | 221 | * @see _civicrm_api3_generic_getlist_params |
9c7c6a00 | 222 | * |
8c6b335b | 223 | * @param array $request |
9c7c6a00 CW |
224 | */ |
225 | function _civicrm_api3_event_getlist_params(&$request) { | |
8250601e CW |
226 | $fieldsToReturn = array('start_date', 'event_type_id', 'title', 'summary'); |
227 | $request['params']['return'] = array_unique(array_merge($fieldsToReturn, $request['extra'])); | |
9c7c6a00 CW |
228 | $request['params']['options']['sort'] = 'start_date DESC'; |
229 | $request['params'] += array( | |
230 | 'is_template' => 0, | |
231 | 'is_active' => 1, | |
232 | ); | |
233 | } | |
234 | ||
235 | /** | |
a6c6059d | 236 | * @see _civicrm_api3_generic_getlist_output |
9c7c6a00 | 237 | * |
8c6b335b CW |
238 | * @param array $result |
239 | * @param array $request | |
9c7c6a00 CW |
240 | * |
241 | * @return array | |
242 | */ | |
243 | function _civicrm_api3_event_getlist_output($result, $request) { | |
244 | $output = array(); | |
245 | if (!empty($result['values'])) { | |
246 | foreach ($result['values'] as $row) { | |
247 | $data = array( | |
248 | 'id' => $row[$request['id_field']], | |
249 | 'label' => $row[$request['label_field']], | |
88881f79 | 250 | 'description' => array(CRM_Core_Pseudoconstant::getLabel('CRM_Event_BAO_Event', 'event_type_id', $row['event_type_id'])), |
9c7c6a00 CW |
251 | ); |
252 | if (!empty($row['start_date'])) { | |
88881f79 | 253 | $data['description'][0] .= ': ' . CRM_Utils_Date::customFormat($row['start_date']); |
9c7c6a00 CW |
254 | } |
255 | if (!empty($row['summary'])) { | |
88881f79 | 256 | $data['description'][] = $row['summary']; |
9c7c6a00 | 257 | } |
8250601e CW |
258 | foreach ($request['extra'] as $field) { |
259 | $data['extra'][$field] = isset($row[$field]) ? $row[$field] : NULL; | |
260 | } | |
9c7c6a00 CW |
261 | $output[] = $data; |
262 | } | |
263 | } | |
264 | return $output; | |
265 | } |