Merge remote-tracking branch 'upstream/4.4' into 4.4-master-2014-04-28-11-04-58
[civicrm-core.git] / CRM / Event / BAO / Query.php
1 <?php
2
3 /*
4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
10 | |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
19 | |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
27 */
28
29 /**
30 *
31 * @package CRM
32 * @copyright CiviCRM LLC (c) 2004-2014
33 * $Id$
34 *
35 */
36 class CRM_Event_BAO_Query {
37
38 static function &getFields() {
39 $fields = array();
40 $fields = array_merge($fields, CRM_Event_DAO_Event::import());
41 $fields = array_merge($fields, self::getParticipantFields());
42 $fields = array_merge($fields, CRM_Core_DAO_Discount::export());
43
44 return $fields;
45 }
46
47 static function &getParticipantFields() {
48 $fields = CRM_Event_BAO_Participant::importableFields('Individual', TRUE, TRUE);
49 return $fields;
50 }
51
52 /**
53 * build select for CiviEvent
54 *
55 * @return void
56 * @access public
57 */
58 static function select(&$query) {
59 if (($query->_mode & CRM_Contact_BAO_Query::MODE_EVENT) ||
60 CRM_Contact_BAO_Query::componentPresent($query->_returnProperties, 'participant_')
61 ) {
62 $query->_select['participant_id'] = "civicrm_participant.id as participant_id";
63 $query->_element['participant_id'] = 1;
64 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
65
66 //add fee level
67 if (!empty($query->_returnProperties['participant_fee_level'])) {
68 $query->_select['participant_fee_level'] = "civicrm_participant.fee_level as participant_fee_level";
69 $query->_element['participant_fee_level'] = 1;
70 }
71
72 //add fee amount
73 if (!empty($query->_returnProperties['participant_fee_amount'])) {
74 $query->_select['participant_fee_amount'] = "civicrm_participant.fee_amount as participant_fee_amount";
75 $query->_element['participant_fee_amount'] = 1;
76 }
77
78 //add fee currency
79 if (!empty($query->_returnProperties['participant_fee_currency'])) {
80 $query->_select['participant_fee_currency'] = "civicrm_participant.fee_currency as participant_fee_currency";
81 $query->_element['participant_fee_currency'] = 1;
82 }
83
84 //add event title also if event id is select
85 if (!empty($query->_returnProperties['event_id']) || !empty($query->_returnProperties['event_title'])) {
86 $query->_select['event_id'] = "civicrm_event.id as event_id";
87 $query->_select['event_title'] = "civicrm_event.title as event_title";
88 $query->_element['event_id'] = 1;
89 $query->_element['event_title'] = 1;
90 $query->_tables['civicrm_event'] = 1;
91 $query->_whereTables['civicrm_event'] = 1;
92 }
93
94 //add start date / end date
95 if (!empty($query->_returnProperties['event_start_date'])) {
96 $query->_select['event_start_date'] = "civicrm_event.start_date as event_start_date";
97 $query->_element['event_start_date'] = 1;
98 }
99
100 if (!empty($query->_returnProperties['event_end_date'])) {
101 $query->_select['event_end_date'] = "civicrm_event.end_date as event_end_date";
102 $query->_element['event_end_date'] = 1;
103 }
104
105 //event type
106 if (!empty($query->_returnProperties['event_type'])) {
107 $query->_select['event_type'] = "event_type.label as event_type";
108 $query->_element['event_type'] = 1;
109 $query->_tables['event_type'] = 1;
110 $query->_whereTables['event_type'] = 1;
111 }
112
113 if (!empty($query->_returnProperties['event_type_id'])) {
114 $query->_select['event_type_id'] = "event_type.id as event_type_id";
115 $query->_element['event_type_id'] = 1;
116 $query->_tables['event_type'] = 1;
117 $query->_whereTables['event_type'] = 1;
118 }
119
120 //add status and status_id
121 if (!empty($query->_returnProperties['participant_status']) || !empty($query->_returnProperties['participant_status_id'])) {
122 $query->_select['participant_status'] = "participant_status.label as participant_status";
123 $query->_select['participant_status_id'] = "participant_status.id as participant_status_id";
124 $query->_element['participant_status_id'] = 1;
125 $query->_element['participant_status'] = 1;
126 $query->_tables['civicrm_participant'] = 1;
127 $query->_tables['participant_status'] = 1;
128 $query->_whereTables['civicrm_participant'] = 1;
129 $query->_whereTables['participant_status'] = 1;
130 }
131
132 //add role
133 if (!empty($query->_returnProperties['participant_role'])) {
134 $query->_select['participant_role'] = "participant_role.label as participant_role";
135 $query->_element['participant_role'] = 1;
136 $query->_tables['civicrm_participant'] = 1;
137 $query->_tables['participant_role'] = 1;
138 $query->_whereTables['civicrm_participant'] = 1;
139 $query->_whereTables['participant_role'] = 1;
140 }
141
142 if (!empty($query->_returnProperties['participant_role_id'])) {
143 $query->_select['participant_role_id'] = "civicrm_participant.role_id as participant_role_id";
144 $query->_element['participant_role_id'] = 1;
145 $query->_tables['civicrm_participant'] = 1;
146 $query->_tables['participant_role'] = 1;
147 $query->_whereTables['civicrm_participant'] = 1;
148 $query->_whereTables['participant_role'] = 1;
149 }
150
151 //add register date
152 if (!empty($query->_returnProperties['participant_register_date'])) {
153 $query->_select['participant_register_date'] = "civicrm_participant.register_date as participant_register_date";
154 $query->_element['participant_register_date'] = 1;
155 }
156
157 //add source
158 if (!empty($query->_returnProperties['participant_source'])) {
159 $query->_select['participant_source'] = "civicrm_participant.source as participant_source";
160 $query->_element['participant_source'] = 1;
161 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
162 }
163
164 //participant note
165 if (!empty($query->_returnProperties['participant_note'])) {
166 $query->_select['participant_note'] = "civicrm_note.note as participant_note";
167 $query->_element['participant_note'] = 1;
168 $query->_tables['participant_note'] = 1;
169 $query->_whereTables['civicrm_note'] = 1;
170 }
171
172 if (!empty($query->_returnProperties['participant_is_pay_later'])) {
173 $query->_select['participant_is_pay_later'] = "civicrm_participant.is_pay_later as participant_is_pay_later";
174 $query->_element['participant_is_pay_later'] = 1;
175 }
176
177 if (!empty($query->_returnProperties['participant_is_test'])) {
178 $query->_select['participant_is_test'] = "civicrm_participant.is_test as participant_is_test";
179 $query->_element['participant_is_test'] = 1;
180 }
181
182 if (!empty($query->_returnProperties['participant_registered_by_id'])) {
183 $query->_select['participant_registered_by_id'] = "civicrm_participant.registered_by_id as participant_registered_by_id";
184 $query->_element['participant_registered_by_id'] = 1;
185 }
186
187 // get discount name
188 if (!empty($query->_returnProperties['participant_discount_name'])) {
189 $query->_select['participant_discount_name'] = "discount_name.title as participant_discount_name";
190 $query->_element['participant_discount_name'] = 1;
191 $query->_tables['civicrm_discount'] = 1;
192 $query->_tables['participant_discount_name'] = 1;
193 $query->_whereTables['civicrm_discount'] = 1;
194 $query->_whereTables['participant_discount_name'] = 1;
195 }
196
197 //carry campaign id to selectors.
198 if (!empty($query->_returnProperties['participant_campaign_id'])) {
199 $query->_select['participant_campaign_id'] = 'civicrm_participant.campaign_id as participant_campaign_id';
200 $query->_element['participant_campaign_id'] = 1;
201 }
202 }
203 }
204
205 static function where(&$query) {
206 $grouping = NULL;
207 foreach (array_keys($query->_params) as $id) {
208 if (empty($query->_params[$id][0])) {
209 continue;
210 }
211 if (substr($query->_params[$id][0], 0, 6) == 'event_' ||
212 substr($query->_params[$id][0], 0, 12) == 'participant_'
213 ) {
214 if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_CONTACTS) {
215 $query->_useDistinct = TRUE;
216 }
217 $grouping = $query->_params[$id][3];
218 self::whereClauseSingle($query->_params[$id], $query);
219 }
220 }
221 }
222
223 static function whereClauseSingle(&$values, &$query) {
224 list($name, $op, $value, $grouping, $wildcard) = $values;
225 switch ($name) {
226 case 'event_start_date_low':
227 case 'event_start_date_high':
228 $query->dateQueryBuilder($values,
229 'civicrm_event', 'event_start_date', 'start_date', 'Start Date'
230 );
231 return;
232
233 case 'event_end_date_low':
234 case 'event_end_date_high':
235 $query->dateQueryBuilder($values,
236 'civicrm_event', 'event_end_date', 'end_date', 'End Date'
237 );
238 return;
239
240 case 'event_id':
241 $query->_where[$grouping][] = "civicrm_event.id $op {$value}";
242 $eventTitle = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $value, 'title');
243 $query->_qill[$grouping][] = ts('Event') . " $op {$eventTitle}";
244 $query->_tables['civicrm_event'] = $query->_whereTables['civicrm_event'] = 1;
245 return;
246
247 case 'event_type_id':
248
249 $eventTypes = CRM_Core_OptionGroup::values("event_type");
250 $query->_where[$grouping][] = "civicrm_participant.event_id = civicrm_event.id and civicrm_event.event_type_id = '{$value}'";
251 $query->_qill[$grouping][] = ts('Event Type - %1', array(1 => $eventTypes[$value]));
252 $query->_tables['civicrm_event'] = $query->_whereTables['civicrm_event'] = 1;
253 return;
254
255 case 'participant_test':
256 // We dont want to include all tests for sql OR CRM-7827
257 if (!$value || $query->getOperator() != 'OR') {
258 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.is_test",
259 $op,
260 $value,
261 "Boolean"
262 );
263 if ($value) {
264 $query->_qill[$grouping][] = ts("Participant is a Test");
265 }
266 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
267 }
268 return;
269
270 case 'participant_fee_id':
271 $feeLabel = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $value, 'label');
272 $feeLabel = CRM_Core_DAO::escapeString(trim($feeLabel));
273 if ($value) {
274 $query->_where[$grouping][] = "civicrm_participant.fee_level LIKE '%$feeLabel%'";
275 $query->_qill[$grouping][] = ts("Fee level") . " contains $feeLabel";
276 }
277 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
278 return;
279
280 case 'participant_fee_amount':
281 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.fee_amount",
282 $op,
283 $value,
284 "Money"
285 );
286 if ($value) {
287 $query->_qill[$grouping][] = ts("Fee Amount") . " $op $value";
288 }
289 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
290 return;
291
292 case 'participant_fee_amount_high':
293 case 'participant_fee_amount_low':
294 $query->numberRangeBuilder($values,
295 'civicrm_participant', 'participant_fee_amount', 'fee_amount', 'Fee Amount'
296 );
297 return;
298
299 case 'participant_pay_later':
300 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.is_pay_later",
301 $op,
302 $value,
303 "Boolean"
304 );
305 $query->_qill[$grouping][] = $value ? ts("Participant is Pay Later") : ts("Participant is not Pay Later");
306 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
307 return;
308
309 case 'participant_status':
310 case 'participant_status_id':
311 $val = array();
312 if (is_array($value)) {
313 foreach ($value as $k => $v) {
314 if ($v) {
315 $val[$k] = $k;
316 }
317 }
318 $status = implode(',', $val);
319 }
320 else {
321 $status = $value;
322 }
323
324 if (count($val) > 1) {
325 $op = 'IN';
326 $status = "({$status})";
327 }
328
329 $statusTypes = CRM_Event_PseudoConstant::participantStatus();
330 $names = array();
331
332 if (!empty($val)) {
333 foreach ($val as $id => $dontCare) {
334 $names[] = $statusTypes[$id];
335 }
336 }
337 else {
338 $names[] = $statusTypes[$value];
339 }
340
341 $query->_qill[$grouping][] = ts('Participant Status %1', array(1 => $op)) . ' ' . implode(' ' . ts('or') . ' ', $names);
342
343 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.status_id",
344 $op,
345 $status,
346 "Integer"
347 );
348 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
349 return;
350
351 case 'participant_role_id':
352 $val = array();
353 if (is_array($value)) {
354 foreach ($value as $k => $v) {
355 if ($v) {
356 $val[$k] = $k;
357 }
358 }
359 }
360 else {
361 $val = array($value => 1);
362 }
363
364 $roleTypes = CRM_Event_PseudoConstant::participantRole();
365
366 $names = array();
367 foreach ($val as $id => $dontCare) {
368 $names[] = $roleTypes[$id];
369 }
370
371 if (!empty($names)) {
372 $query->_qill[$grouping][] =
373 ts('Participant Role %1', array(1 => $op)) .
374 ' ' .
375 implode(' ' . ts('or') . ' ', $names);
376 $query->_where[$grouping][] =
377 " civicrm_participant.role_id REGEXP '[[:<:]]" .
378 implode('[[:>:]]|[[:<:]]', array_keys($val)) .
379 "[[:>:]]' ";
380
381 $query->_tables['civicrm_participant'] =
382 $query->_whereTables['civicrm_participant'] = 1;
383 }
384 return;
385
386 case 'participant_source':
387 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.source",
388 $op,
389 $value,
390 "String"
391 );
392 $query->_qill[$grouping][] = ts("Participant Source") . " $op $value";
393 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
394 return;
395
396 case 'participant_register_date':
397 $query->dateQueryBuilder($values,
398 'civicrm_participant', 'participant_register_date', 'register_date', 'Register Date'
399 );
400 return;
401
402 case 'participant_id':
403 $query->_where[$grouping][] = "civicrm_participant.id $op $value";
404 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
405 return;
406
407 case 'event_id':
408 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_event.id",
409 $op,
410 $value,
411 "Integer"
412 );
413 $query->_tables['civicrm_event'] = $query->_whereTables['civicrm_event'] = 1;
414 $title = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $value, "title");
415 $query->_qill[$grouping][] = ts('Event') . " $op $value";
416 return;
417
418 case 'participant_contact_id':
419 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_participant.contact_id",
420 $op,
421 $value,
422 "Integer"
423 );
424 $query->_tables['civicrm_participant'] = $query->_whereTables['civicrm_participant'] = 1;
425 return;
426
427 case 'event_is_public':
428 $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause("civicrm_event.is_public",
429 $op,
430 $value,
431 "Integer"
432 );
433 $query->_tables['civicrm_event'] = $query->_whereTables['civicrm_event'] = 1;
434 return;
435
436 case 'participant_campaign_id':
437 $campParams = array(
438 'op' => $op,
439 'campaign' => $value,
440 'grouping' => $grouping,
441 'tableName' => 'civicrm_participant',
442 );
443 CRM_Campaign_BAO_Query::componentSearchClause($campParams, $query);
444 return;
445 }
446 }
447
448 static function from($name, $mode, $side) {
449 $from = NULL;
450 switch ($name) {
451 case 'civicrm_participant':
452 $from = " LEFT JOIN civicrm_participant ON civicrm_participant.contact_id = contact_a.id ";
453 break;
454
455 case 'civicrm_event':
456 $from = " INNER JOIN civicrm_event ON civicrm_participant.event_id = civicrm_event.id ";
457 break;
458
459 case 'event_type':
460 $from = " $side JOIN civicrm_option_group option_group_event_type ON (option_group_event_type.name = 'event_type')";
461 $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 ) ";
462 break;
463
464 case 'participant_note':
465 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_participant' AND
466 civicrm_participant.id = civicrm_note.entity_id )";
467 break;
468
469 case 'participant_status':
470 $from .= " $side JOIN civicrm_participant_status_type participant_status ON (civicrm_participant.status_id = participant_status.id) ";
471 break;
472
473 case 'participant_role':
474 $from = " $side JOIN civicrm_option_group option_group_participant_role ON (option_group_participant_role.name = 'participant_role')";
475 $from .= " $side JOIN civicrm_option_value participant_role ON (civicrm_participant.role_id = participant_role.value
476 AND option_group_participant_role.id = participant_role.option_group_id ) ";
477 break;
478
479 case 'participant_discount_name':
480 $from = " $side JOIN civicrm_discount discount ON ( civicrm_participant.discount_id = discount.id )";
481 $from .= " $side JOIN civicrm_option_group discount_name ON ( discount_name.id = discount.price_set_id ) ";
482 break;
483 }
484 return $from;
485 }
486
487 /**
488 * getter for the qill object
489 *
490 * @return string
491 * @access public
492 */
493 function qill() {
494 return (isset($this->_qill)) ? $this->_qill : "";
495 }
496
497 static function defaultReturnProperties($mode,
498 $includeCustomFields = TRUE
499 ) {
500 $properties = NULL;
501 if ($mode & CRM_Contact_BAO_Query::MODE_EVENT) {
502 $properties = array(
503 'contact_type' => 1,
504 'contact_sub_type' => 1,
505 'sort_name' => 1,
506 'display_name' => 1,
507 'event_id' => 1,
508 'event_title' => 1,
509 'event_start_date' => 1,
510 'event_end_date' => 1,
511 'event_type' => 1,
512 'participant_id' => 1,
513 'participant_status' => 1,
514 'participant_role_id' => 1,
515 'participant_note' => 1,
516 'participant_register_date' => 1,
517 'participant_source' => 1,
518 'participant_fee_level' => 1,
519 'participant_is_test' => 1,
520 'participant_is_pay_later' => 1,
521 'participant_fee_amount' => 1,
522 'participant_discount_name' => 1,
523 'participant_fee_currency' => 1,
524 'participant_registered_by_id' => 1,
525 'participant_campaign_id' => 1,
526 );
527
528 if ($includeCustomFields) {
529 // also get all the custom participant properties
530 $fields = CRM_Core_BAO_CustomField::getFieldsForImport('Participant');
531 if (!empty($fields)) {
532 foreach ($fields as $name => $dontCare) {
533 $properties[$name] = 1;
534 }
535 }
536 }
537 }
538
539 return $properties;
540 }
541
542 /**
543 * @param CRM_Core_Form $form
544 */
545 static function buildSearchForm(&$form) {
546 $dataURLEventFee = CRM_Utils_System::url('civicrm/ajax/eventFee',
547 "reset=1",
548 FALSE, NULL, FALSE
549 );
550
551 $form->assign('dataURLEventFee', $dataURLEventFee);
552
553 $eventId = $form->addEntityRef('event_id', ts('Event Name'), array(
554 'entity' => 'event',
555 'placeholder' => ts('- any -'),
556 'select' => array('minimumInputLength' => 0),
557 )
558 );
559 $eventType = $form->addEntityRef('event_type_id', ts('Event Type'), array(
560 'entity' => 'option_value',
561 'placeholder' => ts('- any -'),
562 'select' => array('minimumInputLength' => 0),
563 'api' => array(
564 'params' => array('option_group_id' => 'event_type'),
565 ),
566 )
567 );
568 $form->add('text', 'participant_fee_id', ts('Fee Level'), array('class' => 'big crm-ajax-select'));
569
570 CRM_Core_Form_Date::buildDateRange($form, 'event', 1, '_start_date_low', '_end_date_high', ts('From'), FALSE);
571
572 $status = CRM_Event_PseudoConstant::participantStatus(NULL, NULL, 'label');
573 asort($status);
574 foreach ($status as $id => $Name) {
575 $form->_participantStatus = &$form->addElement('checkbox', "participant_status_id[$id]", NULL, $Name);
576 }
577
578 foreach (CRM_Event_PseudoConstant::participantRole() as $rId => $rName) {
579 $form->_participantRole = &$form->addElement('checkbox', "participant_role_id[$rId]", NULL, $rName);
580 }
581
582 $form->addYesNo('participant_test', ts('Participant is a Test?'), TRUE);
583 $form->addYesNo('participant_pay_later', ts('Participant is Pay Later?'), TRUE);
584 $form->addElement('text', 'participant_fee_amount_low', ts('From'), array('size' => 8, 'maxlength' => 8));
585 $form->addElement('text', 'participant_fee_amount_high', ts('To'), array('size' => 8, 'maxlength' => 8));
586
587 $form->addRule('participant_fee_amount_low', ts('Please enter a valid money value.'), 'money');
588 $form->addRule('participant_fee_amount_high', ts('Please enter a valid money value.'), 'money');
589 // add all the custom searchable fields
590 $extends = array('Participant', 'Event');
591 $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $extends);
592 if ($groupDetails) {
593 $form->assign('participantGroupTree', $groupDetails);
594 foreach ($groupDetails as $group) {
595 foreach ($group['fields'] as $field) {
596 $fieldId = $field['id'];
597 $elementName = 'custom_' . $fieldId;
598 CRM_Core_BAO_CustomField::addQuickFormElement($form,
599 $elementName,
600 $fieldId,
601 FALSE, FALSE, TRUE
602 );
603 }
604 }
605 }
606
607 CRM_Campaign_BAO_Campaign::addCampaignInComponentSearch($form, 'participant_campaign_id');
608
609 $form->assign('validCiviEvent', TRUE);
610 $form->setDefaults(array('participant_test' => 0));
611 }
612
613 static function searchAction(&$row, $id) {}
614
615 static function tableNames(&$tables) {
616 //add participant table
617 if (!empty($tables['civicrm_event'])) {
618 $tables = array_merge(array('civicrm_participant' => 1), $tables);
619 }
620 }
621 }
622