Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 TO |
9 | +--------------------------------------------------------------------+ |
10 | ||
e70a7fc0 | 11 | */ |
6a488035 TO |
12 | |
13 | /** | |
6a488035 | 14 | * @package CRM |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { | |
18 | ||
19 | /** | |
66f9e52b | 20 | * Static field for all the participant information that we can potentially import. |
6a488035 TO |
21 | * |
22 | * @var array | |
6a488035 | 23 | */ |
90b461f1 | 24 | public static $_importableFields = NULL; |
6a488035 TO |
25 | |
26 | /** | |
66f9e52b | 27 | * Static field for all the participant information that we can potentially export. |
6a488035 TO |
28 | * |
29 | * @var array | |
6a488035 | 30 | */ |
90b461f1 | 31 | public static $_exportableFields = NULL; |
6a488035 TO |
32 | |
33 | /** | |
66f9e52b | 34 | * Static array for valid status transitions rules. |
6a488035 TO |
35 | * |
36 | * @var array | |
6a488035 | 37 | */ |
90b461f1 | 38 | public static $_statusTransitionsRules = [ |
be2fb01f CW |
39 | 'Pending from pay later' => ['Registered', 'Cancelled'], |
40 | 'Pending from incomplete transaction' => ['Registered', 'Cancelled'], | |
41 | 'On waitlist' => ['Cancelled', 'Pending from waitlist'], | |
42 | 'Pending from waitlist' => ['Registered', 'Cancelled'], | |
43 | 'Awaiting approval' => ['Cancelled', 'Pending from approval'], | |
44 | 'Pending from approval' => ['Registered', 'Cancelled'], | |
45 | ]; | |
0cf587a7 | 46 | |
6a488035 | 47 | /** |
66f9e52b | 48 | * Takes an associative array and creates a participant object. |
6a488035 TO |
49 | * |
50 | * the function extract all the params it needs to initialize the create a | |
51 | * participant object. the params array could contain additional unused name/value | |
52 | * pairs | |
53 | * | |
d4dd1e85 TO |
54 | * @param array $params |
55 | * (reference ) an assoc array of name/value pairs. | |
77035e4b | 56 | * |
16b10e64 | 57 | * @return CRM_Event_BAO_Participant |
6a488035 | 58 | */ |
00be9182 | 59 | public static function &add(&$params) { |
6a488035 | 60 | |
a7488080 | 61 | if (!empty($params['id'])) { |
6a488035 TO |
62 | CRM_Utils_Hook::pre('edit', 'Participant', $params['id'], $params); |
63 | } | |
64 | else { | |
65 | CRM_Utils_Hook::pre('create', 'Participant', NULL, $params); | |
66 | } | |
67 | ||
68 | // converting dates to mysql format | |
a7488080 | 69 | if (!empty($params['register_date'])) { |
6a488035 TO |
70 | $params['register_date'] = CRM_Utils_Date::isoToMysql($params['register_date']); |
71 | } | |
72 | ||
a7488080 | 73 | if (!empty($params['participant_fee_amount'])) { |
6a488035 TO |
74 | $params['participant_fee_amount'] = CRM_Utils_Rule::cleanMoney($params['participant_fee_amount']); |
75 | } | |
76 | ||
7577274a | 77 | // ensure that role ids are encoded as a string |
3cef9954 | 78 | if (isset($params['role_id']) && is_array($params['role_id'])) { |
653cbe46 | 79 | if (in_array(key($params['role_id']), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) { |
e51b7372 | 80 | $op = key($params['role_id']); |
81 | $params['role_id'] = $params['role_id'][$op]; | |
82 | } | |
774e09ad | 83 | else { |
84 | $params['role_id'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $params['role_id']); | |
85 | } | |
7577274a KJ |
86 | } |
87 | ||
2177d15c | 88 | $participantBAO = new CRM_Event_BAO_Participant(); |
a7488080 | 89 | if (!empty($params['id'])) { |
9c1bc317 | 90 | $participantBAO->id = $params['id'] ?? NULL; |
6a488035 TO |
91 | $participantBAO->find(TRUE); |
92 | $participantBAO->register_date = CRM_Utils_Date::isoToMysql($participantBAO->register_date); | |
93 | } | |
94 | ||
95 | $participantBAO->copyValues($params); | |
96 | ||
97 | //CRM-6910 | |
98 | //1. If currency present, it should be valid one. | |
99 | //2. We should have currency when amount is not null. | |
100 | $currency = $participantBAO->fee_currency; | |
101 | if ($currency || | |
102 | !CRM_Utils_System::isNull($participantBAO->fee_amount) | |
103 | ) { | |
104 | if (!CRM_Utils_Rule::currencyCode($currency)) { | |
105 | $config = CRM_Core_Config::singleton(); | |
106 | $currency = $config->defaultCurrency; | |
107 | } | |
108 | } | |
109 | $participantBAO->fee_currency = $currency; | |
110 | ||
111 | $participantBAO->save(); | |
112 | ||
2b68a50c | 113 | CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush(); |
6a488035 | 114 | |
a7488080 | 115 | if (!empty($params['id'])) { |
6a488035 TO |
116 | CRM_Utils_Hook::post('edit', 'Participant', $participantBAO->id, $participantBAO); |
117 | } | |
118 | else { | |
119 | CRM_Utils_Hook::post('create', 'Participant', $participantBAO->id, $participantBAO); | |
120 | } | |
121 | ||
122 | return $participantBAO; | |
123 | } | |
124 | ||
125 | /** | |
126 | * Given the list of params in the params array, fetch the object | |
127 | * and store the values in the values array | |
128 | * | |
d4dd1e85 TO |
129 | * @param array $params |
130 | * Input parameters to find object. | |
131 | * @param array $values | |
132 | * Output values of the object. | |
6a488035 | 133 | * |
77035e4b EM |
134 | * @param $ids |
135 | * | |
6a488035 | 136 | * @return CRM_Event_BAO_Participant|null the found object or null |
6a488035 | 137 | */ |
db62d3a5 | 138 | public static function getValues(&$params, &$values = [], &$ids = []) { |
6a488035 TO |
139 | if (empty($params)) { |
140 | return NULL; | |
141 | } | |
142 | $participant = new CRM_Event_BAO_Participant(); | |
143 | $participant->copyValues($params); | |
144 | $participant->find(); | |
be2fb01f | 145 | $participants = []; |
6a488035 TO |
146 | while ($participant->fetch()) { |
147 | $ids['participant'] = $participant->id; | |
148 | CRM_Core_DAO::storeValues($participant, $values[$participant->id]); | |
149 | $participants[$participant->id] = $participant; | |
150 | } | |
151 | return $participants; | |
152 | } | |
153 | ||
154 | /** | |
66f9e52b | 155 | * Takes an associative array and creates a participant object. |
6a488035 | 156 | * |
d4dd1e85 TO |
157 | * @param array $params |
158 | * (reference ) an assoc array of name/value pairs. | |
77035e4b | 159 | * |
16b10e64 | 160 | * @return CRM_Event_BAO_Participant |
6a488035 | 161 | */ |
00be9182 | 162 | public static function create(&$params) { |
6a488035 TO |
163 | |
164 | $transaction = new CRM_Core_Transaction(); | |
165 | $status = NULL; | |
166 | ||
a7488080 | 167 | if (!empty($params['id'])) { |
6a488035 TO |
168 | $status = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $params['id'], 'status_id'); |
169 | } | |
170 | ||
171 | $participant = self::add($params); | |
172 | ||
173 | if (is_a($participant, 'CRM_Core_Error')) { | |
174 | $transaction->rollback(); | |
175 | return $participant; | |
176 | } | |
177 | ||
d41da727 CW |
178 | // Log activity when creating new participant or changing status |
179 | if (empty($params['id']) || | |
9af2925b | 180 | (isset($params['status_id']) && $params['status_id'] != $status) |
6a488035 | 181 | ) { |
d41da727 CW |
182 | // Default status if not specified |
183 | $participant->status_id = $participant->status_id ?: self::fields()['participant_status_id']['default']; | |
75ae745c | 184 | CRM_Activity_BAO_Activity::addActivity($participant, 'Event Registration'); |
6a488035 TO |
185 | } |
186 | ||
187 | //CRM-5403 | |
188 | //for update mode | |
189 | if (self::isPrimaryParticipant($participant->id) && $status) { | |
190 | self::updateParticipantStatus($participant->id, $status, $participant->status_id); | |
191 | } | |
192 | ||
193 | $session = CRM_Core_Session::singleton(); | |
194 | $id = $session->get('userID'); | |
195 | if (!$id) { | |
9c1bc317 | 196 | $id = $params['contact_id'] ?? NULL; |
6a488035 TO |
197 | } |
198 | ||
199 | // add custom field values | |
a7488080 | 200 | if (!empty($params['custom']) && |
6a488035 TO |
201 | is_array($params['custom']) |
202 | ) { | |
203 | CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_participant', $participant->id); | |
204 | } | |
205 | ||
206 | //process note, CRM-7634 | |
207 | $noteId = NULL; | |
a7488080 | 208 | if (!empty($params['id'])) { |
6a488035 TO |
209 | $note = CRM_Core_BAO_Note::getNote($params['id'], 'civicrm_participant'); |
210 | $noteId = key($note); | |
211 | } | |
212 | $noteValue = NULL; | |
213 | $hasNoteField = FALSE; | |
be2fb01f | 214 | foreach ([ |
90b461f1 SL |
215 | 'note', |
216 | 'participant_note', | |
217 | ] as $noteFld) { | |
6a488035 TO |
218 | if (array_key_exists($noteFld, $params)) { |
219 | $noteValue = $params[$noteFld]; | |
220 | $hasNoteField = TRUE; | |
221 | break; | |
222 | } | |
223 | } | |
224 | if ($noteId || $noteValue) { | |
225 | if ($noteValue) { | |
be2fb01f | 226 | $noteParams = [ |
6a488035 TO |
227 | 'entity_table' => 'civicrm_participant', |
228 | 'note' => $noteValue, | |
229 | 'entity_id' => $participant->id, | |
230 | 'contact_id' => $id, | |
be2fb01f CW |
231 | ]; |
232 | $noteIDs = []; | |
6a488035 TO |
233 | if ($noteId) { |
234 | $noteIDs['id'] = $noteId; | |
235 | } | |
236 | CRM_Core_BAO_Note::add($noteParams, $noteIDs); | |
237 | } | |
238 | elseif ($noteId && $hasNoteField) { | |
6623e554 | 239 | CRM_Core_BAO_Note::deleteRecord(['id' => $noteId]); |
6a488035 TO |
240 | } |
241 | } | |
242 | ||
243 | // Log the information on successful add/edit of Participant data. | |
be2fb01f | 244 | $logParams = [ |
6a488035 TO |
245 | 'entity_table' => 'civicrm_participant', |
246 | 'entity_id' => $participant->id, | |
247 | 'data' => CRM_Event_PseudoConstant::participantStatus($participant->status_id), | |
248 | 'modified_id' => $id, | |
249 | 'modified_date' => date('Ymd'), | |
be2fb01f | 250 | ]; |
6a488035 TO |
251 | |
252 | CRM_Core_BAO_Log::add($logParams); | |
253 | ||
254 | $params['participant_id'] = $participant->id; | |
255 | ||
256 | $transaction->commit(); | |
257 | ||
258 | // do not add to recent items for import, CRM-4399 | |
a7488080 | 259 | if (empty($params['skipRecentView'])) { |
6a488035 TO |
260 | |
261 | $url = CRM_Utils_System::url('civicrm/contact/view/participant', | |
262 | "action=view&reset=1&id={$participant->id}&cid={$participant->contact_id}&context=home" | |
263 | ); | |
264 | ||
be2fb01f | 265 | $recentOther = []; |
6a488035 TO |
266 | if (CRM_Core_Permission::check('edit event participants')) { |
267 | $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/participant', | |
268 | "action=update&reset=1&id={$participant->id}&cid={$participant->contact_id}&context=home" | |
269 | ); | |
270 | } | |
271 | if (CRM_Core_Permission::check('delete in CiviEvent')) { | |
272 | $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/participant', | |
273 | "action=delete&reset=1&id={$participant->id}&cid={$participant->contact_id}&context=home" | |
274 | ); | |
275 | } | |
276 | ||
277 | $participantRoles = CRM_Event_PseudoConstant::participantRole(); | |
278 | ||
279 | if ($participant->role_id) { | |
280 | $role = explode(CRM_Core_DAO::VALUE_SEPARATOR, $participant->role_id); | |
281 | ||
282 | foreach ($role as & $roleValue) { | |
283 | if (isset($roleValue)) { | |
284 | $roleValue = $participantRoles[$roleValue]; | |
285 | } | |
286 | } | |
287 | $roles = implode(', ', $role); | |
288 | } | |
289 | ||
290 | $roleString = empty($roles) ? '' : $roles; | |
291 | $eventTitle = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $participant->event_id, 'title'); | |
292 | $title = CRM_Contact_BAO_Contact::displayName($participant->contact_id) . ' (' . $roleString . ' - ' . $eventTitle . ')'; | |
293 | ||
294 | // add the recently created Participant | |
295 | CRM_Utils_Recent::add($title, | |
296 | $url, | |
297 | $participant->id, | |
298 | 'Participant', | |
299 | $participant->contact_id, | |
300 | NULL, | |
301 | $recentOther | |
302 | ); | |
303 | } | |
304 | ||
305 | return $participant; | |
306 | } | |
307 | ||
308 | /** | |
66f9e52b | 309 | * Check whether the event is full for participation and return as. |
6a488035 TO |
310 | * per requirements. |
311 | * | |
d4dd1e85 TO |
312 | * @param int $eventId |
313 | * Event id. | |
314 | * @param bool $returnEmptySeats | |
315 | * Are we require number if empty seats. | |
316 | * @param bool $includeWaitingList | |
317 | * Consider waiting list in event full. | |
6a488035 TO |
318 | * calculation or not. (it is for cron job purpose) |
319 | * | |
77035e4b EM |
320 | * @param bool $returnWaitingCount |
321 | * @param bool $considerTestParticipant | |
49f3a6ff JG |
322 | * When TRUE, include participant records where is_test = 1. |
323 | * @param bool $onlyPositiveStatuses | |
324 | * When FALSE, count all participant statuses where is_counted = 1. This includes | |
325 | * both "Positive" participants (Registered, Attended, etc.) and waitlisted | |
326 | * (and some pending) participants. | |
327 | * When TRUE, count only participants with statuses of "Positive". | |
6a488035 | 328 | * |
72b3a70c CW |
329 | * @return bool|int|null|string |
330 | * 1. false => If event having some empty spaces. | |
6a488035 | 331 | */ |
2da40d21 | 332 | public static function eventFull( |
6a488035 TO |
333 | $eventId, |
334 | $returnEmptySeats = FALSE, | |
335 | $includeWaitingList = TRUE, | |
336 | $returnWaitingCount = FALSE, | |
49f3a6ff JG |
337 | $considerTestParticipant = FALSE, |
338 | $onlyPositiveStatuses = FALSE | |
6a488035 TO |
339 | ) { |
340 | $result = NULL; | |
341 | if (!$eventId) { | |
342 | return $result; | |
343 | } | |
344 | ||
345 | // consider event is full when. | |
346 | // 1. (count(is_counted) >= event_size) or | |
347 | // 2. (count(participants-with-status-on-waitlist) > 0) | |
348 | // It might be case there are some empty spaces and still event | |
349 | // is full, as waitlist might represent group require spaces > empty. | |
350 | ||
ddca8f33 TO |
351 | $participantRoles = CRM_Event_PseudoConstant::participantRole(NULL, 'filter = 1'); |
352 | $countedStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 1'); | |
49f3a6ff | 353 | $positiveStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Positive'"); |
ddca8f33 | 354 | $waitingStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Waiting'"); |
6a488035 TO |
355 | $onWaitlistStatusId = array_search('On waitlist', $waitingStatuses); |
356 | ||
be2fb01f | 357 | $where = [' event.id = %1 ']; |
6a488035 TO |
358 | if (!$considerTestParticipant) { |
359 | $where[] = ' ( participant.is_test = 0 OR participant.is_test IS NULL ) '; | |
360 | } | |
49f3a6ff JG |
361 | |
362 | // Only count Participant Roles with the "Counted?" flag. | |
6a488035 | 363 | if (!empty($participantRoles)) { |
be2fb01f | 364 | $escapedRoles = []; |
0906de17 MM |
365 | foreach (array_keys($participantRoles) as $participantRole) { |
366 | $escapedRoles[] = CRM_Utils_Type::escape($participantRole, 'String'); | |
367 | } | |
368 | ||
a7aa4454 CW |
369 | $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', $escapedRoles) . "([[:cntrl:]]|$)"; |
370 | $where[] = " participant.role_id REGEXP '{$regexp}'"; | |
6a488035 TO |
371 | } |
372 | ||
be2fb01f | 373 | $eventParams = [1 => [$eventId, 'Positive']]; |
6a488035 TO |
374 | |
375 | //in case any waiting, straight forward event is full. | |
376 | if ($includeWaitingList && $onWaitlistStatusId) { | |
377 | ||
378 | //build the where clause. | |
ddca8f33 TO |
379 | $whereClause = ' WHERE ' . implode(' AND ', $where); |
380 | $whereClause .= " AND participant.status_id = $onWaitlistStatusId "; | |
6a488035 TO |
381 | $eventSeatsWhere = implode(' AND ', $where) . " AND ( participant.status_id = $onWaitlistStatusId )"; |
382 | ||
383 | $query = " | |
384 | SELECT participant.id id, | |
385 | event.event_full_text as event_full_text | |
386 | FROM civicrm_participant participant | |
387 | INNER JOIN civicrm_event event ON ( event.id = participant.event_id ) | |
388 | {$whereClause}"; | |
389 | ||
92d6c5f5 | 390 | $eventFullText = ts('This event is full.'); |
6a488035 TO |
391 | $participants = CRM_Core_DAO::executeQuery($query, $eventParams); |
392 | while ($participants->fetch()) { | |
393 | //oops here event is full and we don't want waiting count. | |
394 | if ($returnWaitingCount) { | |
395 | return CRM_Event_BAO_Event::eventTotalSeats($eventId, $eventSeatsWhere); | |
396 | } | |
397 | else { | |
398 | return ($participants->event_full_text) ? $participants->event_full_text : $eventFullText; | |
399 | } | |
400 | } | |
401 | } | |
402 | ||
49f3a6ff JG |
403 | //Consider only counted participants, or alternatively only registered (not on waitlist) participants. |
404 | if ($onlyPositiveStatuses) { | |
405 | $where[] = ' participant.status_id IN ( ' . implode(', ', array_keys($positiveStatuses)) . ' ) '; | |
406 | } | |
407 | else { | |
408 | $where[] = ' participant.status_id IN ( ' . implode(', ', array_keys($countedStatuses)) . ' ) '; | |
409 | } | |
ddca8f33 | 410 | $whereClause = ' WHERE ' . implode(' AND ', $where); |
6a488035 TO |
411 | $eventSeatsWhere = implode(' AND ', $where); |
412 | ||
413 | $query = " | |
414 | SELECT participant.id id, | |
415 | event.event_full_text as event_full_text, | |
416 | event.max_participants as max_participants | |
417 | FROM civicrm_participant participant | |
418 | INNER JOIN civicrm_event event ON ( event.id = participant.event_id ) | |
419 | {$whereClause}"; | |
420 | ||
421 | $eventMaxSeats = NULL; | |
92d6c5f5 | 422 | $eventFullText = ts('This event is full.'); |
ddca8f33 | 423 | $participants = CRM_Core_DAO::executeQuery($query, $eventParams); |
6a488035 TO |
424 | while ($participants->fetch()) { |
425 | if ($participants->event_full_text) { | |
426 | $eventFullText = $participants->event_full_text; | |
427 | } | |
428 | $eventMaxSeats = $participants->max_participants; | |
429 | //don't have limit for event seats. | |
430 | if ($participants->max_participants == NULL) { | |
431 | return $result; | |
432 | } | |
433 | } | |
434 | ||
435 | //get the total event seats occupied by these participants. | |
436 | $eventRegisteredSeats = CRM_Event_BAO_Event::eventTotalSeats($eventId, $eventSeatsWhere); | |
437 | ||
438 | if ($eventRegisteredSeats) { | |
439 | if ($eventRegisteredSeats >= $eventMaxSeats) { | |
440 | $result = $eventFullText; | |
441 | } | |
442 | elseif ($returnEmptySeats) { | |
443 | $result = $eventMaxSeats - $eventRegisteredSeats; | |
444 | } | |
445 | return $result; | |
446 | } | |
447 | else { | |
448 | $query = ' | |
449 | SELECT event.event_full_text, | |
450 | event.max_participants | |
451 | FROM civicrm_event event | |
452 | WHERE event.id = %1'; | |
453 | $event = CRM_Core_DAO::executeQuery($query, $eventParams); | |
454 | while ($event->fetch()) { | |
455 | $eventFullText = $event->event_full_text; | |
456 | $eventMaxSeats = $event->max_participants; | |
457 | } | |
458 | } | |
459 | ||
460 | // no limit for registration. | |
461 | if ($eventMaxSeats == NULL) { | |
462 | return $result; | |
463 | } | |
464 | if ($eventMaxSeats) { | |
465 | return ($returnEmptySeats) ? (int) $eventMaxSeats : FALSE; | |
466 | } | |
467 | ||
31312bdc | 468 | return $eventFullText; |
6a488035 TO |
469 | } |
470 | ||
471 | /** | |
472 | * Return the array of all price set field options, | |
473 | * with total participant count that field going to carry. | |
474 | * | |
d4dd1e85 TO |
475 | * @param int $eventId |
476 | * Event id. | |
477 | * @param array $skipParticipantIds | |
478 | * An array of participant ids those we should skip. | |
77035e4b EM |
479 | * @param bool $considerCounted |
480 | * @param bool $considerWaiting | |
481 | * @param bool $considerTestParticipants | |
482 | * | |
a6c01b45 CW |
483 | * @return array |
484 | * an array of each option id and total count | |
6a488035 | 485 | */ |
2da40d21 | 486 | public static function priceSetOptionsCount( |
6a488035 | 487 | $eventId, |
be2fb01f | 488 | $skipParticipantIds = [], |
6a488035 TO |
489 | $considerCounted = TRUE, |
490 | $considerWaiting = TRUE, | |
491 | $considerTestParticipants = FALSE | |
492 | ) { | |
be2fb01f | 493 | $optionsCount = []; |
6a488035 TO |
494 | if (!$eventId) { |
495 | return $optionsCount; | |
496 | } | |
497 | ||
be2fb01f | 498 | $allStatusIds = []; |
6a488035 TO |
499 | if ($considerCounted) { |
500 | $countedStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 1'); | |
501 | $allStatusIds = array_merge($allStatusIds, array_keys($countedStatuses)); | |
502 | } | |
503 | if ($considerWaiting) { | |
504 | $waitingStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Waiting'"); | |
505 | $allStatusIds = array_merge($allStatusIds, array_keys($waitingStatuses)); | |
506 | } | |
507 | $statusIdClause = NULL; | |
508 | if (!empty($allStatusIds)) { | |
509 | $statusIdClause = ' AND participant.status_id IN ( ' . implode(', ', array_values($allStatusIds)) . ')'; | |
510 | } | |
511 | ||
512 | $isTestClause = NULL; | |
513 | if (!$considerTestParticipants) { | |
514 | $isTestClause = ' AND ( participant.is_test IS NULL OR participant.is_test = 0 )'; | |
515 | } | |
516 | ||
517 | $skipParticipantClause = NULL; | |
518 | if (is_array($skipParticipantIds) && !empty($skipParticipantIds)) { | |
519 | $skipParticipantClause = ' AND participant.id NOT IN ( ' . implode(', ', $skipParticipantIds) . ')'; | |
520 | } | |
521 | ||
522 | $sql = " | |
523 | SELECT line.id as lineId, | |
524 | line.entity_id as entity_id, | |
525 | line.qty, | |
526 | value.id as valueId, | |
527 | value.count, | |
528 | field.html_type | |
529 | FROM civicrm_line_item line | |
530 | INNER JOIN civicrm_participant participant ON ( line.entity_table = 'civicrm_participant' | |
531 | AND participant.id = line.entity_id ) | |
532 | INNER JOIN civicrm_price_field_value value ON ( value.id = line.price_field_value_id ) | |
533 | INNER JOIN civicrm_price_field field ON ( value.price_field_id = field.id ) | |
534 | WHERE participant.event_id = %1 | |
0d9c7c6d | 535 | AND line.qty > 0 |
6a488035 TO |
536 | {$statusIdClause} |
537 | {$isTestClause} | |
538 | {$skipParticipantClause}"; | |
539 | ||
be2fb01f | 540 | $lineItem = CRM_Core_DAO::executeQuery($sql, [1 => [$eventId, 'Positive']]); |
6a488035 TO |
541 | while ($lineItem->fetch()) { |
542 | $count = $lineItem->count; | |
543 | if (!$count) { | |
544 | $count = 1; | |
545 | } | |
546 | if ($lineItem->html_type == 'Text') { | |
547 | $count *= $lineItem->qty; | |
548 | } | |
549 | $optionsCount[$lineItem->valueId] = $count + CRM_Utils_Array::value($lineItem->valueId, $optionsCount, 0); | |
550 | } | |
551 | ||
552 | return $optionsCount; | |
553 | } | |
554 | ||
555 | /** | |
556 | * Get the empty spaces for event those we can allocate | |
557 | * to pending participant to become confirm. | |
558 | * | |
49f3a6ff JG |
559 | * @deprecated |
560 | * | |
d4dd1e85 TO |
561 | * @param int $eventId |
562 | * Event id. | |
6a488035 | 563 | * |
a6c01b45 CW |
564 | * @return int |
565 | * $spaces Number of Empty Seats/null. | |
6a488035 | 566 | */ |
00be9182 | 567 | public static function pendingToConfirmSpaces($eventId) { |
49f3a6ff JG |
568 | CRM_Core_Error::deprecatedFunctionWarning('CRM_Event_BAO_Participant::eventFull'); |
569 | return CRM_Event_BAO_Participant::eventFull($eventId, TRUE, FALSE, TRUE, FALSE, TRUE); | |
6a488035 TO |
570 | } |
571 | ||
572 | /** | |
66f9e52b | 573 | * Combine all the importable fields from the lower levels object. |
6a488035 | 574 | * |
77035e4b EM |
575 | * @param string $contactType |
576 | * @param bool $status | |
577 | * @param bool $onlyParticipant | |
e9ff5391 | 578 | * @param bool $checkPermission |
579 | * Is this a permissioned retrieval? | |
77035e4b | 580 | * |
a6c01b45 CW |
581 | * @return array |
582 | * array of importable Fields | |
6a488035 | 583 | */ |
e9ff5391 | 584 | public static function &importableFields($contactType = 'Individual', $status = TRUE, $onlyParticipant = FALSE, $checkPermission = TRUE) { |
6a488035 TO |
585 | if (!self::$_importableFields) { |
586 | if (!$onlyParticipant) { | |
587 | if (!$status) { | |
be2fb01f | 588 | $fields = ['' => ['title' => ts('- do not import -')]]; |
6a488035 TO |
589 | } |
590 | else { | |
be2fb01f | 591 | $fields = ['' => ['title' => ts('- Participant Fields -')]]; |
6a488035 TO |
592 | } |
593 | } | |
594 | else { | |
be2fb01f | 595 | $fields = []; |
6a488035 TO |
596 | } |
597 | ||
598 | $tmpFields = CRM_Event_DAO_Participant::import(); | |
599 | ||
be2fb01f CW |
600 | $note = [ |
601 | 'participant_note' => [ | |
3cb8f9b2 | 602 | 'title' => ts('Participant Note'), |
6a488035 TO |
603 | 'name' => 'participant_note', |
604 | 'headerPattern' => '/(participant.)?note$/i', | |
672b875d | 605 | 'data_type' => CRM_Utils_Type::T_TEXT, |
be2fb01f CW |
606 | ], |
607 | ]; | |
6a488035 | 608 | |
3cb8f9b2 CW |
609 | // Split status and status id into 2 fields |
610 | // Fixme: it would be better to leave as 1 field and intelligently handle both during import | |
be2fb01f CW |
611 | $participantStatus = [ |
612 | 'participant_status' => [ | |
3cb8f9b2 | 613 | 'title' => ts('Participant Status'), |
6a488035 TO |
614 | 'name' => 'participant_status', |
615 | 'data_type' => CRM_Utils_Type::T_STRING, | |
be2fb01f CW |
616 | ], |
617 | ]; | |
3cb8f9b2 | 618 | $tmpFields['participant_status_id']['title'] = ts('Participant Status Id'); |
6a488035 | 619 | |
3cb8f9b2 CW |
620 | // Split role and role id into 2 fields |
621 | // Fixme: it would be better to leave as 1 field and intelligently handle both during import | |
be2fb01f CW |
622 | $participantRole = [ |
623 | 'participant_role' => [ | |
3cb8f9b2 | 624 | 'title' => ts('Participant Role'), |
6a488035 TO |
625 | 'name' => 'participant_role', |
626 | 'data_type' => CRM_Utils_Type::T_STRING, | |
be2fb01f CW |
627 | ], |
628 | ]; | |
3cb8f9b2 | 629 | $tmpFields['participant_role_id']['title'] = ts('Participant Role Id'); |
6a488035 | 630 | |
be2fb01f CW |
631 | $eventType = [ |
632 | 'event_type' => [ | |
3cb8f9b2 | 633 | 'title' => ts('Event Type'), |
6a488035 TO |
634 | 'name' => 'event_type', |
635 | 'data_type' => CRM_Utils_Type::T_STRING, | |
be2fb01f CW |
636 | ], |
637 | ]; | |
6a488035 | 638 | |
be2fb01f CW |
639 | $tmpContactField = $contactFields = []; |
640 | $contactFields = []; | |
6a488035 TO |
641 | if (!$onlyParticipant) { |
642 | $contactFields = CRM_Contact_BAO_Contact::importableFields($contactType, NULL); | |
643 | ||
644 | // Using new Dedupe rule. | |
be2fb01f | 645 | $ruleParams = [ |
6a488035 | 646 | 'contact_type' => $contactType, |
ddca8f33 | 647 | 'used' => 'Unsupervised', |
be2fb01f | 648 | ]; |
61194d45 | 649 | $fieldsArray = CRM_Dedupe_BAO_DedupeRule::dedupeRuleFields($ruleParams); |
6a488035 TO |
650 | |
651 | if (is_array($fieldsArray)) { | |
652 | foreach ($fieldsArray as $value) { | |
653 | $customFieldId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField', | |
654 | $value, | |
655 | 'id', | |
656 | 'column_name' | |
657 | ); | |
658 | $value = $customFieldId ? 'custom_' . $customFieldId : $value; | |
9c1bc317 | 659 | $tmpContactField[trim($value)] = $contactFields[trim($value)] ?? NULL; |
6a488035 TO |
660 | if (!$status) { |
661 | $title = $tmpContactField[trim($value)]['title'] . ' (match to contact)'; | |
662 | } | |
663 | else { | |
664 | $title = $tmpContactField[trim($value)]['title']; | |
665 | } | |
666 | ||
667 | $tmpContactField[trim($value)]['title'] = $title; | |
668 | } | |
669 | } | |
670 | } | |
9c1bc317 | 671 | $extIdentifier = $contactFields['external_identifier'] ?? NULL; |
6a488035 TO |
672 | if ($extIdentifier) { |
673 | $tmpContactField['external_identifier'] = $extIdentifier; | |
6c552737 | 674 | $tmpContactField['external_identifier']['title'] = CRM_Utils_Array::value('title', $extIdentifier) . ' (match to contact)'; |
6a488035 | 675 | } |
6c552737 | 676 | $tmpFields['participant_contact_id']['title'] = $tmpFields['participant_contact_id']['title'] . ' (match to contact)'; |
6a488035 | 677 | |
6a488035 TO |
678 | $fields = array_merge($fields, $tmpContactField); |
679 | $fields = array_merge($fields, $tmpFields); | |
680 | $fields = array_merge($fields, $note, $participantStatus, $participantRole, $eventType); | |
e9ff5391 | 681 | $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Participant', FALSE, FALSE, FALSE, $checkPermission)); |
6a488035 TO |
682 | |
683 | self::$_importableFields = $fields; | |
684 | } | |
685 | ||
686 | return self::$_importableFields; | |
687 | } | |
688 | ||
689 | /** | |
e9ff5391 | 690 | * Combine all the exportable fields from the lower level objects. |
691 | * | |
692 | * @param bool $checkPermission | |
6a488035 | 693 | * |
a6c01b45 CW |
694 | * @return array |
695 | * array of exportable Fields | |
6a488035 | 696 | */ |
e9ff5391 | 697 | public static function &exportableFields($checkPermission = TRUE) { |
6a488035 TO |
698 | if (!self::$_exportableFields) { |
699 | if (!self::$_exportableFields) { | |
be2fb01f | 700 | self::$_exportableFields = []; |
6a488035 TO |
701 | } |
702 | ||
6a488035 | 703 | $participantFields = CRM_Event_DAO_Participant::export(); |
e51b7372 | 704 | $eventFields = CRM_Event_DAO_Event::export(); |
be2fb01f CW |
705 | $noteField = [ |
706 | 'participant_note' => [ | |
e300cf31 | 707 | 'title' => ts('Participant Note'), |
6a488035 | 708 | 'name' => 'participant_note', |
e51b7372 | 709 | 'type' => CRM_Utils_Type::T_STRING, |
be2fb01f CW |
710 | ], |
711 | ]; | |
6a488035 | 712 | |
be2fb01f CW |
713 | $participantStatus = [ |
714 | 'participant_status' => [ | |
e300cf31 | 715 | 'title' => ts('Participant Status (label)'), |
6a488035 | 716 | 'name' => 'participant_status', |
e51b7372 | 717 | 'type' => CRM_Utils_Type::T_STRING, |
be2fb01f CW |
718 | ], |
719 | ]; | |
6a488035 | 720 | |
be2fb01f CW |
721 | $participantRole = [ |
722 | 'participant_role' => [ | |
e300cf31 | 723 | 'title' => ts('Participant Role (label)'), |
6a488035 | 724 | 'name' => 'participant_role', |
e51b7372 | 725 | 'type' => CRM_Utils_Type::T_STRING, |
be2fb01f CW |
726 | ], |
727 | ]; | |
8b8fa582 | 728 | |
1fbc48b0 CW |
729 | $participantFields['participant_role_id']['title'] .= ' (ID)'; |
730 | ||
a1a2a83d | 731 | $discountFields = CRM_Core_DAO_Discount::export(); |
6a488035 | 732 | |
a1a2a83d | 733 | $fields = array_merge($participantFields, $participantStatus, $participantRole, $eventFields, $noteField, $discountFields); |
6a488035 | 734 | |
a1a2a83d | 735 | // add custom data |
e9ff5391 | 736 | $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Participant', FALSE, FALSE, FALSE, $checkPermission)); |
a1a2a83d | 737 | self::$_exportableFields = $fields; |
6a488035 TO |
738 | } |
739 | ||
740 | return self::$_exportableFields; | |
741 | } | |
742 | ||
743 | /** | |
100fef9d | 744 | * Get the event name/sort name for a particular participation / participant |
6a488035 | 745 | * |
d4dd1e85 TO |
746 | * @param int $participantId |
747 | * Id of the participant. | |
6a488035 | 748 | * |
a6c01b45 CW |
749 | * @return array |
750 | * associated array with sort_name and event title | |
6a488035 | 751 | */ |
00be9182 | 752 | public static function participantDetails($participantId) { |
6a488035 TO |
753 | $query = " |
754 | SELECT civicrm_contact.sort_name as name, civicrm_event.title as title, civicrm_contact.id as cid | |
755 | FROM civicrm_participant | |
756 | LEFT JOIN civicrm_event ON (civicrm_participant.event_id = civicrm_event.id) | |
757 | LEFT JOIN civicrm_contact ON (civicrm_participant.contact_id = civicrm_contact.id) | |
758 | WHERE civicrm_participant.id = {$participantId} | |
759 | "; | |
33621c4f | 760 | $dao = CRM_Core_DAO::executeQuery($query); |
6a488035 | 761 | |
be2fb01f | 762 | $details = []; |
6a488035 | 763 | while ($dao->fetch()) { |
ddca8f33 | 764 | $details['name'] = $dao->name; |
6a488035 | 765 | $details['title'] = $dao->title; |
ddca8f33 | 766 | $details['cid'] = $dao->cid; |
6a488035 TO |
767 | } |
768 | ||
769 | return $details; | |
770 | } | |
771 | ||
772 | /** | |
773 | * Get the values for pseudoconstants for name->value and reverse. | |
774 | * | |
d4dd1e85 TO |
775 | * @param array $defaults |
776 | * (reference) the default values, some of which need to be resolved. | |
777 | * @param bool $reverse | |
778 | * True if we want to resolve the values in the reverse direction (value -> name). | |
6a488035 | 779 | */ |
00be9182 | 780 | public static function resolveDefaults(&$defaults, $reverse = FALSE) { |
6a488035 TO |
781 | self::lookupValue($defaults, 'event', CRM_Event_PseudoConstant::event(), $reverse); |
782 | self::lookupValue($defaults, 'status', CRM_Event_PseudoConstant::participantStatus(NULL, NULL, 'label'), $reverse); | |
783 | self::lookupValue($defaults, 'role', CRM_Event_PseudoConstant::participantRole(), $reverse); | |
784 | } | |
785 | ||
786 | /** | |
3bdf1f3a | 787 | * Convert associative array names to values and vice-versa. |
6a488035 TO |
788 | * |
789 | * This function is used by both the web form layer and the api. Note that | |
790 | * the api needs the name => value conversion, also the view layer typically | |
791 | * requires value => name conversion | |
ad37ac8e | 792 | * |
793 | * @param array $defaults | |
794 | * @param string $property | |
64f4eebe | 795 | * @param string[] $lookup |
ad37ac8e | 796 | * @param bool $reverse |
797 | * | |
798 | * @return bool | |
6a488035 | 799 | */ |
00be9182 | 800 | public static function lookupValue(&$defaults, $property, $lookup, $reverse) { |
6a488035 TO |
801 | $id = $property . '_id'; |
802 | ||
803 | $src = $reverse ? $property : $id; | |
804 | $dst = $reverse ? $id : $property; | |
805 | ||
806 | if (!array_key_exists($src, $defaults)) { | |
807 | return FALSE; | |
808 | } | |
809 | ||
810 | $look = $reverse ? array_flip($lookup) : $lookup; | |
811 | ||
812 | if (is_array($look)) { | |
813 | if (!array_key_exists($defaults[$src], $look)) { | |
814 | return FALSE; | |
815 | } | |
816 | } | |
817 | $defaults[$dst] = $look[$defaults[$src]]; | |
818 | return TRUE; | |
819 | } | |
820 | ||
821 | /** | |
3bdf1f3a | 822 | * Delete the records that are associated with this participation. |
6a488035 | 823 | * |
d4dd1e85 TO |
824 | * @param int $id |
825 | * Id of the participation to delete. | |
6a488035 | 826 | * |
3bdf1f3a | 827 | * @return \CRM_Event_DAO_Participant |
6a488035 | 828 | */ |
00be9182 | 829 | public static function deleteParticipant($id) { |
a60c0bc8 SL |
830 | $participant = new CRM_Event_DAO_Participant(); |
831 | $participant->id = $id; | |
832 | if (!$participant->find()) { | |
833 | return FALSE; | |
834 | } | |
be12df5a | 835 | CRM_Utils_Hook::pre('delete', 'Participant', $id); |
6a488035 TO |
836 | |
837 | $transaction = new CRM_Core_Transaction(); | |
838 | ||
839 | //delete activity record | |
be2fb01f | 840 | $params = [ |
6a488035 TO |
841 | 'source_record_id' => $id, |
842 | // activity type id for event registration | |
843 | 'activity_type_id' => 5, | |
be2fb01f | 844 | ]; |
6a488035 TO |
845 | |
846 | CRM_Activity_BAO_Activity::deleteActivity($params); | |
847 | ||
848 | // delete the participant payment record | |
849 | // we need to do this since the cascaded constraints | |
850 | // dont work with join tables | |
be2fb01f | 851 | $p = ['participant_id' => $id]; |
6a488035 TO |
852 | CRM_Event_BAO_ParticipantPayment::deleteParticipantPayment($p); |
853 | ||
854 | // cleanup line items. | |
be2fb01f | 855 | $participantsId = []; |
ddca8f33 | 856 | $participantsId = self::getAdditionalParticipantIds($id); |
6a488035 TO |
857 | $participantsId[] = $id; |
858 | CRM_Price_BAO_LineItem::deleteLineItems($participantsId, 'civicrm_participant'); | |
859 | ||
860 | //delete note when participant deleted. | |
861 | $note = CRM_Core_BAO_Note::getNote($id, 'civicrm_participant'); | |
862 | $noteId = key($note); | |
863 | if ($noteId) { | |
6623e554 | 864 | CRM_Core_BAO_Note::deleteRecord(['id' => $noteId]); |
6a488035 TO |
865 | } |
866 | ||
6a488035 TO |
867 | $participant->delete(); |
868 | ||
869 | $transaction->commit(); | |
870 | ||
871 | CRM_Utils_Hook::post('delete', 'Participant', $participant->id, $participant); | |
872 | ||
6a488035 TO |
873 | return $participant; |
874 | } | |
875 | ||
876 | /** | |
66f9e52b | 877 | * Checks duplicate participants. |
6a488035 | 878 | * |
d4dd1e85 TO |
879 | * @param array $input |
880 | * An assosiative array of name /value pairs. | |
16b10e64 | 881 | * from other function |
a1a2a83d TO |
882 | * @param array $duplicates |
883 | * (reference ) an assoc array of name/value pairs. | |
6a488035 | 884 | * |
16b10e64 | 885 | * @return CRM_Contribute_BAO_Contribution |
6a488035 | 886 | */ |
00be9182 | 887 | public static function checkDuplicate($input, &$duplicates) { |
9c1bc317 CW |
888 | $eventId = $input['event_id'] ?? NULL; |
889 | $contactId = $input['contact_id'] ?? NULL; | |
6a488035 | 890 | |
be2fb01f CW |
891 | $clause = []; |
892 | $input = []; | |
6a488035 TO |
893 | |
894 | if ($eventId) { | |
895 | $clause[] = "event_id = %1"; | |
be2fb01f | 896 | $input[1] = [$eventId, 'Integer']; |
6a488035 TO |
897 | } |
898 | ||
899 | if ($contactId) { | |
900 | $clause[] = "contact_id = %2"; | |
be2fb01f | 901 | $input[2] = [$contactId, 'Integer']; |
6a488035 TO |
902 | } |
903 | ||
904 | if (empty($clause)) { | |
905 | return FALSE; | |
906 | } | |
907 | ||
908 | $clause = implode(' AND ', $clause); | |
909 | ||
ddca8f33 TO |
910 | $query = "SELECT id FROM civicrm_participant WHERE $clause"; |
911 | $dao = CRM_Core_DAO::executeQuery($query, $input); | |
6a488035 TO |
912 | $result = FALSE; |
913 | while ($dao->fetch()) { | |
914 | $duplicates[] = $dao->id; | |
915 | $result = TRUE; | |
916 | } | |
917 | return $result; | |
918 | } | |
919 | ||
920 | /** | |
66f9e52b | 921 | * Fix the event level. |
6a488035 TO |
922 | * |
923 | * When price sets are used as event fee, fee_level is set as ^A | |
77035e4b | 924 | * separated string. We need to change that string to comma |
6a488035 TO |
925 | * separated string before using fee_level in view mode. |
926 | * | |
d4dd1e85 | 927 | * @param string $eventLevel |
3bdf1f3a | 928 | * Event_level string from db. |
6a488035 | 929 | */ |
00be9182 | 930 | public static function fixEventLevel(&$eventLevel) { |
6a488035 TO |
931 | if ((substr($eventLevel, 0, 1) == CRM_Core_DAO::VALUE_SEPARATOR) && |
932 | (substr($eventLevel, -1, 1) == CRM_Core_DAO::VALUE_SEPARATOR) | |
933 | ) { | |
9747cc7e | 934 | $eventLevel = implode(', ', explode(CRM_Core_DAO::VALUE_SEPARATOR, substr($eventLevel, 1, -1))); |
0cca0bf4 J |
935 | $pos = strrpos($eventLevel, '(multiple participants)', 0); |
936 | if ($pos) { | |
6a488035 TO |
937 | $eventLevel = substr_replace($eventLevel, "", $pos - 3, 1); |
938 | } | |
939 | } | |
940 | elseif ((substr($eventLevel, 0, 1) == CRM_Core_DAO::VALUE_SEPARATOR)) { | |
941 | $eventLevel = implode(', ', explode(CRM_Core_DAO::VALUE_SEPARATOR, | |
ddca8f33 TO |
942 | substr($eventLevel, 0, 1) |
943 | )); | |
6a488035 TO |
944 | } |
945 | elseif ((substr($eventLevel, -1, 1) == CRM_Core_DAO::VALUE_SEPARATOR)) { | |
946 | $eventLevel = implode(', ', explode(CRM_Core_DAO::VALUE_SEPARATOR, | |
ddca8f33 TO |
947 | substr($eventLevel, 0, -1) |
948 | )); | |
6a488035 TO |
949 | } |
950 | } | |
951 | ||
fc076fe3 | 952 | /** |
953 | * Get the ID of the default (first) participant role | |
954 | * | |
955 | * @return int | |
956 | * @throws \CiviCRM_API3_Exception | |
957 | */ | |
958 | public static function getDefaultRoleID() { | |
959 | return (int) civicrm_api3('OptionValue', 'getvalue', [ | |
960 | 'return' => 'value', | |
961 | 'option_group_id' => 'participant_role', | |
962 | 'is_active' => 1, | |
963 | 'options' => ['limit' => 1, 'sort' => 'is_default DESC'], | |
964 | ]); | |
965 | } | |
966 | ||
6a488035 | 967 | /** |
100fef9d | 968 | * Get the additional participant ids. |
6a488035 | 969 | * |
d4dd1e85 TO |
970 | * @param int $primaryParticipantId |
971 | * Primary partycipant Id. | |
972 | * @param bool $excludeCancel | |
973 | * Do not include participant those are cancelled. | |
654ca41c | 974 | * |
100fef9d | 975 | * @param int $oldStatusId |
6a488035 | 976 | * |
a6c01b45 | 977 | * @return array |
6a488035 | 978 | */ |
00be9182 | 979 | public static function getAdditionalParticipantIds($primaryParticipantId, $excludeCancel = TRUE, $oldStatusId = NULL) { |
be2fb01f | 980 | $additionalParticipantIds = []; |
6a488035 TO |
981 | if (!$primaryParticipantId) { |
982 | return $additionalParticipantIds; | |
983 | } | |
984 | ||
985 | $where = "participant.registered_by_id={$primaryParticipantId}"; | |
986 | if ($excludeCancel) { | |
ddca8f33 | 987 | $cancelStatusId = 0; |
6a488035 | 988 | $negativeStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Negative'"); |
ddca8f33 | 989 | $cancelStatusId = array_search('Cancelled', $negativeStatuses); |
6a488035 TO |
990 | $where .= " AND participant.status_id != {$cancelStatusId}"; |
991 | } | |
992 | ||
993 | if ($oldStatusId) { | |
994 | $where .= " AND participant.status_id = {$oldStatusId}"; | |
995 | } | |
996 | ||
997 | $query = " | |
998 | SELECT participant.id | |
999 | FROM civicrm_participant participant | |
1000 | WHERE {$where}"; | |
1001 | ||
1002 | $dao = CRM_Core_DAO::executeQuery($query); | |
1003 | while ($dao->fetch()) { | |
1004 | $additionalParticipantIds[$dao->id] = $dao->id; | |
1005 | } | |
1006 | return $additionalParticipantIds; | |
1007 | } | |
1008 | ||
362bd1b7 | 1009 | /** |
1010 | * Get the amount for the undiscounted version of the field. | |
1011 | * | |
1012 | * Note this function is part of the refactoring process rather than the best approach. | |
1013 | * | |
1014 | * @param int $eventID | |
1015 | * @param int $discountedPriceFieldOptionID | |
1016 | * @param string $feeLevel (deprecated) | |
1017 | * | |
1018 | * @return null|string | |
1019 | */ | |
1020 | public static function getUnDiscountedAmountForEventPriceSetFieldValue($eventID, $discountedPriceFieldOptionID, $feeLevel) { | |
1021 | $priceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_event', $eventID, NULL); | |
be2fb01f CW |
1022 | $params = [ |
1023 | 1 => [$priceSetId, 'Integer'], | |
1024 | ]; | |
362bd1b7 | 1025 | if ($discountedPriceFieldOptionID) { |
1026 | $query = "SELECT cpfv.amount FROM `civicrm_price_field_value` cpfv | |
1027 | LEFT JOIN civicrm_price_field cpf ON cpfv.price_field_id = cpf.id | |
1028 | WHERE cpf.price_set_id = %1 AND cpfv.label = (SELECT label from civicrm_price_field_value WHERE id = %2)"; | |
be2fb01f | 1029 | $params[2] = [$discountedPriceFieldOptionID, 'Integer']; |
362bd1b7 | 1030 | } |
1031 | else { | |
1032 | $feeLevel = current($feeLevel); | |
1033 | $query = "SELECT cpfv.amount FROM `civicrm_price_field_value` cpfv | |
1034 | LEFT JOIN civicrm_price_field cpf ON cpfv.price_field_id = cpf.id | |
1035 | WHERE cpf.price_set_id = %1 AND cpfv.label LIKE %2"; | |
be2fb01f | 1036 | $params[2] = [$feeLevel, 'String']; |
362bd1b7 | 1037 | } |
1038 | return CRM_Core_DAO::singleValueQuery($query, $params); | |
1039 | } | |
1040 | ||
6a488035 TO |
1041 | /** |
1042 | * Retrieve additional participants display-names and URL to view their participant records. | |
1043 | * (excludes cancelled participants automatically) | |
1044 | * | |
d4dd1e85 TO |
1045 | * @param int $primaryParticipantID |
1046 | * Id of primary participant record. | |
6a488035 | 1047 | * |
a6c01b45 CW |
1048 | * @return array |
1049 | * $displayName => $viewUrl | |
6a488035 | 1050 | */ |
00be9182 | 1051 | public static function getAdditionalParticipants($primaryParticipantID) { |
be2fb01f | 1052 | $additionalParticipantIDs = []; |
6a488035 TO |
1053 | $additionalParticipantIDs = self::getAdditionalParticipantIds($primaryParticipantID); |
1054 | if (!empty($additionalParticipantIDs)) { | |
1055 | foreach ($additionalParticipantIDs as $additionalParticipantID) { | |
1056 | $additionalContactID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', | |
1057 | $additionalParticipantID, | |
1058 | 'contact_id', 'id' | |
1059 | ); | |
1060 | $additionalContactName = CRM_Contact_BAO_Contact::displayName($additionalContactID); | |
1061 | $pViewURL = CRM_Utils_System::url('civicrm/contact/view/participant', | |
1062 | "action=view&reset=1&id={$additionalParticipantID}&cid={$additionalContactID}" | |
1063 | ); | |
1064 | ||
1065 | $additionalParticipants[$additionalContactName] = $pViewURL; | |
1066 | } | |
1067 | } | |
1068 | return $additionalParticipants; | |
1069 | } | |
1070 | ||
1071 | /** | |
66f9e52b | 1072 | * Function for update primary and additional participant status. |
6a488035 | 1073 | * |
d4dd1e85 TO |
1074 | * @param int $participantID |
1075 | * Primary participant's id. | |
100fef9d CW |
1076 | * @param int $oldStatusID |
1077 | * @param int $newStatusID | |
654ca41c EM |
1078 | * @param bool $updatePrimaryStatus |
1079 | * | |
a1a2a83d | 1080 | * @return bool|NULL |
6a488035 | 1081 | */ |
00be9182 | 1082 | public static function updateParticipantStatus($participantID, $oldStatusID, $newStatusID = NULL, $updatePrimaryStatus = FALSE) { |
6a488035 | 1083 | if (!$participantID || !$oldStatusID) { |
a1a2a83d | 1084 | return NULL; |
6a488035 TO |
1085 | } |
1086 | ||
1087 | if (!$newStatusID) { | |
1088 | $newStatusID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $participantID, 'status_id'); | |
1089 | } | |
1090 | elseif ($updatePrimaryStatus) { | |
1091 | CRM_Core_DAO::setFieldValue('CRM_Event_DAO_Participant', $participantID, 'status_id', $newStatusID); | |
1092 | } | |
1093 | ||
1094 | $cascadeAdditionalIds = self::getValidAdditionalIds($participantID, $oldStatusID, $newStatusID); | |
1095 | ||
1096 | if (!empty($cascadeAdditionalIds)) { | |
f7f14b5c JP |
1097 | try { |
1098 | foreach ($cascadeAdditionalIds as $id) { | |
be2fb01f | 1099 | $participantParams = [ |
f7f14b5c JP |
1100 | 'id' => $id, |
1101 | 'status_id' => $newStatusID, | |
be2fb01f | 1102 | ]; |
f7f14b5c JP |
1103 | civicrm_api3('Participant', 'create', $participantParams); |
1104 | } | |
1105 | return TRUE; | |
1106 | } | |
1107 | catch (CiviCRM_API3_Exception $e) { | |
1108 | throw new CRM_Core_Exception('Failed to update additional participant status in database'); | |
29a59599 | 1109 | } |
6a488035 TO |
1110 | } |
1111 | return FALSE; | |
1112 | } | |
1113 | ||
1114 | /** | |
66f9e52b | 1115 | * Function for update status for given participant ids. |
6a488035 | 1116 | * |
d4dd1e85 TO |
1117 | * @param int $participantIds |
1118 | * Array of participant ids. | |
1119 | * @param int $statusId | |
1120 | * Status id for participant. | |
654ca41c | 1121 | * @param bool $updateRegisterDate |
6a488035 | 1122 | */ |
00be9182 | 1123 | public static function updateStatus($participantIds, $statusId, $updateRegisterDate = FALSE) { |
6a488035 TO |
1124 | if (!is_array($participantIds) || empty($participantIds) || !$statusId) { |
1125 | return; | |
1126 | } | |
1127 | ||
1128 | //lets update register date as we update status to keep track | |
1129 | //when we did update status, useful for moving participant | |
1130 | //from pending to expired. | |
1131 | $setClause = "status_id = {$statusId}"; | |
1132 | if ($updateRegisterDate) { | |
1133 | $setClause .= ", register_date = NOW()"; | |
1134 | } | |
1135 | ||
1136 | $participantIdClause = '( ' . implode(',', $participantIds) . ' )'; | |
1137 | ||
1138 | $query = " | |
1139 | UPDATE civicrm_participant | |
1140 | SET {$setClause} | |
1141 | WHERE id IN {$participantIdClause}"; | |
1142 | ||
1143 | $dao = CRM_Core_DAO::executeQuery($query); | |
1144 | } | |
1145 | ||
654ca41c | 1146 | /** |
6a488035 TO |
1147 | * Function takes participant ids and statuses |
1148 | * update status from $fromStatusId to $toStatusId | |
1149 | * and send mail + create activities. | |
1150 | * | |
d4dd1e85 TO |
1151 | * @param array $participantIds |
1152 | * Participant ids. | |
1153 | * @param int $toStatusId | |
1154 | * Update status id. | |
1155 | * @param int $fromStatusId | |
1156 | * From status id. | |
654ca41c EM |
1157 | * @param bool $returnResult |
1158 | * @param bool $skipCascadeRule | |
1159 | * | |
a1a2a83d | 1160 | * @return array|NULL |
6a488035 | 1161 | */ |
2da40d21 | 1162 | public static function transitionParticipants( |
ddca8f33 | 1163 | $participantIds, $toStatusId, |
6a488035 TO |
1164 | $fromStatusId = NULL, $returnResult = FALSE, $skipCascadeRule = FALSE |
1165 | ) { | |
1166 | if (!is_array($participantIds) || empty($participantIds) || !$toStatusId) { | |
a1a2a83d | 1167 | return NULL; |
6a488035 TO |
1168 | } |
1169 | ||
1170 | //thumb rule is if we triggering primary participant need to triggered additional | |
be2fb01f | 1171 | $allParticipantIds = $primaryANDAdditonalIds = []; |
6a488035 TO |
1172 | foreach ($participantIds as $id) { |
1173 | $allParticipantIds[] = $id; | |
1174 | if (self::isPrimaryParticipant($id)) { | |
1175 | //filter additional as per status transition rules, CRM-5403 | |
1176 | if ($skipCascadeRule) { | |
1177 | $additionalIds = self::getAdditionalParticipantIds($id); | |
1178 | } | |
1179 | else { | |
1180 | $additionalIds = self::getValidAdditionalIds($id, $fromStatusId, $toStatusId); | |
1181 | } | |
1182 | if (!empty($additionalIds)) { | |
1183 | $allParticipantIds = array_merge($allParticipantIds, $additionalIds); | |
1184 | $primaryANDAdditonalIds[$id] = $additionalIds; | |
1185 | } | |
1186 | } | |
1187 | } | |
1188 | ||
1189 | //get the unique participant ids, | |
1190 | $allParticipantIds = array_unique($allParticipantIds); | |
1191 | ||
1192 | //pull required participants, contacts, events data, if not in hand | |
be2fb01f | 1193 | static $eventDetails = []; |
be2fb01f | 1194 | static $contactDetails = []; |
6a488035 | 1195 | |
be2fb01f | 1196 | $contactIds = $eventIds = $participantDetails = []; |
6a488035 | 1197 | |
ddca8f33 | 1198 | $statusTypes = CRM_Event_PseudoConstant::participantStatus(); |
6a488035 | 1199 | $participantRoles = CRM_Event_PseudoConstant::participantRole(); |
ddca8f33 | 1200 | $pendingStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, |
6a488035 TO |
1201 | "class = 'Pending'" |
1202 | ); | |
1203 | ||
1204 | //first thing is pull all necessory data from db. | |
1205 | $participantIdClause = '(' . implode(',', $allParticipantIds) . ')'; | |
1206 | ||
1207 | //get all participants data. | |
1208 | $query = "SELECT * FROM civicrm_participant WHERE id IN {$participantIdClause}"; | |
1209 | $dao = CRM_Core_DAO::executeQuery($query); | |
1210 | while ($dao->fetch()) { | |
be2fb01f | 1211 | $participantDetails[$dao->id] = [ |
6a488035 TO |
1212 | 'id' => $dao->id, |
1213 | 'role' => $participantRoles[$dao->role_id], | |
1214 | 'is_test' => $dao->is_test, | |
1215 | 'event_id' => $dao->event_id, | |
1216 | 'status_id' => $dao->status_id, | |
1217 | 'fee_amount' => $dao->fee_amount, | |
1218 | 'contact_id' => $dao->contact_id, | |
1219 | 'register_date' => $dao->register_date, | |
1220 | 'registered_by_id' => $dao->registered_by_id, | |
be2fb01f | 1221 | ]; |
6a488035 TO |
1222 | if (!array_key_exists($dao->contact_id, $contactDetails)) { |
1223 | $contactIds[$dao->contact_id] = $dao->contact_id; | |
1224 | } | |
1225 | ||
1226 | if (!array_key_exists($dao->event_id, $eventDetails)) { | |
1227 | $eventIds[$dao->event_id] = $dao->event_id; | |
1228 | } | |
1229 | } | |
1230 | ||
6a488035 TO |
1231 | //get all required contacts detail. |
1232 | if (!empty($contactIds)) { | |
97298661 | 1233 | $contactDetails += civicrm_api3('Contact', 'get', ['id' => ['IN' => $contactIds, 'return' => 'display_name']])['values']; |
6a488035 TO |
1234 | } |
1235 | ||
1236 | //get all required events detail. | |
1237 | if (!empty($eventIds)) { | |
1238 | foreach ($eventIds as $eventId) { | |
1239 | //retrieve event information | |
be2fb01f | 1240 | $eventParams = ['id' => $eventId]; |
6a488035 TO |
1241 | CRM_Event_BAO_Event::retrieve($eventParams, $eventDetails[$eventId]); |
1242 | ||
1243 | //get default participant role. | |
9c1bc317 | 1244 | $eventDetails[$eventId]['participant_role'] = $participantRoles[$eventDetails[$eventId]['default_role_id']] ?? NULL; |
6a488035 TO |
1245 | |
1246 | //get the location info | |
be2fb01f | 1247 | $locParams = ['entity_id' => $eventId, 'entity_table' => 'civicrm_event']; |
6a488035 TO |
1248 | $eventDetails[$eventId]['location'] = CRM_Core_BAO_Location::getValues($locParams, TRUE); |
1249 | } | |
1250 | } | |
1251 | ||
1252 | //now we are ready w/ all required data. | |
1253 | //take a decision as per statuses. | |
1254 | ||
ddca8f33 TO |
1255 | $emailType = NULL; |
1256 | $toStatus = $statusTypes[$toStatusId]; | |
9c1bc317 | 1257 | $fromStatus = $statusTypes[$fromStatusId] ?? NULL; |
6a488035 TO |
1258 | |
1259 | switch ($toStatus) { | |
1260 | case 'Pending from waitlist': | |
1261 | case 'Pending from approval': | |
1262 | switch ($fromStatus) { | |
1263 | case 'On waitlist': | |
1264 | case 'Awaiting approval': | |
1265 | $emailType = 'Confirm'; | |
1266 | break; | |
1267 | } | |
1268 | break; | |
1269 | ||
1270 | case 'Expired': | |
1271 | //no matter from where u come send expired mail. | |
1272 | $emailType = $toStatus; | |
1273 | break; | |
1274 | ||
1275 | case 'Cancelled': | |
1276 | //no matter from where u come send cancel mail. | |
1277 | $emailType = $toStatus; | |
1278 | break; | |
1279 | } | |
1280 | ||
1281 | //as we process additional w/ primary, there might be case if user | |
1282 | //select primary as well as additionals, so avoid double processing. | |
be2fb01f CW |
1283 | $processedParticipantIds = []; |
1284 | $mailedParticipants = []; | |
6a488035 TO |
1285 | |
1286 | //send mails and update status. | |
1287 | foreach ($participantDetails as $participantId => $participantValues) { | |
be2fb01f | 1288 | $updateParticipantIds = []; |
6a488035 TO |
1289 | if (in_array($participantId, $processedParticipantIds)) { |
1290 | continue; | |
1291 | } | |
1292 | ||
1293 | //check is it primary and has additional. | |
1294 | if (array_key_exists($participantId, $primaryANDAdditonalIds)) { | |
a0d6db1e | 1295 | foreach ($primaryANDAdditonalIds[$participantId] as $additionalId) { |
6a488035 TO |
1296 | |
1297 | if ($emailType) { | |
a0d6db1e | 1298 | $mail = self::sendTransitionParticipantMail($additionalId, |
1299 | $participantDetails[$additionalId], | |
1300 | $eventDetails[$participantDetails[$additionalId]['event_id']], | |
943c6d0c | 1301 | NULL, |
6a488035 TO |
1302 | $emailType |
1303 | ); | |
1304 | ||
1305 | //get the mail participant ids | |
1306 | if ($mail) { | |
a0d6db1e | 1307 | $mailedParticipants[$additionalId] = $contactDetails[$participantDetails[$additionalId]['contact_id']]['display_name']; |
6a488035 TO |
1308 | } |
1309 | } | |
a0d6db1e | 1310 | $updateParticipantIds[] = $additionalId; |
1311 | $processedParticipantIds[] = $additionalId; | |
6a488035 TO |
1312 | } |
1313 | } | |
1314 | ||
1315 | //now send email appropriate mail to primary. | |
1316 | if ($emailType) { | |
1317 | $mail = self::sendTransitionParticipantMail($participantId, | |
1318 | $participantValues, | |
1319 | $eventDetails[$participantValues['event_id']], | |
943c6d0c | 1320 | NULL, |
6a488035 TO |
1321 | $emailType |
1322 | ); | |
1323 | ||
1324 | //get the mail participant ids | |
1325 | if ($mail) { | |
1326 | $mailedParticipants[$participantId] = $contactDetails[$participantValues['contact_id']]['display_name']; | |
1327 | } | |
1328 | } | |
1329 | ||
1330 | //now update status of group/one at once. | |
1331 | $updateParticipantIds[] = $participantId; | |
1332 | ||
1333 | //update the register date only when we, | |
1334 | //move participant to pending class, CRM-6496 | |
1335 | $updateRegisterDate = FALSE; | |
1336 | if (array_key_exists($toStatusId, $pendingStatuses)) { | |
1337 | $updateRegisterDate = TRUE; | |
1338 | } | |
1339 | self::updateStatus($updateParticipantIds, $toStatusId, $updateRegisterDate); | |
1340 | $processedParticipantIds[] = $participantId; | |
1341 | } | |
1342 | ||
1343 | //return result for cron. | |
1344 | if ($returnResult) { | |
be2fb01f | 1345 | $results = [ |
6a488035 TO |
1346 | 'mailedParticipants' => $mailedParticipants, |
1347 | 'updatedParticipantIds' => $processedParticipantIds, | |
be2fb01f | 1348 | ]; |
6a488035 TO |
1349 | |
1350 | return $results; | |
1351 | } | |
1352 | } | |
1353 | ||
1354 | /** | |
100fef9d | 1355 | * Send mail and create activity |
6a488035 TO |
1356 | * when participant status changed. |
1357 | * | |
d4dd1e85 TO |
1358 | * @param int $participantId |
1359 | * Participant id. | |
1360 | * @param array $participantValues | |
1361 | * Participant detail values. status id for participants. | |
1362 | * @param array $eventDetails | |
1363 | * Required event details. | |
1364 | * @param array $contactDetails | |
1365 | * Required contact details. | |
d4dd1e85 TO |
1366 | * @param string $mailType |
1367 | * (eg 'approval', 'confirm', 'expired' ). | |
6a488035 | 1368 | * |
654ca41c | 1369 | * @return bool |
6a488035 | 1370 | */ |
2da40d21 | 1371 | public static function sendTransitionParticipantMail( |
6a488035 TO |
1372 | $participantId, |
1373 | $participantValues, | |
1374 | $eventDetails, | |
1375 | $contactDetails, | |
6a488035 TO |
1376 | $mailType |
1377 | ) { | |
1378 | //send emails. | |
1379 | $mailSent = FALSE; | |
1380 | ||
0d6fa54d EM |
1381 | if (!$contactDetails) { |
1382 | $contactDetails = civicrm_api3('Contact', 'getsingle', [ | |
1383 | 'id' => $participantValues['contact_id'], | |
1384 | 'return' => ['email', 'display_name'], | |
1385 | ]); | |
1386 | } | |
6a488035 TO |
1387 | //don't send confirmation mail to additional |
1388 | //since only primary able to confirm registration. | |
a7488080 | 1389 | if (!empty($participantValues['registered_by_id']) && |
6a488035 TO |
1390 | $mailType == 'Confirm' |
1391 | ) { | |
1392 | return $mailSent; | |
1393 | } | |
9c1bc317 | 1394 | $toEmail = $contactDetails['email'] ?? NULL; |
0cca0bf4 | 1395 | if ($toEmail) { |
6a488035 TO |
1396 | |
1397 | $contactId = $participantValues['contact_id']; | |
1398 | $participantName = $contactDetails['display_name']; | |
1399 | ||
1400 | //calculate the checksum value. | |
1401 | $checksumValue = NULL; | |
1402 | if ($mailType == 'Confirm' && !$participantValues['registered_by_id']) { | |
1403 | $checksumLife = 'inf'; | |
9c1bc317 | 1404 | $endDate = $eventDetails['end_date'] ?? NULL; |
0cca0bf4 | 1405 | if ($endDate) { |
6a488035 TO |
1406 | $checksumLife = (CRM_Utils_Date::unixTime($endDate) - time()) / (60 * 60); |
1407 | } | |
1408 | $checksumValue = CRM_Contact_BAO_Contact_Utils::generateChecksum($contactId, NULL, $checksumLife); | |
1409 | } | |
1410 | ||
1411 | //take a receipt from as event else domain. | |
bd6ce89b EM |
1412 | $receiptFrom = CRM_Core_BAO_Domain::getFromEmail(); |
1413 | ||
8cc574cf | 1414 | if (!empty($eventDetails['confirm_from_name']) && !empty($eventDetails['confirm_from_email'])) { |
6a488035 TO |
1415 | $receiptFrom = $eventDetails['confirm_from_name'] . ' <' . $eventDetails['confirm_from_email'] . '>'; |
1416 | } | |
1417 | ||
a8829c96 | 1418 | list($mailSent, $subject) = CRM_Core_BAO_MessageTemplate::sendTemplate( |
be2fb01f | 1419 | [ |
a8829c96 | 1420 | 'workflow' => 'participant_' . strtolower($mailType), |
6a488035 | 1421 | 'contactId' => $contactId, |
a8829c96 | 1422 | 'tokenContext' => ['participantId' => $participantId], |
be2fb01f | 1423 | 'tplParams' => [ |
6a488035 TO |
1424 | 'participant' => $participantValues, |
1425 | 'event' => $eventDetails, | |
6b409353 CW |
1426 | 'paidEvent' => $eventDetails['is_monetary'] ?? NULL, |
1427 | 'isShowLocation' => $eventDetails['is_show_location'] ?? NULL, | |
6a488035 | 1428 | 'isAdditional' => $participantValues['registered_by_id'], |
6f09413b EM |
1429 | 'isExpired' => $mailType === 'Expired', |
1430 | 'isConfirm' => $mailType === 'Confirm', | |
6a488035 | 1431 | 'checksumValue' => $checksumValue, |
be2fb01f | 1432 | ], |
6a488035 TO |
1433 | 'from' => $receiptFrom, |
1434 | 'toName' => $participantName, | |
1435 | 'toEmail' => $toEmail, | |
6b409353 CW |
1436 | 'cc' => $eventDetails['cc_confirm'] ?? NULL, |
1437 | 'bcc' => $eventDetails['bcc_confirm'] ?? NULL, | |
be2fb01f | 1438 | ] |
6a488035 TO |
1439 | ); |
1440 | ||
1441 | // 3. create activity record. | |
1442 | if ($mailSent) { | |
ddca8f33 TO |
1443 | $now = date('YmdHis'); |
1444 | $activityType = 'Event Registration'; | |
be2fb01f | 1445 | $activityParams = [ |
6a488035 TO |
1446 | 'subject' => $subject, |
1447 | 'source_contact_id' => $contactId, | |
1448 | 'source_record_id' => $participantId, | |
593dbb07 | 1449 | 'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType), |
6a488035 TO |
1450 | 'activity_date_time' => CRM_Utils_Date::isoToMysql($now), |
1451 | 'due_date_time' => CRM_Utils_Date::isoToMysql($participantValues['register_date']), | |
1452 | 'is_test' => $participantValues['is_test'], | |
1453 | 'status_id' => 2, | |
be2fb01f | 1454 | ]; |
6a488035 TO |
1455 | |
1456 | if (is_a(CRM_Activity_BAO_Activity::create($activityParams), 'CRM_Core_Error')) { | |
79e11805 | 1457 | throw new CRM_Core_Exception('Failed creating Activity for expiration mail'); |
6a488035 TO |
1458 | } |
1459 | } | |
1460 | } | |
1461 | ||
1462 | return $mailSent; | |
1463 | } | |
1464 | ||
1465 | /** | |
100fef9d | 1466 | * Get participant status change message. |
6a488035 | 1467 | * |
100fef9d | 1468 | * @param int $participantId |
654ca41c | 1469 | * @param $statusChangeTo |
100fef9d | 1470 | * @param int $fromStatusId |
654ca41c | 1471 | * |
6a488035 | 1472 | * @return string |
6a488035 | 1473 | */ |
2b58cdf9 | 1474 | public static function updateStatusMessage($participantId, $statusChangeTo, $fromStatusId) { |
6a488035 | 1475 | $statusMsg = NULL; |
be2fb01f | 1476 | $results = self::transitionParticipants([$participantId], |
6a488035 TO |
1477 | $statusChangeTo, $fromStatusId, TRUE |
1478 | ); | |
1479 | ||
1480 | $allStatuses = CRM_Event_PseudoConstant::participantStatus(); | |
1481 | //give user message only when mail has sent. | |
1482 | if (is_array($results) && !empty($results)) { | |
1483 | if (is_array($results['updatedParticipantIds']) && !empty($results['updatedParticipantIds'])) { | |
1484 | foreach ($results['updatedParticipantIds'] as $processedId) { | |
1485 | if (is_array($results['mailedParticipants']) && | |
1486 | array_key_exists($processedId, $results['mailedParticipants']) | |
1487 | ) { | |
1488 | $statusMsg .= '<br /> ' . ts("Participant status has been updated to '%1'. An email has been sent to %2.", | |
be2fb01f | 1489 | [ |
ddca8f33 TO |
1490 | 1 => $allStatuses[$statusChangeTo], |
1491 | 2 => $results['mailedParticipants'][$processedId], | |
be2fb01f | 1492 | ] |
ddca8f33 | 1493 | ); |
6a488035 TO |
1494 | } |
1495 | } | |
1496 | } | |
1497 | } | |
1498 | ||
1499 | return $statusMsg; | |
1500 | } | |
1501 | ||
1502 | /** | |
100fef9d | 1503 | * Get event full and waiting list message. |
6a488035 | 1504 | * |
100fef9d CW |
1505 | * @param int $eventId |
1506 | * @param int $participantId | |
654ca41c | 1507 | * |
6a488035 | 1508 | * @return string |
6a488035 | 1509 | */ |
00be9182 | 1510 | public static function eventFullMessage($eventId, $participantId = NULL) { |
6a488035 TO |
1511 | $eventfullMsg = $dbStatusId = NULL; |
1512 | $checkEventFull = TRUE; | |
1513 | if ($participantId) { | |
1514 | $dbStatusId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $participantId, 'status_id'); | |
1515 | if (array_key_exists($dbStatusId, CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 1'))) { | |
1516 | //participant already in counted status no need to check for event full messages. | |
1517 | $checkEventFull = FALSE; | |
1518 | } | |
1519 | } | |
1520 | ||
1521 | //early return. | |
1522 | if (!$eventId || !$checkEventFull) { | |
1523 | return $eventfullMsg; | |
1524 | } | |
1525 | ||
1526 | //event is truly full. | |
1527 | $emptySeats = self::eventFull($eventId, FALSE, FALSE); | |
1528 | if (is_string($emptySeats) && $emptySeats !== NULL) { | |
1529 | $maxParticipants = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $eventId, 'max_participants'); | |
be2fb01f | 1530 | $eventfullMsg = ts("This event currently has the maximum number of participants registered (%1). However, you can still override this limit and register additional participants using this form.", [ |
90b461f1 SL |
1531 | 1 => $maxParticipants, |
1532 | ]) . '<br />'; | |
6a488035 TO |
1533 | } |
1534 | ||
1535 | $hasWaiting = FALSE; | |
1536 | $waitListedCount = self::eventFull($eventId, FALSE, TRUE, TRUE); | |
1537 | if (is_numeric($waitListedCount)) { | |
1538 | $hasWaiting = TRUE; | |
1539 | //only current processing participant is on waitlist. | |
1540 | if ($waitListedCount == 1 && CRM_Event_PseudoConstant::participantStatus($dbStatusId) == 'On waitlist') { | |
1541 | $hasWaiting = FALSE; | |
1542 | } | |
1543 | } | |
1544 | ||
1545 | if ($hasWaiting) { | |
1546 | $waitingStatusId = array_search('On waitlist', | |
1547 | CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Waiting'") | |
1548 | ); | |
1549 | $viewWaitListUrl = CRM_Utils_System::url('civicrm/event/search', | |
1550 | "reset=1&force=1&event={$eventId}&status={$waitingStatusId}" | |
1551 | ); | |
1552 | ||
1553 | $eventfullMsg .= ts("There are %2 people currently on the waiting list for this event. You can <a href='%1'>view waitlisted registrations here</a>, or you can continue and register additional participants using this form.", | |
be2fb01f | 1554 | [ |
6a488035 TO |
1555 | 1 => $viewWaitListUrl, |
1556 | 2 => $waitListedCount, | |
be2fb01f | 1557 | ] |
6a488035 TO |
1558 | ); |
1559 | } | |
1560 | ||
1561 | return $eventfullMsg; | |
1562 | } | |
1563 | ||
1564 | /** | |
66f9e52b | 1565 | * Check for whether participant is primary or not. |
6a488035 | 1566 | * |
100fef9d | 1567 | * @param int $participantId |
6a488035 | 1568 | * |
72b3a70c CW |
1569 | * @return bool |
1570 | * true if participant is primary | |
6a488035 | 1571 | */ |
00be9182 | 1572 | public static function isPrimaryParticipant($participantId) { |
6a488035 TO |
1573 | |
1574 | $participant = new CRM_Event_DAO_Participant(); | |
1575 | $participant->registered_by_id = $participantId; | |
1576 | ||
1577 | if ($participant->find(TRUE)) { | |
1578 | return TRUE; | |
1579 | } | |
1580 | return FALSE; | |
1581 | } | |
1582 | ||
1583 | /** | |
66f9e52b | 1584 | * Get additional participant Ids for cascading with primary participant status. |
6a488035 | 1585 | * |
d4dd1e85 TO |
1586 | * @param int $participantId |
1587 | * Participant id. | |
1588 | * @param int $oldStatusId | |
1589 | * Previous status. | |
1590 | * @param int $newStatusId | |
1591 | * New status. | |
6a488035 | 1592 | * |
64f4eebe | 1593 | * @return array |
6a488035 | 1594 | */ |
00be9182 | 1595 | public static function getValidAdditionalIds($participantId, $oldStatusId, $newStatusId) { |
6a488035 | 1596 | |
be2fb01f | 1597 | $additionalParticipantIds = []; |
6a488035 | 1598 | |
be2fb01f | 1599 | static $participantStatuses = []; |
6a488035 TO |
1600 | |
1601 | if (empty($participantStatuses)) { | |
1602 | $participantStatuses = CRM_Event_PseudoConstant::participantStatus(); | |
1603 | } | |
1604 | ||
f3acfdd9 | 1605 | if (!empty(self::$_statusTransitionsRules[$participantStatuses[$oldStatusId]]) && |
6a488035 TO |
1606 | in_array($participantStatuses[$newStatusId], self::$_statusTransitionsRules[$participantStatuses[$oldStatusId]]) |
1607 | ) { | |
1608 | $additionalParticipantIds = self::getAdditionalParticipantIds($participantId, TRUE, $oldStatusId); | |
1609 | } | |
1610 | ||
1611 | return $additionalParticipantIds; | |
1612 | } | |
1613 | ||
1614 | /** | |
66f9e52b | 1615 | * Get participant record count for a Contact. |
6a488035 | 1616 | * |
c490a46a | 1617 | * @param int $contactID |
6a488035 | 1618 | * |
a6c01b45 CW |
1619 | * @return int |
1620 | * count of participant records | |
6a488035 | 1621 | */ |
00be9182 | 1622 | public static function getContactParticipantCount($contactID) { |
6a488035 TO |
1623 | $query = "SELECT count(*) |
1624 | FROM civicrm_participant | |
1625 | WHERE civicrm_participant.contact_id = {$contactID} AND | |
1626 | civicrm_participant.is_test = 0"; | |
1627 | return CRM_Core_DAO::singleValueQuery($query); | |
1628 | } | |
1629 | ||
1630 | /** | |
66f9e52b | 1631 | * Get participant ids by contribution id. |
6a488035 | 1632 | * |
d4dd1e85 TO |
1633 | * @param int $contributionId |
1634 | * Contribution Id. | |
1635 | * @param bool $excludeCancelled | |
1636 | * Exclude cancelled additional participant. | |
6a488035 | 1637 | * |
a6c01b45 | 1638 | * @return array |
6a488035 | 1639 | */ |
00be9182 | 1640 | public static function getParticipantIds($contributionId, $excludeCancelled = FALSE) { |
6a488035 | 1641 | |
be2fb01f | 1642 | $ids = []; |
6a488035 TO |
1643 | if (!$contributionId) { |
1644 | return $ids; | |
1645 | } | |
1646 | ||
1647 | // get primary participant id | |
b677b23b JP |
1648 | $query = "SELECT participant_id |
1649 | FROM civicrm_participant cp | |
1650 | LEFT JOIN civicrm_participant_payment cpp ON cp.id = cpp.participant_id | |
1651 | WHERE cpp.contribution_id = {$contributionId} | |
1652 | AND cp.registered_by_id IS NULL"; | |
1653 | $participantPayment = CRM_Core_DAO::executeQuery($query); | |
6a488035 TO |
1654 | |
1655 | // get additional participant ids (including cancelled) | |
b677b23b | 1656 | while ($participantPayment->fetch()) { |
be2fb01f | 1657 | $ids = array_merge($ids, array_merge([ |
b677b23b | 1658 | $participantPayment->participant_id, |
be2fb01f | 1659 | ], self::getAdditionalParticipantIds($participantPayment->participant_id, |
ddca8f33 | 1660 | $excludeCancelled |
b677b23b | 1661 | ))); |
6a488035 TO |
1662 | } |
1663 | ||
1664 | return $ids; | |
1665 | } | |
1666 | ||
1667 | /** | |
100fef9d | 1668 | * Get additional Participant edit & view url . |
6a488035 | 1669 | * |
d4dd1e85 TO |
1670 | * @param array $participantIds |
1671 | * An array of additional participant ids. | |
6a488035 | 1672 | * |
a6c01b45 | 1673 | * @return array |
16b10e64 | 1674 | * Array of Urls. |
6a488035 | 1675 | */ |
00be9182 | 1676 | public static function getAdditionalParticipantUrl($participantIds) { |
6a488035 | 1677 | foreach ($participantIds as $value) { |
be2fb01f | 1678 | $links = []; |
6a488035 TO |
1679 | $details = self::participantDetails($value); |
1680 | $viewUrl = CRM_Utils_System::url('civicrm/contact/view/participant', | |
1681 | "action=view&reset=1&id={$value}&cid={$details['cid']}" | |
1682 | ); | |
1683 | $editUrl = CRM_Utils_System::url('civicrm/contact/view/participant', | |
1684 | "action=update&reset=1&id={$value}&cid={$details['cid']}" | |
1685 | ); | |
1686 | $links[] = "<td><a href='{$viewUrl}'>" . $details['name'] . "</a></td><td></td><td><a href='{$editUrl}'>" . ts('Edit') . "</a></td>"; | |
1687 | $links = "<table><tr>" . implode("</tr><tr>", $links) . "</tr></table>"; | |
1688 | return $links; | |
1689 | } | |
1690 | } | |
1691 | ||
1692 | /** | |
dc195289 | 1693 | * create trxn entry if an event has discount. |
6a488035 | 1694 | * |
d4dd1e85 TO |
1695 | * @param int $eventID |
1696 | * Event id. | |
1697 | * @param array $contributionParams | |
1698 | * Contribution params. | |
654ca41c | 1699 | * |
362bd1b7 | 1700 | * @param string $feeLevel (deprecated) |
1701 | * @param int $discountedPriceFieldOptionID | |
1702 | * ID of the civicrm_price_field_value field for the discount id. | |
6a488035 | 1703 | */ |
9a05ea52 | 1704 | public static function createDiscountTrxn($eventID, $contributionParams, $feeLevel, $discountedPriceFieldOptionID = NULL) { |
362bd1b7 | 1705 | $financialTypeID = $contributionParams['contribution']->financial_type_id; |
1706 | $total_amount = $contributionParams['total_amount']; | |
1707 | ||
0479b4c8 | 1708 | $checkDiscount = CRM_Core_BAO_Discount::findSet($eventID, 'civicrm_event'); |
6a488035 | 1709 | if (!empty($checkDiscount)) { |
362bd1b7 | 1710 | $mainAmount = self::getUnDiscountedAmountForEventPriceSetFieldValue($eventID, $discountedPriceFieldOptionID, $feeLevel); |
876b8ab0 PN |
1711 | $transactionParams['from_financial_account_id'] = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount( |
1712 | $financialTypeID, 'Discounts Account is'); | |
362bd1b7 | 1713 | if (!empty($transactionParams['trxnParams']['from_financial_account_id'])) { |
1714 | $transactionParams['trxnParams']['total_amount'] = $mainAmount - $total_amount; | |
1715 | $transactionParams['trxnParams']['payment_processor_id'] = NULL; | |
1716 | $transactionParams['trxnParams']['payment_instrument_id'] = NULL; | |
1717 | $transactionParams['trxnParams']['check_number'] = NULL; | |
1718 | $transactionParams['trxnParams']['trxn_id'] = NULL; | |
1719 | $transactionParams['trxnParams']['net_amount'] = NULL; | |
1720 | $transactionParams['trxnParams']['fee_amount'] = NULL; | |
1721 | CRM_Core_BAO_FinancialTrxn::create($transactionParams); | |
6a488035 TO |
1722 | } |
1723 | } | |
6a488035 | 1724 | } |
c3d24ba7 PN |
1725 | |
1726 | /** | |
66f9e52b | 1727 | * Delete participants of contact. |
c3d24ba7 | 1728 | * |
0e480632 | 1729 | * @see https://issues.civicrm.org/jira/browse/CRM-12155 |
c3d24ba7 | 1730 | * |
d4dd1e85 TO |
1731 | * @param int $contactId |
1732 | * Contact id. | |
c3d24ba7 | 1733 | * |
c3d24ba7 | 1734 | */ |
00be9182 | 1735 | public static function deleteContactParticipant($contactId) { |
c3d24ba7 PN |
1736 | $participant = new CRM_Event_DAO_Participant(); |
1737 | $participant->contact_id = $contactId; | |
1738 | $participant->find(); | |
1739 | while ($participant->fetch()) { | |
1740 | self::deleteParticipant($participant->id); | |
1741 | } | |
1742 | } | |
6a488035 | 1743 | |
0cf587a7 | 1744 | /** |
100fef9d | 1745 | * @param int $participantId |
0cf587a7 EM |
1746 | * @param $activityType |
1747 | * | |
1748 | * @throws CRM_Core_Exception | |
1749 | */ | |
00be9182 | 1750 | public static function addActivityForSelection($participantId, $activityType) { |
0aaf8fe9 PJ |
1751 | $eventId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $participantId, 'event_id'); |
1752 | $contactId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $participantId, 'contact_id'); | |
1753 | ||
1754 | $date = CRM_Utils_Date::currentDBDate(); | |
1755 | $event = CRM_Event_BAO_Event::getEvents(0, $eventId); | |
28c64535 | 1756 | $subject = sprintf("Registration selections changed for %s", CRM_Utils_Array::value($eventId, $event)); |
0aaf8fe9 PJ |
1757 | |
1758 | // activity params | |
be2fb01f | 1759 | $activityParams = [ |
a0d6db1e | 1760 | 'source_contact_id' => $contactId, |
1761 | 'source_record_id' => $participantId, | |
d66c61b6 | 1762 | 'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType), |
0aaf8fe9 PJ |
1763 | 'subject' => $subject, |
1764 | 'activity_date_time' => $date, | |
d66c61b6 | 1765 | 'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'), |
0aaf8fe9 | 1766 | 'skipRecentView' => TRUE, |
be2fb01f | 1767 | ]; |
0aaf8fe9 PJ |
1768 | |
1769 | // create activity with target contacts | |
2dbdb9b9 | 1770 | $id = CRM_Core_Session::getLoggedInContactID(); |
0aaf8fe9 PJ |
1771 | if ($id) { |
1772 | $activityParams['source_contact_id'] = $id; | |
a0d6db1e | 1773 | $activityParams['target_contact_id'][] = $contactId; |
0aaf8fe9 | 1774 | } |
d66c61b6 | 1775 | // @todo use api & also look at duplication of similar methods. |
0aaf8fe9 PJ |
1776 | CRM_Activity_BAO_Activity::create($activityParams); |
1777 | } | |
f76b27fe CW |
1778 | |
1779 | /** | |
1780 | * Get options for a given field. | |
1781 | * @see CRM_Core_DAO::buildOptions | |
1782 | * | |
d4dd1e85 TO |
1783 | * @param string $fieldName |
1784 | * @param string $context | |
a1a2a83d | 1785 | * @see CRM_Core_DAO::buildOptionsContext |
d4dd1e85 | 1786 | * @param array $props |
16b10e64 | 1787 | * whatever is known about this dao object. |
f76b27fe | 1788 | * |
5c766a0b | 1789 | * @return array|bool |
f76b27fe | 1790 | */ |
be2fb01f CW |
1791 | public static function buildOptions($fieldName, $context = NULL, $props = []) { |
1792 | $params = ['condition' => []]; | |
f76b27fe CW |
1793 | |
1794 | if ($fieldName == 'status_id' && $context != 'validate') { | |
1795 | // Get rid of cart-related option if disabled | |
1796 | // FIXME: Why does this option even exist if cart is disabled? | |
aaffa79f | 1797 | if (!Civi::settings()->get('enable_cart')) { |
f76b27fe CW |
1798 | $params['condition'][] = "name <> 'Pending in cart'"; |
1799 | } | |
1800 | } | |
1801 | ||
1802 | return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context); | |
1803 | } | |
96025800 | 1804 | |
c7d52684 | 1805 | /** |
c50429ca | 1806 | * CRM-17797 -- Format fields and setDefaults for primary and additional participants profile |
1807 | * @param int $contactId | |
1808 | * @param CRM_Core_Form $form | |
c7d52684 | 1809 | */ |
1810 | public static function formatFieldsAndSetProfileDefaults($contactId, &$form) { | |
1811 | if (!$contactId) { | |
1812 | return; | |
1813 | } | |
be2fb01f | 1814 | $fields = []; |
c7d52684 | 1815 | if (!empty($form->_fields)) { |
be2fb01f | 1816 | $removeCustomFieldTypes = ['Participant']; |
c7d52684 | 1817 | |
a36f32b7 | 1818 | foreach ($form->_fields as $name => $fieldInfo) { |
c7d52684 | 1819 | if ((substr($name, 0, 7) == 'custom_' && !$form->_allowConfirmation |
1820 | && !CRM_Core_BAO_CustomGroup::checkCustomField(substr($name, 7), $removeCustomFieldTypes)) | |
1821 | || substr($name, 0, 12) == 'participant_') { | |
1822 | continue; | |
1823 | } | |
a36f32b7 | 1824 | $fields[$name] = $fieldInfo; |
c7d52684 | 1825 | } |
1826 | ||
1827 | if (!empty($fields)) { | |
1828 | CRM_Core_BAO_UFGroup::setProfileDefaults($contactId, $fields, $form->_defaults); | |
1829 | } | |
1830 | } | |
1831 | } | |
1832 | ||
4a3451de JG |
1833 | /** |
1834 | * Evaluate whether a participant record is eligible for self-service transfer/cancellation. If so, | |
1835 | * return additional participant/event details. | |
1836 | * | |
4a3451de JG |
1837 | * @param int $participantId |
1838 | * @param string $url | |
1839 | * @param bool $isBackOffice | |
1840 | */ | |
c0fc0432 | 1841 | public static function getSelfServiceEligibility(int $participantId, string $url, bool $isBackOffice) : array { |
4a3451de JG |
1842 | $optionGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'participant_role', 'id', 'name'); |
1843 | $query = " | |
c0fc0432 | 1844 | SELECT cpst.name as status, cov.name as role, cp.fee_level, cp.fee_amount, cp.register_date, cp.status_id, ce.start_date, ce.title, cp.event_id, ce.allow_selfcancelxfer |
4a3451de JG |
1845 | FROM civicrm_participant cp |
1846 | LEFT JOIN civicrm_participant_status_type cpst ON cpst.id = cp.status_id | |
1847 | LEFT JOIN civicrm_option_value cov ON cov.value = cp.role_id and cov.option_group_id = {$optionGroupId} | |
1848 | LEFT JOIN civicrm_event ce ON ce.id = cp.event_id | |
1849 | WHERE cp.id = {$participantId}"; | |
1850 | $dao = CRM_Core_DAO::executeQuery($query); | |
1851 | while ($dao->fetch()) { | |
c0fc0432 | 1852 | $details['eligible'] = TRUE; |
4a3451de JG |
1853 | $details['status'] = $dao->status; |
1854 | $details['role'] = $dao->role; | |
1855 | $details['fee_level'] = trim($dao->fee_level, CRM_Core_DAO::VALUE_SEPARATOR); | |
1856 | $details['fee_amount'] = $dao->fee_amount; | |
1857 | $details['register_date'] = $dao->register_date; | |
1858 | $details['event_start_date'] = $dao->start_date; | |
c0fc0432 | 1859 | $details['allow_selfcancelxfer'] = $dao->allow_selfcancelxfer; |
4a3451de JG |
1860 | $eventTitle = $dao->title; |
1861 | $eventId = $dao->event_id; | |
1862 | } | |
cd51716e | 1863 | if (!$details['allow_selfcancelxfer'] && !$isBackOffice) { |
c0fc0432 JG |
1864 | $details['eligible'] = FALSE; |
1865 | $details['ineligible_message'] = ts('This event registration can not be transferred or cancelled. Contact the event organizer if you have questions.'); | |
1866 | return $details; | |
1867 | } | |
4a3451de JG |
1868 | //verify participant status is still Registered |
1869 | if ($details['status'] != 'Registered') { | |
c0fc0432 JG |
1870 | $details['eligible'] = FALSE; |
1871 | $details['ineligible_message'] = "You cannot transfer or cancel your registration for " . $eventTitle . ' as you are not currently registered for this event.'; | |
1872 | return $details; | |
4a3451de | 1873 | } |
c0fc0432 | 1874 | // Determine if it's too late to self-service cancel/transfer. |
4a3451de JG |
1875 | $query = "select start_date as start, selfcancelxfer_time as time from civicrm_event where id = " . $eventId; |
1876 | $dao = CRM_Core_DAO::executeQuery($query); | |
1877 | while ($dao->fetch()) { | |
1878 | $time_limit = $dao->time; | |
1879 | $start_date = $dao->start; | |
1880 | } | |
4a3451de | 1881 | $timenow = new Datetime(); |
c674ed12 | 1882 | if (!$isBackOffice && isset($time_limit)) { |
c0fc0432 JG |
1883 | $cancelHours = abs($time_limit); |
1884 | $cancelInterval = new DateInterval("PT${cancelHours}H"); | |
1885 | $cancelInterval->invert = $time_limit < 0 ? 1 : 0; | |
1886 | $cancelDeadline = (new Datetime($start_date))->sub($cancelInterval); | |
1887 | if ($timenow > $cancelDeadline) { | |
1888 | $details['eligible'] = FALSE; | |
a54cf42b | 1889 | // Change the language of the status message based on whether the waitlist time limit is positive or negative. |
c674ed12 JG |
1890 | $afterOrPrior = $time_limit <= 0 ? 'after' : 'prior to'; |
1891 | $moreOrLess = $time_limit <= 0 ? 'more' : 'fewer'; | |
1892 | $details['ineligible_message'] = ts("Registration for this event cannot be cancelled or transferred %1 than %2 hours %3 the event's start time. Contact the event organizer if you have questions.", | |
a54cf42b JG |
1893 | [1 => $moreOrLess, 2 => $cancelHours, 3 => $afterOrPrior]); |
1894 | ||
4a3451de JG |
1895 | } |
1896 | } | |
1897 | return $details; | |
1898 | } | |
1899 | ||
37d5fc55 | 1900 | } |