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