3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * This api exposes CiviCRM Event.
32 * @package CiviCRM_APIv3
38 * @param array $params
44 function civicrm_api3_event_create($params) {
45 // Required fields for creating an event
46 if (empty($params['id']) && empty($params['is_template'])) {
47 civicrm_api3_verify_mandatory($params, NULL, array(
50 array('event_type_id', 'template_id'),
53 // Required fields for creating an event template
54 elseif (empty($params['id']) && !empty($params['is_template'])) {
55 civicrm_api3_verify_mandatory($params, NULL, array(
60 // Clone event from template
61 if (!empty($params['template_id']) && empty($params['id'])) {
62 $copy = CRM_Event_BAO_Event
::copy($params['template_id']);
63 $params['id'] = $copy->id
;
64 unset($params['template_id']);
67 _civicrm_api3_event_create_legacy_support_42($params);
68 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Event');
72 * Adjust Metadata for Create action.
74 * The metadata is used for setting defaults, documentation & validation.
76 * @param array $params
77 * Array of parameters determined by getfields.
79 function _civicrm_api3_event_create_spec(&$params) {
80 $params['is_active']['api.default'] = 1;
81 $params['financial_type_id']['api.aliases'] = array('contribution_type_id');
82 $params['is_template']['api.default'] = 0;
86 * Support for schema changes made in 4.2.
88 * The main purpose of the API is to provide integrators a level of stability not provided by
89 * the core code or schema - this means we have to provide support for api calls (where possible)
90 * across schema changes.
92 * @param array $params
94 function _civicrm_api3_event_create_legacy_support_42(&$params) {
95 if (!empty($params['payment_processor_id'])) {
96 $params['payment_processor'] = CRM_Core_DAO
::VALUE_SEPARATOR
. $params['payment_processor_id'] . CRM_Core_DAO
::VALUE_SEPARATOR
;
103 * @param array $params
106 * Array of all found event property values.
108 function civicrm_api3_event_get($params) {
110 //legacy support for $params['return.sort']
111 if (!empty($params['return.sort'])) {
112 $params['options']['sort'] = $params['return.sort'];
113 unset($params['return.sort']);
116 //legacy support for $params['return.offset']
117 if (!empty($params['return.offset'])) {
118 $params['options']['offset'] = $params['return.offset'];
119 unset($params['return.offset']);
122 //legacy support for $params['return.max_results']
123 if (!empty($params['return.max_results'])) {
124 $params['options']['limit'] = $params['return.max_results'];
125 unset($params['return.max_results']);
128 $sql = CRM_Utils_SQL_Select
::fragment();
129 if (!empty($params['isCurrent'])) {
130 $sql->where('(start_date >= CURDATE() || end_date >= CURDATE())');
133 $events = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, FALSE, 'Event', $sql, TRUE);
134 $options = _civicrm_api3_get_options_from_params($params, TRUE);
135 if ($options['is_count']) {
136 return civicrm_api3_create_success($events, $params, 'Event', 'get');
138 foreach ($events as $id => $event) {
139 if (!empty($options['return']['is_full'])) {
140 _civicrm_api3_event_getisfull($events, $id);
142 _civicrm_api3_event_get_legacy_support_42($events, $id);
143 if (!empty($options['return']['price_set_id'])) {
144 $events[$id]['price_set_id'] = CRM_Price_BAO_PriceSet
::getFor('civicrm_event', $id);
148 return civicrm_api3_create_success($events, $params, 'Event', 'get');
152 * Adjust Metadata for Get action.
154 * The metadata is used for setting defaults, documentation & validation.
156 * @param array $params
157 * Array of parameters determined by getfields.
159 function _civicrm_api3_event_get_spec(&$params) {
160 $params['financial_type_id']['api.aliases'] = array('contribution_type_id');
164 * 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.
170 * @param array $event
171 * @param int $event_id
173 function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) {
174 if (!empty($event[$event_id]['payment_processor'])) {
175 $processors = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $event[$event_id]['payment_processor']);
176 if (count($processors) == 3) {
177 $event[$event_id]['payment_processor_id'] = $processors[1];
183 * Delete an existing Event.
185 * This API is used for deleting a event given its id.
187 * @param array $params
191 function civicrm_api3_event_delete($params) {
192 return CRM_Event_BAO_Event
::del($params['id']) ?
civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while deleting event'));
196 * Add 'is_full' & 'available_seats' to the return array.
198 * (this might be better in the BAO)
199 * Default BAO function returns a string if full rather than a Bool - which is more appropriate to a form
201 * @param array $event
202 * Return array of the event.
203 * @param int $event_id
204 * Id of the event to be updated.
206 function _civicrm_api3_event_getisfull(&$event, $event_id) {
207 $eventFullResult = CRM_Event_BAO_Participant
::eventFull($event_id, 1);
208 if (!empty($eventFullResult) && is_int($eventFullResult)) {
209 $event[$event_id]['available_places'] = $eventFullResult;
211 elseif (is_null($eventFullResult)) {
212 return $event[$event_id]['is_full'] = 0;
215 $event[$event_id]['available_places'] = 0;
217 $event[$event_id]['is_full'] = $event[$event_id]['available_places'] == 0 ?
1 : 0;
222 * Get event list parameters.
224 * @see _civicrm_api3_generic_getlist_params
226 * @param array $request
228 function _civicrm_api3_event_getlist_params(&$request) {
229 $fieldsToReturn = array('start_date', 'event_type_id', 'title', 'summary');
230 $request['params']['return'] = array_unique(array_merge($fieldsToReturn, $request['extra']));
231 $request['params']['options']['sort'] = 'start_date DESC';
232 if (empty($request['params']['id'])) {
233 $request['params'] +
= array(
241 * Get event list output.
243 * @see _civicrm_api3_generic_getlist_output
245 * @param array $result
246 * @param array $request
250 function _civicrm_api3_event_getlist_output($result, $request) {
252 if (!empty($result['values'])) {
253 foreach ($result['values'] as $row) {
255 'id' => $row[$request['id_field']],
256 'label' => $row[$request['label_field']],
257 'description' => array(
258 CRM_Core_Pseudoconstant
::getLabel(
259 'CRM_Event_BAO_Event',
261 $row['event_type_id']
265 if (!empty($row['start_date'])) {
266 $data['description'][0] .= ': ' . CRM_Utils_Date
::customFormat($row['start_date']);
268 if (!empty($row['summary'])) {
269 $data['description'][] = $row['summary'];
271 // Add repeating info
272 $repeat = CRM_Core_BAO_RecurringEntity
::getPositionAndCount($row['id'], 'civicrm_event');
273 $data['extra']['is_recur'] = FALSE;
275 $data['suffix'] = ts('(%1 of %2)', array(1 => $repeat[0], 2 => $repeat[1]));
276 $data['extra']['is_recur'] = TRUE;