Merge pull request #13289 from mfb/pear-mail
[civicrm-core.git] / CRM / Event / BAO / Query.php
CommitLineData
6a488035 1<?php
6a488035
TO
2/*
3 +--------------------------------------------------------------------+
fee14197 4 | CiviCRM version 5 |
6a488035 5 +--------------------------------------------------------------------+
6b83d5bd 6 | Copyright CiviCRM LLC (c) 2004-2019 |
6a488035
TO
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 +--------------------------------------------------------------------+
d25dd0ee 26 */
6a488035
TO
27
28/**
29 *
30 * @package CRM
6b83d5bd 31 * @copyright CiviCRM LLC (c) 2004-2019
6a488035
TO
32 * $Id$
33 *
34 */
86a0d21e 35class CRM_Event_BAO_Query extends CRM_Core_BAO_Query {
6a488035 36
0cf587a7 37 /**
e9ff5391 38 * Function get the import/export fields for contribution.
39 *
40 * @param bool $checkPermission
41 *
0cf587a7 42 * @return array
e9ff5391 43 * Associative array of contribution fields
0cf587a7 44 */
e9ff5391 45 public static function &getFields($checkPermission = TRUE) {
6a488035
TO
46 $fields = array();
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
0cf587a7
EM
54 /**
55 * @return array
56 */
00be9182 57 public static function &getParticipantFields() {
6a488035
TO
58 $fields = CRM_Event_BAO_Participant::importableFields('Individual', TRUE, TRUE);
59 return $fields;
60 }
61
62 /**
66f9e52b 63 * Build select for CiviEvent.
6a488035 64 *
77b97be7 65 * @param $query
6a488035 66 */
00be9182 67 public static function select(&$query) {
6a488035
TO
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
a7488080 76 if (!empty($query->_returnProperties['participant_fee_level'])) {
6a488035
TO
77 $query->_select['participant_fee_level'] = "civicrm_participant.fee_level as participant_fee_level";
78 $query->_element['participant_fee_level'] = 1;
79 }
80
e51b7372 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
6a488035 87 //add fee amount
a7488080 88 if (!empty($query->_returnProperties['participant_fee_amount'])) {
6a488035
TO
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
a7488080 94 if (!empty($query->_returnProperties['participant_fee_currency'])) {
6a488035
TO
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
8cc574cf 100 if (!empty($query->_returnProperties['event_id']) || !empty($query->_returnProperties['event_title'])) {
6a488035
TO
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
a7488080 110 if (!empty($query->_returnProperties['event_start_date'])) {
6a488035
TO
111 $query->_select['event_start_date'] = "civicrm_event.start_date as event_start_date";
112 $query->_element['event_start_date'] = 1;
113 }
114
a7488080 115 if (!empty($query->_returnProperties['event_end_date'])) {
6a488035
TO
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
a7488080 121 if (!empty($query->_returnProperties['event_type'])) {
6a488035
TO
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
a7488080 128 if (!empty($query->_returnProperties['event_type_id'])) {
6a488035
TO
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
f5d67b2a 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";
6a488035 138 $query->_element['participant_status_id'] = 1;
6a488035 139 $query->_tables['civicrm_participant'] = 1;
f5d67b2a 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;
6a488035
TO
147 $query->_tables['participant_status'] = 1;
148 $query->_whereTables['civicrm_participant'] = 1;
6a488035
TO
149 }
150
f5d67b2a 151 //add participant_role_id
152 if (!empty($query->_returnProperties['participant_role_id'])) {
6a488035
TO
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;
f5d67b2a 156 $query->_whereTables['civicrm_participant'] = 1;
348b1fda 157 $query->_pseudoConstantsSelect['participant_role_id'] = array(
158 'pseudoField' => 'participant_role_id',
159 'idCol' => 'participant_role_id',
160 );
f5d67b2a 161 }
162
163 //add participant_role
164 if (!empty($query->_returnProperties['participant_role'])) {
c0bcfbce 165 $query->_select['participant_role'] = "civicrm_participant.role_id as participant_role";
f5d67b2a 166 $query->_element['participant_role'] = 1;
6a488035
TO
167 $query->_tables['participant_role'] = 1;
168 $query->_whereTables['civicrm_participant'] = 1;
348b1fda 169 $query->_pseudoConstantsSelect['participant_role'] = array(
170 'pseudoField' => 'participant_role',
171 'idCol' => 'participant_role',
172 );
6a488035
TO
173 }
174
175 //add register date
a7488080 176 if (!empty($query->_returnProperties['participant_register_date'])) {
6a488035
TO
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
a7488080 182 if (!empty($query->_returnProperties['participant_source'])) {
6a488035
TO
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
a7488080 189 if (!empty($query->_returnProperties['participant_note'])) {
6a488035
TO
190 $query->_select['participant_note'] = "civicrm_note.note as participant_note";
191 $query->_element['participant_note'] = 1;
192 $query->_tables['participant_note'] = 1;
193 $query->_whereTables['civicrm_note'] = 1;
194 }
195
a7488080 196 if (!empty($query->_returnProperties['participant_is_pay_later'])) {
6a488035
TO
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
a7488080 201 if (!empty($query->_returnProperties['participant_is_test'])) {
6a488035
TO
202 $query->_select['participant_is_test'] = "civicrm_participant.is_test as participant_is_test";
203 $query->_element['participant_is_test'] = 1;
204 }
205
a7488080 206 if (!empty($query->_returnProperties['participant_registered_by_id'])) {
6a488035
TO
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
a7488080 212 if (!empty($query->_returnProperties['participant_discount_name'])) {
6a488035
TO
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.
a7488080 222 if (!empty($query->_returnProperties['participant_campaign_id'])) {
6a488035
TO
223 $query->_select['participant_campaign_id'] = 'civicrm_participant.campaign_id as participant_campaign_id';
224 $query->_element['participant_campaign_id'] = 1;
225 }
226 }
227 }
d75f2f47 228
6a488035 229
0cf587a7
EM
230 /**
231 * @param $query
232 */
00be9182 233 public static function where(&$query) {
28c666be 234 $grouping = NULL;
6a488035 235 foreach (array_keys($query->_params) as $id) {
a7488080 236 if (empty($query->_params[$id][0])) {
6a488035
TO
237 continue;
238 }
239 if (substr($query->_params[$id][0], 0, 6) == 'event_' ||
240 substr($query->_params[$id][0], 0, 12) == 'participant_'
241 ) {
242 if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) {
243 $query->_useDistinct = TRUE;
244 }
6a488035
TO
245 $grouping = $query->_params[$id][3];
246 self::whereClauseSingle($query->_params[$id], $query);
247 }
248 }
6a488035
TO
249 }
250
0cf587a7
EM
251 /**
252 * @param $values
253 * @param $query
254 */
00be9182 255 public static function whereClauseSingle(&$values, &$query) {
f27fe817 256 $checkPermission = empty($query->_skipPermission);
6a488035 257 list($name, $op, $value, $grouping, $wildcard) = $values;
3d6fe441 258 $fields = array_merge(CRM_Event_BAO_Event::fields(), CRM_Event_BAO_Participant::exportableFields());
e51b7372 259
6a488035
TO
260 switch ($name) {
261 case 'event_start_date_low':
262 case 'event_start_date_high':
263 $query->dateQueryBuilder($values,
264 'civicrm_event', 'event_start_date', 'start_date', 'Start Date'
265 );
266 return;
267
268 case 'event_end_date_low':
269 case 'event_end_date_high':
270 $query->dateQueryBuilder($values,
271 'civicrm_event', 'event_end_date', 'end_date', 'End Date'
272 );
273 return;
d75f2f47 274
62933949 275 case 'event_include_repeating_events':
276 /**
277 * Include Repeating Events
278 */
279 //Get parent of this event
280 $exEventId = '';
a50a97b8 281 if ($query->_where[$grouping]) {
22e263ad 282 foreach ($query->_where[$grouping] as $key => $val) {
62933949 283 if (strstr($val, 'civicrm_event.id =')) {
284 $exEventId = $val;
285 $extractEventId = explode(" ", $val);
286 $value = $extractEventId[2];
10b3cbde 287 $where = $query->_where[$grouping][$key];
62933949 288 }
948c107f 289 elseif (strstr($val, 'civicrm_event.id IN')) {
f179424e 290 //extract the first event id if multiple events are selected
291 preg_match('/civicrm_event.id IN \(\"(\d+)/', $val, $matches);
292 $value = $matches[1];
10b3cbde 293 $where = $query->_where[$grouping][$key];
f179424e 294 }
295 }
296 if ($exEventId) {
297 $extractEventId = explode(" ", $exEventId);
298 $value = $extractEventId[2];
299 }
948c107f 300 elseif (!empty($matches[1])) {
f179424e 301 $value = $matches[1];
62933949 302 }
10b3cbde 303 $where = $query->_where[$grouping][$key];
62933949 304 }
305 $thisEventHasParent = CRM_Core_BAO_RecurringEntity::getParentFor($value, 'civicrm_event');
a50a97b8 306 if ($thisEventHasParent) {
a99e6f73 307 $getAllConnections = CRM_Core_BAO_RecurringEntity::getEntitiesForParent($thisEventHasParent, 'civicrm_event');
308 $allEventIds = array();
22e263ad 309 foreach ($getAllConnections as $key => $val) {
a99e6f73 310 $allEventIds[] = $val['id'];
311 }
a50a97b8 312 if (!empty($allEventIds)) {
62933949 313 $op = "IN";
92fcb95f 314 $value = "(" . implode(",", $allEventIds) . ")";
62933949 315 }
316 }
10b3cbde 317 $query->_where[$grouping][] = "{$where} OR civicrm_event.id $op {$value}";
d8f8b40f 318 $query->_qill[$grouping][] = ts('Include Repeating Events');
62933949 319 $query->_tables['civicrm_event'] = $query->_whereTables['civicrm_event'] = 1;
320 return;
d75f2f47 321
3a6eb174 322 case 'participant_is_test':
323 $key = array_search('civicrm_participant.is_test = 0', $query->_where[$grouping]);
324 if (!empty($key)) {
325 unset($query->_where[$grouping][$key]);
326 }
6a488035 327 case 'participant_test':
28c666be
CW
328 // We dont want to include all tests for sql OR CRM-7827
329 if (!$value || $query->getOperator() != 'OR') {
330 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.is_test",
331 $op,
332 $value,
333 "Boolean"
334 );
8e4742fc 335
336 $isTest = $value ? 'a Test' : 'not a Test';
337 $query->_qill[$grouping][] = ts("Participant is %1", array(1 => $isTest));
28c666be 338 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
6a488035 339 }
6a488035
TO
340 return;
341
342 case 'participant_fee_id':
f179424e 343 foreach ($value as $k => &$val) {
344 $val = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $val, 'label');
345 $val = CRM_Core_DAO::escapeString(trim($val));
6a488035 346 }
f179424e 347 $feeLabel = implode('|', $value);
348 $query->_where[$grouping][] = "civicrm_participant.fee_level REGEXP '{$feeLabel}'";
349 $query->_qill[$grouping][] = ts("Fee level") . " IN " . implode(', ', $value);
6a488035
TO
350 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
351 return;
352
6a488035
TO
353 case 'participant_fee_amount_high':
354 case 'participant_fee_amount_low':
355 $query->numberRangeBuilder($values,
356 'civicrm_participant', 'participant_fee_amount', 'fee_amount', 'Fee Amount'
357 );
358 return;
359
6a488035 360 case 'participant_status_id':
f6d1d432 361 if ($value && is_array($value) && strpos($op, 'IN') === FALSE) {
884fdc63 362 $op = 'IN';
363 }
364 case 'participant_status':
e51b7372 365 case 'participant_source':
366 case 'participant_id':
367 case 'participant_contact_id':
3a6eb174 368 case 'participant_is_pay_later':
e51b7372 369 case 'participant_fee_amount':
370 case 'participant_fee_level':
6f56dc34 371 case 'participant_campaign_id':
57a56c25 372 case 'participant_registered_by_id':
6f56dc34 373
e51b7372 374 $qillName = $name;
07d76dca 375 if (in_array($name, array(
505f5439 376 'participant_status_id',
377 'participant_source',
378 'participant_id',
379 'participant_contact_id',
380 'participant_fee_amount',
381 'participant_fee_level',
382 'participant_is_pay_later',
383 'participant_campaign_id',
57a56c25 384 'participant_registered_by_id',
505f5439 385 ))
386 ) {
e51b7372 387 $name = str_replace('participant_', '', $name);
3a6eb174 388 if ($name == 'is_pay_later') {
389 $qillName = $name;
390 }
c0bcfbce 391 }
392 elseif ($name == 'participant_status') {
393 $name = 'status_id';
6a488035
TO
394 }
395
e51b7372 396 $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
f5d67b2a 397 $tableName = empty($tableName) ? 'civicrm_participant' : $tableName;
505f5439 398 if (is_array($value) && in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) {
399 $op = key($value);
e6d24997 400 $value = $value[$op];
505f5439 401 }
c0bcfbce 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', array(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':
8e153817 411 $qillName = $name;
412 $name = 'role_id';
c0bcfbce 413
52fa9e7e 414 $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
415 $tableName = empty($tableName) ? 'civicrm_participant' : $tableName;
c0bcfbce 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';
4d795b6f 422 $regexp = "([[:cntrl:]]|^)" . implode('([[:cntrl:]]|$)|([[:cntrl:]]|^)', (array) $value) . "([[:cntrl:]]|$)";
c0bcfbce 423 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.$name", $regexOp, $regexp, 'String');
424 }
425 else {
f5d67b2a 426 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("$tableName.$name", $op, $value, $dataType);
6a488035 427 }
f5d67b2a 428
e51b7372 429 list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Event_DAO_Participant', $name, $value, $op);
430 $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
6a488035
TO
431 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
432 return;
433
434 case 'participant_register_date':
e520211a
SL
435 case 'participant_register_date_high':
436 case 'participant_register_date_low':
6a488035
TO
437 $query->dateQueryBuilder($values,
438 'civicrm_participant', 'participant_register_date', 'register_date', 'Register Date'
439 );
440 return;
441
6a488035 442 case 'event_id':
3a6eb174 443 case 'participant_event_id':
444 $name = str_replace('participant_', '', $name);
e51b7372 445 case 'event_is_public':
446 case 'event_type_id':
22bb0e9d 447 case 'event_title':
e51b7372 448 $qillName = $name;
bed98343 449 if (in_array($name, array(
505f5439 450 'event_id',
451 'event_title',
452 'event_is_public',
453 )
454 )
455 ) {
e51b7372 456 $name = str_replace('event_', '', $name);
457 }
458 $dataType = !empty($fields[$qillName]['type']) ? CRM_Utils_Type::typeToString($fields[$qillName]['type']) : 'String';
6a488035 459
e51b7372 460 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_event.$name", $op, $value, $dataType);
6a488035 461 $query->_tables['civicrm_event'] = $query->_whereTables['civicrm_event'] = 1;
e51b7372 462 if (!array_key_exists($qillName, $fields)) {
463 break;
464 }
450fcddb 465 list($op, $value) = CRM_Contact_BAO_Query::buildQillForFieldValue('CRM_Event_DAO_Event', $name, $value, $op, array('check_permission' => $checkPermission));
e51b7372 466 $query->_qill[$grouping][] = ts('%1 %2 %3', array(1 => $fields[$qillName]['title'], 2 => $op, 3 => $value));
6a488035 467 return;
6a488035
TO
468 }
469 }
470
0cf587a7 471 /**
100fef9d 472 * @param string $name
0cf587a7
EM
473 * @param $mode
474 * @param $side
475 *
476 * @return null|string
477 */
00be9182 478 public static function from($name, $mode, $side) {
6a488035
TO
479 $from = NULL;
480 switch ($name) {
481 case 'civicrm_participant':
482 $from = " LEFT JOIN civicrm_participant ON civicrm_participant.contact_id = contact_a.id ";
483 break;
484
485 case 'civicrm_event':
d4152539
WA
486 //CRM-17121
487 $from = " LEFT JOIN civicrm_event ON civicrm_participant.event_id = civicrm_event.id ";
6a488035
TO
488 break;
489
490 case 'event_type':
491 $from = " $side JOIN civicrm_option_group option_group_event_type ON (option_group_event_type.name = 'event_type')";
492 $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 ) ";
493 break;
494
495 case 'participant_note':
496 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_participant' AND
497 civicrm_participant.id = civicrm_note.entity_id )";
498 break;
499
500 case 'participant_status':
501 $from .= " $side JOIN civicrm_participant_status_type participant_status ON (civicrm_participant.status_id = participant_status.id) ";
502 break;
503
504 case 'participant_role':
505 $from = " $side JOIN civicrm_option_group option_group_participant_role ON (option_group_participant_role.name = 'participant_role')";
348b1fda 506 $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)
6a488035
TO
507 AND option_group_participant_role.id = participant_role.option_group_id ) ";
508 break;
509
510 case 'participant_discount_name':
511 $from = " $side JOIN civicrm_discount discount ON ( civicrm_participant.discount_id = discount.id )";
512 $from .= " $side JOIN civicrm_option_group discount_name ON ( discount_name.id = discount.price_set_id ) ";
513 break;
514 }
515 return $from;
516 }
517
0cf587a7
EM
518 /**
519 * @param $mode
520 * @param bool $includeCustomFields
521 *
522 * @return array|null
523 */
505f5439 524 public static function defaultReturnProperties(
ddca8f33 525 $mode,
6a488035
TO
526 $includeCustomFields = TRUE
527 ) {
528 $properties = NULL;
529 if ($mode & CRM_Contact_BAO_Query::MODE_EVENT) {
530 $properties = array(
531 'contact_type' => 1,
532 'contact_sub_type' => 1,
533 'sort_name' => 1,
534 'display_name' => 1,
535 'event_id' => 1,
536 'event_title' => 1,
537 'event_start_date' => 1,
538 'event_end_date' => 1,
539 'event_type' => 1,
540 'participant_id' => 1,
541 'participant_status' => 1,
348b1fda 542 'participant_status_id' => 1,
543 'participant_role' => 1,
6a488035
TO
544 'participant_role_id' => 1,
545 'participant_note' => 1,
546 'participant_register_date' => 1,
547 'participant_source' => 1,
548 'participant_fee_level' => 1,
549 'participant_is_test' => 1,
550 'participant_is_pay_later' => 1,
551 'participant_fee_amount' => 1,
552 'participant_discount_name' => 1,
553 'participant_fee_currency' => 1,
554 'participant_registered_by_id' => 1,
555 'participant_campaign_id' => 1,
556 );
557
558 if ($includeCustomFields) {
559 // also get all the custom participant properties
560 $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Participant');
561 if (!empty($fields)) {
562 foreach ($fields as $name => $dontCare) {
563 $properties[$name] = 1;
564 }
565 }
566 }
567 }
568
569 return $properties;
570 }
571
6aac2db8
CW
572 /**
573 * @param CRM_Core_Form $form
574 */
00be9182 575 public static function buildSearchForm(&$form) {
6a488035
TO
576 $dataURLEventFee = CRM_Utils_System::url('civicrm/ajax/eventFee',
577 "reset=1",
578 FALSE, NULL, FALSE
579 );
580
6a488035
TO
581 $form->assign('dataURLEventFee', $dataURLEventFee);
582
27d7d241 583 $form->addEntityRef('event_id', ts('Event Name'), array(
af00ced5 584 'entity' => 'Event',
9c7c6a00 585 'placeholder' => ts('- any -'),
f179424e 586 'multiple' => 1,
9c7c6a00
CW
587 'select' => array('minimumInputLength' => 0),
588 )
589 );
27d7d241 590 $form->addEntityRef('event_type_id', ts('Event Type'), array(
af00ced5 591 'entity' => 'OptionValue',
6aac2db8
CW
592 'placeholder' => ts('- any -'),
593 'select' => array('minimumInputLength' => 0),
594 'api' => array(
595 'params' => array('option_group_id' => 'event_type'),
596 ),
597 )
598 );
f179424e 599 $obj = new CRM_Report_Form_Event_ParticipantListing();
600 $form->add('select', 'participant_fee_id',
601 ts('Fee Level'),
602 $obj->getPriceLevels(),
603 FALSE, array('class' => 'crm-select2', 'multiple' => 'multiple', 'placeholder' => ts('- any -'))
604 );
6a488035 605
bc3f7f04 606 CRM_Core_Form_Date::buildDateRange($form, 'event', 1, '_start_date_low', '_end_date_high', ts('From'), FALSE);
27d7d241 607
e520211a
SL
608 CRM_Core_Form_Date::buildDateRange($form, 'participant', 1, '_register_date_low', '_register_date_high', ts('From'), FALSE);
609
738d4d0b
SB
610 $form->addElement('hidden', 'event_date_range_error');
611 $form->addElement('hidden', 'participant_date_range_error');
612 $form->addFormRule(array('CRM_Event_BAO_Query', 'formRule'), $form);
613
27d7d241 614 $form->addElement('checkbox', "event_include_repeating_events", NULL, ts('Include participants from all events in the %1 series', array(1 => '<em>%1</em>')));
6a488035 615
e51b7372 616 $form->addSelect('participant_status_id',
505f5439 617 array(
618 'entity' => 'participant',
619 'label' => ts('Participant Status'),
620 'multiple' => 'multiple',
621 'option_url' => NULL,
9b81f881 622 'placeholder' => ts('- any -'),
505f5439 623 )
e51b7372 624 );
6a488035 625
e51b7372 626 $form->addSelect('participant_role_id',
505f5439 627 array(
628 'entity' => 'participant',
629 'label' => ts('Participant Role'),
630 'multiple' => 'multiple',
631 'option_url' => NULL,
9b81f881 632 'placeholder' => ts('- any -'),
505f5439 633 )
e51b7372 634 );
6a488035 635
8a4f27dc 636 $form->addYesNo('participant_test', ts('Participant is a Test?'), TRUE);
3a6eb174 637 $form->addYesNo('participant_is_pay_later', ts('Participant is Pay Later?'), TRUE);
6a488035
TO
638 $form->addElement('text', 'participant_fee_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
639 $form->addElement('text', 'participant_fee_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
640
641 $form->addRule('participant_fee_amount_low', ts('Please enter a valid money value.'), 'money');
642 $form->addRule('participant_fee_amount_high', ts('Please enter a valid money value.'), 'money');
86a0d21e
CW
643
644 self::addCustomFormFields($form, array('Participant', 'Event'));
6a488035
TO
645
646 CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'participant_campaign_id');
d75f2f47 647
6a488035
TO
648 $form->assign('validCiviEvent', TRUE);
649 $form->setDefaults(array('participant_test' => 0));
650 }
651
0cf587a7
EM
652 /**
653 * @param $tables
654 */
00be9182 655 public static function tableNames(&$tables) {
6a488035 656 //add participant table
a7488080 657 if (!empty($tables['civicrm_event'])) {
6a488035
TO
658 $tables = array_merge(array('civicrm_participant' => 1), $tables);
659 }
660 }
96025800 661
738d4d0b
SB
662 /**
663 * Check if the values in the date range are in correct chronological order.
664 *
79326ee2
SB
665 * @todo Get this to work with CRM_Utils_Rule::validDateRange
666 *
738d4d0b
SB
667 * @param array $fields
668 * @param array $files
669 * @param CRM_Core_Form $form
670 *
671 * @return bool|array
672 */
673 public static function formRule($fields, $files, $form) {
674 $errors = array();
675
676 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']))) {
677 return TRUE;
678 }
679 $lowDate = strtotime($fields['event_start_date_low']);
680 $highDate = strtotime($fields['event_end_date_high']);
681
682 if ($lowDate > $highDate) {
683 $errors['event_date_range_error'] = ts('Please check that your Event Date Range is in correct chronological order.');
684 }
685
686 $lowDate1 = strtotime($fields['participant_register_date_low']);
687 $highDate1 = strtotime($fields['participant_register_date_high']);
688
689 if ($lowDate1 > $highDate1) {
690 $errors['participant_date_range_error'] = ts('Please check that your Registration Date Range is in correct chronological order.');
691 }
692 return empty($errors) ? TRUE : $errors;
693 }
694
6a488035 695}