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'] = "event_type.id as event_type_id";
 130         $query->_element['event_type_id'] = 1;
 131         $query->_tables['event_type'] = 1;
 132         $query->_whereTables['event_type'] = 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         $val_regexp = [];
 343         foreach ($value as $k => &$val) {
 344           $val = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $val, 'label');
 345           $val_regexp[$k] = CRM_Core_DAO::escapeString(preg_quote(trim($val)));
 346           $val = CRM_Core_DAO::escapeString(trim($val));
 347         }
 348         $feeLabel = implode('|', $val_regexp);
 349         $query->_where[$grouping][] = "civicrm_participant.fee_level REGEXP '{$feeLabel}'";
 350         $query->_qill[$grouping][] = ts("Fee level") . " IN " . implode(', ', $value);
 351         $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
 352         return;
 353
 354       case 'participant_fee_amount_high':
 355       case 'participant_fee_amount_low':
 356         $query->numberRangeBuilder($values,
 357           'civicrm_participant', 'participant_fee_amount', 'fee_amount', 'Fee Amount'
 358         );
 359         return;
 360
 361       case 'participant_status_id':
 362         if ($value && is_array($value) && strpos($op, 'IN') === FALSE) {
 363           $op = 'IN';
 364         }
 365       case 'participant_status':
 366       case 'participant_source':
 367       case 'participant_id':
 368       case 'participant_contact_id':
 369       case 'participant_is_pay_later':
 370       case 'participant_fee_amount':
 371       case 'participant_fee_level':
 372       case 'participant_campaign_id':
 373       case 'participant_registered_by_id':
 374
 375         $qillName = $name;
 376         if (in_array($name, [
 377           'participant_status_id',
 378           'participant_source',
 379           'participant_id',
 380           'participant_contact_id',
 381           'participant_fee_amount',
 382           'participant_fee_level',
 383           'participant_is_pay_later',
 384           'participant_campaign_id',
 385           'participant_registered_by_id',
 386         ])) {
 387           $name = str_replace('participant_', '', $name);
 388           if ($name == 'is_pay_later') {
 389             $qillName = $name;
 390           }
 391         }
 392         elseif ($name == 'participant_status') {
 393           $name = 'status_id';
 394         }
 395
 396         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 397         $tableName = empty($tableName) ? 'civicrm_participant' : $tableName;
 398         if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
 399           $op = key($value);
 400           $value = $value[$op];
 401         }
 402         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$tableName.$name", $op, $value, $dataType);
 403
 404         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Event_DAO_Participant', $name, $value, $op);
 405         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
 406         $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
 407         return;
 408
 409       case 'participant_role':
 410       case 'participant_role_id':
 411         $qillName = $name;
 412         $name = 'role_id';
 413
 414         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 415         $tableName = empty($tableName) ? 'civicrm_participant' : $tableName;
 416         if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
 417           $op = key($value);
 418           $value = $value[$op];
 419         }
 420         if (!strstr($op, 'NULL') && !strstr($op, 'EMPTY') && !strstr($op, 'LIKE')) {
 421           $regexOp = (strstr($op, '!') || strstr($op, 'NOT')) ? 'NOT REGEXP' : 'REGEXP';
 422           $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
 423           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.$name", $regexOp, $regexp, 'String');
 424         }
 425         else {
 426           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$tableName.$name", $op, $value, $dataType);
 427         }
 428
 429         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Event_DAO_Participant', $name, $value, $op);
 430         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
 431         $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
 432         return;
 433
 434       case 'participant_register_date':
 435       case 'participant_register_date_high':
 436       case 'participant_register_date_low':
 437         $query->dateQueryBuilder($values,
 438           'civicrm_participant', 'participant_register_date', 'register_date', 'Register Date'
 439         );
 440         return;
 441
 442       case 'event_id':
 443       case 'participant_event_id':
 444         $name = str_replace('participant_', '', $name);
 445       case 'event_is_public':
 446       case 'event_type_id':
 447       case 'event_title':
 448         $qillName = $name;
 449         if (in_array($name, [
 450           'event_id',
 451           'event_title',
 452           'event_is_public',
 453         ])) {
 454           $name = str_replace('event_', '', $name);
 455         }
 456         $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
 457
 458         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_event.$name", $op, $value, $dataType);
 459         $query->_tables['civicrm_event'] = $query->_whereTables['civicrm_event'] = 1;
 460         if (!array_key_exists($qillName, $fields)) {
 461           break;
 462         }
 463         list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Event_DAO_Event', $name, $value, $op, ['check_permission' => $checkPermission]);
 464         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$qillName]['title'], 2 => $op, 3 => $value]);
 465         return;
 466
 467       case 'participant_note':
 468         $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
 469         $query->_tables['participant_note'] = $query->_whereTables['participant_note'] = 1;
 470         $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause('participant_note.note', $op, $value, 'String');
 471         $query->_qill[$grouping][] = ts('%1 %2 %3', [1 => $fields[$name]['title'], 2 => $op, 3 => $value]);
 472         break;
 473     }
 474   }
 475
 476   /**
 477    * @param string $name
 478    * @param $mode
 479    * @param $side
 480    *
 481    * @return null|string
 482    */
 483   public static function from($name, $mode, $side) {
 484     $from = NULL;
 485     switch ($name) {
 486       case 'civicrm_participant':
 487         $from = " LEFT JOIN civicrm_participant ON civicrm_participant.contact_id = contact_a.id ";
 488         break;
 489
 490       case 'civicrm_event':
 491         //CRM-17121
 492         $from = " LEFT JOIN civicrm_event ON civicrm_participant.event_id = civicrm_event.id ";
 493         break;
 494
 495       case 'event_type':
 496         $from = " $side JOIN civicrm_option_group option_group_event_type ON (option_group_event_type.name = 'event_type')";
 497         $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 ) ";
 498         break;
 499
 500       case 'participant_note':
 501         $from .= " $side JOIN civicrm_note participant_note ON ( participant_note.entity_table = 'civicrm_participant' AND
 502                                                         civicrm_participant.id = participant_note.entity_id )";
 503         break;
 504
 505       case 'participant_status':
 506         $from .= " $side JOIN civicrm_participant_status_type participant_status ON (civicrm_participant.status_id = participant_status.id) ";
 507         break;
 508
 509       case 'participant_role':
 510         $from = " $side JOIN civicrm_option_group option_group_participant_role ON (option_group_participant_role.name = 'participant_role')";
 511         $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)
 512                                AND option_group_participant_role.id = participant_role.option_group_id ) ";
 513         break;
 514
 515       case 'participant_discount_name':
 516         $from = " $side JOIN civicrm_discount discount ON ( civicrm_participant.discount_id = discount.id )";
 517         $from .= " $side JOIN civicrm_option_group discount_name ON ( discount_name.id = discount.price_set_id ) ";
 518         break;
 519     }
 520     return $from;
 521   }
 522
 523   /**
 524    * @param $mode
 525    * @param bool $includeCustomFields
 526    *
 527    * @return array|null
 528    */
 529   public static function defaultReturnProperties(
 530     $mode,
 531     $includeCustomFields = TRUE
 532   ) {
 533     $properties = NULL;
 534     if ($mode & CRM_Contact_BAO_Query::MODE_EVENT) {
 535       $properties = [
 536         'contact_type' => 1,
 537         'contact_sub_type' => 1,
 538         'sort_name' => 1,
 539         'display_name' => 1,
 540         'event_id' => 1,
 541         'event_title' => 1,
 542         'event_start_date' => 1,
 543         'event_end_date' => 1,
 544         'event_type' => 1,
 545         'participant_id' => 1,
 546         'participant_status' => 1,
 547         'participant_status_id' => 1,
 548         'participant_role' => 1,
 549         'participant_role_id' => 1,
 550         'participant_note' => 1,
 551         'participant_register_date' => 1,
 552         'participant_source' => 1,
 553         'participant_fee_level' => 1,
 554         'participant_is_test' => 1,
 555         'participant_is_pay_later' => 1,
 556         'participant_fee_amount' => 1,
 557         'participant_discount_name' => 1,
 558         'participant_fee_currency' => 1,
 559         'participant_registered_by_id' => 1,
 560         'participant_campaign_id' => 1,
 561       ];
 562
 563       if ($includeCustomFields) {
 564         // also get all the custom participant properties
 565         $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Participant');
 566         if (!empty($fields)) {
 567           foreach ($fields as $name => $dontCare) {
 568             $properties[$name] = 1;
 569           }
 570         }
 571       }
 572     }
 573
 574     return $properties;
 575   }
 576
 577   /**
 578    * @param CRM_Core_Form $form
 579    */
 580   public static function buildSearchForm(&$form) {
 581     $dataURLEventFee = CRM_Utils_System::url('civicrm/ajax/eventFee',
 582       "reset=1",
 583       FALSE, NULL, FALSE
 584     );
 585
 586     $form->assign('dataURLEventFee', $dataURLEventFee);
 587
 588     $form->addEntityRef('event_id', ts('Event Name'), [
 589       'entity' => 'Event',
 590       'placeholder' => ts('- any -'),
 591       'multiple' => 1,
 592       'select' => ['minimumInputLength' => 0],
 593     ]);
 594     $form->addEntityRef('event_type_id', ts('Event Type'), [
 595       'entity' => 'OptionValue',
 596       'placeholder' => ts('- any -'),
 597       'select' => ['minimumInputLength' => 0],
 598       'api' => [
 599         'params' => ['option_group_id' => 'event_type'],
 600       ],
 601     ]);
 602     $obj = new CRM_Report_Form_Event_ParticipantListing();
 603     $form->add('select', 'participant_fee_id',
 604        ts('Fee Level'),
 605        $obj->getPriceLevels(),
 606        FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -')]
 607     );
 608
 609     CRM_Core_Form_Date::buildDateRange($form, 'event', 1, '_start_date_low', '_end_date_high', ts('From'), FALSE);
 610
 611     CRM_Core_Form_Date::buildDateRange($form, 'participant', 1, '_register_date_low', '_register_date_high', ts('From'), FALSE);
 612
 613     $form->addElement('hidden', 'event_date_range_error');
 614     $form->addElement('hidden', 'participant_date_range_error');
 615     $form->addFormRule(['CRM_Event_BAO_Query', 'formRule'], $form);
 616
 617     $form->addElement('checkbox', "event_include_repeating_events", NULL, ts('Include participants from all events in the %1 series', [1 => '<em>%1</em>']));
 618
 619     $form->addSelect('participant_status_id',
 620       [
 621         'entity' => 'participant',
 622         'label' => ts('Participant Status'),
 623         'multiple' => 'multiple',
 624         'option_url' => NULL,
 625         'placeholder' => ts('- any -'),
 626       ]
 627     );
 628
 629     $form->addSelect('participant_role_id',
 630       [
 631         'entity' => 'participant',
 632         'label' => ts('Participant Role'),
 633         'multiple' => 'multiple',
 634         'option_url' => NULL,
 635         'placeholder' => ts('- any -'),
 636       ]
 637     );
 638
 639     $form->addYesNo('participant_test', ts('Participant is a Test?'), TRUE);
 640     $form->addYesNo('participant_is_pay_later', ts('Participant is Pay Later?'), TRUE);
 641     $form->addElement('text', 'participant_fee_amount_low', ts('From'), ['size' => 8, 'maxlength' => 8]);
 642     $form->addElement('text', 'participant_fee_amount_high', ts('To'), ['size' => 8, 'maxlength' => 8]);
 643
 644     $form->addRule('participant_fee_amount_low', ts('Please enter a valid money value.'), 'money');
 645     $form->addRule('participant_fee_amount_high', ts('Please enter a valid money value.'), 'money');
 646
 647     self::addCustomFormFields($form, ['Participant', 'Event']);
 648
 649     CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'participant_campaign_id');
 650
 651     $form->assign('validCiviEvent', TRUE);
 652     $form->setDefaults(['participant_test' => 0]);
 653   }
 654
 655   /**
 656    * @param $tables
 657    */
 658   public static function tableNames(&$tables) {
 659     //add participant table
 660     if (!empty($tables['civicrm_event'])) {
 661       $tables = array_merge(['civicrm_participant' => 1], $tables);
 662     }
 663   }
 664
 665   /**
 666    * Check if the values in the date range are in correct chronological order.
 667    *
 668    * @todo Get this to work with CRM_Utils_Rule::validDateRange
 669    *
 670    * @param array $fields
 671    * @param array $files
 672    * @param CRM_Core_Form $form
 673    *
 674    * @return bool|array
 675    */
 676   public static function formRule($fields, $files, $form) {
 677     $errors = [];
 678
 679     if ((empty($fields['event_start_date_low']) || empty($fields['event_end_date_high'])) && (empty($fields['participant_register_date_low']) || empty($fields['participant_register_date_high']))) {
 680       return TRUE;
 681     }
 682     $lowDate = strtotime($fields['event_start_date_low']);
 683     $highDate = strtotime($fields['event_end_date_high']);
 684
 685     if ($lowDate > $highDate) {
 686       $errors['event_date_range_error'] = ts('Please check that your Event Date Range is in correct chronological order.');
 687     }
 688
 689     $lowDate1 = strtotime($fields['participant_register_date_low']);
 690     $highDate1 = strtotime($fields['participant_register_date_high']);
 691
 692     if ($lowDate1 > $highDate1) {
 693       $errors['participant_date_range_error'] = ts('Please check that your Registration Date Range is in correct chronological order.');
 694     }
 695     return empty($errors) ? TRUE : $errors;
 696   }
 697
 698 }