CRM/Event/BAO/Participant.php

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