CRM/Event/BAO/Query.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  * $Id$
  33  *
  34  */
  35 class CRM_Event_BAO_Query extends CRM_Core_BAO_Query {
  36
  37   /**
  38    * Function get the import/export fields for contribution.
  39    *
  40    * @param bool $checkPermission
  41    *
  42    * @return array
  43    *   Associative array of contribution fields
  44    */
  45   public static function &getFields($checkPermission = TRUE) {
  46     $fields = [];
  47     $fields = array_merge($fields, CRM_Event_DAO_Event::import());
  48     $fields = array_merge($fields, self::getParticipantFields());
  49     $fields = array_merge($fields, CRM_Core_DAO_Discount::export());
  50
  51     return $fields;
  52   }
  53
  54   /**
  55    * @return array
  56    */
  57   public static function &getParticipantFields() {
  58     $fields = CRM_Event_BAO_Participant::importableFields('Individual', TRUE, TRUE);
  59     return $fields;
  60   }
  61
  62   /**
  63    * Build select for CiviEvent.
  64    *
  65    * @param $query
  66    */
  67   public static function select(&$query) {
  68     if (($query->_mode & CRM_Contact_BAO_Query::MODE_EVENT) ||
  69       CRM_Contact_BAO_Query::componentPresent($query->_returnProperties, 'participant_')
  70     ) {
  71       $query->_select['participant_id'] = "civicrm_participant.id as participant_id";
  72       $query->_element['participant_id'] = 1;
  73       $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
  74
  75       //add fee level
  76       if (!empty($query->_returnProperties['participant_fee_level'])) {
  77         $query->_select['participant_fee_level'] = "civicrm_participant.fee_level as participant_fee_level";
  78         $query->_element['participant_fee_level'] = 1;
  79       }
  80
  81       //add participant contact ID
  82       if (!empty($query->_returnProperties['participant_contact_id'])) {
  83         $query->_select['participant_contact_id'] = "civicrm_participant.contact_id as participant_contact_id";
  84         $query->_element['participant_contact_id'] = 1;
  85       }
  86
  87       //add fee amount
  88       if (!empty($query->_returnProperties['participant_fee_amount'])) {
  89         $query->_select['participant_fee_amount'] = "civicrm_participant.fee_amount as participant_fee_amount";
  90         $query->_element['participant_fee_amount'] = 1;
  91       }
  92
  93       //add fee currency
  94       if (!empty($query->_returnProperties['participant_fee_currency'])) {
  95         $query->_select['participant_fee_currency'] = "civicrm_participant.fee_currency as participant_fee_currency";
  96         $query->_element['participant_fee_currency'] = 1;
  97       }
  98
  99       //add event title also if event id is select
 100       if (!empty($query->_returnProperties['event_id']) || !empty($query->_returnProperties['event_title'])) {
 101         $query->_select['event_id'] = "civicrm_event.id as event_id";
 102         $query->_select['event_title'] = "civicrm_event.title as event_title";
 103         $query->_element['event_id'] = 1;
 104         $query->_element['event_title'] = 1;
 105         $query->_tables['civicrm_event'] = 1;
 106         $query->_whereTables['civicrm_event'] = 1;
 107       }
 108
 109       //add start date / end date
 110       if (!empty($query->_returnProperties['event_start_date'])) {
 111         $query->_select['event_start_date'] = "civicrm_event.start_date as event_start_date";
 112         $query->_element['event_start_date'] = 1;
 113       }
 114
 115       if (!empty($query->_returnProperties['event_end_date'])) {
 116         $query->_select['event_end_date'] = "civicrm_event.end_date as event_end_date";
 117         $query->_element['event_end_date'] = 1;
 118       }
 119
 120       //event type
 121       if (!empty($query->_returnProperties['event_type'])) {
 122         $query->_select['event_type'] = "event_type.label as event_type";
 123         $query->_element['event_type'] = 1;
 124         $query->_tables['event_type'] = 1;
 125         $query->_whereTables['event_type'] = 1;
 126       }
 127
 128       if (!empty($query->_returnProperties['event_type_id'])) {
 129         $query->_select['event_type_id'] = "civicrm_event.event_type_id as event_type_id";
 130         $query->_element['event_type_id'] = 1;
 131         $query->_tables['civicrm_event'] = 1;
 132         $query->_whereTables['civicrm_event'] = 1;
 133       }
 134
 135       //add status_id
 136       if (!empty($query->_returnProperties['participant_status_id'])) {
 137         $query->_select['participant_status_id'] = "civicrm_participant.status_id as participant_status_id";
 138         $query->_element['participant_status_id'] = 1;
 139         $query->_tables['civicrm_participant'] = 1;
 140         $query->_whereTables['civicrm_participant'] = 1;
 141       }
 142
 143       // get particupant_status label
 144       if (!empty($query->_returnProperties['participant_status'])) {
 145         $query->_select['participant_status'] = "participant_status.label as participant_status";
 146         $query->_element['participant_status'] = 1;
 147         $query->_tables['participant_status'] = 1;
 148         $query->_whereTables['civicrm_participant'] = 1;
 149       }
 150
 151       //add participant_role_id
 152       if (!empty($query->_returnProperties['participant_role_id'])) {
 153         $query->_select['participant_role_id'] = "civicrm_participant.role_id as participant_role_id";
 154         $query->_element['participant_role_id'] = 1;
 155         $query->_tables['civicrm_participant'] = 1;
 156         $query->_whereTables['civicrm_participant'] = 1;
 157         $query->_pseudoConstantsSelect['participant_role_id'] = [
 158           'pseudoField' => 'participant_role_id',
 159           'idCol' => 'participant_role_id',
 160         ];
 161       }
 162
 163       //add participant_role
 164       if (!empty($query->_returnProperties['participant_role'])) {
 165         $query->_select['participant_role'] = "civicrm_participant.role_id as participant_role";
 166         $query->_element['participant_role'] = 1;
 167         $query->_tables['participant_role'] = 1;
 168         $query->_whereTables['civicrm_participant'] = 1;
 169         $query->_pseudoConstantsSelect['participant_role'] = [
 170           'pseudoField' => 'participant_role',
 171           'idCol' => 'participant_role',
 172         ];
 173       }
 174
 175       //add register date
 176       if (!empty($query->_returnProperties['participant_register_date'])) {
 177         $query->_select['participant_register_date'] = "civicrm_participant.register_date as participant_register_date";
 178         $query->_element['participant_register_date'] = 1;
 179       }
 180
 181       //add source
 182       if (!empty($query->_returnProperties['participant_source'])) {
 183         $query->_select['participant_source'] = "civicrm_participant.source as participant_source";
 184         $query->_element['participant_source'] = 1;
 185         $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
 186       }
 187
 188       //participant note
 189       if (!empty($query->_returnProperties['participant_note'])) {
 190         $query->_select['participant_note'] = "participant_note.note as participant_note";
 191         $query->_element['participant_note'] = 1;
 192         $query->_tables['participant_note'] = 1;
 193         $query->_whereTables['participant_note'] = 1;
 194       }
 195
 196       if (!empty($query->_returnProperties['participant_is_pay_later'])) {
 197         $query->_select['participant_is_pay_later'] = "civicrm_participant.is_pay_later as participant_is_pay_later";
 198         $query->_element['participant_is_pay_later'] = 1;
 199       }
 200
 201       if (!empty($query->_returnProperties['participant_is_test'])) {
 202         $query->_select['participant_is_test'] = "civicrm_participant.is_test as participant_is_test";
 203         $query->_element['participant_is_test'] = 1;
 204       }
 205
 206       if (!empty($query->_returnProperties['participant_registered_by_id'])) {
 207         $query->_select['participant_registered_by_id'] = "civicrm_participant.registered_by_id as participant_registered_by_id";
 208         $query->_element['participant_registered_by_id'] = 1;
 209       }
 210
 211       // get discount name
 212       if (!empty($query->_returnProperties['participant_discount_name'])) {
 213         $query->_select['participant_discount_name'] = "discount_name.title as participant_discount_name";
 214         $query->_element['participant_discount_name'] = 1;
 215         $query->_tables['civicrm_discount'] = 1;
 216         $query->_tables['participant_discount_name'] = 1;
 217         $query->_whereTables['civicrm_discount'] = 1;
 218         $query->_whereTables['participant_discount_name'] = 1;
 219       }
 220
 221       //carry campaign id to selectors.
 222       if (!empty($query->_returnProperties['participant_campaign_id'])) {
 223         $query->_select['participant_campaign_id'] = 'civicrm_participant.campaign_id as participant_campaign_id';
 224         $query->_element['participant_campaign_id'] = 1;
 225       }
 226     }
 227   }
 228
 229   /**
 230    * @param $query
 231    */
 232   public static function where(&$query) {
 233     $grouping = NULL;
 234     foreach (array_keys($query->_params) as $id) {
 235       if (empty($query->_params[$id][0])) {
 236         continue;
 237       }
 238       if (substr($query->_params[$id][0], 0, 6) == 'event_' ||
 239         substr($query->_params[$id][0], 0, 12) == 'participant_'
 240       ) {
 241         if ($query->_mode == CRM_Contact_BAO_Query::MODE_CONTACTS) {
 242           $query->_useDistinct = TRUE;
 243         }
 244         $grouping = $query->_params[$id][3];
 245         self::whereClauseSingle($query->_params[$id], $query);
 246       }
 247     }
 248   }
 249
 250   /**
 251    * @param $values
 252    * @param $query
 253    */
 254   public static function whereClauseSingle(&$values, &$query) {
 255     $checkPermission = empty($query->_skipPermission);
 256     list($name, $op, $value, $grouping, $wildcard) = $values;
 257     $fields = array_merge(CRM_Event_BAO_Event::fields(), CRM_Event_BAO_Participant::exportableFields());
 258
 259     switch ($name) {
 260       case 'event_start_date_low':
 261       case 'event_start_date_high':
 262         $query->dateQueryBuilder($values,
 263           'civicrm_event', 'event_start_date', 'start_date', 'Start Date'
 264         );
 265         return;
 266
 267       case 'event_end_date_low':
 268       case 'event_end_date_high':
 269         $query->dateQueryBuilder($values,
 270           'civicrm_event', 'event_end_date', 'end_date', 'End Date'
 271         );
 272         return;
 273
 274       case 'event_include_repeating_events':
 275         /**
 276          * Include Repeating Events
 277          */
 278         //Get parent of this event
 279         $exEventId = '';
 280         if ($query->_where[$grouping]) {
 281           foreach ($query->_where[$grouping] as $key => $val) {
 282             if (strstr($val, 'civicrm_event.id =')) {
 283               $exEventId = $val;
 284               $extractEventId = explode(" ", $val);
 285               $value = $extractEventId[2];
 286               $where = $query->_where[$grouping][$key];
 287             }
 288             elseif (strstr($val, 'civicrm_event.id IN')) {
 289               //extract the first event id if multiple events are selected
 290               preg_match('/civicrm_event.id IN \(\"(\d+)/', $val, $matches);
 291               $value = $matches[1];
 292               $where = $query->_where[$grouping][$key];
 293             }
 294           }
 295           if ($exEventId) {
 296             $extractEventId = explode(" ", $exEventId);
 297             $value = $extractEventId[2];
 298           }
 299           elseif (!empty($matches[1])) {
 300             $value = $matches[1];
 301           }
 302           $where = $query->_where[$grouping][$key];
 303         }
 304         $thisEventHasParent = CRM_Core_BAO_RecurringEntity::getParentFor($value, 'civicrm_event');
 305         if ($thisEventHasParent) {
 306           $getAllConnections = CRM_Core_BAO_RecurringEntity::getEntitiesForParent($thisEventHasParent, 'civicrm_event');
 307           $allEventIds = [];
 308           foreach ($getAllConnections as $key => $val) {
 309             $allEventIds[] = $val['id'];
 310           }
 311           if (!empty($allEventIds)) {
 312             $op = "IN";
 313             $value = "(" . implode(",", $allEventIds) . ")";
 314           }
 315         }
 316         $query->_where[$grouping][] = "{$where} OR civicrm_event.id $op {$value}";
 317         $query->_qill[$grouping][] = ts('Include Repeating Events');
 318         $query->_tables['civicrm_event'] = $query->_whereTables['civicrm_event'] = 1;
 319         return;
 320
 321       case 'participant_is_test':
 322         $key = array_search('civicrm_participant.is_test = 0', $query->_where[$grouping]);
 323         if (!empty($key)) {
 324           unset($query->_where[$grouping][$key]);
 325         }
 326       case 'participant_test':
 327         // We dont want to include all tests for sql OR CRM-7827
 328         if (!$value || $query->getOperator() != 'OR') {
 329           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.is_test",
 330             $op,
 331             $value,
 332             "Boolean"
 333           );
 334
 335           $isTest = $value ? 'a Test' : 'not a Test';
 336           $query->_qill[$grouping][] = ts("Participant is %1", [1 => $isTest]);
 337           $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
 338         }
 339         return;
 340
 341       case 'participant_fee_id':
 342         $labels = [];
 343         foreach ($value as $val) {
 344           $labels[] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $val, 'label');
 345         }
 346         $query->_where[$grouping][] = "civicrm_line_item.price_field_value_id IN (" . implode(', ', $value) . ")";
 347         $query->_qill[$grouping][] = ts("Fee level") . " IN " . implode(', ', $labels);
 348         $query->_tables['civicrm_participant'] = $query->_tables['civicrm_line_item'] = $query->_whereTables['civicrm_line_item'] = 1;
 349         return;
 350
 351       case 'participant_fee_amount_high':
 352       case 'participant_fee_amount_low':
 353         $query->numberRangeBuilder($values,
 354           'civicrm_participant', 'participant_fee_amount', 'fee_amount', 'Fee Amount'
 355         );
 356         return;
 357
 358       case 'participant_status_id':
 359         if ($value && is_array($value) && strpos($op, 'IN') === FALSE) {
 360           $op = 'IN';
 361         }
 362       case 'participant_status':
 363       case 'participant_source':
 364       case 'participant_id':
 365       case 'participant_contact_id':
 366       case 'participant_is_pay_later':
 367       case 'participant_fee_amount':
 368       case 'participant_fee_level':
 369       case 'participant_campaign_id':
 370       case 'participant_registered_by_id':
 371
 372         $qillName = $name;
 373         if (in_array($name, [
 374           'participant_status_id',
 375           'participant_source',
 376           'participant_id',
 377           'participant_contact_id',
 378           'participant_fee_amount',
 379           'participant_fee_level',
 380           'participant_is_pay_later',
 381           'participant_campaign_id',
 382           'participant_registered_by_id',
 383         ])) {
 384           $name = str_replace('participant_', '', $name);
 385           if ($name == 'is_pay_later') {
 386             $qillName = $name;
 387           }
 388         }
 389         elseif ($name == 'participant_status') {
 390           $name = 'status_id';
 391         }
 392
 393         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 394         $tableName = empty($tableName) ? 'civicrm_participant' : $tableName;
 395         if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
 396           $op = key($value);
 397           $value = $value[$op];
 398         }
 399         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$tableName.$name", $op, $value, $dataType);
 400
 401         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Event_DAO_Participant', $name, $value, $op);
 402         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
 403         $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
 404         return;
 405
 406       case 'participant_role':
 407       case 'participant_role_id':
 408         $qillName = $name;
 409         $name = 'role_id';
 410
 411         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 412         $tableName = empty($tableName) ? 'civicrm_participant' : $tableName;
 413         if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
 414           $op = key($value);
 415           $value = $value[$op];
 416         }
 417         if (!strstr($op, 'NULL') && !strstr($op, 'EMPTY') && !strstr($op, 'LIKE')) {
 418           $regexOp = (strstr($op, '!') || strstr($op, 'NOT')) ? 'NOT REGEXP' : 'REGEXP';
 419           $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
 420           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.$name", $regexOp, $regexp, 'String');
 421         }
 422         else {
 423           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$tableName.$name", $op, $value, $dataType);
 424         }
 425
 426         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Event_DAO_Participant', $name, $value, $op);
 427         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
 428         $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
 429         return;
 430
 431       case 'participant_register_date':
 432       case 'participant_register_date_high':
 433       case 'participant_register_date_low':
 434         $query->dateQueryBuilder($values,
 435           'civicrm_participant', 'participant_register_date', 'register_date', 'Register Date'
 436         );
 437         return;
 438
 439       case 'event_id':
 440       case 'participant_event_id':
 441         $name = str_replace('participant_', '', $name);
 442       case 'event_is_public':
 443       case 'event_type_id':
 444       case 'event_title':
 445         $qillName = $name;
 446         if (in_array($name, [
 447           'event_id',
 448           'event_title',
 449           'event_is_public',
 450         ])) {
 451           $name = str_replace('event_', '', $name);
 452         }
 453         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 454
 455         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_event.$name", $op, $value, $dataType);
 456         $query->_tables['civicrm_event'] = $query->_whereTables['civicrm_event'] = 1;
 457         if (!array_key_exists($qillName, $fields)) {
 458           break;
 459         }
 460         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Event_DAO_Event', $name, $value, $op, ['check_permission' => $checkPermission]);
 461         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
 462         return;
 463
 464       case 'participant_note':
 465         $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
 466         $query->_tables['participant_note'] = $query->_whereTables['participant_note'] = 1;
 467         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('participant_note.note', $op, $value, 'String');
 468         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$name]['title'], 2 => $op, 3 => $value]);
 469         break;
 470     }
 471   }
 472
 473   /**
 474    * @param string $name
 475    * @param $mode
 476    * @param $side
 477    *
 478    * @return null|string
 479    */
 480   public static function from($name, $mode, $side) {
 481     $from = NULL;
 482     switch ($name) {
 483       case 'civicrm_participant':
 484         $from = " LEFT JOIN civicrm_participant ON civicrm_participant.contact_id = contact_a.id ";
 485         break;
 486
 487       case 'civicrm_event':
 488         //CRM-17121
 489         $from = " LEFT JOIN civicrm_event ON civicrm_participant.event_id = civicrm_event.id ";
 490         break;
 491
 492       case 'event_type':
 493         $from = " $side JOIN civicrm_option_group option_group_event_type ON (option_group_event_type.name = 'event_type')";
 494         $from .= " $side JOIN civicrm_option_value event_type ON (civicrm_event.event_type_id = event_type.value AND option_group_event_type.id = event_type.option_group_id ) ";
 495         break;
 496
 497       case 'participant_note':
 498         $from .= " $side JOIN civicrm_note participant_note ON ( participant_note.entity_table = 'civicrm_participant' AND
 499                                                         civicrm_participant.id = participant_note.entity_id )";
 500         break;
 501
 502       case 'participant_status':
 503         $from .= " $side JOIN civicrm_participant_status_type participant_status ON (civicrm_participant.status_id = participant_status.id) ";
 504         break;
 505
 506       case 'participant_role':
 507         $from = " $side JOIN civicrm_option_group option_group_participant_role ON (option_group_participant_role.name = 'participant_role')";
 508         $from .= " $side JOIN civicrm_option_value participant_role ON ((civicrm_participant.role_id = participant_role.value OR SUBSTRING_INDEX(role_id,'\ 1', 1) = participant_role.value)
 509                                AND option_group_participant_role.id = participant_role.option_group_id ) ";
 510         break;
 511
 512       case 'participant_discount_name':
 513         $from = " $side JOIN civicrm_discount discount ON ( civicrm_participant.discount_id = discount.id )";
 514         $from .= " $side JOIN civicrm_option_group discount_name ON ( discount_name.id = discount.price_set_id ) ";
 515         break;
 516
 517       case 'civicrm_line_item':
 518         $from .= " $side JOIN civicrm_line_item ON civicrm_line_item.entity_id = civicrm_participant.id AND civicrm_line_item.entity_table = 'civicrm_participant'";
 519         break;
 520     }
 521     return $from;
 522   }
 523
 524   /**
 525    * @param $mode
 526    * @param bool $includeCustomFields
 527    *
 528    * @return array|null
 529    */
 530   public static function defaultReturnProperties(
 531     $mode,
 532     $includeCustomFields = TRUE
 533   ) {
 534     $properties = NULL;
 535     if ($mode & CRM_Contact_BAO_Query::MODE_EVENT) {
 536       $properties = [
 537         'contact_type' => 1,
 538         'contact_sub_type' => 1,
 539         'sort_name' => 1,
 540         'display_name' => 1,
 541         'event_id' => 1,
 542         'event_title' => 1,
 543         'event_start_date' => 1,
 544         'event_end_date' => 1,
 545         'event_type' => 1,
 546         'participant_id' => 1,
 547         'participant_status' => 1,
 548         'participant_status_id' => 1,
 549         'participant_role' => 1,
 550         'participant_role_id' => 1,
 551         'participant_note' => 1,
 552         'participant_register_date' => 1,
 553         'participant_source' => 1,
 554         'participant_fee_level' => 1,
 555         'participant_is_test' => 1,
 556         'participant_is_pay_later' => 1,
 557         'participant_fee_amount' => 1,
 558         'participant_discount_name' => 1,
 559         'participant_fee_currency' => 1,
 560         'participant_registered_by_id' => 1,
 561         'participant_campaign_id' => 1,
 562       ];
 563
 564       if ($includeCustomFields) {
 565         // also get all the custom participant properties
 566         $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Participant');
 567         if (!empty($fields)) {
 568           foreach ($fields as $name => $dontCare) {
 569             $properties[$name] = 1;
 570           }
 571         }
 572       }
 573     }
 574
 575     return $properties;
 576   }
 577
 578   /**
 579    * Get the metadata for fields to be included on the grant search form.
 580    *
 581    * @throws \CiviCRM_API3_Exception
 582    */
 583   public static function getSearchFieldMetadata() {
 584     $fields = [
 585       'participant_status_id',
 586       'participant_register_date',
 587     ];
 588     $metadata = civicrm_api3('Participant', 'getfields', [])['values'];
 589     return array_intersect_key($metadata, array_flip($fields));
 590   }
 591
 592   /**
 593    * Build the event search form.
 594    *
 595    * @param \CRM_Event_Form_Search $form
 596    *
 597    * @throws \CiviCRM_API3_Exception
 598    * @throws \CRM_Core_Exception
 599    */
 600   public static function buildSearchForm(&$form) {
 601     $form->addSearchFieldMetadata(['Participant' => self::getSearchFieldMetadata()]);
 602     $form->addFormFieldsFromMetadata();
 603     $dataURLEventFee = CRM_Utils_System::url('civicrm/ajax/eventFee',
 604       "reset=1",
 605       FALSE, NULL, FALSE
 606     );
 607
 608     $form->assign('dataURLEventFee', $dataURLEventFee);
 609
 610     $form->addEntityRef('event_id', ts('Event Name'), [
 611       'entity' => 'Event',
 612       'placeholder' => ts('- any -'),
 613       'multiple' => 1,
 614       'select' => ['minimumInputLength' => 0],
 615     ]);
 616     $form->addEntityRef('event_type_id', ts('Event Type'), [
 617       'entity' => 'OptionValue',
 618       'placeholder' => ts('- any -'),
 619       'select' => ['minimumInputLength' => 0],
 620       'api' => [
 621         'params' => ['option_group_id' => 'event_type'],
 622       ],
 623     ]);
 624     $obj = new CRM_Report_Form_Event_ParticipantListing();
 625     $form->add('select', 'participant_fee_id',
 626        ts('Fee Level'),
 627        $obj->getPriceLevels(),
 628        FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')]
 629     );
 630
 631     CRM_Core_Form_Date::buildDateRange($form, 'event', 1, '_start_date_low', '_end_date_high', ts('From'), FALSE);
 632
 633     $form->addElement('hidden', 'event_date_range_error');
 634     $form->addFormRule(['CRM_Event_BAO_Query', 'formRule'], $form);
 635
 636     $form->addElement('checkbox', "event_include_repeating_events", NULL, ts('Include participants from all events in the %1 series', [1 => '<em>%1</em>']));
 637
 638     $form->addSelect('participant_role_id',
 639       [
 640         'entity' => 'participant',
 641         'label' => ts('Participant Role'),
 642         'multiple' => 'multiple',
 643         'option_url' => NULL,
 644         'placeholder' => ts('- any -'),
 645       ]
 646     );
 647
 648     $form->addYesNo('participant_test', ts('Participant is a Test?'), TRUE);
 649     $form->addYesNo('participant_is_pay_later', ts('Participant is Pay Later?'), TRUE);
 650     $form->addElement('text', 'participant_fee_amount_low', ts('From'), ['size' => 8, 'maxlength' => 8]);
 651     $form->addElement('text', 'participant_fee_amount_high', ts('To'), ['size' => 8, 'maxlength' => 8]);
 652
 653     $form->addRule('participant_fee_amount_low', ts('Please enter a valid money value.'), 'money');
 654     $form->addRule('participant_fee_amount_high', ts('Please enter a valid money value.'), 'money');
 655
 656     self::addCustomFormFields($form, ['Participant', 'Event']);
 657
 658     CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'participant_campaign_id');
 659
 660     $form->assign('validCiviEvent', TRUE);
 661     $form->setDefaults(['participant_test' => 0]);
 662   }
 663
 664   /**
 665    * @param $tables
 666    */
 667   public static function tableNames(&$tables) {
 668     //add participant table
 669     if (!empty($tables['civicrm_event'])) {
 670       $tables = array_merge(['civicrm_participant' => 1], $tables);
 671     }
 672   }
 673
 674   /**
 675    * Check if the values in the date range are in correct chronological order.
 676    *
 677    * @todo Get this to work with CRM_Utils_Rule::validDateRange
 678    *
 679    * @param array $fields
 680    * @param array $files
 681    * @param CRM_Core_Form $form
 682    *
 683    * @return bool|array
 684    */
 685   public static function formRule($fields, $files, $form) {
 686     $errors = [];
 687
 688     if ((empty($fields['event_start_date_low']) || empty($fields['event_end_date_high']))) {
 689       return TRUE;
 690     }
 691     $lowDate = strtotime($fields['event_start_date_low']);
 692     $highDate = strtotime($fields['event_end_date_high']);
 693
 694     if ($lowDate > $highDate) {
 695       $errors['event_date_range_error'] = ts('Please check that your Event Date Range is in correct chronological order.');
 696     }
 697
 698     return empty($errors) ? TRUE : $errors;
 699   }
 700
 701 }