3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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 +--------------------------------------------------------------------+
33 * @copyright CiviCRM LLC (c) 2004-2015
37 class CRM_Event_BAO_Participant
extends CRM_Event_DAO_Participant
{
40 * Static field for all the participant information that we can potentially import.
44 static $_importableFields = NULL;
47 * Static field for all the participant information that we can potentially export.
51 static $_exportableFields = NULL;
54 * Static array for valid status transitions rules.
58 static $_statusTransitionsRules = array(
59 'Pending from pay later' => array('Registered', 'Cancelled'),
60 'Pending from incomplete transaction' => array('Registered', 'Cancelled'),
61 'On waitlist' => array('Cancelled', 'Pending from waitlist'),
62 'Pending from waitlist' => array('Registered', 'Cancelled'),
63 'Awaiting approval' => array('Cancelled', 'Pending from approval'),
64 'Pending from approval' => array('Registered', 'Cancelled'),
69 public function __construct() {
70 parent
::__construct();
74 * Takes an associative array and creates a participant object.
76 * the function extract all the params it needs to initialize the create a
77 * participant object. the params array could contain additional unused name/value
80 * @param array $params
81 * (reference ) an assoc array of name/value pairs.
83 * @return CRM_Event_BAO_Participant
85 public static function &add(&$params) {
87 if (!empty($params['id'])) {
88 CRM_Utils_Hook
::pre('edit', 'Participant', $params['id'], $params);
91 CRM_Utils_Hook
::pre('create', 'Participant', NULL, $params);
94 // converting dates to mysql format
95 if (!empty($params['register_date'])) {
96 $params['register_date'] = CRM_Utils_Date
::isoToMysql($params['register_date']);
99 if (!empty($params['participant_fee_amount'])) {
100 $params['participant_fee_amount'] = CRM_Utils_Rule
::cleanMoney($params['participant_fee_amount']);
103 if (!empty($params['fee_amount'])) {
104 $params['fee_amount'] = CRM_Utils_Rule
::cleanMoney($params['fee_amount']);
107 // ensure that role ids are encoded as a string
108 if (isset($params['role_id']) && is_array($params['role_id'])) {
109 if (in_array(key($params['role_id']), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
110 $op = key($params['role_id']);
111 $params['role_id'] = $params['role_id'][$op];
114 $params['role_id'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $params['role_id']);
118 $participantBAO = new CRM_Event_BAO_Participant();
119 if (!empty($params['id'])) {
120 $participantBAO->id
= CRM_Utils_Array
::value('id', $params);
121 $participantBAO->find(TRUE);
122 $participantBAO->register_date
= CRM_Utils_Date
::isoToMysql($participantBAO->register_date
);
125 $participantBAO->copyValues($params);
128 //1. If currency present, it should be valid one.
129 //2. We should have currency when amount is not null.
130 $currency = $participantBAO->fee_currency
;
132 !CRM_Utils_System
::isNull($participantBAO->fee_amount
)
134 if (!CRM_Utils_Rule
::currencyCode($currency)) {
135 $config = CRM_Core_Config
::singleton();
136 $currency = $config->defaultCurrency
;
139 $participantBAO->fee_currency
= $currency;
141 $participantBAO->save();
143 $session = CRM_Core_Session
::singleton();
145 // reset the group contact cache for this group
146 CRM_Contact_BAO_GroupContactCache
::remove();
148 if (!empty($params['id'])) {
149 CRM_Utils_Hook
::post('edit', 'Participant', $participantBAO->id
, $participantBAO);
152 CRM_Utils_Hook
::post('create', 'Participant', $participantBAO->id
, $participantBAO);
155 return $participantBAO;
159 * Given the list of params in the params array, fetch the object
160 * and store the values in the values array
162 * @param array $params
163 * Input parameters to find object.
164 * @param array $values
165 * Output values of the object.
169 * @return CRM_Event_BAO_Participant|null the found object or null
171 public static function getValues(&$params, &$values, &$ids) {
172 if (empty($params)) {
175 $participant = new CRM_Event_BAO_Participant();
176 $participant->copyValues($params);
177 $participant->find();
178 $participants = array();
179 while ($participant->fetch()) {
180 $ids['participant'] = $participant->id
;
181 CRM_Core_DAO
::storeValues($participant, $values[$participant->id
]);
182 $participants[$participant->id
] = $participant;
184 return $participants;
188 * Takes an associative array and creates a participant object.
190 * @param array $params
191 * (reference ) an assoc array of name/value pairs.
193 * @return CRM_Event_BAO_Participant
195 public static function create(&$params) {
197 $transaction = new CRM_Core_Transaction();
200 if (!empty($params['id'])) {
201 $status = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $params['id'], 'status_id');
204 $participant = self
::add($params);
206 if (is_a($participant, 'CRM_Core_Error')) {
207 $transaction->rollback();
211 if ((!CRM_Utils_Array
::value('id', $params)) ||
212 (isset($params['status_id']) && $params['status_id'] != $status)
214 CRM_Activity_BAO_Activity
::addActivity($participant);
219 if (self
::isPrimaryParticipant($participant->id
) && $status) {
220 self
::updateParticipantStatus($participant->id
, $status, $participant->status_id
);
223 $session = CRM_Core_Session
::singleton();
224 $id = $session->get('userID');
226 $id = CRM_Utils_Array
::value('contact_id', $params);
229 // add custom field values
230 if (!empty($params['custom']) &&
231 is_array($params['custom'])
233 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_participant', $participant->id
);
236 //process note, CRM-7634
238 if (!empty($params['id'])) {
239 $note = CRM_Core_BAO_Note
::getNote($params['id'], 'civicrm_participant');
240 $noteId = key($note);
243 $hasNoteField = FALSE;
248 if (array_key_exists($noteFld, $params)) {
249 $noteValue = $params[$noteFld];
250 $hasNoteField = TRUE;
254 if ($noteId ||
$noteValue) {
257 'entity_table' => 'civicrm_participant',
258 'note' => $noteValue,
259 'entity_id' => $participant->id
,
261 'modified_date' => date('Ymd'),
265 $noteIDs['id'] = $noteId;
267 CRM_Core_BAO_Note
::add($noteParams, $noteIDs);
269 elseif ($noteId && $hasNoteField) {
270 CRM_Core_BAO_Note
::del($noteId, FALSE);
274 // Log the information on successful add/edit of Participant data.
276 'entity_table' => 'civicrm_participant',
277 'entity_id' => $participant->id
,
278 'data' => CRM_Event_PseudoConstant
::participantStatus($participant->status_id
),
279 'modified_id' => $id,
280 'modified_date' => date('Ymd'),
283 CRM_Core_BAO_Log
::add($logParams);
285 $params['participant_id'] = $participant->id
;
287 $transaction->commit();
289 // do not add to recent items for import, CRM-4399
290 if (empty($params['skipRecentView'])) {
292 $url = CRM_Utils_System
::url('civicrm/contact/view/participant',
293 "action=view&reset=1&id={$participant->id}&cid={$participant->contact_id}&context=home"
296 $recentOther = array();
297 if (CRM_Core_Permission
::check('edit event participants')) {
298 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/participant',
299 "action=update&reset=1&id={$participant->id}&cid={$participant->contact_id}&context=home"
302 if (CRM_Core_Permission
::check('delete in CiviEvent')) {
303 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/participant',
304 "action=delete&reset=1&id={$participant->id}&cid={$participant->contact_id}&context=home"
308 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
310 if ($participant->role_id
) {
311 $role = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $participant->role_id
);
313 foreach ($role as & $roleValue) {
314 if (isset($roleValue)) {
315 $roleValue = $participantRoles[$roleValue];
318 $roles = implode(', ', $role);
321 $roleString = empty($roles) ?
'' : $roles;
322 $eventTitle = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $participant->event_id
, 'title');
323 $title = CRM_Contact_BAO_Contact
::displayName($participant->contact_id
) . ' (' . $roleString . ' - ' . $eventTitle . ')';
325 // add the recently created Participant
326 CRM_Utils_Recent
::add($title,
330 $participant->contact_id
,
340 * Check whether the event is full for participation and return as.
343 * @param int $eventId
345 * @param bool $returnEmptySeats
346 * Are we require number if empty seats.
347 * @param bool $includeWaitingList
348 * Consider waiting list in event full.
349 * calculation or not. (it is for cron job purpose)
351 * @param bool $returnWaitingCount
352 * @param bool $considerTestParticipant
354 * @return bool|int|null|string
355 * 1. false => If event having some empty spaces.
357 public static function eventFull(
359 $returnEmptySeats = FALSE,
360 $includeWaitingList = TRUE,
361 $returnWaitingCount = FALSE,
362 $considerTestParticipant = FALSE
369 // consider event is full when.
370 // 1. (count(is_counted) >= event_size) or
371 // 2. (count(participants-with-status-on-waitlist) > 0)
372 // It might be case there are some empty spaces and still event
373 // is full, as waitlist might represent group require spaces > empty.
375 $participantRoles = CRM_Event_PseudoConstant
::participantRole(NULL, 'filter = 1');
376 $countedStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
377 $waitingStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Waiting'");
378 $onWaitlistStatusId = array_search('On waitlist', $waitingStatuses);
380 //when we do require only waiting count don't consider counted.
381 if (!$returnWaitingCount && !empty($countedStatuses)) {
382 $allStatusIds = array_keys($countedStatuses);
385 $where = array(' event.id = %1 ');
386 if (!$considerTestParticipant) {
387 $where[] = ' ( participant.is_test = 0 OR participant.is_test IS NULL ) ';
389 if (!empty($participantRoles)) {
390 $where[] = ' participant.role_id IN ( ' . implode(', ', array_keys($participantRoles)) . ' ) ';
393 $eventParams = array(1 => array($eventId, 'Positive'));
395 //in case any waiting, straight forward event is full.
396 if ($includeWaitingList && $onWaitlistStatusId) {
398 //build the where clause.
399 $whereClause = ' WHERE ' . implode(' AND ', $where);
400 $whereClause .= " AND participant.status_id = $onWaitlistStatusId ";
401 $eventSeatsWhere = implode(' AND ', $where) . " AND ( participant.status_id = $onWaitlistStatusId )";
404 SELECT participant.id id,
405 event.event_full_text as event_full_text
406 FROM civicrm_participant participant
407 INNER JOIN civicrm_event event ON ( event.id = participant.event_id )
410 $eventFullText = ts('This event is full.');
411 $participants = CRM_Core_DAO
::executeQuery($query, $eventParams);
412 while ($participants->fetch()) {
413 //oops here event is full and we don't want waiting count.
414 if ($returnWaitingCount) {
415 return CRM_Event_BAO_Event
::eventTotalSeats($eventId, $eventSeatsWhere);
418 return ($participants->event_full_text
) ?
$participants->event_full_text
: $eventFullText;
423 //consider only counted participants.
424 $where[] = ' participant.status_id IN ( ' . implode(', ', array_keys($countedStatuses)) . ' ) ';
425 $whereClause = ' WHERE ' . implode(' AND ', $where);
426 $eventSeatsWhere = implode(' AND ', $where);
429 SELECT participant.id id,
430 event.event_full_text as event_full_text,
431 event.max_participants as max_participants
432 FROM civicrm_participant participant
433 INNER JOIN civicrm_event event ON ( event.id = participant.event_id )
436 $eventMaxSeats = NULL;
437 $eventFullText = ts('This event is full.');
438 $participants = CRM_Core_DAO
::executeQuery($query, $eventParams);
439 while ($participants->fetch()) {
440 if ($participants->event_full_text
) {
441 $eventFullText = $participants->event_full_text
;
443 $eventMaxSeats = $participants->max_participants
;
444 //don't have limit for event seats.
445 if ($participants->max_participants
== NULL) {
450 //get the total event seats occupied by these participants.
451 $eventRegisteredSeats = CRM_Event_BAO_Event
::eventTotalSeats($eventId, $eventSeatsWhere);
453 if ($eventRegisteredSeats) {
454 if ($eventRegisteredSeats >= $eventMaxSeats) {
455 $result = $eventFullText;
457 elseif ($returnEmptySeats) {
458 $result = $eventMaxSeats - $eventRegisteredSeats;
464 SELECT event.event_full_text,
465 event.max_participants
466 FROM civicrm_event event
467 WHERE event.id = %1';
468 $event = CRM_Core_DAO
::executeQuery($query, $eventParams);
469 while ($event->fetch()) {
470 $eventFullText = $event->event_full_text
;
471 $eventMaxSeats = $event->max_participants
;
475 // no limit for registration.
476 if ($eventMaxSeats == NULL) {
479 if ($eventMaxSeats) {
480 return ($returnEmptySeats) ?
(int) $eventMaxSeats : FALSE;
483 return $eventFullText;
487 * Return the array of all price set field options,
488 * with total participant count that field going to carry.
490 * @param int $eventId
492 * @param array $skipParticipantIds
493 * An array of participant ids those we should skip.
494 * @param bool $considerCounted
495 * @param bool $considerWaiting
496 * @param bool $considerTestParticipants
499 * an array of each option id and total count
501 public static function priceSetOptionsCount(
503 $skipParticipantIds = array(),
504 $considerCounted = TRUE,
505 $considerWaiting = TRUE,
506 $considerTestParticipants = FALSE
508 $optionsCount = array();
510 return $optionsCount;
513 $allStatusIds = array();
514 if ($considerCounted) {
515 $countedStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
516 $allStatusIds = array_merge($allStatusIds, array_keys($countedStatuses));
518 if ($considerWaiting) {
519 $waitingStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Waiting'");
520 $allStatusIds = array_merge($allStatusIds, array_keys($waitingStatuses));
522 $statusIdClause = NULL;
523 if (!empty($allStatusIds)) {
524 $statusIdClause = ' AND participant.status_id IN ( ' . implode(', ', array_values($allStatusIds)) . ')';
527 $isTestClause = NULL;
528 if (!$considerTestParticipants) {
529 $isTestClause = ' AND ( participant.is_test IS NULL OR participant.is_test = 0 )';
532 $skipParticipantClause = NULL;
533 if (is_array($skipParticipantIds) && !empty($skipParticipantIds)) {
534 $skipParticipantClause = ' AND participant.id NOT IN ( ' . implode(', ', $skipParticipantIds) . ')';
538 SELECT line.id as lineId,
539 line.entity_id as entity_id,
544 FROM civicrm_line_item line
545 INNER JOIN civicrm_participant participant ON ( line.entity_table = 'civicrm_participant'
546 AND participant.id = line.entity_id )
547 INNER JOIN civicrm_price_field_value value ON ( value.id = line.price_field_value_id )
548 INNER JOIN civicrm_price_field field ON ( value.price_field_id = field.id )
549 WHERE participant.event_id = %1
552 {$skipParticipantClause}";
554 $lineItem = CRM_Core_DAO
::executeQuery($sql, array(1 => array($eventId, 'Positive')));
555 while ($lineItem->fetch()) {
556 $count = $lineItem->count
;
560 if ($lineItem->html_type
== 'Text') {
561 $count *= $lineItem->qty
;
563 $optionsCount[$lineItem->valueId
] = $count + CRM_Utils_Array
::value($lineItem->valueId
, $optionsCount, 0);
566 return $optionsCount;
570 * Get the empty spaces for event those we can allocate
571 * to pending participant to become confirm.
573 * @param int $eventId
577 * $spaces Number of Empty Seats/null.
579 public static function pendingToConfirmSpaces($eventId) {
585 $positiveStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Positive'");
586 $statusIds = '(' . implode(',', array_keys($positiveStatuses)) . ')';
589 SELECT count(participant.id) as registered,
590 civicrm_event.max_participants
591 FROM civicrm_participant participant, civicrm_event
592 WHERE participant.event_id = {$eventId}
593 AND civicrm_event.id = participant.event_id
594 AND participant.status_id IN {$statusIds}
595 GROUP BY participant.event_id
597 $dao = CRM_Core_DAO
::executeQuery($query);
601 if ($dao->max_participants
== NULL ||
$dao->max_participants
<= 0) {
606 if ($dao->registered
>= $dao->max_participants
) {
611 return $dao->max_participants
- $dao->registered
;
614 //space in case no registeration yet.
615 return CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $eventId, 'max_participants');
619 * Combine all the importable fields from the lower levels object.
621 * @param string $contactType
622 * @param bool $status
623 * @param bool $onlyParticipant
626 * array of importable Fields
628 public static function &importableFields($contactType = 'Individual', $status = TRUE, $onlyParticipant = FALSE) {
629 if (!self
::$_importableFields) {
630 if (!$onlyParticipant) {
632 $fields = array('' => array('title' => ts('- do not import -')));
635 $fields = array('' => array('title' => ts('- Participant Fields -')));
642 $tmpFields = CRM_Event_DAO_Participant
::import();
645 'participant_note' => array(
646 'title' => ts('Participant Note'),
647 'name' => 'participant_note',
648 'headerPattern' => '/(participant.)?note$/i',
652 // Split status and status id into 2 fields
653 // Fixme: it would be better to leave as 1 field and intelligently handle both during import
654 $participantStatus = array(
655 'participant_status' => array(
656 'title' => ts('Participant Status'),
657 'name' => 'participant_status',
658 'data_type' => CRM_Utils_Type
::T_STRING
,
661 $tmpFields['participant_status_id']['title'] = ts('Participant Status Id');
663 // Split role and role id into 2 fields
664 // Fixme: it would be better to leave as 1 field and intelligently handle both during import
665 $participantRole = array(
666 'participant_role' => array(
667 'title' => ts('Participant Role'),
668 'name' => 'participant_role',
669 'data_type' => CRM_Utils_Type
::T_STRING
,
672 $tmpFields['participant_role_id']['title'] = ts('Participant Role Id');
675 'event_type' => array(
676 'title' => ts('Event Type'),
677 'name' => 'event_type',
678 'data_type' => CRM_Utils_Type
::T_STRING
,
682 $tmpContactField = $contactFields = array();
683 $contactFields = array();
684 if (!$onlyParticipant) {
685 $contactFields = CRM_Contact_BAO_Contact
::importableFields($contactType, NULL);
687 // Using new Dedupe rule.
689 'contact_type' => $contactType,
690 'used' => 'Unsupervised',
692 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
694 if (is_array($fieldsArray)) {
695 foreach ($fieldsArray as $value) {
696 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
701 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
702 $tmpContactField[trim($value)] = CRM_Utils_Array
::value(trim($value), $contactFields);
704 $title = $tmpContactField[trim($value)]['title'] . ' (match to contact)';
707 $title = $tmpContactField[trim($value)]['title'];
710 $tmpContactField[trim($value)]['title'] = $title;
714 $extIdentifier = CRM_Utils_Array
::value('external_identifier', $contactFields);
715 if ($extIdentifier) {
716 $tmpContactField['external_identifier'] = $extIdentifier;
717 $tmpContactField['external_identifier']['title'] = CRM_Utils_Array
::value('title', $extIdentifier) . ' (match to contact)';
719 $tmpFields['participant_contact_id']['title'] = $tmpFields['participant_contact_id']['title'] . ' (match to contact)';
721 $fields = array_merge($fields, $tmpContactField);
722 $fields = array_merge($fields, $tmpFields);
723 $fields = array_merge($fields, $note, $participantStatus, $participantRole, $eventType);
724 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Participant'));
726 self
::$_importableFields = $fields;
729 return self
::$_importableFields;
733 * Combine all the exportable fields from the lower levels object.
736 * array of exportable Fields
738 public static function &exportableFields() {
739 if (!self
::$_exportableFields) {
740 if (!self
::$_exportableFields) {
741 self
::$_exportableFields = array();
746 $participantFields = CRM_Event_DAO_Participant
::export();
747 $eventFields = CRM_Event_DAO_Event
::export();
749 'participant_note' => array(
750 'title' => 'Participant Note',
751 'name' => 'participant_note',
752 'type' => CRM_Utils_Type
::T_STRING
,
756 $participantStatus = array(
757 'participant_status' => array(
758 'title' => 'Participant Status',
759 'name' => 'participant_status',
760 'type' => CRM_Utils_Type
::T_STRING
,
764 $participantRole = array(
765 'participant_role' => array(
766 'title' => 'Participant Role',
767 'name' => 'participant_role',
768 'type' => CRM_Utils_Type
::T_STRING
,
772 $discountFields = CRM_Core_DAO_Discount
::export();
774 $fields = array_merge($participantFields, $participantStatus, $participantRole, $eventFields, $noteField, $discountFields);
777 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Participant'));
778 self
::$_exportableFields = $fields;
781 return self
::$_exportableFields;
785 * Get the event name/sort name for a particular participation / participant
787 * @param int $participantId
788 * Id of the participant.
791 * associated array with sort_name and event title
793 public static function participantDetails($participantId) {
795 SELECT civicrm_contact.sort_name as name, civicrm_event.title as title, civicrm_contact.id as cid
796 FROM civicrm_participant
797 LEFT JOIN civicrm_event ON (civicrm_participant.event_id = civicrm_event.id)
798 LEFT JOIN civicrm_contact ON (civicrm_participant.contact_id = civicrm_contact.id)
799 WHERE civicrm_participant.id = {$participantId}
801 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
804 while ($dao->fetch()) {
805 $details['name'] = $dao->name
;
806 $details['title'] = $dao->title
;
807 $details['cid'] = $dao->cid
;
814 * Get the values for pseudoconstants for name->value and reverse.
816 * @param array $defaults
817 * (reference) the default values, some of which need to be resolved.
818 * @param bool $reverse
819 * True if we want to resolve the values in the reverse direction (value -> name).
823 public static function resolveDefaults(&$defaults, $reverse = FALSE) {
824 self
::lookupValue($defaults, 'event', CRM_Event_PseudoConstant
::event(), $reverse);
825 self
::lookupValue($defaults, 'status', CRM_Event_PseudoConstant
::participantStatus(NULL, NULL, 'label'), $reverse);
826 self
::lookupValue($defaults, 'role', CRM_Event_PseudoConstant
::participantRole(), $reverse);
830 * convert associative array names to values
833 * This function is used by both the web form layer and the api. Note that
834 * the api needs the name => value conversion, also the view layer typically
835 * requires value => name conversion
837 public static function lookupValue(&$defaults, $property, $lookup, $reverse) {
838 $id = $property . '_id';
840 $src = $reverse ?
$property : $id;
841 $dst = $reverse ?
$id : $property;
843 if (!array_key_exists($src, $defaults)) {
847 $look = $reverse ?
array_flip($lookup) : $lookup;
849 if (is_array($look)) {
850 if (!array_key_exists($defaults[$src], $look)) {
854 $defaults[$dst] = $look[$defaults[$src]];
859 * Delete the record that are associated with this participation.
862 * Id of the participation to delete.
866 public static function deleteParticipant($id) {
867 CRM_Utils_Hook
::pre('delete', 'Participant', $id, CRM_Core_DAO
::$_nullArray);
869 $transaction = new CRM_Core_Transaction();
871 //delete activity record
873 'source_record_id' => $id,
874 // activity type id for event registration
875 'activity_type_id' => 5,
878 CRM_Activity_BAO_Activity
::deleteActivity($params);
880 // delete the participant payment record
881 // we need to do this since the cascaded constraints
882 // dont work with join tables
883 $p = array('participant_id' => $id);
884 CRM_Event_BAO_ParticipantPayment
::deleteParticipantPayment($p);
886 // cleanup line items.
887 $participantsId = array();
888 $participantsId = self
::getAdditionalParticipantIds($id);
889 $participantsId[] = $id;
890 CRM_Price_BAO_LineItem
::deleteLineItems($participantsId, 'civicrm_participant');
892 //delete note when participant deleted.
893 $note = CRM_Core_BAO_Note
::getNote($id, 'civicrm_participant');
894 $noteId = key($note);
896 CRM_Core_BAO_Note
::del($noteId, FALSE);
899 $participant = new CRM_Event_DAO_Participant();
900 $participant->id
= $id;
901 $participant->delete();
903 $transaction->commit();
905 CRM_Utils_Hook
::post('delete', 'Participant', $participant->id
, $participant);
907 // delete the recently created Participant
908 $participantRecent = array(
910 'type' => 'Participant',
913 CRM_Utils_Recent
::del($participantRecent);
919 * Checks duplicate participants.
921 * @param array $input
922 * An assosiative array of name /value pairs.
923 * from other function
924 * @param array $duplicates
925 * (reference ) an assoc array of name/value pairs.
927 * @return CRM_Contribute_BAO_Contribution
929 public static function checkDuplicate($input, &$duplicates) {
930 $eventId = CRM_Utils_Array
::value('event_id', $input);
931 $contactId = CRM_Utils_Array
::value('contact_id', $input);
937 $clause[] = "event_id = %1";
938 $input[1] = array($eventId, 'Integer');
942 $clause[] = "contact_id = %2";
943 $input[2] = array($contactId, 'Integer');
946 if (empty($clause)) {
950 $clause = implode(' AND ', $clause);
952 $query = "SELECT id FROM civicrm_participant WHERE $clause";
953 $dao = CRM_Core_DAO
::executeQuery($query, $input);
955 while ($dao->fetch()) {
956 $duplicates[] = $dao->id
;
963 * Fix the event level.
965 * When price sets are used as event fee, fee_level is set as ^A
966 * separated string. We need to change that string to comma
967 * separated string before using fee_level in view mode.
969 * @param string $eventLevel
970 * Event_leval string from db.
975 public static function fixEventLevel(&$eventLevel) {
976 if ((substr($eventLevel, 0, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
) &&
977 (substr($eventLevel, -1, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
)
979 $eventLevel = implode(', ', explode(CRM_Core_DAO
::VALUE_SEPARATOR
, substr($eventLevel, 1, -1)));
980 $pos = strrpos($eventLevel, '(multiple participants)', 0);
982 $eventLevel = substr_replace($eventLevel, "", $pos - 3, 1);
985 elseif ((substr($eventLevel, 0, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
)) {
986 $eventLevel = implode(', ', explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
987 substr($eventLevel, 0, 1)
990 elseif ((substr($eventLevel, -1, 1) == CRM_Core_DAO
::VALUE_SEPARATOR
)) {
991 $eventLevel = implode(', ', explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
992 substr($eventLevel, 0, -1)
998 * Get the additional participant ids.
1000 * @param int $primaryParticipantId
1001 * Primary partycipant Id.
1002 * @param bool $excludeCancel
1003 * Do not include participant those are cancelled.
1005 * @param int $oldStatusId
1009 public static function getAdditionalParticipantIds($primaryParticipantId, $excludeCancel = TRUE, $oldStatusId = NULL) {
1010 $additionalParticipantIds = array();
1011 if (!$primaryParticipantId) {
1012 return $additionalParticipantIds;
1015 $where = "participant.registered_by_id={$primaryParticipantId}";
1016 if ($excludeCancel) {
1017 $cancelStatusId = 0;
1018 $negativeStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Negative'");
1019 $cancelStatusId = array_search('Cancelled', $negativeStatuses);
1020 $where .= " AND participant.status_id != {$cancelStatusId}";
1024 $where .= " AND participant.status_id = {$oldStatusId}";
1028 SELECT participant.id
1029 FROM civicrm_participant participant
1032 $dao = CRM_Core_DAO
::executeQuery($query);
1033 while ($dao->fetch()) {
1034 $additionalParticipantIds[$dao->id
] = $dao->id
;
1036 return $additionalParticipantIds;
1040 * Get the event fee info for given participant ids
1041 * either from line item table / participant table.
1043 * @param array $participantIds
1045 * @param bool $hasLineItems
1046 * Do fetch from line items.
1050 public function getFeeDetails($participantIds, $hasLineItems = FALSE) {
1051 $feeDetails = array();
1052 if (!is_array($participantIds) ||
empty($participantIds)) {
1057 SELECT participant.id as id,
1058 participant.fee_level as fee_level,
1059 participant.fee_amount as fee_amount';
1060 $from = 'FROM civicrm_participant participant';
1061 if ($hasLineItems) {
1063 lineItem.id as lineId,
1064 lineItem.label as label,
1065 lineItem.qty as qty,
1066 lineItem.unit_price as unit_price,
1067 lineItem.line_total as line_total,
1068 field.label as field_title,
1069 field.html_type as html_type,
1070 field.id as price_field_id,
1071 value.id as price_field_value_id,
1072 value.description as description,
1073 IF( value.count, value.count, 0 ) as participant_count';
1075 INNER JOIN civicrm_line_item lineItem ON ( lineItem.entity_table = 'civicrm_participant'
1076 AND lineItem.entity_id = participant.id )
1077 INNER JOIN civicrm_price_field field ON ( field.id = lineItem.price_field_id )
1078 INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_value_id )
1081 $where = 'WHERE participant.id IN ( ' . implode(', ', $participantIds) . ' )';
1082 $query = "$select $from $where";
1084 $feeInfo = CRM_Core_DAO
::executeQuery($query);
1085 $feeProperties = array('fee_level', 'fee_amount');
1086 $lineProperties = array(
1095 'participant_count',
1096 'price_field_value_id',
1099 while ($feeInfo->fetch()) {
1100 if ($hasLineItems) {
1101 foreach ($lineProperties as $property) {
1102 $feeDetails[$feeInfo->id
][$feeInfo->lineId
][$property] = $feeInfo->$property;
1106 foreach ($feeProperties as $property) {
1107 $feeDetails[$feeInfo->id
][$property] = $feeInfo->$property;
1116 * Retrieve additional participants display-names and URL to view their participant records.
1117 * (excludes cancelled participants automatically)
1119 * @param int $primaryParticipantID
1120 * Id of primary participant record.
1123 * $displayName => $viewUrl
1125 public static function getAdditionalParticipants($primaryParticipantID) {
1126 $additionalParticipantIDs = array();
1127 $additionalParticipantIDs = self
::getAdditionalParticipantIds($primaryParticipantID);
1128 if (!empty($additionalParticipantIDs)) {
1129 foreach ($additionalParticipantIDs as $additionalParticipantID) {
1130 $additionalContactID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
1131 $additionalParticipantID,
1134 $additionalContactName = CRM_Contact_BAO_Contact
::displayName($additionalContactID);
1135 $pViewURL = CRM_Utils_System
::url('civicrm/contact/view/participant',
1136 "action=view&reset=1&id={$additionalParticipantID}&cid={$additionalContactID}"
1139 $additionalParticipants[$additionalContactName] = $pViewURL;
1142 return $additionalParticipants;
1146 * Function for update primary and additional participant status.
1148 * @param int $participantID
1149 * Primary participant's id.
1150 * @param int $oldStatusID
1151 * @param int $newStatusID
1152 * @param bool $updatePrimaryStatus
1156 public static function updateParticipantStatus($participantID, $oldStatusID, $newStatusID = NULL, $updatePrimaryStatus = FALSE) {
1157 if (!$participantID ||
!$oldStatusID) {
1161 if (!$newStatusID) {
1162 $newStatusID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $participantID, 'status_id');
1164 elseif ($updatePrimaryStatus) {
1165 CRM_Core_DAO
::setFieldValue('CRM_Event_DAO_Participant', $participantID, 'status_id', $newStatusID);
1168 $cascadeAdditionalIds = self
::getValidAdditionalIds($participantID, $oldStatusID, $newStatusID);
1170 if (!empty($cascadeAdditionalIds)) {
1171 $cascadeAdditionalIds = implode(',', $cascadeAdditionalIds);
1172 $query = "UPDATE civicrm_participant cp SET cp.status_id = %1 WHERE cp.id IN ({$cascadeAdditionalIds})";
1173 $params = array(1 => array($newStatusID, 'Integer'));
1174 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1181 * Function for update status for given participant ids.
1183 * @param int $participantIds
1184 * Array of participant ids.
1185 * @param int $statusId
1186 * Status id for participant.
1187 * @param bool $updateRegisterDate
1192 public static function updateStatus($participantIds, $statusId, $updateRegisterDate = FALSE) {
1193 if (!is_array($participantIds) ||
empty($participantIds) ||
!$statusId) {
1197 //lets update register date as we update status to keep track
1198 //when we did update status, useful for moving participant
1199 //from pending to expired.
1200 $setClause = "status_id = {$statusId}";
1201 if ($updateRegisterDate) {
1202 $setClause .= ", register_date = NOW()";
1205 $participantIdClause = '( ' . implode(',', $participantIds) . ' )';
1208 UPDATE civicrm_participant
1210 WHERE id IN {$participantIdClause}";
1212 $dao = CRM_Core_DAO
::executeQuery($query);
1216 * Function takes participant ids and statuses
1217 * update status from $fromStatusId to $toStatusId
1218 * and send mail + create activities.
1220 * @param array $participantIds
1222 * @param int $toStatusId
1224 * @param int $fromStatusId
1226 * @param bool $returnResult
1227 * @param bool $skipCascadeRule
1229 * @return array|NULL
1231 public static function transitionParticipants(
1232 $participantIds, $toStatusId,
1233 $fromStatusId = NULL, $returnResult = FALSE, $skipCascadeRule = FALSE
1235 if (!is_array($participantIds) ||
empty($participantIds) ||
!$toStatusId) {
1239 //thumb rule is if we triggering primary participant need to triggered additional
1240 $allParticipantIds = $primaryANDAdditonalIds = array();
1241 foreach ($participantIds as $id) {
1242 $allParticipantIds[] = $id;
1243 if (self
::isPrimaryParticipant($id)) {
1244 //filter additional as per status transition rules, CRM-5403
1245 if ($skipCascadeRule) {
1246 $additionalIds = self
::getAdditionalParticipantIds($id);
1249 $additionalIds = self
::getValidAdditionalIds($id, $fromStatusId, $toStatusId);
1251 if (!empty($additionalIds)) {
1252 $allParticipantIds = array_merge($allParticipantIds, $additionalIds);
1253 $primaryANDAdditonalIds[$id] = $additionalIds;
1258 //get the unique participant ids,
1259 $allParticipantIds = array_unique($allParticipantIds);
1261 //pull required participants, contacts, events data, if not in hand
1262 static $eventDetails = array();
1263 static $domainValues = array();
1264 static $contactDetails = array();
1266 $contactIds = $eventIds = $participantDetails = array();
1268 $statusTypes = CRM_Event_PseudoConstant
::participantStatus();
1269 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
1270 $pendingStatuses = CRM_Event_PseudoConstant
::participantStatus(NULL,
1274 //first thing is pull all necessory data from db.
1275 $participantIdClause = '(' . implode(',', $allParticipantIds) . ')';
1277 //get all participants data.
1278 $query = "SELECT * FROM civicrm_participant WHERE id IN {$participantIdClause}";
1279 $dao = CRM_Core_DAO
::executeQuery($query);
1280 while ($dao->fetch()) {
1281 $participantDetails[$dao->id
] = array(
1283 'role' => $participantRoles[$dao->role_id
],
1284 'is_test' => $dao->is_test
,
1285 'event_id' => $dao->event_id
,
1286 'status_id' => $dao->status_id
,
1287 'fee_amount' => $dao->fee_amount
,
1288 'contact_id' => $dao->contact_id
,
1289 'register_date' => $dao->register_date
,
1290 'registered_by_id' => $dao->registered_by_id
,
1292 if (!array_key_exists($dao->contact_id
, $contactDetails)) {
1293 $contactIds[$dao->contact_id
] = $dao->contact_id
;
1296 if (!array_key_exists($dao->event_id
, $eventDetails)) {
1297 $eventIds[$dao->event_id
] = $dao->event_id
;
1301 //get the domain values.
1302 if (empty($domainValues)) {
1303 // making all tokens available to templates.
1304 $domain = CRM_Core_BAO_Domain
::getDomain();
1306 'domain' => array('name', 'phone', 'address', 'email'),
1307 'contact' => CRM_Core_SelectValues
::contactTokens(),
1310 foreach ($tokens['domain'] as $token) {
1311 $domainValues[$token] = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain);
1315 //get all required contacts detail.
1316 if (!empty($contactIds)) {
1317 // get the contact details.
1318 list($currentContactDetails) = CRM_Utils_Token
::getTokenDetails($contactIds, NULL,
1321 'CRM_Event_BAO_Participant'
1323 foreach ($currentContactDetails as $contactId => $contactValues) {
1324 $contactDetails[$contactId] = $contactValues;
1328 //get all required events detail.
1329 if (!empty($eventIds)) {
1330 foreach ($eventIds as $eventId) {
1331 //retrieve event information
1332 $eventParams = array('id' => $eventId);
1333 CRM_Event_BAO_Event
::retrieve($eventParams, $eventDetails[$eventId]);
1335 //get default participant role.
1336 $eventDetails[$eventId]['participant_role'] = CRM_Utils_Array
::value($eventDetails[$eventId]['default_role_id'], $participantRoles);
1338 //get the location info
1339 $locParams = array('entity_id' => $eventId, 'entity_table' => 'civicrm_event');
1340 $eventDetails[$eventId]['location'] = CRM_Core_BAO_Location
::getValues($locParams, TRUE);
1344 //now we are ready w/ all required data.
1345 //take a decision as per statuses.
1348 $toStatus = $statusTypes[$toStatusId];
1349 $fromStatus = CRM_Utils_Array
::value($fromStatusId, $statusTypes);
1351 switch ($toStatus) {
1352 case 'Pending from waitlist':
1353 case 'Pending from approval':
1354 switch ($fromStatus) {
1356 case 'Awaiting approval':
1357 $emailType = 'Confirm';
1363 //no matter from where u come send expired mail.
1364 $emailType = $toStatus;
1368 //no matter from where u come send cancel mail.
1369 $emailType = $toStatus;
1373 //as we process additional w/ primary, there might be case if user
1374 //select primary as well as additionals, so avoid double processing.
1375 $processedParticipantIds = array();
1376 $mailedParticipants = array();
1378 //send mails and update status.
1379 foreach ($participantDetails as $participantId => $participantValues) {
1380 $updateParticipantIds = array();
1381 if (in_array($participantId, $processedParticipantIds)) {
1385 //check is it primary and has additional.
1386 if (array_key_exists($participantId, $primaryANDAdditonalIds)) {
1387 foreach ($primaryANDAdditonalIds[$participantId] as $additonalId) {
1390 $mail = self
::sendTransitionParticipantMail($additonalId,
1391 $participantDetails[$additonalId],
1392 $eventDetails[$participantDetails[$additonalId]['event_id']],
1393 $contactDetails[$participantDetails[$additonalId]['contact_id']],
1398 //get the mail participant ids
1400 $mailedParticipants[$additonalId] = $contactDetails[$participantDetails[$additonalId]['contact_id']]['display_name'];
1403 $updateParticipantIds[] = $additonalId;
1404 $processedParticipantIds[] = $additonalId;
1408 //now send email appropriate mail to primary.
1410 $mail = self
::sendTransitionParticipantMail($participantId,
1412 $eventDetails[$participantValues['event_id']],
1413 $contactDetails[$participantValues['contact_id']],
1418 //get the mail participant ids
1420 $mailedParticipants[$participantId] = $contactDetails[$participantValues['contact_id']]['display_name'];
1424 //now update status of group/one at once.
1425 $updateParticipantIds[] = $participantId;
1427 //update the register date only when we,
1428 //move participant to pending class, CRM-6496
1429 $updateRegisterDate = FALSE;
1430 if (array_key_exists($toStatusId, $pendingStatuses)) {
1431 $updateRegisterDate = TRUE;
1433 self
::updateStatus($updateParticipantIds, $toStatusId, $updateRegisterDate);
1434 $processedParticipantIds[] = $participantId;
1437 //return result for cron.
1438 if ($returnResult) {
1440 'mailedParticipants' => $mailedParticipants,
1441 'updatedParticipantIds' => $processedParticipantIds,
1449 * Send mail and create activity
1450 * when participant status changed.
1452 * @param int $participantId
1454 * @param array $participantValues
1455 * Participant detail values. status id for participants.
1456 * @param array $eventDetails
1457 * Required event details.
1458 * @param array $contactDetails
1459 * Required contact details.
1460 * @param array $domainValues
1461 * Required domain values.
1462 * @param string $mailType
1463 * (eg 'approval', 'confirm', 'expired' ).
1467 public static function sendTransitionParticipantMail(
1478 //don't send confirmation mail to additional
1479 //since only primary able to confirm registration.
1480 if (!empty($participantValues['registered_by_id']) &&
1481 $mailType == 'Confirm'
1485 $toEmail = CRM_Utils_Array
::value('email', $contactDetails);
1488 $contactId = $participantValues['contact_id'];
1489 $participantName = $contactDetails['display_name'];
1491 //calculate the checksum value.
1492 $checksumValue = NULL;
1493 if ($mailType == 'Confirm' && !$participantValues['registered_by_id']) {
1494 $checksumLife = 'inf';
1495 $endDate = CRM_Utils_Array
::value('end_date', $eventDetails);
1497 $checksumLife = (CRM_Utils_Date
::unixTime($endDate) - time()) / (60 * 60);
1499 $checksumValue = CRM_Contact_BAO_Contact_Utils
::generateChecksum($contactId, NULL, $checksumLife);
1502 //take a receipt from as event else domain.
1503 $receiptFrom = $domainValues['name'] . ' <' . $domainValues['email'] . '>';
1504 if (!empty($eventDetails['confirm_from_name']) && !empty($eventDetails['confirm_from_email'])) {
1505 $receiptFrom = $eventDetails['confirm_from_name'] . ' <' . $eventDetails['confirm_from_email'] . '>';
1508 list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate(
1510 'groupName' => 'msg_tpl_workflow_event',
1511 'valueName' => 'participant_' . strtolower($mailType),
1512 'contactId' => $contactId,
1513 'tplParams' => array(
1514 'contact' => $contactDetails,
1515 'domain' => $domainValues,
1516 'participant' => $participantValues,
1517 'event' => $eventDetails,
1518 'paidEvent' => CRM_Utils_Array
::value('is_monetary', $eventDetails),
1519 'isShowLocation' => CRM_Utils_Array
::value('is_show_location', $eventDetails),
1520 'isAdditional' => $participantValues['registered_by_id'],
1521 'isExpired' => $mailType == 'Expired',
1522 'isConfirm' => $mailType == 'Confirm',
1523 'checksumValue' => $checksumValue,
1525 'from' => $receiptFrom,
1526 'toName' => $participantName,
1527 'toEmail' => $toEmail,
1528 'cc' => CRM_Utils_Array
::value('cc_confirm', $eventDetails),
1529 'bcc' => CRM_Utils_Array
::value('bcc_confirm', $eventDetails),
1533 // 3. create activity record.
1535 $now = date('YmdHis');
1536 $activityType = 'Event Registration';
1537 $activityParams = array(
1538 'subject' => $subject,
1539 'source_contact_id' => $contactId,
1540 'source_record_id' => $participantId,
1541 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
1545 'activity_date_time' => CRM_Utils_Date
::isoToMysql($now),
1546 'due_date_time' => CRM_Utils_Date
::isoToMysql($participantValues['register_date']),
1547 'is_test' => $participantValues['is_test'],
1551 if (is_a(CRM_Activity_BAO_Activity
::create($activityParams), 'CRM_Core_Error')) {
1552 CRM_Core_Error
::fatal('Failed creating Activity for expiration mail');
1561 * Get participant status change message.
1563 * @param int $participantId
1564 * @param $statusChangeTo
1565 * @param int $fromStatusId
1569 public function updateStatusMessage($participantId, $statusChangeTo, $fromStatusId) {
1571 $results = self
::transitionParticipants(array($participantId),
1572 $statusChangeTo, $fromStatusId, TRUE
1575 $allStatuses = CRM_Event_PseudoConstant
::participantStatus();
1576 //give user message only when mail has sent.
1577 if (is_array($results) && !empty($results)) {
1578 if (is_array($results['updatedParticipantIds']) && !empty($results['updatedParticipantIds'])) {
1579 foreach ($results['updatedParticipantIds'] as $processedId) {
1580 if (is_array($results['mailedParticipants']) &&
1581 array_key_exists($processedId, $results['mailedParticipants'])
1583 $statusMsg .= '<br /> ' . ts("Participant status has been updated to '%1'. An email has been sent to %2.",
1585 1 => $allStatuses[$statusChangeTo],
1586 2 => $results['mailedParticipants'][$processedId],
1598 * Get event full and waiting list message.
1600 * @param int $eventId
1601 * @param int $participantId
1605 public static function eventFullMessage($eventId, $participantId = NULL) {
1606 $eventfullMsg = $dbStatusId = NULL;
1607 $checkEventFull = TRUE;
1608 if ($participantId) {
1609 $dbStatusId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $participantId, 'status_id');
1610 if (array_key_exists($dbStatusId, CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1'))) {
1611 //participant already in counted status no need to check for event full messages.
1612 $checkEventFull = FALSE;
1617 if (!$eventId ||
!$checkEventFull) {
1618 return $eventfullMsg;
1621 //event is truly full.
1622 $emptySeats = self
::eventFull($eventId, FALSE, FALSE);
1623 if (is_string($emptySeats) && $emptySeats !== NULL) {
1624 $maxParticipants = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $eventId, 'max_participants');
1625 $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.", array(
1626 1 => $maxParticipants,
1630 $hasWaiting = FALSE;
1631 $waitListedCount = self
::eventFull($eventId, FALSE, TRUE, TRUE);
1632 if (is_numeric($waitListedCount)) {
1634 //only current processing participant is on waitlist.
1635 if ($waitListedCount == 1 && CRM_Event_PseudoConstant
::participantStatus($dbStatusId) == 'On waitlist') {
1636 $hasWaiting = FALSE;
1641 $waitingStatusId = array_search('On waitlist',
1642 CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Waiting'")
1644 $viewWaitListUrl = CRM_Utils_System
::url('civicrm/event/search',
1645 "reset=1&force=1&event={$eventId}&status={$waitingStatusId}"
1648 $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.",
1650 1 => $viewWaitListUrl,
1651 2 => $waitListedCount,
1656 return $eventfullMsg;
1660 * Check for whether participant is primary or not.
1662 * @param int $participantId
1665 * true if participant is primary
1667 public static function isPrimaryParticipant($participantId) {
1669 $participant = new CRM_Event_DAO_Participant();
1670 $participant->registered_by_id
= $participantId;
1672 if ($participant->find(TRUE)) {
1679 * Get additional participant Ids for cascading with primary participant status.
1681 * @param int $participantId
1683 * @param int $oldStatusId
1685 * @param int $newStatusId
1691 public static function getValidAdditionalIds($participantId, $oldStatusId, $newStatusId) {
1693 $additionalParticipantIds = array();
1695 static $participantStatuses = array();
1697 if (empty($participantStatuses)) {
1698 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
1701 if (CRM_Utils_Array
::value($participantStatuses[$oldStatusId], self
::$_statusTransitionsRules) &&
1702 in_array($participantStatuses[$newStatusId], self
::$_statusTransitionsRules[$participantStatuses[$oldStatusId]])
1704 $additionalParticipantIds = self
::getAdditionalParticipantIds($participantId, TRUE, $oldStatusId);
1707 return $additionalParticipantIds;
1711 * Get participant record count for a Contact.
1713 * @param int $contactID
1716 * count of participant records
1718 public static function getContactParticipantCount($contactID) {
1719 $query = "SELECT count(*)
1720 FROM civicrm_participant
1721 WHERE civicrm_participant.contact_id = {$contactID} AND
1722 civicrm_participant.is_test = 0";
1723 return CRM_Core_DAO
::singleValueQuery($query);
1727 * Get participant ids by contribution id.
1729 * @param int $contributionId
1731 * @param bool $excludeCancelled
1732 * Exclude cancelled additional participant.
1736 public static function getParticipantIds($contributionId, $excludeCancelled = FALSE) {
1739 if (!$contributionId) {
1743 // get primary participant id
1744 $query = "SELECT participant_id FROM civicrm_participant_payment WHERE contribution_id = {$contributionId}";
1745 $participantId = CRM_Core_DAO
::singleValueQuery($query);
1747 // get additional participant ids (including cancelled)
1748 if ($participantId) {
1749 $ids = array_merge(array(
1751 ), self
::getAdditionalParticipantIds($participantId,
1760 * Get additional Participant edit & view url .
1762 * @param array $participantIds
1763 * An array of additional participant ids.
1768 public static function getAdditionalParticipantUrl($participantIds) {
1769 foreach ($participantIds as $value) {
1771 $details = self
::participantDetails($value);
1772 $viewUrl = CRM_Utils_System
::url('civicrm/contact/view/participant',
1773 "action=view&reset=1&id={$value}&cid={$details['cid']}"
1775 $editUrl = CRM_Utils_System
::url('civicrm/contact/view/participant',
1776 "action=update&reset=1&id={$value}&cid={$details['cid']}"
1778 $links[] = "<td><a href='{$viewUrl}'>" . $details['name'] . "</a></td><td></td><td><a href='{$editUrl}'>" . ts('Edit') . "</a></td>";
1779 $links = "<table><tr>" . implode("</tr><tr>", $links) . "</tr></table>";
1785 * create trxn entry if an event has discount.
1787 * @param int $eventID
1789 * @param array $contributionParams
1790 * Contribution params.
1795 public static function createDiscountTrxn($eventID, $contributionParams, $feeLevel) {
1797 $checkDiscount = CRM_Core_BAO_Discount
::findSet($eventID, 'civicrm_event');
1798 if (!empty($checkDiscount)) {
1799 $feeLevel = current($feeLevel);
1800 $priceSetId = CRM_Price_BAO_PriceSet
::getFor('civicrm_event', $eventID, NULL);
1801 $query = "SELECT cpfv.amount FROM `civicrm_price_field_value` cpfv
1802 LEFT JOIN civicrm_price_field cpf ON cpfv.price_field_id = cpf.id
1803 WHERE cpf.price_set_id = %1 AND cpfv.label LIKE %2";
1805 1 => array($priceSetId, 'Integer'),
1806 2 => array($feeLevel, 'String'),
1808 $mainAmount = CRM_Core_DAO
::singleValueQuery($query, $params);
1809 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Discounts Account is' "));
1810 $contributionParams['trxnParams']['from_financial_account_id'] = CRM_Contribute_PseudoConstant
::financialAccountType(
1811 $contributionParams['contribution']->financial_type_id
, $relationTypeId);
1812 if (!empty($contributionParams['trxnParams']['from_financial_account_id'])) {
1813 $contributionParams['trxnParams']['total_amount'] = $mainAmount - $contributionParams['total_amount'];
1814 $contributionParams['trxnParams']['payment_processor_id'] = NULL;
1815 $contributionParams['trxnParams']['payment_instrument_id'] = NULL;
1816 $contributionParams['trxnParams']['check_number'] = NULL;
1817 $contributionParams['trxnParams']['trxn_id'] = NULL;
1818 $contributionParams['trxnParams']['net_amount'] = NULL;
1819 $contributionParams['trxnParams']['fee_amount'] = NULL;
1821 CRM_Core_BAO_FinancialTrxn
::create($contributionParams['trxnParams']);
1827 * Delete participants of contact.
1831 * @param int $contactId
1835 public static function deleteContactParticipant($contactId) {
1836 $participant = new CRM_Event_DAO_Participant();
1837 $participant->contact_id
= $contactId;
1838 $participant->find();
1839 while ($participant->fetch()) {
1840 self
::deleteParticipant($participant->id
);
1845 * @param array $params
1846 * @param int $participantId
1847 * @param int $contributionId
1849 * @param array $lineItems
1850 * @param $paidAmount
1851 * @param int $priceSetId
1853 public static function changeFeeSelections($params, $participantId, $contributionId, $feeBlock, $lineItems, $paidAmount, $priceSetId) {
1854 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
1855 $partiallyPaidStatusId = array_search('Partially paid', $contributionStatuses);
1856 $pendingRefundStatusId = array_search('Pending refund', $contributionStatuses);
1857 $previousLineItems = CRM_Price_BAO_LineItem
::getLineItems($participantId, 'participant');
1858 CRM_Price_BAO_PriceSet
::processAmount($feeBlock,
1862 // get the submitted
1863 foreach ($feeBlock as $id => $values) {
1864 CRM_Price_BAO_LineItem
::format($id, $params, $values, $submittedLineItems);
1865 $submittedFieldId[] = CRM_Utils_Array
::retrieveValueRecursive($submittedLineItems, 'price_field_id');
1867 if (!empty($submittedLineItems)) {
1868 $insertLines = $submittedLineItems;
1870 $submittedFieldValueIds = array_keys($submittedLineItems);
1871 $updateLines = array();
1872 foreach ($previousLineItems as $id => $previousLineItem) {
1873 // check through the submitted items if the previousItem exists,
1874 // if found in submitted items, do not use it for new item creations
1875 if (in_array($previousLineItem['price_field_value_id'], $submittedFieldValueIds)) {
1876 // if submitted line items are existing don't fire INSERT query
1877 unset($insertLines[$previousLineItem['price_field_value_id']]);
1878 // for updating the line items i.e. use-case - once deselect-option selecting again
1879 if (($previousLineItem['line_total'] != $submittedLineItems[$previousLineItem['price_field_value_id']]['line_total']) ||
1880 ($submittedLineItems[$previousLineItem['price_field_value_id']]['line_total'] == 0 && $submittedLineItems[$previousLineItem['price_field_value_id']]['qty'] == 1)
1882 $updateLines[$previousLineItem['price_field_value_id']] = $submittedLineItems[$previousLineItem['price_field_value_id']];
1883 $updateLines[$previousLineItem['price_field_value_id']]['id'] = $id;
1888 $submittedFields = implode(', ', $submittedFieldId);
1889 $submittedFieldValues = implode(', ', $submittedFieldValueIds);
1891 if (!empty($submittedFields) && !empty($submittedFieldValues)) {
1892 $updateLineItem = "UPDATE civicrm_line_item li
1893 INNER JOIN civicrm_financial_item fi
1894 ON (li.id = fi.entity_id AND fi.entity_table = 'civicrm_line_item')
1896 li.line_total = 0.00,
1897 li.tax_amount = NULL
1898 WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantId}) AND
1899 (price_field_value_id NOT IN ({$submittedFieldValues}))
1901 CRM_Core_DAO
::executeQuery($updateLineItem);
1903 // gathering necessary info to record negative (deselected) financial_item
1904 $updateFinancialItem = "
1905 SELECT fi.*, SUM(fi.amount) as differenceAmt, price_field_value_id, financial_type_id, tax_amount
1906 FROM civicrm_financial_item fi LEFT JOIN civicrm_line_item li ON (li.id = fi.entity_id AND fi.entity_table = 'civicrm_line_item')
1907 WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantId})
1908 GROUP BY li.entity_table, li.entity_id, price_field_value_id
1910 $updateFinancialItemInfoDAO = CRM_Core_DAO
::executeQuery($updateFinancialItem);
1911 $trxn = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($contributionId, 'DESC', TRUE);
1912 $trxnId['id'] = $trxn['financialTrxnId'];
1913 $invoiceSettings = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::CONTRIBUTE_PREFERENCES_NAME
, 'contribution_invoice_settings');
1914 $taxTerm = CRM_Utils_Array
::value('tax_term', $invoiceSettings);
1915 $updateFinancialItemInfoValues = array();
1916 $financialItemsArray = array();
1917 while ($updateFinancialItemInfoDAO->fetch()) {
1918 $updateFinancialItemInfoValues = (array) $updateFinancialItemInfoDAO;
1919 $updateFinancialItemInfoValues['transaction_date'] = date('YmdHis');
1920 // the below params are not needed
1921 unset($updateFinancialItemInfoValues['id']);
1922 unset($updateFinancialItemInfoValues['created_date']);
1923 // if not submitted and difference is not 0 make it negative
1924 if (!in_array($updateFinancialItemInfoValues['price_field_value_id'], $submittedFieldValueIds) && $updateFinancialItemInfoValues['differenceAmt'] != 0) {
1925 // INSERT negative financial_items
1926 $updateFinancialItemInfoValues['amount'] = -$updateFinancialItemInfoValues['amount'];
1927 if ($previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount']) {
1928 $updateFinancialItemInfoValues['tax']['amount'] = -($previousLineItems[$updateFinancialItemInfoValues['entity_id']]['tax_amount']);
1929 $updateFinancialItemInfoValues['tax']['description'] = $taxTerm;
1930 if ($updateFinancialItemInfoValues['financial_type_id']) {
1931 $updateFinancialItemInfoValues['tax']['financial_account_id'] = CRM_Contribute_BAO_Contribution
::getFinancialAccountId($updateFinancialItemInfoValues['financial_type_id']);
1934 // INSERT negative financial_items for tax amount
1935 $financialItemsArray[] = $updateFinancialItemInfoValues;
1937 // if submitted and difference is 0 add a positive entry again
1938 elseif (in_array($updateFinancialItemInfoValues['price_field_value_id'], $submittedFieldValueIds) && $updateFinancialItemInfoValues['differenceAmt'] == 0) {
1939 $updateFinancialItemInfoValues['amount'] = $updateFinancialItemInfoValues['amount'];
1940 // INSERT financial_items for tax amount
1941 if ($updateFinancialItemInfoValues['entity_id'] == $updateLines[$updateFinancialItemInfoValues['price_field_value_id']]['id'] &&
1942 isset($updateLines[$updateFinancialItemInfoValues['price_field_value_id']]['tax_amount'])
1944 $updateFinancialItemInfoValues['tax']['amount'] = $updateLines[$updateFinancialItemInfoValues['price_field_value_id']]['tax_amount'];
1945 $updateFinancialItemInfoValues['tax']['description'] = $taxTerm;
1946 if ($updateLines[$updateFinancialItemInfoValues['price_field_value_id']]['financial_type_id']) {
1947 $updateFinancialItemInfoValues['tax']['financial_account_id'] = CRM_Contribute_BAO_Contribution
::getFinancialAccountId($updateLines[$updateFinancialItemInfoValues['price_field_value_id']]['financial_type_id']);
1950 $financialItemsArray[] = $updateFinancialItemInfoValues;
1954 elseif (empty($submittedFields) && empty($submittedFieldValues)) {
1955 $updateLineItem = "UPDATE civicrm_line_item li
1956 INNER JOIN civicrm_financial_item fi
1957 ON (li.id = fi.entity_id AND fi.entity_table = 'civicrm_line_item')
1959 li.line_total = 0.00,
1960 li.tax_amount = NULL
1961 WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantId})";
1962 CRM_Core_DAO
::executeQuery($updateLineItem);
1964 if (!empty($updateLines)) {
1965 foreach ($updateLines as $valueId => $vals) {
1966 if (isset($vals['tax_amount'])) {
1967 $taxAmount = $vals['tax_amount'];
1970 $taxAmount = "NULL";
1973 UPDATE civicrm_line_item li
1974 SET li.qty = {$vals['qty']},
1975 li.line_total = {$vals['line_total']},
1976 li.tax_amount = {$taxAmount},
1977 li.unit_price = {$vals['unit_price']},
1979 WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantId}) AND
1980 (price_field_value_id = {$valueId})
1982 CRM_Core_DAO
::executeQuery($updateLineItem, array(1 => array($vals['label'], 'String')));
1985 // insert new 'adjusted amount' transaction entry and update contribution entry.
1986 // ensure entity_financial_trxn table has a linking of it.
1987 // insert new line items
1988 if (!empty($insertLines)) {
1989 foreach ($insertLines as $valueId => $lineParams) {
1990 $lineParams['entity_table'] = 'civicrm_participant';
1991 $lineParams['entity_id'] = $participantId;
1992 $lineParams['contribution_id'] = $contributionId;
1993 $lineObj = CRM_Price_BAO_LineItem
::create($lineParams);
1997 // the recordAdjustedAmt code would execute over here
1998 $ids = CRM_Event_BAO_Participant
::getParticipantIds($contributionId);
1999 if (count($ids) > 1) {
2001 foreach ($ids as $val) {
2002 $total +
= CRM_Price_BAO_LineItem
::getLineTotal($val, 'civicrm_participant');
2004 $updatedAmount = $total;
2007 $updatedAmount = $params['amount'];
2009 if (strlen($params['tax_amount']) != 0) {
2010 $taxAmount = $params['tax_amount'];
2013 $taxAmount = "NULL";
2015 $trxn = self
::recordAdjustedAmt($updatedAmount, $paidAmount, $contributionId, $taxAmount);
2018 $trxnId['id'] = $trxn->id
;
2019 foreach ($financialItemsArray as $updateFinancialItemInfoValues) {
2020 CRM_Financial_BAO_FinancialItem
::create($updateFinancialItemInfoValues, NULL, $trxnId);
2021 if (!empty($updateFinancialItemInfoValues['tax'])) {
2022 $updateFinancialItemInfoValues['tax']['amount'] = $updateFinancialItemInfoValues['amount'];
2023 $updateFinancialItemInfoValues['tax']['description'] = $updateFinancialItemInfoValues['description'];
2024 if (!empty($updateFinancialItemInfoValues['financial_account_id'])) {
2025 $updateFinancialItemInfoValues['financial_account_id'] = $updateFinancialItemInfoValues['tax']['financial_account_id'];
2027 CRM_Financial_BAO_FinancialItem
::create($updateFinancialItemInfoValues, NULL, $trxnId);
2031 $fetchCon = array('id' => $contributionId);
2032 $updatedContribution = CRM_Contribute_BAO_Contribution
::retrieve($fetchCon, CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullArray);
2033 // insert financial items
2034 if (!empty($insertLines)) {
2035 foreach ($insertLines as $valueId => $lineParams) {
2036 $lineParams['entity_table'] = 'civicrm_participant';
2037 $lineParams['entity_id'] = $participantId;
2038 $lineObj = CRM_Price_BAO_LineItem
::retrieve($lineParams, CRM_Core_DAO
::$_nullArray);
2039 // insert financial items
2040 // ensure entity_financial_trxn table has a linking of it.
2041 $prevItem = CRM_Financial_BAO_FinancialItem
::add($lineObj, $updatedContribution, NULL, $trxnId);
2042 if (isset($lineObj->tax_amount
)) {
2043 CRM_Financial_BAO_FinancialItem
::add($lineObj, $updatedContribution, TRUE, $trxnId);
2048 // update participant fee_amount column
2049 $partUpdateFeeAmt['id'] = $participantId;
2050 $getUpdatedLineItems = "SELECT *
2051 FROM civicrm_line_item
2052 WHERE (entity_table = 'civicrm_participant' AND entity_id = {$participantId} AND qty > 0)";
2053 $getUpdatedLineItemsDAO = CRM_Core_DAO
::executeQuery($getUpdatedLineItems);
2054 while ($getUpdatedLineItemsDAO->fetch()) {
2055 $line[$getUpdatedLineItemsDAO->price_field_value_id
] = $getUpdatedLineItemsDAO->label
. ' - ' . (float) $getUpdatedLineItemsDAO->qty
;
2058 $partUpdateFeeAmt['fee_level'] = implode(', ', $line);
2059 $partUpdateFeeAmt['fee_amount'] = $params['amount'];
2060 self
::add($partUpdateFeeAmt);
2063 self
::addActivityForSelection($participantId, 'Change Registration');
2067 * @param $updatedAmount
2068 * @param $paidAmount
2069 * @param int $contributionId
2071 public static function recordAdjustedAmt($updatedAmount, $paidAmount, $contributionId, $taxAmount = NULL) {
2072 $pendingAmount = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($contributionId);
2073 $pendingAmount = CRM_Utils_Array
::value('total_amount', $pendingAmount, 0);
2074 $balanceAmt = $updatedAmount - $paidAmount;
2075 if ($paidAmount != $pendingAmount) {
2076 $balanceAmt -= $pendingAmount;
2079 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2080 $partiallyPaidStatusId = array_search('Partially paid', $contributionStatuses);
2081 $pendingRefundStatusId = array_search('Pending refund', $contributionStatuses);
2082 $completedStatusId = array_search('Completed', $contributionStatuses);
2084 $updatedContributionDAO = new CRM_Contribute_BAO_Contribution();
2085 $adjustedTrxn = $skip = FALSE;
2087 if ($balanceAmt > 0 && $paidAmount != 0) {
2088 $contributionStatusVal = $partiallyPaidStatusId;
2090 elseif ($balanceAmt < 0 && $paidAmount != 0) {
2091 $contributionStatusVal = $pendingRefundStatusId;
2093 elseif ($paidAmount == 0) {
2094 //skip updating the contribution status if no payment is made
2096 $updatedContributionDAO->cancel_date
= 'null';
2097 $updatedContributionDAO->cancel_reason
= NULL;
2099 // update contribution status and total amount without trigger financial code
2100 // as this is handled in current BAO function used for change selection
2101 $updatedContributionDAO->id
= $contributionId;
2103 $updatedContributionDAO->contribution_status_id
= $contributionStatusVal;
2105 $updatedContributionDAO->total_amount
= $updatedContributionDAO->net_amount
= $updatedAmount;
2106 $updatedContributionDAO->fee_amount
= 0;
2107 $updatedContributionDAO->tax_amount
= $taxAmount;
2108 $updatedContributionDAO->save();
2109 // adjusted amount financial_trxn creation
2110 $updatedContribution = CRM_Contribute_BAO_Contribution
::getValues(
2111 array('id' => $contributionId),
2112 CRM_Core_DAO
::$_nullArray,
2113 CRM_Core_DAO
::$_nullArray
2115 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
2116 $toFinancialAccount = CRM_Contribute_PseudoConstant
::financialAccountType($updatedContribution->financial_type_id
, $relationTypeId);
2117 $adjustedTrxnValues = array(
2118 'from_financial_account_id' => NULL,
2119 'to_financial_account_id' => $toFinancialAccount,
2120 'total_amount' => $balanceAmt,
2121 'status_id' => $completedStatusId,
2122 'payment_instrument_id' => $updatedContribution->payment_instrument_id
,
2123 'contribution_id' => $updatedContribution->id
,
2124 'trxn_date' => date('YmdHis'),
2125 'currency' => $updatedContribution->currency
,
2127 $adjustedTrxn = CRM_Core_BAO_FinancialTrxn
::create($adjustedTrxnValues);
2129 return $adjustedTrxn;
2133 * @param int $participantId
2134 * @param $activityType
2136 * @throws CRM_Core_Exception
2138 public static function addActivityForSelection($participantId, $activityType) {
2139 $eventId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Participant', $participantId, 'event_id');
2140 $contactId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Participant', $participantId, 'contact_id');
2142 $date = CRM_Utils_Date
::currentDBDate();
2143 $event = CRM_Event_BAO_Event
::getEvents(0, $eventId);
2144 $eventTitle = $event[$eventId];
2145 $subject = "Registration selections changed for $eventTitle";
2146 $targetCid = $contactId;
2147 $srcRecId = $participantId;
2150 $activityParams = array(
2151 'source_contact_id' => $targetCid,
2152 'source_record_id' => $srcRecId,
2153 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
2157 'subject' => $subject,
2158 'activity_date_time' => $date,
2159 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
2163 'skipRecentView' => TRUE,
2166 // create activity with target contacts
2167 $session = CRM_Core_Session
::singleton();
2168 $id = $session->get('userID');
2170 $activityParams['source_contact_id'] = $id;
2171 $activityParams['target_contact_id'][] = $targetCid;
2173 CRM_Activity_BAO_Activity
::create($activityParams);
2177 * Get options for a given field.
2178 * @see CRM_Core_DAO::buildOptions
2180 * @param string $fieldName
2181 * @param string $context
2182 * @see CRM_Core_DAO::buildOptionsContext
2183 * @param array $props
2184 * whatever is known about this dao object.
2186 * @return array|bool
2188 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
2189 $params = array('condition' => array());
2191 if ($fieldName == 'status_id' && $context != 'validate') {
2192 // Get rid of cart-related option if disabled
2193 // FIXME: Why does this option even exist if cart is disabled?
2194 if (!CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::EVENT_PREFERENCES_NAME
, 'enable_cart')) {
2195 $params['condition'][] = "name <> 'Pending in cart'";
2199 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);