Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
232624b1 | 4 | | CiviCRM version 4.4 | |
6a488035 TO |
5 | +--------------------------------------------------------------------+ |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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-2013 | |
32 | * $Id$ | |
314dbef8 | 33 | * |
6a488035 TO |
34 | */ |
35 | ||
36 | /** | |
37 | * This class is a heart of search query building mechanism. | |
38 | */ | |
39 | class CRM_Contact_BAO_Query { | |
40 | ||
41 | /** | |
42 | * The various search modes | |
43 | * | |
44 | * @var int | |
45 | */ | |
46 | CONST | |
47 | MODE_CONTACTS = 1, | |
48 | MODE_CONTRIBUTE = 2, | |
49 | MODE_MEMBER = 8, | |
50 | MODE_EVENT = 16, | |
51 | MODE_GRANT = 128, | |
52 | MODE_PLEDGEBANK = 256, | |
53 | MODE_PLEDGE = 512, | |
54 | MODE_CASE = 2048, | |
55 | MODE_ALL = 17407, | |
56 | MODE_ACTIVITY = 4096, | |
57 | MODE_CAMPAIGN = 8192, | |
58 | MODE_MAILING = 16384; | |
59 | ||
60 | /** | |
61 | * the default set of return properties | |
62 | * | |
63 | * @var array | |
64 | * @static | |
65 | */ | |
66 | static $_defaultReturnProperties = NULL; | |
67 | ||
68 | /** | |
69 | * the default set of hier return properties | |
70 | * | |
71 | * @var array | |
72 | * @static | |
73 | */ | |
74 | static $_defaultHierReturnProperties; | |
75 | ||
76 | /** | |
77 | * the set of input params | |
78 | * | |
79 | * @var array | |
80 | */ | |
81 | public $_params; | |
82 | ||
83 | public $_cfIDs; | |
84 | ||
85 | public $_paramLookup; | |
86 | ||
87 | /** | |
88 | * the set of output params | |
89 | * | |
90 | * @var array | |
91 | */ | |
92 | public $_returnProperties; | |
93 | ||
94 | /** | |
95 | * the select clause | |
96 | * | |
97 | * @var array | |
98 | */ | |
99 | public $_select; | |
100 | ||
101 | /** | |
102 | * the name of the elements that are in the select clause | |
103 | * used to extract the values | |
104 | * | |
105 | * @var array | |
106 | */ | |
107 | public $_element; | |
108 | ||
109 | /** | |
110 | * the tables involved in the query | |
111 | * | |
112 | * @var array | |
113 | */ | |
114 | public $_tables; | |
115 | ||
116 | /** | |
117 | * the table involved in the where clause | |
118 | * | |
119 | * @var array | |
120 | */ | |
121 | public $_whereTables; | |
122 | ||
123 | /** | |
124 | * the where clause | |
125 | * | |
126 | * @var array | |
127 | */ | |
128 | public $_where; | |
129 | ||
130 | /** | |
131 | * the where string | |
132 | * | |
133 | * @var string | |
134 | * | |
135 | */ | |
136 | public $_whereClause; | |
137 | ||
138 | /** | |
139 | * additional permission Where Clause | |
140 | * | |
141 | * @var string | |
142 | * | |
143 | */ | |
144 | public $_permissionWhereClause; | |
a30e57e0 | 145 | |
6a488035 TO |
146 | /** |
147 | * the from string | |
148 | * | |
149 | * @var string | |
150 | * | |
151 | */ | |
152 | public $_fromClause; | |
153 | ||
154 | /** | |
155 | * additional permission from clause | |
156 | * | |
157 | * @var string | |
158 | * | |
159 | */ | |
160 | public $_permissionFromClause; | |
161 | ||
162 | /** | |
163 | * the from clause for the simple select and alphabetical | |
164 | * select | |
165 | * | |
166 | * @var string | |
167 | */ | |
168 | public $_simpleFromClause; | |
169 | ||
170 | /** | |
171 | * the having values | |
172 | * | |
173 | * @var string | |
174 | * | |
175 | */ | |
176 | public $_having; | |
177 | ||
178 | /** | |
179 | * The english language version of the query | |
180 | * | |
181 | * @var array | |
182 | */ | |
183 | public $_qill; | |
184 | ||
185 | /** | |
186 | * All the fields that could potentially be involved in | |
187 | * this query | |
188 | * | |
189 | * @var array | |
190 | */ | |
191 | public $_fields; | |
192 | ||
193 | /** | |
194 | * The cache to translate the option values into labels | |
195 | * | |
196 | * @var array | |
197 | */ | |
198 | public $_options; | |
199 | ||
200 | /** | |
201 | * are we in search mode | |
202 | * | |
203 | * @var boolean | |
204 | */ | |
205 | public $_search = TRUE; | |
206 | ||
207 | /** | |
208 | * should we skip permission checking | |
209 | * | |
210 | * @var boolean | |
211 | */ | |
212 | public $_skipPermission = FALSE; | |
213 | ||
214 | /** | |
215 | * should we skip adding of delete clause | |
216 | * | |
217 | * @var boolean | |
218 | */ | |
219 | public $_skipDeleteClause = FALSE; | |
220 | ||
221 | /** | |
222 | * are we in strict mode (use equality over LIKE) | |
223 | * | |
224 | * @var boolean | |
225 | */ | |
226 | public $_strict = FALSE; | |
227 | ||
228 | /** | |
229 | * What operator to use to group the clauses | |
230 | * | |
231 | * @var string | |
232 | */ | |
233 | public $_operator = 'AND'; | |
234 | ||
235 | public $_mode = 1; | |
236 | ||
237 | /** | |
238 | * Should we only search on primary location | |
239 | * | |
240 | * @var boolean | |
241 | */ | |
242 | public $_primaryLocation = TRUE; | |
243 | ||
244 | /** | |
245 | * are contact ids part of the query | |
246 | * | |
247 | * @var boolean | |
248 | */ | |
249 | public $_includeContactIds = FALSE; | |
250 | ||
251 | /** | |
252 | * Should we use the smart group cache | |
253 | * | |
254 | * @var boolean | |
255 | */ | |
256 | public $_smartGroupCache = TRUE; | |
257 | ||
258 | /** | |
259 | * Should we display contacts with a specific relationship type | |
260 | * | |
261 | * @var string | |
262 | */ | |
263 | public $_displayRelationshipType = NULL; | |
264 | ||
265 | /** | |
266 | * reference to the query object for custom values | |
267 | * | |
268 | * @var Object | |
269 | */ | |
270 | public $_customQuery; | |
271 | ||
272 | /** | |
273 | * should we enable the distinct clause, used if we are including | |
274 | * more than one group | |
275 | * | |
276 | * @var boolean | |
277 | */ | |
278 | public $_useDistinct = FALSE; | |
279 | ||
280 | /** | |
281 | * Should we just display one contact record | |
282 | */ | |
283 | public $_useGroupBy = FALSE; | |
284 | ||
285 | /** | |
286 | * the relationship type direction | |
287 | * | |
288 | * @var array | |
289 | * @static | |
290 | */ | |
291 | static $_relType; | |
292 | ||
293 | /** | |
294 | * the activity role | |
295 | * | |
296 | * @var array | |
297 | * @static | |
298 | */ | |
299 | static $_activityRole; | |
300 | ||
301 | /** | |
302 | * Consider the component activity type | |
303 | * during activity search. | |
304 | * | |
305 | * @var array | |
306 | * @static | |
307 | */ | |
308 | static $_considerCompActivities; | |
309 | ||
310 | /** | |
311 | * Consider with contact activities only, | |
312 | * during activity search. | |
313 | * | |
314 | * @var array | |
315 | * @static | |
316 | */ | |
317 | static $_withContactActivitiesOnly; | |
318 | ||
319 | /** | |
320 | * use distinct component clause for component searches | |
321 | * | |
322 | * @var string | |
323 | */ | |
324 | public $_distinctComponentClause; | |
325 | ||
326 | /** | |
327 | * use groupBy component clause for component searches | |
328 | * | |
329 | * @var string | |
330 | */ | |
331 | public $_groupByComponentClause; | |
332 | ||
333 | /** | |
334 | * Track open panes, useful in advance search | |
335 | * | |
336 | * @var array | |
337 | * @static | |
338 | */ | |
339 | public static $_openedPanes = array(); | |
340 | ||
442df34b CW |
341 | /** |
342 | * For search builder - which custom fields are location-dependent | |
343 | * @var array | |
344 | */ | |
345 | public $_locationSpecificCustomFields = array(); | |
346 | ||
6a488035 TO |
347 | /** |
348 | * The tables which have a dependency on location and/or address | |
349 | * | |
350 | * @var array | |
351 | * @static | |
352 | */ | |
353 | static $_dependencies = array( | |
354 | 'civicrm_state_province' => 1, | |
355 | 'civicrm_country' => 1, | |
356 | 'civicrm_county' => 1, | |
357 | 'civicrm_address' => 1, | |
358 | 'civicrm_location_type' => 1, | |
359 | ); | |
360 | ||
361 | /** | |
362 | * List of location specific fields | |
363 | */ | |
364 | static $_locationSpecificFields = array( | |
365 | 'street_address', | |
366 | 'street_number', | |
367 | 'street_name', | |
368 | 'street_unit', | |
369 | 'supplemental_address_1', | |
370 | 'supplemental_address_2', | |
371 | 'city', | |
372 | 'postal_code', | |
373 | 'postal_code_suffix', | |
374 | 'geo_code_1', | |
375 | 'geo_code_2', | |
376 | 'state_province', | |
377 | 'country', | |
378 | 'county', | |
379 | 'phone', | |
380 | 'email', | |
381 | 'im', | |
382 | 'address_name', | |
383 | ); | |
384 | ||
385 | /** | |
386 | * Rememeber if we handle either end of a number or date range | |
387 | * so we can skip the other | |
388 | */ | |
389 | protected $_rangeCache = array(); | |
d9ab802d PJ |
390 | /** |
391 | * Set to true when $this->relationship is run to avoid adding twice | |
392 | * @var Boolean | |
393 | */ | |
ad682134 | 394 | protected $_relationshipValuesAdded = FALSE; |
d9ab802d | 395 | |
7c96365b | 396 | /** |
397 | * Set to the name of the temp table if one has been created | |
398 | * @var String | |
399 | */ | |
400 | static $_relationshipTempTable = NULL; | |
d9ab802d | 401 | |
7c96365b | 402 | public $_pseudoConstantsSelect = array(); |
9131c564 | 403 | |
6a488035 TO |
404 | /** |
405 | * class constructor which also does all the work | |
406 | * | |
407 | * @param array $params | |
408 | * @param array $returnProperties | |
409 | * @param array $fields | |
410 | * @param boolean $includeContactIds | |
411 | * @param boolean $strict | |
412 | * @param boolean $mode - mode the search is operating on | |
413 | * | |
414 | * @return Object | |
415 | * @access public | |
416 | */ | |
417 | function __construct( | |
418 | $params = NULL, $returnProperties = NULL, $fields = NULL, | |
419 | $includeContactIds = FALSE, $strict = FALSE, $mode = 1, | |
420 | $skipPermission = FALSE, $searchDescendentGroups = TRUE, | |
421 | $smartGroupCache = TRUE, $displayRelationshipType = NULL, | |
422 | $operator = 'AND' | |
423 | ) { | |
424 | $this->_params = &$params; | |
425 | if ($this->_params == NULL) { | |
426 | $this->_params = array(); | |
427 | } | |
428 | ||
429 | if (empty($returnProperties)) { | |
430 | $this->_returnProperties = self::defaultReturnProperties($mode); | |
431 | } | |
432 | else { | |
433 | $this->_returnProperties = &$returnProperties; | |
434 | } | |
435 | ||
436 | $this->_includeContactIds = $includeContactIds; | |
437 | $this->_strict = $strict; | |
438 | $this->_mode = $mode; | |
439 | $this->_skipPermission = $skipPermission; | |
440 | $this->_smartGroupCache = $smartGroupCache; | |
441 | $this->_displayRelationshipType = $displayRelationshipType; | |
442 | $this->setOperator($operator); | |
443 | ||
444 | if ($fields) { | |
445 | $this->_fields = &$fields; | |
446 | $this->_search = FALSE; | |
447 | $this->_skipPermission = TRUE; | |
448 | } | |
449 | else { | |
450 | $this->_fields = CRM_Contact_BAO_Contact::exportableFields('All', FALSE, TRUE, TRUE); | |
451 | ||
452 | $fields = CRM_Core_Component::getQueryFields(); | |
453 | unset($fields['note']); | |
454 | $this->_fields = array_merge($this->_fields, $fields); | |
455 | ||
456 | // add activity fields | |
457 | $fields = CRM_Activity_BAO_Activity::exportableFields(); | |
458 | $this->_fields = array_merge($this->_fields, $fields); | |
f2a9b25c | 459 | |
99e9587a DS |
460 | // add any fields provided by hook implementers |
461 | $extFields = CRM_Contact_BAO_Query_Hook::singleton()->getFields(); | |
f2a9b25c | 462 | $this->_fields = array_merge($this->_fields, $extFields); |
6a488035 TO |
463 | } |
464 | ||
465 | // basically do all the work once, and then reuse it | |
466 | $this->initialize(); | |
467 | } | |
468 | ||
469 | /** | |
470 | * function which actually does all the work for the constructor | |
471 | * | |
472 | * @return void | |
473 | * @access private | |
474 | */ | |
475 | function initialize() { | |
476 | $this->_select = array(); | |
477 | $this->_element = array(); | |
478 | $this->_tables = array(); | |
479 | $this->_whereTables = array(); | |
480 | $this->_where = array(); | |
481 | $this->_qill = array(); | |
482 | $this->_options = array(); | |
483 | $this->_cfIDs = array(); | |
484 | $this->_paramLookup = array(); | |
485 | $this->_having = array(); | |
486 | ||
487 | $this->_customQuery = NULL; | |
488 | ||
489 | // reset cached static variables - CRM-5803 | |
490 | self::$_activityRole = NULL; | |
491 | self::$_considerCompActivities = NULL; | |
492 | self::$_withContactActivitiesOnly = NULL; | |
493 | ||
494 | $this->_select['contact_id'] = 'contact_a.id as contact_id'; | |
495 | $this->_element['contact_id'] = 1; | |
496 | $this->_tables['civicrm_contact'] = 1; | |
497 | ||
498 | if (!empty($this->_params)) { | |
499 | $this->buildParamsLookup(); | |
500 | } | |
501 | ||
502 | $this->_whereTables = $this->_tables; | |
503 | ||
504 | $this->selectClause(); | |
505 | $this->_whereClause = $this->whereClause(); | |
506 | ||
507 | $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode); | |
508 | $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode); | |
509 | ||
510 | $this->openedSearchPanes(TRUE); | |
511 | } | |
512 | ||
513 | function buildParamsLookup() { | |
514 | // first fix and handle contact deletion nicely | |
515 | // this code is primarily for search builder use case | |
516 | // where different clauses can specify if they want deleted | |
517 | // contacts or not | |
518 | // CRM-11971 | |
519 | $trashParamExists = FALSE; | |
520 | $paramByGroup = array(); | |
521 | foreach ( $this->_params as $k => $param ) { | |
e6f3f602 | 522 | if (!empty($param[0]) && $param[0] == 'contact_is_deleted' ) { |
6a488035 TO |
523 | $trashParamExists = TRUE; |
524 | } | |
e6f3f602 | 525 | if (!empty($param[3])) { |
526 | $paramByGroup[$param[3]][$k] = $param; | |
527 | } | |
6a488035 TO |
528 | } |
529 | ||
530 | if ( $trashParamExists ) { | |
531 | $this->_skipDeleteClause = TRUE; | |
532 | ||
533 | //cycle through group sets and explicitly add trash param if not set | |
534 | foreach ( $paramByGroup as $setID => $set ) { | |
535 | if ( | |
536 | !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params) && | |
537 | !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params) ) { | |
538 | $this->_params[] = array( | |
539 | 'contact_is_deleted', | |
540 | '=', | |
541 | '0', | |
542 | $setID, | |
543 | '0', | |
544 | ); | |
545 | } | |
546 | } | |
547 | } | |
548 | ||
549 | foreach ($this->_params as $value) { | |
550 | if (!CRM_Utils_Array::value(0, $value)) { | |
551 | continue; | |
552 | } | |
553 | $cfID = CRM_Core_BAO_CustomField::getKeyID($value[0]); | |
554 | if ($cfID) { | |
555 | if (!array_key_exists($cfID, $this->_cfIDs)) { | |
556 | $this->_cfIDs[$cfID] = array(); | |
557 | } | |
558 | $this->_cfIDs[$cfID][] = $value; | |
559 | } | |
560 | ||
561 | if (!array_key_exists($value[0], $this->_paramLookup)) { | |
562 | $this->_paramLookup[$value[0]] = array(); | |
563 | } | |
564 | $this->_paramLookup[$value[0]][] = $value; | |
565 | } | |
566 | } | |
567 | ||
568 | /** | |
569 | * Some composite fields do not appear in the fields array | |
570 | * hack to make them part of the query | |
571 | * | |
572 | * @return void | |
573 | * @access public | |
574 | */ | |
575 | function addSpecialFields() { | |
576 | static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name'); | |
577 | foreach ($special as $name) { | |
578 | if (CRM_Utils_Array::value($name, $this->_returnProperties)) { | |
579 | $this->_select[$name] = "contact_a.{$name} as $name"; | |
580 | $this->_element[$name] = 1; | |
581 | } | |
582 | } | |
583 | } | |
584 | ||
585 | /** | |
586 | * Given a list of conditions in params and a list of desired | |
587 | * return Properties generate the required select and from | |
588 | * clauses. Note that since the where clause introduces new | |
589 | * tables, the initial attempt also retrieves all variables used | |
590 | * in the params list | |
591 | * | |
592 | * @return void | |
593 | * @access public | |
594 | */ | |
595 | function selectClause() { | |
6a488035 TO |
596 | |
597 | $this->addSpecialFields(); | |
598 | ||
599 | foreach ($this->_fields as $name => $field) { | |
6a488035 TO |
600 | // skip component fields |
601 | // there are done by the alter query below | |
602 | // and need not be done on every field | |
1071730c DL |
603 | if ( |
604 | (substr($name, 0, 12) == 'participant_') || | |
6a488035 TO |
605 | (substr($name, 0, 7) == 'pledge_') || |
606 | (substr($name, 0, 5) == 'case_') | |
607 | ) { | |
608 | continue; | |
609 | } | |
610 | ||
611 | // redirect to activity select clause | |
612 | if (substr($name, 0, 9) == 'activity_') { | |
613 | CRM_Activity_BAO_Query::select($this); | |
614 | continue; | |
615 | } | |
616 | ||
617 | // if this is a hierarchical name, we ignore it | |
618 | $names = explode('-', $name); | |
619 | if (count($names > 1) && isset($names[1]) && is_numeric($names[1])) { | |
620 | continue; | |
621 | } | |
622 | ||
c6ff5b0d | 623 | // make an exception for special cases, to add the field in select clause |
fd18baa6 | 624 | $makeException = FALSE; |
c6ff5b0d KJ |
625 | |
626 | //special handling for groups/tags | |
627 | if (in_array($name, array('groups', 'tags', 'notes')) | |
fd18baa6 KJ |
628 | && isset($this->_returnProperties[substr($name, 0, -1)]) |
629 | ) { | |
630 | $makeException = TRUE; | |
631 | } | |
632 | ||
c6ff5b0d KJ |
633 | // since note has 3 different options we need special handling |
634 | // note / note_subject / note_body | |
635 | if ($name == 'notes') { | |
636 | foreach (array('note', 'note_subject', 'note_body') as $noteField) { | |
637 | if (isset($this->_returnProperties[$noteField])) { | |
638 | $makeException = TRUE; | |
639 | break; | |
640 | } | |
641 | } | |
642 | } | |
a87ba7c0 | 643 | |
9161277f | 644 | if (in_array($name, array('prefix_id', 'suffix_id', 'gender_id'))) { |
a87ba7c0 | 645 | if (CRM_Utils_Array::value($field['pseudoconstant']['optionGroupName'], $this->_returnProperties)) { |
9161277f CW |
646 | $makeException = TRUE; |
647 | } | |
648 | } | |
649 | ||
6a488035 | 650 | $cfID = CRM_Core_BAO_CustomField::getKeyID($name); |
1071730c DL |
651 | if ( |
652 | CRM_Utils_Array::value($name, $this->_paramLookup) || | |
fd18baa6 KJ |
653 | CRM_Utils_Array::value($name, $this->_returnProperties) || |
654 | $makeException | |
6a488035 | 655 | ) { |
6a488035 TO |
656 | if ($cfID) { |
657 | // add to cfIDs array if not present | |
658 | if (!array_key_exists($cfID, $this->_cfIDs)) { | |
659 | $this->_cfIDs[$cfID] = array(); | |
660 | } | |
661 | } | |
662 | elseif (isset($field['where'])) { | |
663 | list($tableName, $fieldName) = explode('.', $field['where'], 2); | |
664 | if (isset($tableName)) { | |
6a488035 TO |
665 | if (CRM_Utils_Array::value($tableName, self::$_dependencies)) { |
666 | $this->_tables['civicrm_address'] = 1; | |
667 | $this->_select['address_id'] = 'civicrm_address.id as address_id'; | |
668 | $this->_element['address_id'] = 1; | |
669 | } | |
670 | ||
d9ab802d PJ |
671 | if ($tableName == 'im_provider' || $tableName == 'email_greeting' || |
672 | $tableName == 'postal_greeting' || $tableName == 'addressee' | |
6a488035 | 673 | ) { |
d9ab802d PJ |
674 | if ($tableName == 'im_provider') { |
675 | CRM_Core_OptionValue::select($this); | |
676 | } | |
677 | ||
678 | if (in_array($tableName, | |
679 | array('email_greeting', 'postal_greeting', 'addressee'))) { | |
680 | $this->_element["{$name}_id"] = 1; | |
681 | $this->_select["{$name}_id"] = "contact_a.{$name}_id as {$name}_id"; | |
682 | $this->_pseudoConstantsSelect[$name] = array('pseudoField' => $tableName, 'idCol' => "{$name}_id"); | |
683 | $this->_pseudoConstantsSelect[$name]['select'] = "{$name}.{$fieldName} as $name"; | |
684 | $this->_pseudoConstantsSelect[$name]['element'] = $name; | |
685 | ||
686 | if ($tableName == 'email_greeting') { | |
687 | $this->_pseudoConstantsSelect[$name]['join'] = | |
688 | " LEFT JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')"; | |
689 | $this->_pseudoConstantsSelect[$name]['join'] .= | |
690 | " LEFT JOIN civicrm_option_value email_greeting ON (contact_a.email_greeting_id = email_greeting.value AND option_group_email_greeting.id = email_greeting.option_group_id ) "; | |
691 | } | |
692 | elseif ($tableName == 'postal_greeting') { | |
693 | $this->_pseudoConstantsSelect[$name]['join'] = | |
694 | " LEFT JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')"; | |
695 | $this->_pseudoConstantsSelect[$name]['join'] .= | |
696 | " LEFT JOIN civicrm_option_value postal_greeting ON (contact_a.postal_greeting_id = postal_greeting.value AND option_group_postal_greeting.id = postal_greeting.option_group_id ) "; | |
697 | } | |
698 | elseif ($tableName == 'addressee') { | |
699 | $this->_pseudoConstantsSelect[$name]['join'] = | |
700 | " LEFT JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')"; | |
701 | $this->_pseudoConstantsSelect[$name]['join'] .= | |
702 | " LEFT JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) "; | |
703 | } | |
704 | $this->_pseudoConstantsSelect[$name]['table'] = $tableName; | |
705 | ||
6a488035 TO |
706 | //get display |
707 | $greetField = "{$name}_display"; | |
708 | $this->_select[$greetField] = "contact_a.{$greetField} as {$greetField}"; | |
709 | $this->_element[$greetField] = 1; | |
710 | //get custom | |
711 | $greetField = "{$name}_custom"; | |
712 | $this->_select[$greetField] = "contact_a.{$greetField} as {$greetField}"; | |
713 | $this->_element[$greetField] = 1; | |
714 | } | |
715 | } | |
716 | else { | |
d9ab802d PJ |
717 | if (!in_array($tableName, array('civicrm_state_province', 'civicrm_country', 'civicrm_county'))) { |
718 | $this->_tables[$tableName] = 1; | |
719 | } | |
6a488035 TO |
720 | |
721 | // also get the id of the tableName | |
722 | $tName = substr($tableName, 8); | |
d9ab802d | 723 | if (in_array($tName, array('country', 'state_province', 'county'))) { |
d9ab802d | 724 | if ($tName == 'state_province') { |
7f84f734 EM |
725 | $this->_pseudoConstantsSelect['state_province_name'] = |
726 | array('pseudoField' => "{$tName}", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address', | |
727 | 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id "); | |
728 | ||
d9ab802d | 729 | $this->_pseudoConstantsSelect[$tName] = |
04ffef8d CW |
730 | array('pseudoField' => 'state_province_abbreviation', 'idCol' => "{$tName}_id", |
731 | 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id "); | |
d9ab802d | 732 | } |
7f84f734 EM |
733 | else { |
734 | $this->_pseudoConstantsSelect[$name] = | |
735 | array('pseudoField' => "{$tName}_id", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address', | |
736 | 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id "); | |
737 | } | |
6a488035 | 738 | |
d9ab802d PJ |
739 | $this->_select["{$tName}_id"] = "civicrm_address.{$tName}_id as {$tName}_id"; |
740 | $this->_element["{$tName}_id"] = 1; | |
741 | } | |
742 | elseif ($tName != 'contact') { | |
6a488035 TO |
743 | $this->_select["{$tName}_id"] = "{$tableName}.id as {$tName}_id"; |
744 | $this->_element["{$tName}_id"] = 1; | |
745 | } | |
746 | ||
747 | //special case for phone | |
748 | if ($name == 'phone') { | |
749 | $this->_select['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id"; | |
750 | $this->_element['phone_type_id'] = 1; | |
751 | } | |
752 | ||
753 | // if IM then select provider_id also | |
754 | // to get "IM Service Provider" in a file to be exported, CRM-3140 | |
755 | if ($name == 'im') { | |
756 | $this->_select['provider_id'] = "civicrm_im.provider_id as provider_id"; | |
757 | $this->_element['provider_id'] = 1; | |
758 | } | |
759 | ||
d9ab802d | 760 | if ($tName == 'contact') { |
6a488035 TO |
761 | // special case, when current employer is set for Individual contact |
762 | if ($fieldName == 'organization_name') { | |
763 | $this->_select[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name"; | |
764 | } | |
765 | elseif ($fieldName != 'id') { | |
04ffef8d | 766 | if ($fieldName == 'prefix_id') { |
a87ba7c0 | 767 | $this->_pseudoConstantsSelect['individual_prefix'] = array('pseudoField' => 'prefix_id', 'idCol' => "prefix_id", 'bao' => 'CRM_Contact_BAO_Contact'); |
d9ab802d | 768 | } |
04ffef8d | 769 | if ($fieldName == 'suffix_id') { |
a87ba7c0 | 770 | $this->_pseudoConstantsSelect['individual_suffix'] = array('pseudoField' => 'suffix_id', 'idCol' => "suffix_id", 'bao' => 'CRM_Contact_BAO_Contact'); |
d9ab802d | 771 | } |
04ffef8d | 772 | if ($fieldName == 'gender_id') { |
a87ba7c0 | 773 | $this->_pseudoConstantsSelect['gender'] = array('pseudoField' => 'gender_id', 'idCol' => "gender_id", 'bao' => 'CRM_Contact_BAO_Contact'); |
d9ab802d | 774 | } |
6a488035 TO |
775 | $this->_select[$name] = "contact_a.{$fieldName} as `$name`"; |
776 | } | |
777 | } | |
4e6490d4 E |
778 | elseif (in_array($tName, array('country', 'county'))) { |
779 | $this->_pseudoConstantsSelect[$name]['select'] = "{$field['where']} as `$name`"; | |
780 | $this->_pseudoConstantsSelect[$name]['element'] = $name; | |
781 | } | |
782 | elseif ($tName == 'state_province') { | |
783 | $this->_pseudoConstantsSelect[$tName]['select'] = "{$field['where']} as `$name`"; | |
784 | $this->_pseudoConstantsSelect[$tName]['element'] = $name; | |
d9ab802d | 785 | } |
6a488035 TO |
786 | else { |
787 | $this->_select[$name] = "{$field['where']} as `$name`"; | |
788 | } | |
d9ab802d PJ |
789 | if (!in_array($tName, array('state_province', 'country', 'county'))) { |
790 | $this->_element[$name] = 1; | |
791 | } | |
6a488035 TO |
792 | } |
793 | } | |
794 | } | |
795 | elseif ($name === 'tags') { | |
796 | $this->_useGroupBy = TRUE; | |
797 | $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags"; | |
798 | $this->_element[$name] = 1; | |
799 | $this->_tables['civicrm_tag'] = 1; | |
800 | $this->_tables['civicrm_entity_tag'] = 1; | |
801 | } | |
802 | elseif ($name === 'groups') { | |
803 | $this->_useGroupBy = TRUE; | |
804 | $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_group.title)) as groups"; | |
805 | $this->_element[$name] = 1; | |
806 | $this->_tables['civicrm_group'] = 1; | |
807 | } | |
808 | elseif ($name === 'notes') { | |
e3199114 | 809 | // if note field is subject then return subject else body of the note |
810 | $noteColumn = 'note'; | |
811 | if (isset($noteField) && $noteField == 'note_subject') { | |
812 | $noteColumn = 'subject'; | |
813 | } | |
814 | ||
6a488035 | 815 | $this->_useGroupBy = TRUE; |
e3199114 | 816 | $this->_select[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.$noteColumn)) as notes"; |
6a488035 TO |
817 | $this->_element[$name] = 1; |
818 | $this->_tables['civicrm_note'] = 1; | |
819 | } | |
820 | elseif ($name === 'current_employer') { | |
821 | $this->_select[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer"; | |
822 | $this->_element[$name] = 1; | |
823 | } | |
824 | } | |
825 | ||
826 | if ($cfID && | |
827 | CRM_Utils_Array::value('is_search_range', $field) | |
828 | ) { | |
829 | // this is a custom field with range search enabled, so we better check for two/from values | |
830 | if (CRM_Utils_Array::value($name . '_from', $this->_paramLookup)) { | |
831 | if (!array_key_exists($cfID, $this->_cfIDs)) { | |
832 | $this->_cfIDs[$cfID] = array(); | |
833 | } | |
834 | foreach ($this->_paramLookup[$name . '_from'] as $pID => $p) { | |
835 | // search in the cdID array for the same grouping | |
836 | $fnd = FALSE; | |
837 | foreach ($this->_cfIDs[$cfID] as $cID => $c) { | |
838 | if ($c[3] == $p[3]) { | |
839 | $this->_cfIDs[$cfID][$cID][2]['from'] = $p[2]; | |
840 | $fnd = TRUE; | |
841 | } | |
842 | } | |
843 | if (!$fnd) { | |
844 | $p[2] = array('from' => $p[2]); | |
845 | $this->_cfIDs[$cfID][] = $p; | |
846 | } | |
847 | } | |
848 | } | |
849 | if (CRM_Utils_Array::value($name . '_to', $this->_paramLookup)) { | |
850 | if (!array_key_exists($cfID, $this->_cfIDs)) { | |
851 | $this->_cfIDs[$cfID] = array(); | |
852 | } | |
853 | foreach ($this->_paramLookup[$name . '_to'] as $pID => $p) { | |
854 | // search in the cdID array for the same grouping | |
855 | $fnd = FALSE; | |
856 | foreach ($this->_cfIDs[$cfID] as $cID => $c) { | |
857 | if ($c[4] == $p[4]) { | |
858 | $this->_cfIDs[$cfID][$cID][2]['to'] = $p[2]; | |
859 | $fnd = TRUE; | |
860 | } | |
861 | } | |
862 | if (!$fnd) { | |
863 | $p[2] = array('to' => $p[2]); | |
864 | $this->_cfIDs[$cfID][] = $p; | |
865 | } | |
866 | } | |
867 | } | |
868 | } | |
869 | } | |
870 | ||
871 | // add location as hierarchical elements | |
872 | $this->addHierarchicalElements(); | |
873 | ||
874 | // add multiple field like website | |
875 | $this->addMultipleElements(); | |
876 | ||
877 | //fix for CRM-951 | |
878 | CRM_Core_Component::alterQuery($this, 'select'); | |
879 | ||
99e9587a | 880 | CRM_Contact_BAO_Query_Hook::singleton()->alterSearchQuery($this, 'select'); |
f2a9b25c | 881 | |
6a488035 | 882 | if (!empty($this->_cfIDs)) { |
442df34b | 883 | $this->_customQuery = new CRM_Core_BAO_CustomQuery($this->_cfIDs, TRUE, $this->_locationSpecificCustomFields); |
6a488035 TO |
884 | $this->_customQuery->query(); |
885 | $this->_select = array_merge($this->_select, $this->_customQuery->_select); | |
886 | $this->_element = array_merge($this->_element, $this->_customQuery->_element); | |
887 | $this->_tables = array_merge($this->_tables, $this->_customQuery->_tables); | |
888 | $this->_whereTables = array_merge($this->_whereTables, $this->_customQuery->_whereTables); | |
889 | $this->_options = $this->_customQuery->_options; | |
890 | } | |
891 | } | |
892 | ||
893 | /** | |
894 | * If the return Properties are set in a hierarchy, traverse the hierarchy to get | |
895 | * the return values | |
896 | * | |
897 | * @return void | |
898 | * @access public | |
899 | */ | |
900 | function addHierarchicalElements() { | |
901 | if (!CRM_Utils_Array::value('location', $this->_returnProperties)) { | |
902 | return; | |
903 | } | |
904 | if (!is_array($this->_returnProperties['location'])) { | |
905 | return; | |
906 | } | |
907 | ||
b2b0530a | 908 | $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
6a488035 TO |
909 | $processed = array(); |
910 | $index = 0; | |
911 | ||
912 | $addressCustomFields = CRM_Core_BAO_CustomField::getFieldsForImport('Address'); | |
913 | $addressCustomFieldIds = array(); | |
914 | ||
915 | foreach ($this->_returnProperties['location'] as $name => $elements) { | |
916 | $lCond = self::getPrimaryCondition($name); | |
917 | ||
918 | if (!$lCond) { | |
919 | $locationTypeId = array_search($name, $locationTypes); | |
920 | if ($locationTypeId === FALSE) { | |
921 | continue; | |
922 | } | |
923 | $lCond = "location_type_id = $locationTypeId"; | |
924 | $this->_useDistinct = TRUE; | |
925 | ||
926 | //commented for CRM-3256 | |
927 | $this->_useGroupBy = TRUE; | |
928 | } | |
929 | ||
930 | $name = str_replace(' ', '_', $name); | |
931 | ||
932 | $tName = "$name-location_type"; | |
933 | $ltName = "`$name-location_type`"; | |
934 | $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`"; | |
935 | $this->_select["{$tName}"] = "`$tName`.name as `{$tName}`"; | |
936 | $this->_element["{$tName}_id"] = 1; | |
937 | $this->_element["{$tName}"] = 1; | |
938 | ||
939 | $locationTypeName = $tName; | |
940 | $locationTypeJoin = array(); | |
941 | ||
942 | $addAddress = FALSE; | |
943 | $addWhereCount = 0; | |
944 | foreach ($elements as $elementFullName => $dontCare) { | |
945 | $index++; | |
946 | $elementName = $elementCmpName = $elementFullName; | |
947 | ||
948 | if (substr($elementCmpName, 0, 5) == 'phone') { | |
949 | $elementCmpName = 'phone'; | |
950 | } | |
951 | ||
952 | if (in_array($elementCmpName, array_keys($addressCustomFields))) { | |
953 | if ($cfID = CRM_Core_BAO_CustomField::getKeyID($elementCmpName)) { | |
954 | $addressCustomFieldIds[$cfID][$name] = 1; | |
955 | } | |
956 | } | |
957 | //add address table only once | |
958 | if ((in_array($elementCmpName, self::$_locationSpecificFields) || !empty($addressCustomFieldIds)) | |
959 | && !$addAddress | |
960 | && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid')) | |
961 | ) { | |
962 | $tName = "$name-address"; | |
963 | $aName = "`$name-address`"; | |
964 | $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`"; | |
965 | $this->_element["{$tName}_id"] = 1; | |
966 | $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)"; | |
967 | $this->_tables[$tName] = $addressJoin; | |
968 | $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) "; | |
969 | $processed[$aName] = 1; | |
970 | $addAddress = TRUE; | |
971 | } | |
972 | ||
973 | $cond = $elementType = ''; | |
974 | if (strpos($elementName, '-') !== FALSE) { | |
975 | // this is either phone, email or IM | |
976 | list($elementName, $elementType) = explode('-', $elementName); | |
977 | ||
978 | ||
979 | if (($elementName != 'phone') && ($elementName != 'im')) { | |
980 | $cond = self::getPrimaryCondition($elementType); | |
981 | } | |
6e7e6dc0 PJ |
982 | // CRM-13011 : If location type is primary, do not restrict search to the phone |
983 | // type id - we want the primary phone, regardless of what type it is. | |
984 | // Otherwise, restrict to the specified phone type for the given field. | |
985 | if ((!$cond) && ($elementName == 'phone') && $elements['location_type'] != 'Primary') { | |
6a488035 TO |
986 | $cond = "phone_type_id = '$elementType'"; |
987 | } | |
988 | elseif ((!$cond) && ($elementName == 'im')) { | |
989 | // IM service provider id, CRM-3140 | |
990 | $cond = "provider_id = '$elementType'"; | |
991 | } | |
992 | $elementType = '-' . $elementType; | |
993 | } | |
994 | ||
995 | $field = CRM_Utils_Array::value($elementName, $this->_fields); | |
996 | ||
997 | // hack for profile, add location id | |
998 | if (!$field) { | |
999 | if ($elementType && | |
1000 | // fix for CRM-882( to handle phone types ) | |
1001 | !is_numeric($elementType) | |
1002 | ) { | |
1003 | if (is_numeric($name)) { | |
1004 | $field = CRM_Utils_Array::value($elementName . "-Primary$elementType", $this->_fields); | |
1005 | } | |
1006 | else { | |
1007 | $field = CRM_Utils_Array::value($elementName . "-$locationTypeId$elementType", $this->_fields); | |
1008 | } | |
1009 | } | |
1010 | elseif (is_numeric($name)) { | |
1011 | //this for phone type to work | |
1012 | if (in_array($elementName, array('phone', 'phone_ext'))) { | |
1013 | $field = CRM_Utils_Array::value($elementName . "-Primary" . $elementType, $this->_fields); | |
1014 | } | |
1015 | else { | |
1016 | $field = CRM_Utils_Array::value($elementName . "-Primary", $this->_fields); | |
1017 | } | |
1018 | } | |
1019 | else { | |
1020 | //this is for phone type to work for profile edit | |
1021 | if (in_array($elementName, array('phone', 'phone_ext'))) { | |
1022 | $field = CRM_Utils_Array::value($elementName . "-$locationTypeId$elementType", $this->_fields); | |
1023 | } | |
1024 | else { | |
1025 | $field = CRM_Utils_Array::value($elementName . "-$locationTypeId", $this->_fields); | |
1026 | } | |
1027 | } | |
1028 | } | |
1029 | ||
314dbef8 | 1030 | // Check if there is a value, if so also add to where Clause |
6a488035 TO |
1031 | $addWhere = FALSE; |
1032 | if ($this->_params) { | |
1033 | $nm = $elementName; | |
1034 | if (isset($locationTypeId)) { | |
1035 | $nm .= "-$locationTypeId"; | |
1036 | } | |
1037 | if (!is_numeric($elementType)) { | |
1038 | $nm .= "$elementType"; | |
1039 | } | |
1040 | ||
1041 | foreach ($this->_params as $id => $values) { | |
1042 | if ($values[0] == $nm || | |
1043 | (in_array($elementName, array('phone', 'im')) | |
1044 | && (strpos($values[0], $nm) !== FALSE) | |
1045 | ) | |
1046 | ) { | |
1047 | $addWhere = TRUE; | |
1048 | $addWhereCount++; | |
1049 | break; | |
1050 | } | |
1051 | } | |
1052 | } | |
1053 | ||
1054 | if ($field && isset($field['where'])) { | |
1055 | list($tableName, $fieldName) = explode('.', $field['where'], 2); | |
d9ab802d PJ |
1056 | $pf = substr($tableName, 8); |
1057 | $tName = $name . '-' . $pf . $elementType; | |
6a488035 | 1058 | if (isset($tableName)) { |
d9ab802d PJ |
1059 | if ($tableName == 'civicrm_state_province' || $tableName == 'civicrm_country' || $tableName == 'civicrm_county') { |
1060 | $this->_select["{$tName}_id"] = "{$aName}.{$pf}_id as `{$tName}_id`"; | |
1061 | } | |
1062 | else { | |
1063 | $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`"; | |
1064 | } | |
1065 | ||
6a488035 TO |
1066 | $this->_element["{$tName}_id"] = 1; |
1067 | if (substr($tName, -15) == '-state_province') { | |
1068 | // FIXME: hack to fix CRM-1900 | |
1069 | $a = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, | |
1070 | 'address_format' | |
1071 | ); | |
1072 | ||
1073 | if (substr_count($a, 'state_province_name') > 0) { | |
d9ab802d | 1074 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"] = |
09aefef4 | 1075 | array('pseudoField' => '{$pf}_id', 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address'); |
d9ab802d | 1076 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['select'] = "`$tName`.name as `{$name}-{$elementFullName}`"; |
6a488035 TO |
1077 | } |
1078 | else { | |
d9ab802d PJ |
1079 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"] = |
1080 | array('pseudoField' => 'state_province_abbreviation', 'idCol' => "{$tName}_id"); | |
1081 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['select'] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`"; | |
6a488035 TO |
1082 | } |
1083 | } | |
1084 | else { | |
1085 | if (substr($elementFullName, 0, 2) == 'im') { | |
1086 | $provider = "{$name}-{$elementFullName}-provider_id"; | |
1087 | $this->_select[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`"; | |
1088 | $this->_element[$provider] = 1; | |
1089 | } | |
d9ab802d | 1090 | if ($pf == 'country' || $pf == 'county') { |
09aefef4 | 1091 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"] = array('pseudoField' => "{$pf}_id", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address'); |
d9ab802d PJ |
1092 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['select'] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`"; |
1093 | } | |
1094 | else { | |
1095 | $this->_select["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`"; | |
1096 | } | |
1097 | } | |
6a488035 | 1098 | |
d9ab802d PJ |
1099 | if (in_array($pf, array('state_province', 'country', 'county'))) { |
1100 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['element'] = "{$name}-{$elementFullName}"; | |
1101 | } | |
1102 | else { | |
1103 | $this->_element["{$name}-{$elementFullName}"] = 1; | |
6a488035 TO |
1104 | } |
1105 | ||
6a488035 TO |
1106 | if (!CRM_Utils_Array::value("`$tName`", $processed)) { |
1107 | $processed["`$tName`"] = 1; | |
1108 | $newName = $tableName . '_' . $index; | |
1109 | switch ($tableName) { | |
1110 | case 'civicrm_phone': | |
1111 | case 'civicrm_email': | |
1112 | case 'civicrm_im': | |
1113 | case 'civicrm_openid': | |
1114 | ||
1115 | $this->_tables[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id AND `$tName`.$lCond"; | |
1116 | // this special case to add phone type | |
1117 | if ($cond) { | |
1118 | $phoneTypeCondition = " AND `$tName`.$cond "; | |
1119 | //gross hack to pickup corrupted data also, CRM-7603 | |
1120 | if (strpos($cond, 'phone_type_id') !== FALSE) { | |
1121 | $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) "; | |
1122 | } | |
1123 | $this->_tables[$tName] .= $phoneTypeCondition; | |
1124 | } | |
1125 | ||
1126 | //build locationType join | |
1127 | $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )"; | |
1128 | ||
1129 | if ($addWhere) { | |
1130 | $this->_whereTables[$tName] = $this->_tables[$tName]; | |
1131 | } | |
1132 | break; | |
1133 | ||
1134 | case 'civicrm_state_province': | |
d9ab802d PJ |
1135 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['table'] = $tName; |
1136 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['join'] = | |
1137 | "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id"; | |
6a488035 TO |
1138 | if ($addWhere) { |
1139 | $this->_whereTables["{$name}-address"] = $addressJoin; | |
6a488035 TO |
1140 | } |
1141 | break; | |
1142 | ||
1143 | case 'civicrm_country': | |
d9ab802d PJ |
1144 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['table'] = $newName; |
1145 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['join'] = | |
1146 | "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id"; | |
6a488035 TO |
1147 | if ($addWhere) { |
1148 | $this->_whereTables["{$name}-address"] = $addressJoin; | |
6a488035 TO |
1149 | } |
1150 | break; | |
1151 | ||
1152 | case 'civicrm_county': | |
d9ab802d PJ |
1153 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['table'] = $newName; |
1154 | $this->_pseudoConstantsSelect["{$name}-{$elementFullName}"]['join'] = | |
1155 | "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id"; | |
6a488035 TO |
1156 | if ($addWhere) { |
1157 | $this->_whereTables["{$name}-address"] = $addressJoin; | |
6a488035 TO |
1158 | } |
1159 | break; | |
1160 | ||
1161 | default: | |
1162 | if ($addWhere) { | |
1163 | $this->_whereTables["{$name}-address"] = $addressJoin; | |
1164 | } | |
1165 | break; | |
1166 | } | |
1167 | } | |
1168 | } | |
1169 | } | |
1170 | } | |
1171 | ||
1172 | // add location type join | |
1173 | $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )"; | |
1174 | $this->_tables[$locationTypeName] = $ltypeJoin; | |
1175 | ||
1176 | // table should be present in $this->_whereTables, | |
1177 | // to add its condition in location type join, CRM-3939. | |
1178 | if ($addWhereCount) { | |
1179 | $locClause = array(); | |
1180 | foreach ($this->_whereTables as $tableName => $clause) { | |
1181 | if (CRM_Utils_Array::value($tableName, $locationTypeJoin)) { | |
1182 | $locClause[] = $locationTypeJoin[$tableName]; | |
1183 | } | |
1184 | } | |
1185 | ||
1186 | if (!empty($locClause)) { | |
1187 | $this->_whereTables[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )"; | |
1188 | } | |
1189 | } | |
1190 | } | |
1191 | ||
1192 | if (!empty($addressCustomFieldIds)) { | |
442df34b | 1193 | $customQuery = new CRM_Core_BAO_CustomQuery($addressCustomFieldIds); |
6a488035 TO |
1194 | foreach ($addressCustomFieldIds as $cfID => $locTypeName) { |
1195 | foreach ($locTypeName as $name => $dnc) { | |
442df34b | 1196 | $this->_locationSpecificCustomFields[$cfID] = array($name, array_search($name, $locationTypes)); |
6a488035 TO |
1197 | $fieldName = "$name-custom_{$cfID}"; |
1198 | $tName = "$name-address-custom-{$cfID}"; | |
1199 | $aName = "`$name-address-custom-{$cfID}`"; | |
1200 | $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`"; | |
1201 | $this->_element["{$tName}_id"] = 1; | |
1202 | $this->_select[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`"; | |
1203 | $this->_element[$fieldName] = 1; | |
1204 | $this->_tables[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)"; | |
1205 | } | |
1206 | } | |
1207 | } | |
1208 | } | |
1209 | ||
1210 | /** | |
1211 | * If the return Properties are set in a hierarchy, traverse the hierarchy to get | |
1212 | * the return values | |
1213 | * | |
1214 | * @return void | |
1215 | * @access public | |
1216 | */ | |
1217 | function addMultipleElements() { | |
1218 | if (!CRM_Utils_Array::value('website', $this->_returnProperties)) { | |
1219 | return; | |
1220 | } | |
1221 | if (!is_array($this->_returnProperties['website'])) { | |
1222 | return; | |
1223 | } | |
1224 | ||
1225 | foreach ($this->_returnProperties['website'] as $key => $elements) { | |
1226 | foreach ($elements as $elementFullName => $dontCare) { | |
1227 | $tName = "website-{$key}-{$elementFullName}"; | |
1228 | $this->_select["{$tName}_id"] = "`$tName`.id as `{$tName}_id`"; | |
1229 | $this->_select["{$tName}"] = "`$tName`.url as `{$tName}`"; | |
1230 | $this->_element["{$tName}_id"] = 1; | |
1231 | $this->_element["{$tName}"] = 1; | |
1232 | ||
1233 | $type = "website-{$key}-website_type_id"; | |
1234 | $this->_select[$type] = "`$tName`.website_type_id as `{$type}`"; | |
1235 | $this->_element[$type] = 1; | |
1236 | $this->_tables[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id )"; | |
1237 | } | |
1238 | } | |
1239 | } | |
1240 | ||
1241 | /** | |
1242 | * generate the query based on what type of query we need | |
1243 | * | |
1244 | * @param boolean $count | |
1245 | * @param boolean $sortByChar | |
1246 | * @param boolean $groupContacts | |
1247 | * | |
1248 | * @return the sql string for that query (this will most likely | |
1249 | * change soon) | |
1250 | * @access public | |
1251 | */ | |
1252 | function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE) { | |
1253 | if ($count) { | |
1254 | if (isset($this->_distinctComponentClause)) { | |
1255 | // we add distinct to get the right count for components | |
1256 | // for the more complex result set, we use GROUP BY the same id | |
1257 | // CRM-9630 | |
1258 | $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} )"; | |
1259 | } | |
1260 | else { | |
1261 | $select = 'SELECT count(DISTINCT contact_a.id) as rowCount'; | |
1262 | } | |
1263 | $from = $this->_simpleFromClause; | |
1264 | if ($this->_useDistinct) { | |
1265 | $this->_useGroupBy = TRUE; | |
1266 | } | |
1267 | } | |
1268 | elseif ($sortByChar) { | |
1269 | $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name'; | |
1270 | $from = $this->_simpleFromClause; | |
1271 | } | |
1272 | elseif ($groupContacts) { | |
1273 | $select = 'SELECT contact_a.id as id'; | |
1274 | if ($this->_useDistinct) { | |
1275 | $this->_useGroupBy = TRUE; | |
1276 | } | |
1277 | $from = $this->_simpleFromClause; | |
1278 | } | |
1279 | else { | |
1280 | if (CRM_Utils_Array::value('group', $this->_paramLookup)) { | |
1281 | // make sure there is only one element | |
1282 | // this is used when we are running under smog and need to know | |
1283 | // how the contact was added (CRM-1203) | |
1284 | if ((count($this->_paramLookup['group']) == 1) && | |
1285 | (count($this->_paramLookup['group'][0][2]) == 1) | |
1286 | ) { | |
1287 | $groups = array_keys($this->_paramLookup['group'][0][2]); | |
1288 | $groupId = $groups[0]; | |
1289 | ||
1290 | //check if group is saved search | |
1291 | $group = new CRM_Contact_BAO_Group(); | |
1292 | $group->id = $groupId; | |
1293 | $group->find(TRUE); | |
1294 | ||
1295 | if (!isset($group->saved_search_id)) { | |
1296 | $tbName = "`civicrm_group_contact-{$groupId}`"; | |
1297 | $this->_select['group_contact_id'] = "$tbName.id as group_contact_id"; | |
1298 | $this->_element['group_contact_id'] = 1; | |
1299 | $this->_select['status'] = "$tbName.status as status"; | |
1300 | $this->_element['status'] = 1; | |
6a488035 TO |
1301 | } |
1302 | } | |
1303 | $this->_useGroupBy = TRUE; | |
1304 | } | |
1305 | if ($this->_useDistinct && !isset($this->_distinctComponentClause)) { | |
1306 | if (!($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY)) { | |
1307 | // CRM-5954 | |
1308 | $this->_select['contact_id'] = 'contact_a.id as contact_id'; | |
1309 | $this->_useDistinct = FALSE; | |
1310 | $this->_useGroupBy = TRUE; | |
1311 | } | |
1312 | } | |
1313 | ||
1314 | $select = "SELECT "; | |
1315 | if (isset($this->_distinctComponentClause)) { | |
1316 | $select .= "{$this->_distinctComponentClause}, "; | |
1317 | } | |
1318 | $select .= implode(', ', $this->_select); | |
1319 | $from = $this->_fromClause; | |
1320 | } | |
1321 | ||
1322 | $where = ''; | |
1323 | if (!empty($this->_whereClause)) { | |
1324 | $where = "WHERE {$this->_whereClause}"; | |
1325 | } | |
1326 | ||
1327 | $having = ''; | |
1328 | if (!empty($this->_having)) { | |
1329 | foreach ($this->_having as $havingsets) { | |
1330 | foreach ($havingsets as $havingset) { | |
1331 | $havingvalue[] = $havingset; | |
1332 | } | |
1333 | } | |
1334 | $having = ' HAVING ' . implode(' AND ', $havingvalue); | |
1335 | } | |
1336 | ||
1337 | // if we are doing a transform, do it here | |
1338 | // use the $from, $where and $having to get the contact ID | |
1339 | if ($this->_displayRelationshipType) { | |
1340 | $this->filterRelatedContacts($from, $where, $having); | |
1341 | } | |
1342 | ||
1343 | return array($select, $from, $where, $having); | |
1344 | } | |
1345 | ||
1346 | function &getWhereValues($name, $grouping) { | |
1347 | $result = NULL; | |
f4bff68a | 1348 | foreach ($this->_params as $values) { |
6a488035 TO |
1349 | if ($values[0] == $name && $values[3] == $grouping) { |
1350 | return $values; | |
1351 | } | |
1352 | } | |
1353 | ||
1354 | return $result; | |
1355 | } | |
1356 | ||
1357 | static function fixDateValues($relative, &$from, &$to) { | |
1358 | if ($relative) { | |
1359 | list($from, $to) = CRM_Utils_Date::getFromTo($relative, $from, $to); | |
1360 | } | |
1361 | } | |
1362 | ||
1363 | static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE) { | |
1364 | $params = array(); | |
1365 | if (empty($formValues)) { | |
1366 | return $params; | |
1367 | } | |
1368 | ||
1369 | foreach ($formValues as $id => $values) { | |
1370 | if ($id == 'privacy') { | |
1371 | if (is_array($formValues['privacy'])) { | |
1372 | $op = CRM_Utils_Array::value('do_not_toggle', $formValues['privacy']) ? '=' : '!='; | |
1373 | foreach ($formValues['privacy'] as $key => $value) { | |
1374 | if ($value) { | |
1375 | $params[] = array($key, $op, $value, 0, 0); | |
1376 | } | |
1377 | } | |
1378 | } | |
1379 | } | |
1380 | elseif ($id == 'email_on_hold') { | |
1381 | if ($formValues['email_on_hold']['on_hold']) { | |
1382 | $params[] = array('on_hold', '=', $formValues['email_on_hold']['on_hold'], 0, 0); | |
1383 | } | |
1384 | } | |
1385 | elseif (preg_match('/_date_relative$/', $id) || | |
1386 | $id == 'event_relative' || | |
1387 | $id == 'case_from_relative' || | |
1388 | $id == 'case_to_relative' | |
1389 | ) { | |
1390 | if ($id == 'event_relative') { | |
1391 | $fromRange = 'event_start_date_low'; | |
1392 | $toRange = 'event_end_date_high'; | |
1393 | } | |
1394 | else if ($id == 'case_from_relative') { | |
1395 | $fromRange = 'case_from_start_date_low'; | |
1396 | $toRange = 'case_from_start_date_high'; | |
1397 | } | |
1398 | else if ($id == 'case_to_relative') { | |
1399 | $fromRange = 'case_to_end_date_low'; | |
1400 | $toRange = 'case_to_end_date_high'; | |
1401 | } | |
1402 | else { | |
1403 | $dateComponent = explode('_date_relative', $id); | |
1404 | $fromRange = "{$dateComponent[0]}_date_low"; | |
1405 | $toRange = "{$dateComponent[0]}_date_high"; | |
1406 | } | |
1407 | ||
1408 | if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) { | |
1409 | CRM_Contact_BAO_Query::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]); | |
1410 | continue; | |
1411 | } | |
1412 | } | |
1413 | else { | |
1414 | $values = CRM_Contact_BAO_Query::fixWhereValues($id, $values, $wildcard, $useEquals); | |
1415 | ||
1416 | if (!$values) { | |
1417 | continue; | |
1418 | } | |
1419 | $params[] = $values; | |
1420 | } | |
1421 | } | |
1422 | return $params; | |
1423 | } | |
1424 | ||
1425 | static function &fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE) { | |
1426 | // skip a few search variables | |
1427 | static $skipWhere = NULL; | |
1428 | static $arrayValues = NULL; | |
1429 | static $likeNames = NULL; | |
1430 | $result = NULL; | |
1431 | ||
1432 | if (CRM_Utils_System::isNull($values)) { | |
1433 | return $result; | |
1434 | } | |
1435 | ||
1436 | if (!$skipWhere) { | |
1437 | $skipWhere = array( | |
1438 | 'task', 'radio_ts', 'uf_group_id', | |
1439 | 'component_mode', 'qfKey', 'operator', | |
1440 | 'display_relationship_type', | |
1441 | ); | |
1442 | } | |
1443 | ||
1444 | if (in_array($id, $skipWhere) || | |
1445 | substr($id, 0, 4) == '_qf_' || | |
1446 | substr($id, 0, 7) == 'hidden_' | |
1447 | ) { | |
1448 | return $result; | |
1449 | } | |
1450 | ||
1451 | if (!$likeNames) { | |
1452 | $likeNames = array('sort_name', 'email', 'note', 'display_name'); | |
1453 | } | |
1454 | ||
1455 | // email comes in via advanced search | |
1456 | // so use wildcard always | |
1457 | if ($id == 'email') { | |
1458 | $wildcard = 1; | |
1459 | } | |
1460 | ||
1461 | if (!$useEquals && in_array($id, $likeNames)) { | |
1462 | $result = array($id, 'LIKE', $values, 0, 1); | |
1463 | } | |
1464 | elseif (is_string($values) && strpos($values, '%') !== FALSE) { | |
1465 | $result = array($id, 'LIKE', $values, 0, 0); | |
1466 | } | |
1467 | elseif ($id == 'group') { | |
1468 | if (is_array($values)) { | |
1469 | foreach ($values as $groupIds => $val) { | |
1470 | $matches = array(); | |
1471 | if (preg_match('/-(\d+)$/', $groupIds, $matches)) { | |
1472 | if (strlen($matches[1]) > 0) { | |
1473 | $values[$matches[1]] = 1; | |
1474 | unset($values[$groupIds]); | |
1475 | } | |
1476 | } | |
1477 | } | |
1478 | } | |
1479 | else { | |
1480 | $groupIds = explode(',', $values); | |
1481 | unset($values); | |
1482 | foreach ($groupIds as $groupId) { | |
1483 | $values[$groupId] = 1; | |
1484 | } | |
1485 | } | |
1486 | ||
1487 | $result = array($id, 'IN', $values, 0, 0); | |
1488 | } | |
1489 | elseif ($id == 'contact_tags' || $id == 'tag') { | |
1490 | if (!is_array($values)) { | |
1491 | $tagIds = explode(',', $values); | |
1492 | unset($values); | |
1493 | foreach ($tagIds as $tagId) { | |
1494 | $values[$tagId] = 1; | |
1495 | } | |
1496 | } | |
1497 | $result = array($id, 'IN', $values, 0, 0); | |
1498 | } | |
1499 | else { | |
1500 | $result = array($id, '=', $values, 0, $wildcard); | |
1501 | } | |
1502 | ||
1503 | return $result; | |
1504 | } | |
1505 | ||
1506 | function whereClauseSingle(&$values) { | |
1507 | // do not process custom fields or prefixed contact ids or component params | |
1508 | if (CRM_Core_BAO_CustomField::getKeyID($values[0]) || | |
1509 | (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) || | |
1510 | (substr($values[0], 0, 13) == 'contribution_') || | |
1511 | (substr($values[0], 0, 6) == 'event_') || | |
1512 | (substr($values[0], 0, 12) == 'participant_') || | |
1513 | (substr($values[0], 0, 7) == 'member_') || | |
1514 | (substr($values[0], 0, 6) == 'grant_') || | |
1515 | (substr($values[0], 0, 7) == 'pledge_') || | |
289c8051 | 1516 | (substr($values[0], 0, 5) == 'case_') || |
3c53f77e DL |
1517 | (substr($values[0], 0, 10) == 'financial_') || |
1518 | (substr($values[0], 0, 11) == 'membership_') | |
6a488035 TO |
1519 | ) { |
1520 | return; | |
1521 | } | |
1522 | ||
efa3a566 DS |
1523 | // skip for hook injected fields / params |
1524 | $extFields = CRM_Contact_BAO_Query_Hook::singleton()->getFields(); | |
1525 | if (array_key_exists($values[0], $extFields)) { | |
1526 | return; | |
1527 | } | |
1528 | ||
6a488035 TO |
1529 | switch ($values[0]) { |
1530 | case 'deleted_contacts': | |
1531 | $this->deletedContacts($values); | |
1532 | return; | |
1533 | ||
1534 | case 'contact_type': | |
1535 | $this->contactType($values); | |
1536 | return; | |
1537 | ||
1538 | case 'contact_sub_type': | |
1539 | $this->contactSubType($values); | |
1540 | return; | |
1541 | ||
1542 | case 'group': | |
6a488035 TO |
1543 | $this->group($values); |
1544 | return; | |
c905b59f | 1545 | |
6a488035 TO |
1546 | case 'group_type': |
1547 | // so we resolve this into a list of groups & proceed as if they had been | |
1548 | // handed in | |
1549 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
1550 | $values[0] = 'group'; | |
1551 | $values[1] = 'IN'; | |
1552 | $this->_paramLookup['group'][0][0] ='group'; | |
1553 | $this->_paramLookup['group'][0][1] = 'IN'; | |
1554 | $this->_paramLookup['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value); | |
1555 | $this->group($values); | |
1556 | return; | |
6a488035 | 1557 | |
c905b59f | 1558 | // case tag comes from find contacts |
6a488035 TO |
1559 | case 'tag_search': |
1560 | $this->tagSearch($values); | |
1561 | return; | |
1562 | ||
1563 | case 'tag': | |
1564 | case 'contact_tags': | |
1565 | $this->tag($values); | |
1566 | return; | |
1567 | ||
1568 | case 'note': | |
1569 | case 'note_body': | |
1570 | case 'note_subject': | |
1571 | $this->notes($values); | |
1572 | return; | |
1573 | ||
1574 | case 'uf_user': | |
1575 | $this->ufUser($values); | |
1576 | return; | |
1577 | ||
1578 | case 'sort_name': | |
1579 | case 'display_name': | |
1580 | $this->sortName($values); | |
6a488035 TO |
1581 | return; |
1582 | ||
1583 | case 'email': | |
1584 | $this->email($values); | |
1585 | return; | |
1586 | ||
1587 | case 'phone_numeric': | |
1588 | $this->phone_numeric($values); | |
1589 | return; | |
1590 | ||
1591 | case 'phone_phone_type_id': | |
1592 | case 'phone_location_type_id': | |
1593 | $this->phone_option_group($values); | |
1594 | return; | |
1595 | ||
1596 | case 'street_address': | |
1597 | $this->street_address($values); | |
1598 | return; | |
1599 | ||
1600 | case 'street_number': | |
1601 | $this->street_number($values); | |
1602 | return; | |
1603 | ||
1604 | case 'sortByCharacter': | |
1605 | $this->sortByCharacter($values); | |
1606 | return; | |
1607 | ||
1608 | case 'location_type': | |
1609 | $this->locationType($values); | |
1610 | return; | |
1611 | ||
1612 | case 'county': | |
1613 | $this->county($values); | |
1614 | return; | |
1615 | ||
1616 | case 'state_province': | |
1617 | $this->stateProvince($values); | |
1618 | return; | |
1619 | ||
1620 | case 'country': | |
1621 | $this->country($values, FALSE); | |
1622 | return; | |
1623 | ||
1624 | case 'postal_code': | |
1625 | case 'postal_code_low': | |
1626 | case 'postal_code_high': | |
1627 | $this->postalCode($values); | |
1628 | return; | |
1629 | ||
1630 | case 'activity_date': | |
1631 | case 'activity_date_low': | |
1632 | case 'activity_date_high': | |
1633 | case 'activity_role': | |
1634 | case 'activity_status': | |
1635 | case 'activity_subject': | |
1636 | case 'test_activities': | |
1637 | case 'activity_type_id': | |
3e4a4597 | 1638 | case 'activity_type': |
6a488035 TO |
1639 | case 'activity_survey_id': |
1640 | case 'activity_tags': | |
1641 | case 'activity_taglist': | |
1642 | case 'activity_test': | |
6a488035 TO |
1643 | case 'activity_campaign_id': |
1644 | case 'activity_engagement_level': | |
1645 | case 'activity_id': | |
4041c9b6 | 1646 | case 'activity_result': |
6a488035 TO |
1647 | case 'source_contact': |
1648 | CRM_Activity_BAO_Query::whereClauseSingle($values, $this); | |
1649 | return; | |
1650 | ||
1651 | case 'birth_date_low': | |
1652 | case 'birth_date_high': | |
1653 | case 'deceased_date_low': | |
1654 | case 'deceased_date_high': | |
1655 | $this->demographics($values); | |
1656 | return; | |
1657 | ||
1658 | case 'log_date_low': | |
1659 | case 'log_date_high': | |
1660 | $this->modifiedDates($values); | |
1661 | return; | |
1662 | ||
1663 | case 'changed_by': | |
1664 | $this->changeLog($values); | |
1665 | return; | |
1666 | ||
1667 | case 'do_not_phone': | |
1668 | case 'do_not_email': | |
1669 | case 'do_not_mail': | |
1670 | case 'do_not_sms': | |
1671 | case 'do_not_trade': | |
1672 | case 'is_opt_out': | |
1673 | $this->privacy($values); | |
1674 | return; | |
1675 | ||
1676 | case 'privacy_options': | |
1677 | $this->privacyOptions($values); | |
1678 | return; | |
1679 | ||
1680 | case 'privacy_operator': | |
1681 | case 'privacy_toggle': | |
1682 | // these are handled by privacy options | |
1683 | return; | |
1684 | ||
1685 | case 'preferred_communication_method': | |
1686 | $this->preferredCommunication($values); | |
1687 | return; | |
1688 | ||
1689 | case 'relation_type_id': | |
ad682134 | 1690 | case 'relation_start_date_high': |
1691 | case 'relation_start_date_low': | |
1692 | case 'relation_end_date_high': | |
1693 | case 'relation_end_date_low': | |
6a488035 TO |
1694 | case 'relation_target_name': |
1695 | case 'relation_status': | |
1696 | case 'relation_date_low': | |
1697 | case 'relation_date_high': | |
7c96365b | 1698 | $this->relationship($values); |
1699 | $this->_relationshipValuesAdded = TRUE; | |
6a488035 TO |
1700 | return; |
1701 | ||
1702 | case 'task_status_id': | |
1703 | $this->task($values); | |
1704 | return; | |
1705 | ||
1706 | case 'task_id': | |
1707 | // since this case is handled with the above | |
1708 | return; | |
1709 | ||
1710 | case 'prox_distance': | |
1711 | CRM_Contact_BAO_ProximityQuery::process($this, $values); | |
1712 | return; | |
1713 | ||
1714 | case 'prox_street_address': | |
1715 | case 'prox_city': | |
1716 | case 'prox_postal_code': | |
1717 | case 'prox_state_province_id': | |
1718 | case 'prox_country_id': | |
1719 | // handled by the proximity_distance clause | |
1720 | return; | |
1721 | ||
1722 | default: | |
1723 | $this->restWhere($values); | |
1724 | return; | |
1725 | } | |
1726 | } | |
1727 | ||
1728 | /** | |
1729 | * Given a list of conditions in params generate the required | |
1730 | * where clause | |
1731 | * | |
1732 | * @return void | |
1733 | * @access public | |
1734 | */ | |
1735 | function whereClause() { | |
1736 | $this->_where[0] = array(); | |
1737 | $this->_qill[0] = array(); | |
1738 | ||
6a488035 TO |
1739 | $this->includeContactIds(); |
1740 | if (!empty($this->_params)) { | |
6a488035 TO |
1741 | foreach (array_keys($this->_params) as $id) { |
1742 | if (!CRM_Utils_Array::value(0, $this->_params[$id])) { | |
1743 | continue; | |
1744 | } | |
1745 | // check for both id and contact_id | |
1746 | if ($this->_params[$id][0] == 'id' || $this->_params[$id][0] == 'contact_id') { | |
a7516181 DL |
1747 | if ( |
1748 | $this->_params[$id][1] == 'IS NULL' || | |
6a488035 TO |
1749 | $this->_params[$id][1] == 'IS NOT NULL' |
1750 | ) { | |
1751 | $this->_where[0][] = "contact_a.id {$this->_params[$id][1]}"; | |
1752 | } | |
a7516181 DL |
1753 | elseif (is_array($this->_params[$id][2])) { |
1754 | $idList = implode("','", $this->_params[$id][2]); | |
78c0bfc0 | 1755 | //why on earth do they put ' in the middle & not on the outside? We have to assume it's |
1756 | //to support 'something' so lets add them conditionally to support the api (which is a tested flow | |
1757 | // so if you are looking to alter this check api test results | |
1758 | if(strpos(trim($idList), "'") > 0) { | |
1759 | $idList = "'" . $idList . "'"; | |
1760 | } | |
1761 | ||
a7516181 DL |
1762 | $this->_where[0][] = "contact_a.id IN ({$idList})"; |
1763 | } | |
6a488035 TO |
1764 | else { |
1765 | $this->_where[0][] = "contact_a.id {$this->_params[$id][1]} {$this->_params[$id][2]}"; | |
1766 | } | |
1767 | } | |
1768 | else { | |
1769 | $this->whereClauseSingle($this->_params[$id]); | |
1770 | } | |
1771 | } | |
1772 | ||
1773 | CRM_Core_Component::alterQuery($this, 'where'); | |
f2a9b25c | 1774 | |
99e9587a | 1775 | CRM_Contact_BAO_Query_Hook::singleton()->alterSearchQuery($this, 'where'); |
6a488035 TO |
1776 | } |
1777 | ||
1778 | if ($this->_customQuery) { | |
1779 | // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info. | |
1780 | // Hope it wont affect the other part of civicrm.. if it does please remove it. | |
1781 | if (!empty($this->_customQuery->_where)) { | |
1782 | $this->_where = CRM_Utils_Array::crmArrayMerge($this->_where, $this->_customQuery->_where); | |
1783 | } | |
1784 | ||
1785 | $this->_qill = CRM_Utils_Array::crmArrayMerge($this->_qill, $this->_customQuery->_qill); | |
1786 | } | |
1787 | ||
1788 | $clauses = array(); | |
1789 | $andClauses = array(); | |
1790 | ||
1791 | $validClauses = 0; | |
1792 | if (!empty($this->_where)) { | |
1793 | foreach ($this->_where as $grouping => $values) { | |
1794 | if ($grouping > 0 && !empty($values)) { | |
1795 | $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) '; | |
1796 | $validClauses++; | |
1797 | } | |
1798 | } | |
1799 | ||
1800 | if (!empty($this->_where[0])) { | |
1801 | $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where[0]) . ' ) '; | |
1802 | } | |
1803 | if (!empty($clauses)) { | |
1804 | $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) '; | |
1805 | } | |
1806 | ||
1807 | if ($validClauses > 1) { | |
1808 | $this->_useDistinct = TRUE; | |
1809 | } | |
1810 | } | |
1811 | ||
1812 | return implode(' AND ', $andClauses); | |
1813 | } | |
1814 | ||
1815 | function restWhere(&$values) { | |
1816 | $name = CRM_Utils_Array::value(0, $values); | |
1817 | $op = CRM_Utils_Array::value(1, $values); | |
1818 | $value = CRM_Utils_Array::value(2, $values); | |
1819 | $grouping = CRM_Utils_Array::value(3, $values); | |
1820 | $wildcard = CRM_Utils_Array::value(4, $values); | |
1821 | ||
1822 | if (isset($grouping) && !CRM_Utils_Array::value($grouping, $this->_where)) { | |
1823 | $this->_where[$grouping] = array(); | |
1824 | } | |
1825 | ||
1826 | $multipleFields = array('url'); | |
1827 | ||
1828 | //check if the location type exits for fields | |
1829 | $lType = ''; | |
1830 | $locType = explode('-', $name); | |
1831 | ||
1832 | if (!in_array($locType[0], $multipleFields)) { | |
1833 | //add phone type if exists | |
1834 | if (isset($locType[2]) && $locType[2]) { | |
1835 | $locType[2] = CRM_Core_DAO::escapeString($locType[2]); | |
1836 | } | |
1837 | } | |
1838 | ||
1839 | $field = CRM_Utils_Array::value($name, $this->_fields); | |
1840 | ||
1841 | if (!$field) { | |
1842 | $field = CRM_Utils_Array::value($locType[0], $this->_fields); | |
1843 | ||
1844 | if (!$field) { | |
1845 | return; | |
1846 | } | |
1847 | } | |
1848 | ||
1849 | $setTables = TRUE; | |
1850 | ||
1851 | $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; | |
d9ab802d | 1852 | $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
6a488035 TO |
1853 | |
1854 | if (substr($name, 0, 14) === 'state_province') { | |
1855 | if (isset($locType[1]) && is_numeric($locType[1])) { | |
2e155dbd | 1856 | $setTables = FALSE; |
d9ab802d PJ |
1857 | $aName = "{$locationType[$locType[1]]}-address"; |
1858 | $where = "`$aName`.state_province_id"; | |
6a488035 TO |
1859 | } |
1860 | else { | |
d9ab802d | 1861 | $where = "civicrm_address.state_province_id"; |
6a488035 TO |
1862 | } |
1863 | ||
d9ab802d | 1864 | $states = CRM_Core_PseudoConstant::stateProvince(); |
6a488035 | 1865 | if (is_numeric($value)) { |
6a488035 | 1866 | $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive'); |
6a488035 TO |
1867 | $value = $states[(int ) $value]; |
1868 | } | |
1869 | else { | |
d9ab802d PJ |
1870 | $intVal = CRM_Utils_Array::key($value, $states); |
1871 | $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive'); | |
6a488035 TO |
1872 | } |
1873 | if (!$lType) { | |
1874 | $this->_qill[$grouping][] = ts('State') . " $op '$value'"; | |
1875 | } | |
1876 | else { | |
1877 | $this->_qill[$grouping][] = ts('State') . " ($lType) $op '$value'"; | |
1878 | } | |
1879 | } | |
1c1a84a2 | 1880 | elseif (!empty($field['pseudoconstant'])) { |
1071730c DL |
1881 | $this->optionValueQuery( |
1882 | $name, $op, $value, $grouping, | |
9df8a11d | 1883 | CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', $field['name']), |
1071730c | 1884 | $field, |
a30e57e0 DL |
1885 | $field['title'], |
1886 | 'String', | |
1887 | TRUE | |
1071730c | 1888 | ); |
9df8a11d | 1889 | if ($name == 'gender_id') { |
1071730c DL |
1890 | self::$_openedPanes[ts('Demographics')] = TRUE; |
1891 | } | |
1892 | } | |
6a488035 TO |
1893 | elseif (substr($name, 0, 7) === 'country') { |
1894 | if (isset($locType[1]) && is_numeric($locType[1])) { | |
2e155dbd | 1895 | $setTables = FALSE; |
d9ab802d PJ |
1896 | $aName = "{$locationType[$locType[1]]}-address"; |
1897 | $where = "`$aName`.country_id"; | |
6a488035 TO |
1898 | } |
1899 | else { | |
d9ab802d | 1900 | $where = "civicrm_address.country_id"; |
6a488035 TO |
1901 | } |
1902 | ||
d9ab802d | 1903 | $countries = CRM_Core_PseudoConstant::country(); |
6a488035 | 1904 | if (is_numeric($value)) { |
6a488035 | 1905 | $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive'); |
6a488035 TO |
1906 | $value = $countries[(int ) $value]; |
1907 | } | |
1908 | else { | |
d9ab802d PJ |
1909 | $intVal = CRM_Utils_Array::key($value, $countries); |
1910 | $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive'); | |
6a488035 | 1911 | } |
2e155dbd | 1912 | |
6a488035 TO |
1913 | if (!$lType) { |
1914 | $this->_qill[$grouping][] = ts('Country') . " $op '$value'"; | |
1915 | } | |
1916 | else { | |
1917 | $this->_qill[$grouping][] = ts('Country') . " ($lType) $op '$value'"; | |
1918 | } | |
1919 | } | |
1920 | elseif (substr($name, 0, 6) === 'county') { | |
1921 | if (isset($locType[1]) && is_numeric($locType[1])) { | |
2e155dbd | 1922 | $setTables = FALSE; |
d9ab802d PJ |
1923 | $aName = "{$locationType[$locType[1]]}-address"; |
1924 | $where = "`$aName`.county_id"; | |
6a488035 TO |
1925 | } |
1926 | else { | |
d9ab802d | 1927 | $where = "civicrm_address.county_id"; |
6a488035 | 1928 | } |
d9ab802d PJ |
1929 | |
1930 | $counties = CRM_Core_PseudoConstant::county(); | |
6a488035 | 1931 | if (is_numeric($value)) { |
6a488035 | 1932 | $this->_where[$grouping][] = self::buildClause($where, $op, $value, 'Positive'); |
6a488035 TO |
1933 | $value = $counties[(int ) $value]; |
1934 | } | |
1935 | else { | |
d9ab802d PJ |
1936 | $intVal = CRM_Utils_Array::key($value, $counties); |
1937 | $this->_where[$grouping][] = self::buildClause($where, $op, $intVal, 'Positive'); | |
6a488035 TO |
1938 | } |
1939 | ||
1940 | if (!$lType) { | |
1941 | $this->_qill[$grouping][] = ts('County') . " $op '$value'"; | |
1942 | } | |
1943 | else { | |
1944 | $this->_qill[$grouping][] = ts('County') . " ($lType) $op '$value'"; | |
1945 | } | |
1946 | } | |
1947 | elseif ($name === 'world_region') { | |
1948 | $this->optionValueQuery( | |
1949 | $name, $op, $value, $grouping, | |
1950 | CRM_Core_PseudoConstant::worldRegion(), | |
1951 | $field, | |
8b695e91 CW |
1952 | ts('World Region'), |
1953 | 'Positive', | |
1954 | TRUE | |
6a488035 TO |
1955 | ); |
1956 | } | |
6a488035 TO |
1957 | elseif ($name === 'birth_date') { |
1958 | $date = CRM_Utils_Date::processDate($value); | |
1959 | $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $date); | |
1960 | ||
1961 | if ($date) { | |
1962 | $date = CRM_Utils_Date::customFormat($date); | |
1963 | $this->_qill[$grouping][] = "$field[title] $op \"$date\""; | |
1964 | } | |
1965 | else { | |
1966 | $this->_qill[$grouping][] = "$field[title] $op"; | |
1967 | } | |
1968 | self::$_openedPanes[ts('Demographics')] = TRUE; | |
1969 | } | |
1970 | elseif ($name === 'deceased_date') { | |
1971 | $date = CRM_Utils_Date::processDate($value); | |
1972 | $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $date); | |
1973 | if ($date) { | |
1974 | $date = CRM_Utils_Date::customFormat($date); | |
1975 | $this->_qill[$grouping][] = "$field[title] $op \"$date\""; | |
1976 | } | |
1977 | else { | |
1978 | $this->_qill[$grouping][] = "$field[title] $op"; | |
1979 | } | |
1980 | self::$_openedPanes[ts('Demographics')] = TRUE; | |
1981 | } | |
1982 | elseif ($name === 'is_deceased') { | |
1983 | $this->_where[$grouping][] = self::buildClause("contact_a.{$name}", $op, $value); | |
1984 | $this->_qill[$grouping][] = "$field[title] $op \"$value\""; | |
1985 | self::$_openedPanes[ts('Demographics')] = TRUE; | |
1986 | } | |
1987 | elseif ($name === 'contact_id') { | |
1988 | if (is_int($value)) { | |
1989 | $this->_where[$grouping][] = self::buildClause($field['where'], $op, $value); | |
1990 | $this->_qill[$grouping][] = "$field[title] $op $value"; | |
1991 | } | |
1992 | } | |
1993 | elseif ($name === 'name') { | |
1994 | $value = $strtolower(CRM_Core_DAO::escapeString($value)); | |
1995 | if ($wildcard) { | |
1996 | $value = "%$value%"; | |
1997 | $op = 'LIKE'; | |
1998 | } | |
1999 | $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}"; | |
2000 | $this->_where[$grouping][] = self::buildClause($wc, $op, "'$value'"); | |
2001 | $this->_qill[$grouping][] = "$field[title] $op \"$value\""; | |
2002 | } | |
2003 | elseif ($name === 'current_employer') { | |
2004 | $value = $strtolower(CRM_Core_DAO::escapeString($value)); | |
2005 | if ($wildcard) { | |
2006 | $value = "%$value%"; | |
2007 | $op = 'LIKE'; | |
2008 | } | |
2009 | $wc = self::caseImportant($op) ? "LOWER(contact_a.organization_name)" : "contact_a.organization_name"; | |
0d77b56a PJ |
2010 | $ceWhereClause = self::buildClause($wc, $op, |
2011 | $value | |
6a488035 | 2012 | ); |
0d77b56a PJ |
2013 | $ceWhereClause .= " AND contact_a.contact_type = 'Individual'"; |
2014 | $this->_where[$grouping][] = $ceWhereClause; | |
6a488035 TO |
2015 | $this->_qill[$grouping][] = "$field[title] $op \"$value\""; |
2016 | } | |
2017 | elseif ($name === 'email_greeting') { | |
2018 | $filterCondition = array('greeting_type' => 'email_greeting'); | |
2019 | $this->optionValueQuery( | |
2020 | $name, $op, $value, $grouping, | |
2021 | CRM_Core_PseudoConstant::greeting($filterCondition), | |
2022 | $field, | |
2023 | ts('Email Greeting') | |
2024 | ); | |
2025 | } | |
2026 | elseif ($name === 'postal_greeting') { | |
2027 | $filterCondition = array('greeting_type' => 'postal_greeting'); | |
2028 | $this->optionValueQuery( | |
2029 | $name, $op, $value, $grouping, | |
2030 | CRM_Core_PseudoConstant::greeting($filterCondition), | |
2031 | $field, | |
2032 | ts('Postal Greeting') | |
2033 | ); | |
2034 | } | |
2035 | elseif ($name === 'addressee') { | |
2036 | $filterCondition = array('greeting_type' => 'addressee'); | |
2037 | $this->optionValueQuery( | |
2038 | $name, $op, $value, $grouping, | |
2039 | CRM_Core_PseudoConstant::greeting($filterCondition), | |
2040 | $field, | |
2041 | ts('Addressee') | |
2042 | ); | |
2043 | } | |
2044 | elseif (substr($name, 0, 4) === 'url-') { | |
2045 | $tName = 'civicrm_website'; | |
2046 | $this->_whereTables[$tName] = $this->_tables[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )"; | |
2047 | $value = $strtolower(CRM_Core_DAO::escapeString($value)); | |
2048 | if ($wildcard) { | |
2049 | $value = "%$value%"; | |
2050 | $op = 'LIKE'; | |
2051 | } | |
2052 | ||
2053 | $wc = 'civicrm_website.url'; | |
0d77b56a | 2054 | $this->_where[$grouping][] = $d = self::buildClause($wc, $op, $value); |
6a488035 TO |
2055 | $this->_qill[$grouping][] = "$field[title] $op \"$value\""; |
2056 | } | |
2057 | elseif ($name === 'contact_is_deleted') { | |
2058 | $this->_where[$grouping][] = self::buildClause("contact_a.is_deleted", $op, $value); | |
2059 | $this->_qill[$grouping][] = "$field[title] $op \"$value\""; | |
2060 | } | |
2061 | else { | |
2062 | // sometime the value is an array, need to investigate and fix | |
2063 | if (is_array($value)) { | |
2064 | CRM_Core_Error::fatal(); | |
2065 | } | |
2066 | ||
2067 | if (!empty($field['where'])) { | |
2068 | if ($op != 'IN') { | |
2069 | $value = $strtolower($value); | |
2070 | } | |
2071 | if ($wildcard) { | |
2072 | $value = "%$value%"; | |
2073 | $op = 'LIKE'; | |
2074 | } | |
2075 | ||
2076 | if (isset($locType[1]) && | |
2077 | is_numeric($locType[1]) | |
2078 | ) { | |
2079 | $setTables = FALSE; | |
2080 | ||
2081 | //get the location name | |
6a488035 TO |
2082 | list($tName, $fldName) = self::getLocationTableName($field['where'], $locType); |
2083 | ||
2084 | $where = "`$tName`.$fldName"; | |
2085 | ||
2086 | $this->_where[$grouping][] = self::buildClause("LOWER($where)", $op, $value); | |
2087 | $this->_whereTables[$tName] = $this->_tables[$tName]; | |
2088 | $this->_qill[$grouping][] = "$field[title] $op '$value'"; | |
2089 | } | |
2090 | else { | |
2091 | list($tableName, $fieldName) = explode('.', $field['where'], 2); | |
2092 | if ($tableName == 'civicrm_contact') { | |
2093 | $fieldName = "LOWER(contact_a.{$fieldName})"; | |
2094 | } | |
2095 | else { | |
2096 | if ($op != 'IN' && !is_numeric($value)) { | |
2097 | $fieldName = "LOWER({$field['where']})"; | |
2098 | } | |
2099 | else { | |
2100 | $fieldName = "{$field['where']}"; | |
2101 | } | |
2102 | } | |
2103 | ||
2104 | $type = NULL; | |
2105 | if (CRM_Utils_Array::value('type', $field)) { | |
2106 | $type = CRM_Utils_Type::typeToString($field['type']); | |
2107 | } | |
2108 | ||
2109 | $this->_where[$grouping][] = self::buildClause($fieldName, $op, $value, $type); | |
2110 | $this->_qill[$grouping][] = "$field[title] $op $value"; | |
2111 | } | |
2112 | } | |
2113 | } | |
2114 | ||
2115 | if ($setTables && isset($field['where'])) { | |
2116 | list($tableName, $fieldName) = explode('.', $field['where'], 2); | |
2117 | if (isset($tableName)) { | |
2118 | $this->_tables[$tableName] = 1; | |
2119 | $this->_whereTables[$tableName] = 1; | |
2120 | } | |
2121 | } | |
2122 | } | |
2123 | ||
2124 | ||
2125 | static function getLocationTableName(&$where, &$locType) { | |
2126 | if (isset($locType[1]) && is_numeric($locType[1])) { | |
2127 | list($tbName, $fldName) = explode(".", $where); | |
2128 | ||
2129 | //get the location name | |
b2b0530a | 2130 | $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
6a488035 TO |
2131 | $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext'); |
2132 | if (in_array($locType[0], $specialFields)) { | |
2133 | //hack to fix / special handing for phone_ext | |
2134 | if ($locType[0] == 'phone_ext') { | |
2135 | $locType[0] = 'phone'; | |
2136 | } | |
2137 | if (isset($locType[2]) && $locType[2]) { | |
2138 | $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}"; | |
2139 | } | |
2140 | else { | |
2141 | $tName = "{$locationType[$locType[1]]}-{$locType[0]}"; | |
2142 | } | |
2143 | } | |
2144 | elseif (in_array($locType[0], | |
2145 | array( | |
2146 | 'address_name', 'street_address', 'supplemental_address_1', 'supplemental_address_2', | |
2147 | 'city', 'postal_code', 'postal_code_suffix', 'geo_code_1', 'geo_code_2', | |
2148 | ) | |
2149 | )) { | |
2150 | //fix for search by profile with address fields. | |
2151 | $tName = "{$locationType[$locType[1]]}-address"; | |
2152 | } | |
2153 | elseif ($locType[0] == 'on_hold') { | |
2154 | $tName = "{$locationType[$locType[1]]}-email"; | |
2155 | } | |
2156 | else { | |
2157 | $tName = "{$locationType[$locType[1]]}-{$locType[0]}"; | |
2158 | } | |
2159 | $tName = str_replace(' ', '_', $tName); | |
2160 | return array($tName, $fldName); | |
2161 | } | |
2162 | CRM_Core_Error::fatal(); | |
2163 | } | |
2164 | ||
2165 | /** | |
2166 | * Given a result dao, extract the values and return that array | |
2167 | * | |
2168 | * @param Object $dao | |
2169 | * | |
2170 | * @return array values for this query | |
2171 | */ | |
2172 | function store($dao) { | |
2173 | $value = array(); | |
2174 | ||
2175 | foreach ($this->_element as $key => $dontCare) { | |
2176 | if (property_exists($dao, $key)) { | |
2177 | if (strpos($key, '-') !== FALSE) { | |
2178 | $values = explode('-', $key); | |
2179 | $lastElement = array_pop($values); | |
2180 | $current = &$value; | |
2181 | $cnt = count($values); | |
2182 | $count = 1; | |
2183 | foreach ($values as $v) { | |
2184 | if (!array_key_exists($v, $current)) { | |
2185 | $current[$v] = array(); | |
2186 | } | |
2187 | //bad hack for im_provider | |
2188 | if ($lastElement == 'provider_id') { | |
2189 | if ($count < $cnt) { | |
2190 | $current = &$current[$v]; | |
2191 | } | |
2192 | else { | |
2193 | $lastElement = "{$v}_{$lastElement}"; | |
2194 | } | |
2195 | } | |
2196 | else { | |
2197 | $current = &$current[$v]; | |
2198 | } | |
2199 | $count++; | |
2200 | } | |
2201 | ||
2202 | $current[$lastElement] = $dao->$key; | |
2203 | } | |
2204 | else { | |
2205 | $value[$key] = $dao->$key; | |
2206 | } | |
2207 | } | |
2208 | } | |
2209 | return $value; | |
2210 | } | |
2211 | ||
2212 | /** | |
2213 | * getter for tables array | |
2214 | * | |
2215 | * @return array | |
2216 | * @access public | |
2217 | */ | |
2218 | function tables() { | |
2219 | return $this->_tables; | |
2220 | } | |
2221 | ||
2222 | function whereTables() { | |
2223 | return $this->_whereTables; | |
2224 | } | |
2225 | ||
2226 | /** | |
2227 | * generate the where clause (used in match contacts and permissions) | |
2228 | * | |
2229 | * @param array $params | |
2230 | * @param array $fields | |
2231 | * @param array $tables | |
2232 | * @param boolean $strict | |
2233 | * | |
2234 | * @return string | |
2235 | * @access public | |
2236 | * @static | |
2237 | */ | |
2238 | static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) { | |
2239 | $query = new CRM_Contact_BAO_Query($params, NULL, $fields, | |
2240 | FALSE, $strict | |
2241 | ); | |
2242 | ||
2243 | $tables = array_merge($query->tables(), $tables); | |
2244 | $whereTables = array_merge($query->whereTables(), $whereTables); | |
2245 | ||
2246 | return $query->_whereClause; | |
2247 | } | |
2248 | ||
2249 | /** | |
2250 | * create the from clause | |
2251 | * | |
2252 | * @param array $tables tables that need to be included in this from clause | |
2253 | * if null, return mimimal from clause (i.e. civicrm_contact) | |
2254 | * @param array $inner tables that should be inner-joined | |
2255 | * @param array $right tables that should be right-joined | |
2256 | * | |
2257 | * @return string the from clause | |
2258 | * @access public | |
2259 | * @static | |
2260 | */ | |
2261 | static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) { | |
2262 | ||
2263 | $from = ' FROM civicrm_contact contact_a'; | |
2264 | if (empty($tables)) { | |
2265 | return $from; | |
2266 | } | |
2267 | ||
2268 | if (CRM_Utils_Array::value('civicrm_worldregion', $tables)) { | |
2269 | $tables = array_merge(array('civicrm_country' => 1), $tables); | |
2270 | } | |
2271 | ||
2272 | if ((CRM_Utils_Array::value('civicrm_state_province', $tables) || | |
2273 | CRM_Utils_Array::value('civicrm_country', $tables) || | |
2274 | CRM_Utils_Array::value('civicrm_county', $tables) | |
2275 | ) && | |
2276 | !CRM_Utils_Array::value('civicrm_address', $tables) | |
2277 | ) { | |
2278 | $tables = array_merge(array('civicrm_address' => 1), | |
2279 | $tables | |
2280 | ); | |
2281 | } | |
2282 | ||
2283 | // add group_contact table if group table is present | |
2284 | if (CRM_Utils_Array::value('civicrm_group', $tables) && | |
2285 | !CRM_Utils_Array::value('civicrm_group_contact', $tables) | |
2286 | ) { | |
2287 | $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added'"; | |
2288 | } | |
2289 | ||
2290 | // add group_contact and group table is subscription history is present | |
2291 | if (CRM_Utils_Array::value('civicrm_subscription_history', $tables) | |
2292 | && !CRM_Utils_Array::value('civicrm_group', $tables) | |
2293 | ) { | |
2294 | $tables = array_merge(array( | |
2295 | 'civicrm_group' => 1, | |
2296 | 'civicrm_group_contact' => 1, | |
2297 | ), | |
2298 | $tables | |
2299 | ); | |
2300 | } | |
2301 | ||
2302 | // to handle table dependencies of components | |
2303 | CRM_Core_Component::tableNames($tables); | |
efa3a566 DS |
2304 | // to handle table dependencies of hook injected tables |
2305 | CRM_Contact_BAO_Query_Hook::singleton()->setTableDependency($tables); | |
6a488035 TO |
2306 | |
2307 | //format the table list according to the weight | |
2308 | $info = CRM_Core_TableHierarchy::info(); | |
2309 | ||
2310 | foreach ($tables as $key => $value) { | |
2311 | $k = 99; | |
2312 | if (strpos($key, '-') !== FALSE) { | |
2313 | $keyArray = explode('-', $key); | |
2314 | $k = CRM_Utils_Array::value('civicrm_' . $keyArray[1], $info, 99); | |
2315 | } | |
2316 | elseif (strpos($key, '_') !== FALSE) { | |
2317 | $keyArray = explode('_', $key); | |
2318 | if (is_numeric(array_pop($keyArray))) { | |
2319 | $k = CRM_Utils_Array::value(implode('_', $keyArray), $info, 99); | |
2320 | } | |
2321 | else { | |
2322 | $k = CRM_Utils_Array::value($key, $info, 99); | |
2323 | } | |
2324 | } | |
2325 | else { | |
2326 | $k = CRM_Utils_Array::value($key, $info, 99); | |
2327 | } | |
2328 | $tempTable[$k . ".$key"] = $key; | |
2329 | } | |
2330 | ksort($tempTable); | |
2331 | $newTables = array(); | |
2332 | foreach ($tempTable as $key) { | |
2333 | $newTables[$key] = $tables[$key]; | |
2334 | } | |
2335 | ||
2336 | $tables = $newTables; | |
2337 | ||
2338 | foreach ($tables as $name => $value) { | |
2339 | if (!$value) { | |
2340 | continue; | |
2341 | } | |
2342 | ||
2343 | if (CRM_Utils_Array::value($name, $inner)) { | |
2344 | $side = 'INNER'; | |
2345 | } | |
2346 | elseif (CRM_Utils_Array::value($name, $right)) { | |
2347 | $side = 'RIGHT'; | |
2348 | } | |
2349 | else { | |
2350 | $side = 'LEFT'; | |
2351 | } | |
2352 | ||
2353 | if ($value != 1) { | |
2354 | // if there is already a join statement in value, use value itself | |
2355 | if (strpos($value, 'JOIN')) { | |
2356 | $from .= " $value "; | |
2357 | } | |
2358 | else { | |
2359 | $from .= " $side JOIN $name ON ( $value ) "; | |
2360 | } | |
2361 | continue; | |
2362 | } | |
2363 | switch ($name) { | |
2364 | case 'civicrm_address': | |
2365 | if ($primaryLocation) { | |
2366 | $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )"; | |
2367 | } | |
2368 | else { | |
2369 | $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) "; | |
2370 | } | |
2371 | continue; | |
2372 | ||
2373 | case 'civicrm_phone': | |
2374 | $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) "; | |
2375 | continue; | |
2376 | ||
2377 | case 'civicrm_email': | |
2378 | $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) "; | |
2379 | continue; | |
2380 | ||
2381 | case 'civicrm_im': | |
2382 | $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) "; | |
2383 | continue; | |
2384 | ||
2385 | case 'im_provider': | |
2386 | $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) "; | |
2387 | $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'"; | |
2388 | $from .= " $side JOIN civicrm_option_value im_provider ON (civicrm_im.provider_id = im_provider.value AND option_group_imProvider.id = im_provider.option_group_id)"; | |
2389 | continue; | |
2390 | ||
2391 | case 'civicrm_openid': | |
2392 | $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )"; | |
2393 | continue; | |
2394 | ||
6a488035 | 2395 | case 'civicrm_worldregion': |
d9ab802d | 2396 | $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id "; |
6a488035 TO |
2397 | $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id "; |
2398 | continue; | |
2399 | ||
6a488035 TO |
2400 | case 'civicrm_location_type': |
2401 | $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id "; | |
2402 | continue; | |
2403 | ||
2404 | case 'civicrm_group': | |
2405 | $from .= " $side JOIN civicrm_group ON civicrm_group.id = civicrm_group_contact.group_id "; | |
2406 | continue; | |
2407 | ||
2408 | case 'civicrm_group_contact': | |
2409 | $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id "; | |
2410 | continue; | |
2411 | ||
2412 | case 'civicrm_activity': | |
2413 | case 'civicrm_activity_tag': | |
2414 | case 'activity_type': | |
2415 | case 'activity_status': | |
2416 | case 'civicrm_activity_contact': | |
2417 | case 'source_contact': | |
2418 | $from .= CRM_Activity_BAO_Query::from($name, $mode, $side); | |
2419 | continue; | |
2420 | ||
2421 | case 'civicrm_entity_tag': | |
2422 | $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND | |
2423 | civicrm_entity_tag.entity_id = contact_a.id ) "; | |
2424 | continue; | |
2425 | ||
2426 | case 'civicrm_note': | |
2427 | $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND | |
2428 | contact_a.id = civicrm_note.entity_id ) "; | |
2429 | continue; | |
2430 | ||
2431 | case 'civicrm_subscription_history': | |
2432 | $from .= " $side JOIN civicrm_subscription_history | |
2433 | ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id | |
2434 | AND civicrm_group_contact.group_id = civicrm_subscription_history.group_id"; | |
2435 | continue; | |
2436 | ||
6a488035 TO |
2437 | case 'civicrm_relationship': |
2438 | if (self::$_relType == 'reciprocal') { | |
7c96365b | 2439 | if(self::$_relationshipTempTable) { |
2440 | // we have a temptable to join on | |
2441 | $tbl = self::$_relationshipTempTable; | |
2442 | $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id"; | |
2443 | } | |
2444 | else { | |
2445 | $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)"; | |
2446 | $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id OR civicrm_relationship.contact_id_b = contact_b.id)"; | |
2447 | } | |
6a488035 TO |
2448 | } |
2449 | elseif (self::$_relType == 'b') { | |
2450 | $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )"; | |
2451 | $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )"; | |
2452 | } | |
2453 | else { | |
2454 | $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )"; | |
2455 | $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )"; | |
2456 | } | |
2457 | continue; | |
2458 | ||
2459 | case 'civicrm_log': | |
f391b06e | 2460 | $from .= " INNER JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')"; |
2461 | $from .= " INNER JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)"; | |
6a488035 TO |
2462 | continue; |
2463 | ||
2464 | case 'civicrm_tag': | |
2465 | $from .= " $side JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id "; | |
2466 | continue; | |
2467 | ||
6a488035 TO |
2468 | case 'civicrm_grant': |
2469 | $from .= CRM_Grant_BAO_Query::from($name, $mode, $side); | |
2470 | continue; | |
2471 | ||
6a488035 TO |
2472 | case 'civicrm_website': |
2473 | $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id "; | |
2474 | continue; | |
2475 | ||
2476 | default: | |
2477 | $from .= CRM_Core_Component::from($name, $mode, $side); | |
99e9587a DS |
2478 | $from .= CRM_Contact_BAO_Query_Hook::singleton()->buildSearchfrom($name, $mode, $side); |
2479 | ||
6a488035 TO |
2480 | continue; |
2481 | } | |
2482 | } | |
2483 | ||
2484 | return $from; | |
2485 | } | |
2486 | ||
2487 | /** | |
2488 | * WHERE / QILL clause for deleted_contacts | |
2489 | * | |
2490 | * @return void | |
2491 | */ | |
2492 | function deletedContacts($values) { | |
2493 | list($_, $_, $value, $grouping, $_) = $values; | |
2494 | if ($value) { | |
2495 | // *prepend* to the relevant grouping as this is quite an important factor | |
2496 | array_unshift($this->_qill[$grouping], ts('Search in Trash')); | |
2497 | } | |
2498 | } | |
2499 | ||
2500 | /** | |
2501 | * where / qill clause for contact_type | |
2502 | * | |
2503 | * @return void | |
2504 | * @access public | |
2505 | */ | |
2506 | function contactType(&$values) { | |
2507 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
2508 | ||
2509 | $subTypes = array(); | |
2510 | $clause = array(); | |
2511 | ||
2512 | // account for search builder mapping multiple values | |
2513 | if (!is_array($value)) { | |
2514 | $values = self::parseSearchBuilderString($value, 'String'); | |
2515 | if (is_array($values)) { | |
2516 | $value = array_flip($values); | |
2517 | } | |
2518 | } | |
2519 | ||
2520 | if (is_array($value)) { | |
2521 | foreach ($value as $k => $v) { | |
2522 | // fix for CRM-771 | |
2523 | if ($k) { | |
2524 | $subType = NULL; | |
2525 | $contactType = $k; | |
2526 | if (strpos($k, CRM_Core_DAO::VALUE_SEPARATOR)) { | |
2527 | list($contactType, $subType) = explode(CRM_Core_DAO::VALUE_SEPARATOR, $k, 2); | |
2528 | } | |
2529 | ||
2530 | if (!empty($subType)) { | |
2531 | $subTypes[$subType] = 1; | |
2532 | } | |
2533 | $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'"; | |
2534 | } | |
2535 | } | |
2536 | } | |
2537 | else { | |
2538 | $contactTypeANDSubType = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value, 2); | |
2539 | $contactType = $contactTypeANDSubType[0]; | |
2540 | $subType = CRM_Utils_Array::value(1, $contactTypeANDSubType); | |
2541 | if (!empty($subType)) { | |
2542 | $subTypes[$subType] = 1; | |
2543 | } | |
2544 | $clause[$contactType] = "'" . CRM_Utils_Type::escape($contactType, 'String') . "'"; | |
2545 | } | |
2546 | ||
2547 | // fix for CRM-771 | |
2548 | if (!empty($clause)) { | |
3b3bc827 CW |
2549 | if ($op == 'IN' || $op == 'NOT IN') { |
2550 | $this->_where[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')'; | |
2551 | } | |
2552 | else { | |
d4b81b9a | 2553 | $quill = $clause; |
3b3bc827 CW |
2554 | $type = array_pop($clause); |
2555 | $this->_where[$grouping][] = "contact_a.contact_type $op $type"; | |
2556 | } | |
d4b81b9a | 2557 | |
2558 | $this->_qill[$grouping][] = ts('Contact Type') . ' - ' . implode(' ' . ts('or') . ' ', $quill); | |
6a488035 TO |
2559 | |
2560 | if (!empty($subTypes)) { | |
2561 | $this->includeContactSubTypes($subTypes, $grouping); | |
2562 | } | |
2563 | } | |
2564 | } | |
2565 | ||
2566 | /** | |
2567 | * where / qill clause for contact_sub_type | |
2568 | * | |
2569 | * @return void | |
2570 | * @access public | |
2571 | */ | |
2572 | function contactSubType(&$values) { | |
2573 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
2574 | $this->includeContactSubTypes($value, $grouping); | |
2575 | } | |
2576 | ||
2577 | function includeContactSubTypes($value, $grouping) { | |
2578 | ||
2579 | $clause = array(); | |
2580 | $alias = "contact_a.contact_sub_type"; | |
2581 | ||
2582 | if (is_array($value)) { | |
2583 | foreach ($value as $k => $v) { | |
2584 | if (!empty($k)) { | |
2585 | $clause[$k] = "($alias like '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($k, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')"; | |
2586 | } | |
2587 | } | |
2588 | } | |
2589 | else { | |
2590 | $clause[$value] = "($alias like '%" . CRM_Core_DAO::VALUE_SEPARATOR . CRM_Utils_Type::escape($value, 'String') . CRM_Core_DAO::VALUE_SEPARATOR . "%')"; | |
2591 | } | |
2592 | ||
2593 | if (!empty($clause)) { | |
2594 | $this->_where[$grouping][] = "( " . implode(' OR ', $clause) . " )"; | |
2595 | $this->_qill[$grouping][] = ts('Contact Subtype') . ' - ' . implode(' ' . ts('or') . ' ', array_keys($clause)); | |
2596 | } | |
2597 | } | |
2598 | ||
2599 | /** | |
2600 | * where / qill clause for groups | |
2601 | * | |
2602 | * @return void | |
2603 | * @access public | |
2604 | */ | |
2605 | function group(&$values) { | |
2606 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
2607 | ||
2608 | if (count($value) > 1) { | |
2609 | $this->_useDistinct = TRUE; | |
2610 | } | |
2611 | ||
2612 | $groupNames = CRM_Core_PseudoConstant::group(); | |
2613 | $groupIds = implode(',', array_keys($value)); | |
2614 | ||
2615 | $names = array(); | |
2616 | foreach ($value as $id => $dontCare) { | |
2617 | if (array_key_exists($id, $groupNames) && $dontCare) { | |
2618 | $names[] = $groupNames[$id]; | |
2619 | } | |
2620 | } | |
2621 | ||
2622 | $statii = array(); | |
2623 | $in = FALSE; | |
2624 | $gcsValues = &$this->getWhereValues('group_contact_status', $grouping); | |
2625 | if ($gcsValues && | |
2626 | is_array($gcsValues[2]) | |
2627 | ) { | |
2628 | foreach ($gcsValues[2] as $k => $v) { | |
2629 | if ($v) { | |
2630 | if ($k == 'Added') { | |
2631 | $in = TRUE; | |
2632 | } | |
2633 | $statii[] = "'" . CRM_Utils_Type::escape($k, 'String') . "'"; | |
2634 | } | |
2635 | } | |
2636 | } | |
2637 | else { | |
2638 | $statii[] = '"Added"'; | |
2639 | $in = TRUE; | |
2640 | } | |
2641 | ||
2642 | $skipGroup = FALSE; | |
2643 | if (count($value) == 1 && | |
2644 | count($statii) == 1 && | |
2645 | $statii[0] == '"Added"' | |
2646 | ) { | |
2647 | // check if smart group, if so we can get rid of that one additional | |
2648 | // left join | |
2649 | $groupIDs = array_keys($value); | |
2650 | ||
2651 | if (CRM_Utils_Array::value(0, $groupIDs) && | |
2652 | CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', | |
2653 | $groupIDs[0], | |
2654 | 'saved_search_id' | |
2655 | ) | |
2656 | ) { | |
2657 | $skipGroup = TRUE; | |
2658 | } | |
2659 | } | |
2660 | ||
2661 | if (!$skipGroup) { | |
2662 | $gcTable = "`civicrm_group_contact-{$groupIds}`"; | |
c905b59f | 2663 | $this->_tables[$gcTable] = $this->_whereTables[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON ( contact_a.id = {$gcTable}.contact_id AND {$gcTable}.group_id $op ( $groupIds ) )"; |
6a488035 TO |
2664 | } |
2665 | ||
2666 | $qill = ts('Contacts %1', array(1 => $op)); | |
2667 | $qill .= ' ' . implode(' ' . ts('or') . ' ', $names); | |
2668 | ||
2669 | $groupClause = NULL; | |
2670 | ||
2671 | if (!$skipGroup) { | |
2672 | $groupClause = "{$gcTable}.group_id $op ( $groupIds )"; | |
2673 | if (!empty($statii)) { | |
2674 | $groupClause .= " AND {$gcTable}.status IN (" . implode(', ', $statii) . ")"; | |
2675 | $qill .= " " . ts('AND') . " " . ts('Group Status') . ' - ' . implode(' ' . ts('or') . ' ', $statii); | |
2676 | } | |
2677 | } | |
2678 | ||
2679 | if ($in) { | |
2680 | $ssClause = $this->savedSearch($values); | |
2681 | if ($ssClause) { | |
2682 | if ($groupClause) { | |
2683 | $groupClause = "( ( $groupClause ) OR ( $ssClause ) )"; | |
2684 | } | |
2685 | else { | |
2686 | $groupClause = $ssClause; | |
2687 | } | |
2688 | } | |
2689 | } | |
2690 | ||
2691 | $this->_where[$grouping][] = $groupClause; | |
2692 | $this->_qill[$grouping][] = $qill; | |
2693 | } | |
2694 | /* | |
2695 | * Function translates selection of group type into a list of groups | |
2696 | */ | |
2697 | function getGroupsFromTypeCriteria($value){ | |
2698 | $groupIds = array(); | |
2699 | foreach ($value as $groupTypeValue) { | |
2700 | $groupList = CRM_Core_PseudoConstant::group($groupTypeValue); | |
2701 | $groupIds = ($groupIds + $groupList); | |
2702 | } | |
2703 | return $groupIds; | |
2704 | } | |
2705 | ||
2706 | /** | |
2707 | * where / qill clause for smart groups | |
2708 | * | |
2709 | * @return void | |
2710 | * @access public | |
2711 | */ | |
2712 | function savedSearch(&$values) { | |
2713 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
2714 | return $this->addGroupContactCache(array_keys($value)); | |
2715 | } | |
2716 | ||
2717 | function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a") { | |
2718 | $config = CRM_Core_Config::singleton(); | |
2719 | ||
2720 | // find all the groups that are part of a saved search | |
2721 | $groupIDs = implode(',', $groups); | |
2722 | if (empty($groupIDs)) { | |
2723 | return NULL; | |
2724 | } | |
2725 | ||
2726 | $sql = " | |
2727 | SELECT id, cache_date, saved_search_id, children | |
2728 | FROM civicrm_group | |
2729 | WHERE id IN ( $groupIDs ) | |
2730 | AND ( saved_search_id != 0 | |
2731 | OR saved_search_id IS NOT NULL | |
2732 | OR children IS NOT NULL ) | |
2733 | "; | |
2734 | $group = CRM_Core_DAO::executeQuery($sql); | |
2735 | $ssWhere = array(); | |
2736 | while ($group->fetch()) { | |
2737 | if ($tableAlias == NULL) { | |
2738 | $alias = "`civicrm_group_contact_cache_{$group->id}`"; | |
2739 | } | |
2740 | else { | |
2741 | $alias = $tableAlias; | |
2742 | } | |
2743 | ||
2744 | $this->_useDistinct = TRUE; | |
2745 | ||
2746 | if (!$this->_smartGroupCache || $group->cache_date == NULL) { | |
2747 | CRM_Contact_BAO_GroupContactCache::load($group); | |
2748 | } | |
2749 | ||
2750 | $this->_tables[$alias] = $this->_whereTables[$alias] = " LEFT JOIN civicrm_group_contact_cache {$alias} ON {$joinTable}.id = {$alias}.contact_id "; | |
2751 | $ssWhere[] = "{$alias}.group_id = {$group->id}"; | |
2752 | } | |
2753 | ||
2754 | if (!empty($ssWhere)) { | |
2755 | return implode(' OR ', $ssWhere); | |
2756 | } | |
2757 | return NULL; | |
2758 | } | |
2759 | ||
2760 | /** | |
2761 | * where / qill clause for cms users | |
2762 | * | |
2763 | * @return void | |
2764 | * @access public | |
2765 | */ | |
2766 | function ufUser(&$values) { | |
2767 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
2768 | ||
2769 | if ($value == 1) { | |
2770 | $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id '; | |
2771 | ||
2772 | $this->_qill[$grouping][] = ts('CMS User'); | |
2773 | } | |
2774 | elseif ($value == 0) { | |
2775 | $this->_tables['civicrm_uf_match'] = $this->_whereTables['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id '; | |
2776 | ||
2777 | $this->_where[$grouping][] = " civicrm_uf_match.contact_id IS NULL"; | |
2778 | $this->_qill[$grouping][] = ts('Not a CMS User'); | |
2779 | } | |
2780 | } | |
2781 | ||
2782 | /** | |
2783 | * all tag search specific | |
2784 | * | |
2785 | * @return void | |
2786 | * @access public | |
2787 | */ | |
2788 | function tagSearch(&$values) { | |
2789 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
2790 | ||
2791 | $op = "LIKE"; | |
2792 | $value = "%{$value}%"; | |
2793 | ||
2794 | ||
2795 | $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping); | |
2796 | $tagTypesText = $this->getWhereValues('tag_types_text', $grouping); | |
2797 | ||
2798 | $etTable = "`civicrm_entity_tag-" . $value . "`"; | |
2799 | $tTable = "`civicrm_tag-" . $value . "`"; | |
2800 | ||
2801 | if ($useAllTagTypes[2]) { | |
2802 | $this->_tables[$etTable] = | |
2803 | $this->_whereTables[$etTable] = | |
2804 | " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id) | |
2805 | LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id )"; | |
2806 | ||
2807 | // search tag in cases | |
2808 | $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`"; | |
2809 | $tCaseTable = "`civicrm_case_tag-" . $value . "`"; | |
2810 | $this->_tables[$etCaseTable] = | |
2811 | $this->_whereTables[$etCaseTable] = | |
2812 | " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id | |
2813 | LEFT JOIN civicrm_case | |
2814 | ON (civicrm_case_contact.case_id = civicrm_case.id | |
2815 | AND civicrm_case.is_deleted = 0 ) | |
2816 | LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) | |
2817 | LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id )"; | |
2818 | // search tag in activities | |
2819 | $etActTable = "`civicrm_entity_act_tag-" . $value . "`"; | |
2820 | $tActTable = "`civicrm_act_tag-" . $value . "`"; | |
e7e657f0 | 2821 | $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name'); |
9e74e3ce | 2822 | $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts); |
1071730c | 2823 | |
6a488035 TO |
2824 | $this->_tables[$etActTable] = |
2825 | $this->_whereTables[$etActTable] = | |
91da6cd5 | 2826 | " LEFT JOIN civicrm_activity_contact |
9e74e3ce | 2827 | ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} ) |
6a488035 | 2828 | LEFT JOIN civicrm_activity |
91da6cd5 | 2829 | ON ( civicrm_activity.id = civicrm_activity_contact.activity_id |
6a488035 TO |
2830 | AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 ) |
2831 | LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) | |
2832 | LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id )"; | |
2833 | ||
2834 | $this->_where[$grouping][] = "({$tTable}.name $op '". $value . "' OR {$tCaseTable}.name $op '". $value . "' OR {$tActTable}.name $op '". $value . "')"; | |
10a5be27 | 2835 | $this->_qill[$grouping][] = ts('Tag %1 %2 ', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value; |
6a488035 TO |
2836 | } else { |
2837 | $etTable = "`civicrm_entity_tag-" . $value . "`"; | |
2838 | $tTable = "`civicrm_tag-" . $value . "`"; | |
2839 | $this->_tables[$etTable] = $this->_whereTables[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND | |
2840 | {$etTable}.entity_table = 'civicrm_contact' ) | |
2841 | LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id ) "; | |
2842 | ||
2843 | $this->_where[$grouping][] = self::buildClause("{$tTable}.name", $op, $value, 'String'); | |
2844 | $this->_qill[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value; | |
2845 | } | |
2846 | } | |
2847 | ||
2848 | /** | |
2849 | * where / qill clause for tag | |
2850 | * | |
2851 | * @return void | |
2852 | * @access public | |
2853 | */ | |
2854 | function tag(&$values) { | |
2855 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
2856 | ||
cd43c5e3 | 2857 | $tagNames = CRM_Core_PseudoConstant::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE)); |
6a488035 TO |
2858 | if (is_array($value)) { |
2859 | if (count($value) > 1) { | |
2860 | $this->_useDistinct = TRUE; | |
2861 | } | |
2862 | foreach ($value as $id => $dontCare) { | |
2863 | $names[] = CRM_Utils_Array::value($id, $tagNames); | |
2864 | } | |
2865 | $names = implode(' ' . ts('or') . ' ', $names); | |
2866 | $value = implode(',', array_keys($value)); | |
2867 | } | |
2868 | else { | |
2869 | $names = CRM_Utils_Array::value($value, $tagNames); | |
2870 | } | |
2871 | ||
2872 | ||
2873 | $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping); | |
2874 | $tagTypesText = $this->getWhereValues('tag_types_text', $grouping); | |
2875 | ||
2876 | $etTable = "`civicrm_entity_tag-" . $value . "`"; | |
2877 | ||
2878 | if ($useAllTagTypes[2]) { | |
2879 | $this->_tables[$etTable] = | |
2880 | $this->_whereTables[$etTable] = | |
2881 | " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') "; | |
2882 | ||
2883 | // search tag in cases | |
2884 | $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`"; | |
e7e657f0 | 2885 | $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name'); |
9e74e3ce | 2886 | $targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts); |
2887 | ||
6a488035 TO |
2888 | $this->_tables[$etCaseTable] = |
2889 | $this->_whereTables[$etCaseTable] = | |
2890 | " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id | |
2891 | LEFT JOIN civicrm_case | |
2892 | ON (civicrm_case_contact.case_id = civicrm_case.id | |
2893 | AND civicrm_case.is_deleted = 0 ) | |
2894 | LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) "; | |
2895 | // search tag in activities | |
2896 | $etActTable = "`civicrm_entity_act_tag-" . $value . "`"; | |
2897 | $this->_tables[$etActTable] = | |
2898 | $this->_whereTables[$etActTable] = | |
91da6cd5 | 2899 | " LEFT JOIN civicrm_activity_contact |
9e74e3ce | 2900 | ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} ) |
6a488035 | 2901 | LEFT JOIN civicrm_activity |
91da6cd5 | 2902 | ON ( civicrm_activity.id = civicrm_activity_contact.activity_id |
6a488035 TO |
2903 | AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 ) |
2904 | LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) "; | |
2905 | ||
2906 | // CRM-10338 | |
2907 | if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) { | |
2908 | $this->_where[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)"; | |
2909 | } | |
2910 | else { | |
2911 | $this->_where[$grouping][] = "({$etTable}.tag_id $op (". $value . ") OR {$etCaseTable}.tag_id $op (". $value . ") OR {$etActTable}.tag_id $op (". $value . "))"; | |
2912 | } | |
10a5be27 | 2913 | $this->_qill[$grouping][] = ts('Tag %1 %2', array(1 => $op, 2 => $tagTypesText[2])) . ' ' . $names; |
6a488035 TO |
2914 | } else { |
2915 | $this->_tables[$etTable] = | |
2916 | $this->_whereTables[$etTable] = | |
2917 | " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') "; | |
2918 | ||
2919 | // CRM-10338 | |
2920 | if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) { | |
2921 | // this converts IS (NOT)? EMPTY to IS (NOT)? NULL | |
2922 | $op = str_replace('EMPTY', 'NULL', $op); | |
2923 | $this->_where[$grouping][] = "{$etTable}.tag_id $op"; | |
2924 | } | |
2925 | else { | |
2926 | $this->_where[$grouping][] = "{$etTable}.tag_id $op (" . $value . ')'; | |
2927 | } | |
2928 | $this->_qill[$grouping][] = ts('Tagged %1', array( 1 => $op)) . ' ' . $names; | |
2929 | } | |
2930 | ||
2931 | } | |
2932 | ||
2933 | /** | |
2934 | * where/qill clause for notes | |
2935 | * | |
2936 | * @return void | |
2937 | * @access public | |
2938 | */ | |
2939 | function notes(&$values) { | |
2940 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
2941 | ||
2942 | $noteOptionValues = $this->getWhereValues('note_option', $grouping); | |
2943 | $noteOption = CRM_Utils_Array::value('2', $noteOptionValues, '6'); | |
2944 | $noteOption = ($name == 'note_body') ? 2 : (($name == 'note_subject') ? 3 : $noteOption); | |
2945 | ||
2946 | $this->_useDistinct = TRUE; | |
2947 | ||
2948 | $this->_tables['civicrm_note'] = | |
2949 | $this->_whereTables['civicrm_note'] = | |
2950 | " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) "; | |
2951 | ||
2952 | $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; | |
2953 | $n = trim($value); | |
2954 | $value = $strtolower(CRM_Core_DAO::escapeString($n)); | |
2955 | if ($wildcard || $op == 'LIKE') { | |
2956 | if (strpos($value, '%') === FALSE) { | |
2957 | $value = "%$value%"; | |
2958 | } | |
2959 | $op = 'LIKE'; | |
2960 | } | |
2961 | elseif ($op == 'IS NULL' || $op == 'IS NOT NULL') { | |
2962 | $value = NULL; | |
2963 | } | |
2964 | ||
2965 | $label = NULL; | |
2966 | $clauses = array(); | |
2967 | if ( $noteOption % 2 == 0 ) { | |
2968 | $clauses[] = self::buildClause('civicrm_note.note', $op, $value, 'String'); | |
2969 | $label = ts('Note: Body Only'); | |
2970 | } | |
2971 | if ( $noteOption % 3 == 0 ) { | |
2972 | $clauses[] = self::buildClause('civicrm_note.subject', $op, $value, 'String'); | |
2973 | $label = $label ? ts('Note: Body and Subject') : ts('Note: Subject Only'); | |
2974 | } | |
2975 | $this->_where[$grouping][] = "( " . implode(' OR ', $clauses) . " )"; | |
2976 | $this->_qill[$grouping][] = $label . " $op - '$n'"; | |
2977 | } | |
2978 | ||
2979 | function nameNullOrEmptyOp($name, $op, $grouping) { | |
2980 | switch ( $op ) { | |
2981 | case 'IS NULL': | |
2982 | case 'IS NOT NULL': | |
2983 | $this->_where[$grouping][] = "contact_a.$name $op"; | |
2984 | $this->_qill[$grouping][] = ts('Name') . ' ' . $op; | |
2985 | return true; | |
2986 | ||
2987 | case 'IS EMPTY': | |
2988 | $this->_where[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')"; | |
2989 | $this->_qill[$grouping][] = ts('Name') . ' ' . $op; | |
2990 | return true; | |
2991 | ||
2992 | case 'IS NOT EMPTY': | |
2993 | $this->_where[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')"; | |
2994 | $this->_qill[$grouping][] = ts('Name') . ' ' . $op; | |
2995 | return true; | |
2996 | ||
2997 | default: | |
2998 | return false; | |
2999 | } | |
3000 | } | |
3001 | ||
3002 | /** | |
3003 | * where / qill clause for sort_name | |
3004 | * | |
3005 | * @return void | |
3006 | * @access public | |
3007 | */ | |
3008 | function sortName(&$values) { | |
3009 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3010 | ||
3011 | // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY | |
3012 | if ( $this->nameNullOrEmptyOp( $name, $op, $grouping ) ) { | |
3013 | return; | |
3014 | } | |
3015 | ||
3016 | $newName = $name; | |
3017 | $name = trim($value); | |
3018 | ||
3019 | if (empty($name)) { | |
3020 | return; | |
3021 | } | |
3022 | ||
3023 | $config = CRM_Core_Config::singleton(); | |
3024 | ||
3025 | $sub = array(); | |
3026 | ||
3027 | //By default, $sub elements should be joined together with OR statements (don't change this variable). | |
3028 | $subGlue = ' OR '; | |
3029 | ||
3030 | $strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower'; | |
d9ab802d | 3031 | $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
6a488035 TO |
3032 | |
3033 | if (substr($name, 0, 1) == '"' && | |
3034 | substr($name, -1, 1) == '"' | |
3035 | ) { | |
3036 | //If name is encased in double quotes, the value should be taken to be the string in entirety and the | |
3037 | $value = substr($name, 1, -1); | |
3038 | $value = $strtolower(CRM_Core_DAO::escapeString($value)); | |
3039 | $wc = ($newName == 'sort_name') ? 'LOWER(contact_a.sort_name)' : 'LOWER(contact_a.display_name)'; | |
3040 | $sub[] = " ( $wc = '$value' ) "; | |
3041 | if ($config->includeEmailInName) { | |
3042 | $sub[] = " ( civicrm_email.email = '$value' ) "; | |
3043 | } | |
3044 | } | |
3045 | elseif (strpos($name, ',') !== FALSE) { | |
3046 | // if we have a comma in the string, search for the entire string | |
3047 | $value = $strtolower(CRM_Core_DAO::escapeString($name)); | |
3048 | if ($wildcard) { | |
3049 | if ($config->includeWildCardInName) { | |
3050 | $value = "'%$value%'"; | |
3051 | } | |
3052 | else { | |
3053 | $value = "'$value%'"; | |
3054 | } | |
3055 | $op = 'LIKE'; | |
3056 | } | |
3057 | else { | |
3058 | $value = "'$value'"; | |
3059 | } | |
3060 | if ($newName == 'sort_name') { | |
3061 | $wc = self::caseImportant($op) ? "LOWER(contact_a.sort_name)" : "contact_a.sort_name"; | |
3062 | } | |
3063 | else { | |
3064 | $wc = self::caseImportant($op) ? "LOWER(contact_a.display_name)" : "contact_a.display_name"; | |
3065 | } | |
3066 | $sub[] = " ( $wc $op $value )"; | |
3067 | if ($config->includeNickNameInName) { | |
3068 | $wc = self::caseImportant($op) ? "LOWER(contact_a.nick_name)" : "contact_a.nick_name"; | |
3069 | $sub[] = " ( $wc $op $value )"; | |
3070 | } | |
3071 | if ($config->includeEmailInName) { | |
3072 | $sub[] = " ( civicrm_email.email $op $value ) "; | |
3073 | } | |
3074 | } | |
3075 | else { | |
3076 | // the string should be treated as a series of keywords to be matched with match ANY OR | |
3077 | // match ALL depending on Civi config settings (see CiviAdmin) | |
3078 | ||
3079 | // The Civi configuration setting can be overridden if the string *starts* with the case | |
3080 | // insenstive strings 'AND:' or 'OR:'TO THINK ABOUT: what happens when someone searches | |
3081 | // for the following "AND: 'a string in quotes'"? - probably nothing - it would make the | |
3082 | // AND OR variable reduntant because there is only one search string? | |
3083 | ||
3084 | // Check to see if the $subGlue is overridden in the search text | |
3085 | if (strtolower(substr($name, 0, 4)) == 'and:') { | |
3086 | $name = substr($name, 4); | |
3087 | $subGlue = ' AND '; | |
3088 | } | |
3089 | if (strtolower(substr($name, 0, 3)) == 'or:') { | |
3090 | $name = substr($name, 3); | |
3091 | $subGlue = ' OR '; | |
3092 | } | |
3093 | ||
3094 | $firstChar = substr($name, 0, 1); | |
3095 | $lastChar = substr($name, -1, 1); | |
3096 | $quotes = array("'", '"'); | |
3097 | if ((strlen($name) > 2) && in_array($firstChar, $quotes) && | |
3098 | in_array($lastChar, $quotes) | |
3099 | ) { | |
3100 | $name = substr($name, 1); | |
3101 | $name = substr($name, 0, -1); | |
3102 | $pieces = array($name); | |
3103 | } | |
3104 | else { | |
3105 | $pieces = explode(' ', $name); | |
3106 | } | |
3107 | foreach ($pieces as $piece) { | |
3108 | $value = $strtolower(CRM_Core_DAO::escapeString(trim($piece))); | |
3109 | if (strlen($value)) { | |
3110 | // Added If as a sanitization - without it, when you do an OR search, any string with | |
3111 | // double spaces (i.e. " ") or that has a space after the keyword (e.g. "OR: ") will | |
3112 | // return all contacts because it will include a condition similar to "OR contact | |
3113 | // name LIKE '%'". It might be better to replace this with array_filter. | |
3114 | $fieldsub = array(); | |
3115 | if ($wildcard) { | |
3116 | if ($config->includeWildCardInName) { | |
3117 | $value = "'%$value%'"; | |
3118 | } | |
3119 | else { | |
3120 | $value = "'$value%'"; | |
3121 | } | |
3122 | $op = 'LIKE'; | |
3123 | } | |
3124 | else { | |
3125 | $value = "'$value'"; | |
3126 | } | |
3127 | if ($newName == 'sort_name') { | |
3128 | $wc = self::caseImportant($op) ? "LOWER(contact_a.sort_name)" : "contact_a.sort_name"; | |
3129 | } | |
3130 | else { | |
3131 | $wc = self::caseImportant($op) ? "LOWER(contact_a.display_name)" : "contact_a.display_name"; | |
3132 | } | |
3133 | $fieldsub[] = " ( $wc $op $value )"; | |
3134 | if ($config->includeNickNameInName) { | |
3135 | $wc = self::caseImportant($op) ? "LOWER(contact_a.nick_name)" : "contact_a.nick_name"; | |
3136 | $fieldsub[] = " ( $wc $op $value )"; | |
3137 | } | |
3138 | if ($config->includeEmailInName) { | |
3139 | $fieldsub[] = " ( civicrm_email.email $op $value ) "; | |
3140 | } | |
3141 | $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) '; | |
3142 | // I seperated the glueing in two. The first stage should always be OR because we are searching for matches in *ANY* of these fields | |
3143 | } | |
3144 | } | |
3145 | } | |
3146 | ||
3147 | $sub = ' ( ' . implode($subGlue, $sub) . ' ) '; | |
3148 | ||
3149 | $this->_where[$grouping][] = $sub; | |
3150 | if ($config->includeEmailInName) { | |
3151 | $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1; | |
3152 | $this->_qill[$grouping][] = ts('Name or Email ') . "$op - '$name'"; | |
3153 | } | |
3154 | else { | |
3155 | $this->_qill[$grouping][] = ts('Name like') . " - '$name'"; | |
3156 | } | |
3157 | } | |
3158 | ||
3159 | /** | |
3160 | * where / qill clause for email | |
3161 | * | |
3162 | * @return void | |
3163 | * @access public | |
3164 | */ | |
3165 | function email(&$values) { | |
3166 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3167 | ||
3168 | $n = trim($value); | |
3169 | if ($n) { | |
3170 | $config = CRM_Core_Config::singleton(); | |
3171 | ||
3172 | if (substr($n, 0, 1) == '"' && | |
3173 | substr($n, -1, 1) == '"' | |
3174 | ) { | |
3175 | $n = substr($n, 1, -1); | |
3176 | $value = strtolower(CRM_Core_DAO::escapeString($n)); | |
3177 | $value = "'$value'"; | |
3178 | $op = '='; | |
3179 | } | |
3180 | else { | |
3181 | $value = strtolower($n); | |
3182 | if ($wildcard) { | |
3183 | if (strpos($value, '%') === FALSE) { | |
3184 | $value = "%{$value}%"; | |
3185 | } | |
3186 | $op = 'LIKE'; | |
3187 | } | |
3188 | } | |
3189 | $this->_qill[$grouping][] = ts('Email') . " $op '$n'"; | |
3190 | $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, $value, 'String'); | |
3191 | } | |
3192 | else { | |
3193 | $this->_qill[$grouping][] = ts('Email') . " $op "; | |
3194 | $this->_where[$grouping][] = self::buildClause('civicrm_email.email', $op, NULL, 'String'); | |
3195 | } | |
3196 | ||
3197 | $this->_tables['civicrm_email'] = $this->_whereTables['civicrm_email'] = 1; | |
3198 | } | |
3199 | ||
3200 | /** | |
3201 | * where / qill clause for phone number | |
3202 | * | |
3203 | * @return void | |
3204 | * @access public | |
3205 | */ | |
3206 | function phone_numeric(&$values) { | |
3207 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
a195fab2 BS |
3208 | // Strip non-numeric characters; allow wildcards |
3209 | $number = preg_replace('/[^\d%]/', '', $value); | |
6a488035 | 3210 | if ($number) { |
a195fab2 BS |
3211 | if ( strpos($number, '%') === FALSE ) { |
3212 | $number = "%$number%"; | |
3213 | } | |
3214 | ||
6a488035 | 3215 | $this->_qill[$grouping][] = ts('Phone number contains') . " $number"; |
a195fab2 | 3216 | $this->_where[$grouping][] = self::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String'); |
6a488035 TO |
3217 | $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1; |
3218 | } | |
3219 | } | |
3220 | ||
3221 | /** | |
3222 | * where / qill clause for phone type/location | |
3223 | * | |
3224 | * @return void | |
3225 | * @access public | |
3226 | */ | |
3227 | function phone_option_group($values) { | |
3228 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
cbf48754 AS |
3229 | $option = ($name == 'phone_phone_type_id' ? 'phone_type_id' : 'location_type_id'); |
3230 | $options = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Phone', $option); | |
6a488035 TO |
3231 | $optionName = $options[$value]; |
3232 | $this->_qill[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ? ts('type') : ('location')) . " $op $optionName"; | |
3233 | $this->_where[$grouping][] = self::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer'); | |
3234 | $this->_tables['civicrm_phone'] = $this->_whereTables['civicrm_phone'] = 1; | |
3235 | } | |
3236 | ||
3237 | /** | |
3238 | * where / qill clause for street_address | |
3239 | * | |
3240 | * @return void | |
3241 | * @access public | |
3242 | */ | |
3243 | function street_address(&$values) { | |
3244 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3245 | ||
3246 | if (!$op) { | |
3247 | $op = 'LIKE'; | |
3248 | } | |
3249 | ||
3250 | $n = trim($value); | |
3251 | ||
3252 | if ($n) { | |
3253 | $value = strtolower($n); | |
3254 | if (strpos($value, '%') === FALSE) { | |
3255 | // only add wild card if not there | |
3256 | $value = "%{$value}%"; | |
3257 | } | |
3258 | $op = 'LIKE'; | |
3259 | $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String'); | |
3260 | $this->_qill[$grouping][] = ts('Street') . " $op '$n'"; | |
3261 | } | |
3262 | else { | |
3263 | $this->_where[$grouping][] = self::buildClause('civicrm_address.street_address', $op, NULL, 'String'); | |
3264 | $this->_qill[$grouping][] = ts('Street') . " $op "; | |
3265 | } | |
3266 | ||
3267 | $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1; | |
3268 | } | |
3269 | ||
3270 | /** | |
3271 | * where / qill clause for street_unit | |
3272 | * | |
3273 | * @return void | |
3274 | * @access public | |
3275 | */ | |
3276 | function street_number(&$values) { | |
3277 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3278 | ||
3279 | if (!$op) { | |
3280 | $op = '='; | |
3281 | } | |
3282 | ||
3283 | $n = trim($value); | |
3284 | ||
3285 | if (strtolower($n) == 'odd') { | |
3286 | $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )"; | |
3287 | $this->_qill[$grouping][] = ts('Street Number is odd'); | |
3288 | } | |
3289 | elseif (strtolower($n) == 'even') { | |
3290 | $this->_where[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )"; | |
3291 | $this->_qill[$grouping][] = ts('Street Number is even'); | |
3292 | } | |
3293 | else { | |
3294 | $value = strtolower($n); | |
3295 | ||
3296 | $this->_where[$grouping][] = self::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String'); | |
3297 | $this->_qill[$grouping][] = ts('Street Number') . " $op '$n'"; | |
3298 | } | |
3299 | ||
3300 | $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1; | |
3301 | } | |
3302 | ||
3303 | /** | |
3304 | * where / qill clause for sorting by character | |
3305 | * | |
3306 | * @return void | |
3307 | * @access public | |
3308 | */ | |
3309 | function sortByCharacter(&$values) { | |
3310 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3311 | ||
3312 | $name = trim($value); | |
3313 | $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($name)) . "%'"; | |
3314 | $this->_where[$grouping][] = $cond; | |
3315 | $this->_qill[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name)); | |
3316 | } | |
3317 | ||
3318 | /** | |
3319 | * where / qill clause for including contact ids | |
3320 | * | |
3321 | * @return void | |
3322 | * @access public | |
3323 | */ | |
3324 | function includeContactIDs() { | |
3325 | if (!$this->_includeContactIds || empty($this->_params)) { | |
3326 | return; | |
3327 | } | |
3328 | ||
3329 | $contactIds = array(); | |
3330 | foreach ($this->_params as $id => $values) { | |
3331 | if (substr($values[0], 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) { | |
3332 | $contactIds[] = substr($values[0], CRM_Core_Form::CB_PREFIX_LEN); | |
3333 | } | |
3334 | } | |
3335 | if (!empty($contactIds)) { | |
3336 | $this->_where[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) "; | |
3337 | } | |
3338 | } | |
3339 | ||
3340 | /** | |
3341 | * where / qill clause for postal code | |
3342 | * | |
3343 | * @return void | |
3344 | * @access public | |
3345 | */ | |
3346 | function postalCode(&$values) { | |
3347 | // skip if the fields dont have anything to do with postal_code | |
3348 | if (!CRM_Utils_Array::value('postal_code', $this->_fields)) { | |
3349 | return; | |
3350 | } | |
3351 | ||
3352 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3353 | ||
3354 | // Handle numeric postal code range searches properly by casting the column as numeric | |
3355 | if (is_numeric($value)) { | |
3356 | $field = 'ROUND(civicrm_address.postal_code)'; | |
3357 | $val = CRM_Utils_Type::escape($value, 'Integer'); | |
3358 | } | |
3359 | else { | |
3360 | $field = 'civicrm_address.postal_code'; | |
3361 | $val = CRM_Utils_Type::escape($value, 'String'); | |
3362 | } | |
3363 | ||
3364 | $this->_tables['civicrm_address'] = $this->_whereTables['civicrm_address'] = 1; | |
3365 | ||
3366 | if ($name == 'postal_code') { | |
3367 | $this->_where[$grouping][] = self::buildClause($field, $op, $val, 'String'); | |
3368 | $this->_qill[$grouping][] = ts('Postal code') . " {$op} {$value}"; | |
3369 | } | |
3370 | elseif ($name == 'postal_code_low') { | |
3371 | $this->_where[$grouping][] = " ( $field >= '$val' ) "; | |
3372 | $this->_qill[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value)); | |
3373 | } | |
3374 | elseif ($name == 'postal_code_high') { | |
3375 | $this->_where[$grouping][] = " ( $field <= '$val' ) "; | |
3376 | $this->_qill[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value)); | |
3377 | } | |
3378 | } | |
3379 | ||
3380 | /** | |
3381 | * where / qill clause for location type | |
3382 | * | |
3383 | * @return void | |
3384 | * @access public | |
3385 | */ | |
3386 | function locationType(&$values, $status = NULL) { | |
3387 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3388 | ||
3389 | if (is_array($value)) { | |
3390 | $this->_where[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', array_keys($value)) . ')'; | |
3391 | $this->_tables['civicrm_address'] = 1; | |
3392 | $this->_whereTables['civicrm_address'] = 1; | |
3393 | ||
b2b0530a | 3394 | $locationType = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
6a488035 TO |
3395 | $names = array(); |
3396 | foreach (array_keys($value) as $id) { | |
3397 | $names[] = $locationType[$id]; | |
3398 | } | |
3399 | ||
3400 | $this->_primaryLocation = FALSE; | |
3401 | ||
3402 | if (!$status) { | |
3403 | $this->_qill[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names); | |
3404 | } | |
3405 | else { | |
3406 | return implode(' ' . ts('or') . ' ', $names); | |
3407 | } | |
3408 | } | |
3409 | } | |
3410 | ||
3411 | function country(&$values, $fromStateProvince = TRUE) { | |
3412 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3413 | ||
3414 | if (!$fromStateProvince) { | |
3415 | $stateValues = $this->getWhereValues('state_province', $grouping); | |
3416 | if (!empty($stateValues)) { | |
3417 | // return back to caller if there are state province values | |
3418 | // since that handles this case | |
3419 | return; | |
3420 | } | |
3421 | } | |
3422 | ||
3423 | $countryClause = $countryQill = NULL; | |
3424 | if ( | |
3425 | $values && | |
3426 | !empty($value) | |
3427 | ) { | |
d9ab802d PJ |
3428 | |
3429 | $this->_tables['civicrm_address'] = 1; | |
3430 | $this->_whereTables['civicrm_address'] = 1; | |
6a488035 TO |
3431 | |
3432 | $countries = CRM_Core_PseudoConstant::country(); | |
3433 | if (is_numeric($value)) { | |
3434 | $countryClause = self::buildClause( | |
d9ab802d | 3435 | 'civicrm_address.country_id', |
6a488035 TO |
3436 | $op, |
3437 | $value, | |
3438 | 'Positive' | |
3439 | ); | |
3440 | $countryName = $countries[(int ) $value]; | |
3441 | } | |
3442 | ||
3443 | else { | |
3444 | $intValues = self::parseSearchBuilderString($value); | |
3445 | if ($intValues && ($op == 'IN' || $op == 'NOT IN')) { | |
3446 | $countryClause = self::buildClause( | |
d9ab802d | 3447 | 'civicrm_address.country_id', |
6a488035 TO |
3448 | $op, |
3449 | $intValues, | |
3450 | 'Positive' | |
3451 | ); | |
3452 | $countryNames = array(); | |
3453 | foreach ($intValues as $v) { | |
3454 | $countryNames[] = $countries[$v]; | |
3455 | } | |
3456 | $countryName = implode(',', $countryNames); | |
3457 | } | |
3458 | else { | |
d9ab802d PJ |
3459 | $countries = CRM_Core_PseudoConstant::country(); |
3460 | $intVal = CRM_Utils_Array::key($value, $countries); | |
6a488035 | 3461 | $countryClause = self::buildClause( |
d9ab802d | 3462 | 'civicrm_address.country_id', |
6a488035 | 3463 | $op, |
d9ab802d PJ |
3464 | $intVal, |
3465 | 'Integer' | |
6a488035 TO |
3466 | ); |
3467 | $countryName = $value; | |
3468 | } | |
3469 | } | |
3470 | $countryQill = ts('Country') . " {$op} '$countryName'"; | |
3471 | ||
3472 | if (!$fromStateProvince) { | |
3473 | $this->_where[$grouping][] = $countryClause; | |
3474 | $this->_qill[$grouping][] = $countryQill; | |
3475 | } | |
3476 | } | |
3477 | ||
3478 | if ($fromStateProvince) { | |
3479 | if (!empty($countryClause)) { | |
3480 | return array( | |
3481 | $countryClause, | |
3482 | " ...AND... " . $countryQill, | |
3483 | ); | |
3484 | } | |
3485 | else { | |
3486 | return array(NULL, NULL); | |
3487 | } | |
3488 | } | |
3489 | } | |
3490 | ||
3491 | /** | |
3492 | * where / qill clause for county (if present) | |
3493 | * | |
3494 | * @return void | |
3495 | * @access public | |
3496 | */ | |
3497 | function county(&$values, $status = null) { | |
3498 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3499 | ||
3500 | if (! is_array($value)) { | |
3501 | // force the county to be an array | |
3502 | $value = array($value); | |
3503 | } | |
3504 | ||
3505 | // check if the values are ids OR names of the counties | |
3506 | $inputFormat = 'id'; | |
3507 | foreach ($value as $v) { | |
3508 | if (!is_numeric($v)) { | |
3509 | $inputFormat = 'name'; | |
3510 | break; | |
3511 | } | |
3512 | } | |
3513 | $names = array(); | |
d9ab802d PJ |
3514 | if ($op == '=') { |
3515 | $op = 'IN'; | |
3516 | } | |
3517 | else if ($op == '!=') { | |
3518 | $op = 'NOT IN'; | |
3519 | } | |
3520 | else { | |
3521 | // this converts IS (NOT)? EMPTY to IS (NOT)? NULL | |
3522 | $op = str_replace('EMPTY', 'NULL', $op); | |
3523 | } | |
3524 | ||
3525 | if (in_array( $op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) { | |
3526 | $clause = "civicrm_address.county_id $op"; | |
3527 | } | |
3528 | elseif ($inputFormat == 'id') { | |
3529 | $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')'; | |
6a488035 TO |
3530 | |
3531 | $county = CRM_Core_PseudoConstant::county(); | |
3532 | foreach ($value as $id) { | |
3533 | $names[] = CRM_Utils_Array::value($id, $county); | |
3534 | } | |
3535 | } | |
3536 | else { | |
3537 | $inputClause = array(); | |
d9ab802d | 3538 | $county = CRM_Core_PseudoConstant::county(); |
6a488035 TO |
3539 | foreach ($value as $name) { |
3540 | $name = trim($name); | |
d9ab802d | 3541 | $inputClause[] = CRM_Utils_Array::key($name, $county); |
6a488035 | 3542 | } |
d9ab802d | 3543 | $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')'; |
6a488035 TO |
3544 | $names = $value; |
3545 | } | |
d9ab802d PJ |
3546 | $this->_tables['civicrm_address'] = 1; |
3547 | $this->_whereTables['civicrm_address'] = 1; | |
6a488035 TO |
3548 | |
3549 | $this->_where[$grouping][] = $clause; | |
d9ab802d | 3550 | if (!$status) { |
6a488035 TO |
3551 | $this->_qill[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names); |
3552 | } else { | |
3553 | return implode(' ' . ts('or') . ' ', $names); | |
3554 | } | |
3555 | } | |
3556 | ||
3557 | /** | |
3558 | * where / qill clause for state/province AND country (if present) | |
3559 | * | |
3560 | * @return void | |
3561 | * @access public | |
3562 | */ | |
3563 | function stateProvince(&$values, $status = NULL) { | |
3564 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3565 | ||
3566 | // quick escape for IS NULL | |
3567 | if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) { | |
3568 | $value = NULL; | |
3569 | } | |
3570 | else if (!is_array($value)) { | |
3571 | // force the state to be an array | |
3572 | // check if its in the mapper format! | |
3573 | $values = self::parseSearchBuilderString($value); | |
3574 | if (is_array($values)) { | |
3575 | $value = $values; | |
3576 | } | |
3577 | else { | |
3578 | $value = array($value); | |
3579 | } | |
3580 | } | |
3581 | ||
3582 | // check if the values are ids OR names of the states | |
3583 | $inputFormat = 'id'; | |
3584 | if ($value) { | |
3585 | foreach ($value as $v) { | |
3586 | if (!is_numeric($v)) { | |
3587 | $inputFormat = 'name'; | |
3588 | break; | |
3589 | } | |
3590 | } | |
3591 | } | |
3592 | ||
3593 | $names = array(); | |
3594 | if ($op == '=') { | |
3595 | $op = 'IN'; | |
3596 | } | |
3597 | else if ($op == '!=') { | |
3598 | $op = 'NOT IN'; | |
3599 | } | |
3600 | else { | |
3601 | // this converts IS (NOT)? EMPTY to IS (NOT)? NULL | |
3602 | $op = str_replace('EMPTY', 'NULL', $op); | |
3603 | } | |
3604 | if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) { | |
d9ab802d | 3605 | $stateClause = "civicrm_address.state_province_id $op"; |
6a488035 TO |
3606 | } |
3607 | else if ($inputFormat == 'id') { | |
3608 | if ($op != 'NOT IN') { | |
3609 | $op = 'IN'; | |
3610 | } | |
d9ab802d | 3611 | $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $value) . ')'; |
6a488035 TO |
3612 | |
3613 | $stateProvince = CRM_Core_PseudoConstant::stateProvince(); | |
3614 | foreach ($value as $id) { | |
3615 | $names[] = CRM_Utils_Array::value($id, $stateProvince); | |
3616 | } | |
3617 | } | |
3618 | else { | |
3619 | $inputClause = array(); | |
d9ab802d | 3620 | $stateProvince = CRM_Core_PseudoConstant::stateProvince(); |
6a488035 TO |
3621 | foreach ($value as $name) { |
3622 | $name = trim($name); | |
d9ab802d | 3623 | $inputClause[] = CRM_Utils_Array::key($name, $stateProvince); |
6a488035 | 3624 | } |
d9ab802d | 3625 | $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $inputClause) . ')'; |
6a488035 TO |
3626 | $names = $value; |
3627 | } | |
d9ab802d PJ |
3628 | $this->_tables['civicrm_address'] = 1; |
3629 | $this->_whereTables['civicrm_address'] = 1; | |
6a488035 TO |
3630 | |
3631 | $countryValues = $this->getWhereValues('country', $grouping); | |
3632 | list($countryClause, $countryQill) = $this->country($countryValues, TRUE); | |
3633 | ||
3634 | if ($countryClause) { | |
3635 | $clause = "( $stateClause AND $countryClause )"; | |
3636 | } | |
3637 | else { | |
3638 | $clause = $stateClause; | |
3639 | } | |
3640 | ||
3641 | $this->_where[$grouping][] = $clause; | |
3642 | if (!$status) { | |
3643 | $this->_qill[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill; | |
3644 | } | |
3645 | else { | |
9fd71915 | 3646 | return implode(' ' . ts('or') . ' ', $names) . $countryQill; |
6a488035 TO |
3647 | } |
3648 | } | |
3649 | ||
3650 | /** | |
3651 | * where / qill clause for change log | |
3652 | * | |
3653 | * @return void | |
3654 | * @access public | |
3655 | */ | |
3656 | function changeLog(&$values) { | |
3657 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3658 | ||
3659 | $targetName = $this->getWhereValues('changed_by', $grouping); | |
3660 | if (!$targetName) { | |
3661 | return; | |
3662 | } | |
3663 | ||
3664 | $name = trim($targetName[2]); | |
3665 | $name = strtolower(CRM_Core_DAO::escapeString($name)); | |
3666 | $name = $targetName[4] ? "%$name%" : $name; | |
3667 | $this->_where[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'"; | |
3668 | $this->_tables['civicrm_log'] = $this->_whereTables['civicrm_log'] = 1; | |
f391b06e | 3669 | $this->_qill[$grouping][] = ts('Modified by') . ": $name"; |
6a488035 TO |
3670 | } |
3671 | ||
3672 | function modifiedDates($values) { | |
3673 | $this->_useDistinct = TRUE; | |
9e9b8fdb DL |
3674 | |
3675 | // CRM-11281, default to added date if not set | |
228917cd | 3676 | $fieldTitle = ts('Added Date'); |
06103b23 | 3677 | $fieldName = 'created_date'; |
6a488035 TO |
3678 | foreach (array_keys($this->_params) as $id) { |
3679 | if ($this->_params[$id][0] == 'log_date') { | |
228917cd DL |
3680 | if ($this->_params[$id][2] == 2) { |
3681 | $fieldTitle = ts('Modified Date'); | |
06103b23 | 3682 | $fieldName = 'modified_date'; |
6a488035 TO |
3683 | } |
3684 | } | |
3685 | } | |
3686 | ||
06103b23 | 3687 | |
3688 | $this->dateQueryBuilder($values, 'contact_a', 'log_date', $fieldName, $fieldTitle); | |
3689 | ||
3690 | self::$_openedPanes[ts('Change Log')] = TRUE; | |
6a488035 TO |
3691 | } |
3692 | ||
3693 | function demographics(&$values) { | |
3694 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3695 | ||
3696 | if (($name == 'birth_date_low') || ($name == 'birth_date_high')) { | |
3697 | ||
3698 | $this->dateQueryBuilder($values, | |
3699 | 'contact_a', 'birth_date', 'birth_date', ts('Birth Date') | |
3700 | ); | |
3701 | } | |
3702 | elseif (($name == 'deceased_date_low') || ($name == 'deceased_date_high')) { | |
3703 | ||
3704 | $this->dateQueryBuilder($values, | |
3705 | 'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date') | |
3706 | ); | |
3707 | } | |
3708 | ||
3709 | self::$_openedPanes[ts('Demographics')] = TRUE; | |
3710 | } | |
3711 | ||
3712 | function privacy(&$values) { | |
3713 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3714 | //fixed for profile search listing CRM-4633 | |
3715 | if (strpbrk($value, "[")) { | |
3716 | $value = "'{$value}'"; | |
3717 | $op = "!{$op}"; | |
3718 | $this->_where[$grouping][] = "contact_a.{$name} $op $value"; | |
3719 | } | |
3720 | else { | |
3721 | $this->_where[$grouping][] = "contact_a.{$name} $op $value"; | |
3722 | } | |
3723 | $field = CRM_Utils_Array::value($name, $this->_fields); | |
3724 | $title = $field ? $field['title'] : $name; | |
3725 | $this->_qill[$grouping][] = "$title $op $value"; | |
3726 | } | |
3727 | ||
3728 | function privacyOptions($values) { | |
3729 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3730 | ||
9fd71915 CW |
3731 | if (empty($value) || !is_array($value)) { |
3732 | return; | |
6a488035 TO |
3733 | } |
3734 | ||
3735 | // get the operator and toggle values | |
3736 | $opValues = $this->getWhereValues('privacy_operator', $grouping); | |
3737 | $operator = 'OR'; | |
3738 | if ($opValues && | |
3739 | strtolower($opValues[2] == 'AND') | |
3740 | ) { | |
3741 | $operator = 'AND'; | |
3742 | } | |
3743 | ||
3744 | $toggleValues = $this->getWhereValues('privacy_toggle', $grouping); | |
3745 | $compareOP = '!='; | |
3746 | if ($toggleValues && | |
3747 | $toggleValues[2] == 2 | |
3748 | ) { | |
3749 | $compareOP = '='; | |
3750 | } | |
3751 | ||
3752 | $clauses = array(); | |
3753 | $qill = array(); | |
3754 | foreach ($value as $dontCare => $pOption) { | |
3755 | $clauses[] = " ( contact_a.{$pOption} $compareOP 1 ) "; | |
3756 | $field = CRM_Utils_Array::value($pOption, $this->_fields); | |
3757 | $title = $field ? $field['title'] : $pOption; | |
3758 | $qill[] = " $title $compareOP 1 "; | |
3759 | } | |
3760 | ||
3761 | $this->_where[$grouping][] = '( ' . implode($operator, $clauses) . ' )'; | |
3762 | $this->_qill[$grouping][] = implode($operator, $qill); | |
3763 | } | |
3764 | ||
3765 | function preferredCommunication(&$values) { | |
3766 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
3767 | ||
3768 | $pref = array(); | |
4b20f7df PJ |
3769 | if (in_array($op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) { |
3770 | $value = NULL; | |
3771 | } | |
3772 | elseif (!is_array($value)) { | |
6a488035 TO |
3773 | $v = array(); |
3774 | $value = trim($value, ' ()'); | |
3775 | if (strpos($value, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) { | |
3776 | $v = explode(CRM_Core_DAO::VALUE_SEPARATOR, $value); | |
3777 | } | |
3778 | else { | |
3779 | $v = explode(",", $value); | |
3780 | } | |
3781 | ||
3782 | foreach ($v as $item) { | |
3783 | if ($item) { | |
3784 | $pref[] = $item; | |
3785 | } | |
3786 | } | |
3787 | } | |
3788 | else { | |
3789 | foreach ($value as $key => $checked) { | |
3790 | if ($checked) { | |
3791 | $pref[] = $key; | |
3792 | } | |
3793 | } | |
3794 | } | |
3795 | ||
e7e657f0 | 3796 | $commPref = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method'); |
6a488035 TO |
3797 | |
3798 | $sqlValue = array(); | |
4b20f7df | 3799 | $showValue = array(); |
6a488035 | 3800 | $sql = "contact_a.preferred_communication_method"; |
4b20f7df PJ |
3801 | if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) { |
3802 | $sqlValue[] = "{$sql} {$op}"; | |
3803 | } | |
3804 | else { | |
3805 | foreach ($pref as $val) { | |
3806 | $sqlValue[] = "( $sql like '%" . CRM_Core_DAO::VALUE_SEPARATOR . $val . CRM_Core_DAO::VALUE_SEPARATOR . "%' ) "; | |
3807 | $showValue[] = $commPref[$val]; | |
3808 | } | |
6a488035 TO |
3809 | } |
3810 | $this->_where[$grouping][] = "( " . implode(' OR ', $sqlValue) . " )"; | |
3811 | $this->_qill[$grouping][] = ts('Preferred Communication Method') . " $op " . implode(' ' . ts('or') . ' ', $showValue); | |
3812 | } | |
3813 | ||
6a488035 TO |
3814 | /** |
3815 | * where / qill clause for relationship | |
3816 | * | |
3817 | * @return void | |
3818 | * @access public | |
3819 | */ | |
3820 | function relationship(&$values) { | |
3821 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
ad682134 | 3822 | if($this->_relationshipValuesAdded){ |
3823 | return; | |
3824 | } | |
6a488035 TO |
3825 | // also get values array for relation_target_name |
3826 | // for relatinship search we always do wildcard | |
3827 | $targetName = $this->getWhereValues('relation_target_name', $grouping); | |
3828 | $relStatus = $this->getWhereValues('relation_status', $grouping); | |
5ea73a9f | 3829 | $relPermission = $this->getWhereValues('relation_permission', $grouping); |
6a488035 | 3830 | $targetGroup = $this->getWhereValues('relation_target_group', $grouping); |
6a488035 TO |
3831 | |
3832 | $nameClause = $name = NULL; | |
3833 | if ($targetName) { | |
3834 | $name = trim($targetName[2]); | |
3835 | if (substr($name, 0, 1) == '"' && | |
3836 | substr($name, -1, 1) == '"' | |
3837 | ) { | |
3838 | $name = substr($name, 1, -1); | |
3839 | $name = strtolower(CRM_Core_DAO::escapeString($name)); | |
3840 | $nameClause = "= '$name'"; | |
3841 | } | |
3842 | else { | |
3843 | $name = strtolower(CRM_Core_DAO::escapeString($name)); | |
3844 | $nameClause = "LIKE '%{$name}%'"; | |
3845 | } | |
3846 | } | |
3847 | ||
3848 | $rel = explode('_', $value); | |
3849 | ||
3850 | self::$_relType = $rel[1]; | |
ad682134 | 3851 | $params = array('id' => $rel[0]); |
3852 | $rTypeValues = array(); | |
3853 | $rType = CRM_Contact_BAO_RelationshipType::retrieve($params, $rTypeValues); | |
3854 | if ($rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) { | |
7c96365b | 3855 | // if we don't know which end of the relationship we are dealing with we'll create a temp table |
3856 | //@todo unless we are dealing with a target group | |
ad682134 | 3857 | self::$_relType = 'reciprocal'; |
3858 | } | |
7c96365b | 3859 | // if we are creating a temp table we build our own where for the relationship table |
085e6226 | 3860 | $relationshipTempTable = NULL; |
7c96365b | 3861 | if(self::$_relType == 'reciprocal' && empty($targetGroup)) { |
3862 | $where = array(); | |
085e6226 DL |
3863 | self::$_relationshipTempTable = |
3864 | $relationshipTempTable = | |
3865 | CRM_Core_DAO::createTempTableName( 'civicrm_rel'); | |
7c96365b | 3866 | if($nameClause) { |
3867 | $where[$grouping][] = " sort_name $nameClause "; | |
3868 | } | |
6a488035 | 3869 | } |
7c96365b | 3870 | else { |
3871 | $where = &$this->_where; | |
3872 | if ($nameClause) { | |
3873 | $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )"; | |
3874 | } | |
3875 | } | |
3876 | ||
04ffef8d | 3877 | |
6a488035 TO |
3878 | $relTypeInd = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Individual'); |
3879 | $relTypeOrg = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Organization'); | |
3880 | $relTypeHou = CRM_Contact_BAO_Relationship::getContactRelationshipType(NULL, 'null', NULL, 'Household'); | |
3881 | $allRelationshipType = array(); | |
3882 | $allRelationshipType = array_merge($relTypeInd, $relTypeOrg); | |
3883 | $allRelationshipType = array_merge($allRelationshipType, $relTypeHou); | |
3884 | ||
3885 | if ($nameClause || !$targetGroup) { | |
3886 | $this->_qill[$grouping][] = "$allRelationshipType[$value] $name"; | |
3887 | } | |
3888 | ||
3889 | ||
3890 | //check to see if the target contact is in specified group | |
3891 | if ($targetGroup) { | |
3892 | //add contacts from static groups | |
3893 | $this->_tables['civicrm_relationship_group_contact'] = | |
3894 | $this->_whereTables['civicrm_relationship_group_contact'] = | |
085e6226 DL |
3895 | " LEFT JOIN civicrm_group_contact civicrm_relationship_group_contact ON civicrm_relationship_group_contact.contact_id = contact_b.id AND civicrm_relationship_group_contact.status = 'Added'"; |
3896 | $groupWhere[] = | |
3897 | "( civicrm_relationship_group_contact.group_id IN (" . | |
3898 | implode(",", $targetGroup[2]) . ") ) "; | |
6a488035 TO |
3899 | |
3900 | //add contacts from saved searches | |
3901 | $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b"); | |
3902 | ||
3903 | //set the group where clause | |
3904 | if ($ssWhere) { | |
3905 | $groupWhere[] = "( " . $ssWhere . " )"; | |
3906 | } | |
3907 | $this->_where[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )"; | |
3908 | ||
3909 | //Get the names of the target groups for the qill | |
085e6226 | 3910 | $groupNames = CRM_Core_PseudoConstant::group(); |
6a488035 TO |
3911 | $qillNames = array(); |
3912 | foreach ($targetGroup[2] as $groupId) { | |
3913 | if (array_key_exists($groupId, $groupNames)) { | |
3914 | $qillNames[] = $groupNames[$groupId]; | |
3915 | } | |
3916 | } | |
3917 | $this->_qill[$grouping][] = "$allRelationshipType[$value] ( " . implode(", ", $qillNames) . " )"; | |
3918 | } | |
3919 | ||
12ba37a0 CW |
3920 | // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way |
3921 | $today = date('Ymd'); | |
6a488035 TO |
3922 | //check for active, inactive and all relation status |
3923 | if ($relStatus[2] == 0) { | |
7c96365b | 3924 | $where[$grouping][] = "( |
6a488035 | 3925 | civicrm_relationship.is_active = 1 AND |
12ba37a0 CW |
3926 | ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND |
3927 | ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} ) | |
6a488035 TO |
3928 | )"; |
3929 | $this->_qill[$grouping][] = ts('Relationship - Active and Current'); | |
3930 | } | |
3931 | elseif ($relStatus[2] == 1) { | |
7c96365b | 3932 | $where[$grouping][] = "( |
6a488035 | 3933 | civicrm_relationship.is_active = 0 OR |
12ba37a0 CW |
3934 | civicrm_relationship.end_date < {$today} OR |
3935 | civicrm_relationship.start_date > {$today} | |
6a488035 TO |
3936 | )"; |
3937 | $this->_qill[$grouping][] = ts('Relationship - Inactive or not Current'); | |
3938 | } | |
3939 | ||
5ea73a9f DG |
3940 | //check for permissioned, non-permissioned and all permissioned relations |
3941 | if ($relPermission[2] == 1) { | |
3942 | $this->_where[$grouping][] = "( | |
3943 | civicrm_relationship.is_permission_a_b = 1 | |
3944 | )"; | |
3945 | $this->_qill[$grouping][] = ts('Relationship - Permissioned'); | |
3946 | } elseif ($relPermission[2] == 2) { | |
3947 | //non-allowed permission relationship. | |
3948 | $this->_where[$grouping][] = "( | |
3949 | civicrm_relationship.is_permission_a_b = 0 | |
3950 | )"; | |
3951 | $this->_qill[$grouping][] = ts('Relationship - Non-permissioned'); | |
3952 | } | |
3953 | ||
7c96365b | 3954 | $this->addRelationshipDateClauses($grouping, $where); |
ad682134 | 3955 | if(!empty($rType) && isset($rType->id)){ |
7c96365b | 3956 | $where[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rType->id; |
6a488035 | 3957 | } |
6a488035 TO |
3958 | $this->_tables['civicrm_relationship'] = $this->_whereTables['civicrm_relationship'] = 1; |
3959 | $this->_useDistinct = TRUE; | |
ad682134 | 3960 | $this->_relationshipValuesAdded = TRUE; |
7c96365b | 3961 | // it could be a or b, using an OR creates an unindexed join - better to create a temp table & |
3962 | // join on that, | |
3963 | // @todo creating a temp table could be expanded to group filter | |
3964 | // as even creating a temp table of all relationships is much much more efficient than | |
3965 | // an OR in the join | |
3966 | if($relationshipTempTable) { | |
3967 | $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]); | |
3968 | $sql = " | |
3969 | CREATE TEMPORARY TABLE {$relationshipTempTable} | |
3970 | (SELECT contact_id_b as contact_id, civicrm_relationship.id | |
3971 | FROM civicrm_relationship | |
3972 | INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_a = c.id | |
3973 | $whereClause ) | |
3974 | UNION | |
3975 | (SELECT contact_id_a as contact_id, civicrm_relationship.id | |
3976 | FROM civicrm_relationship | |
3977 | INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id | |
3978 | $whereClause ) | |
3979 | "; | |
3980 | CRM_Core_DAO::executeQuery($sql); | |
3981 | } | |
3982 | ||
6a488035 | 3983 | } |
ad682134 | 3984 | /** |
3985 | * Add start & end date criteria in | |
3986 | * @param string $grouping | |
7c96365b | 3987 | * @param array $where = array to add where clauses to, in case you are generating a temp table |
3988 | * not the main query. | |
ad682134 | 3989 | */ |
7c96365b | 3990 | function addRelationshipDateClauses($grouping, &$where){ |
ad682134 | 3991 | $dateValues = array(); |
3992 | $dateTypes = array( | |
3993 | 'start_date', | |
3994 | 'end_date', | |
3995 | ); | |
6a488035 | 3996 | |
ad682134 | 3997 | foreach ($dateTypes as $dateField){ |
3998 | $dateValueLow = $this->getWhereValues('relation_'. $dateField .'_low', $grouping); | |
3999 | $dateValueHigh= $this->getWhereValues('relation_'. $dateField .'_high', $grouping); | |
4000 | if(!empty($dateValueLow)){ | |
4001 | $date = date('Ymd', strtotime($dateValueLow[2])); | |
7c96365b | 4002 | $where[$grouping][] = "civicrm_relationship.$dateField >= $date"; |
ad682134 | 4003 | $this->_qill[$grouping][] = ($dateField == 'end_date' ? ts('Relationship Ended on or After') : ts('Relationship Recorded Start Date On or Before')) . " " . CRM_Utils_Date::customFormat($date); |
4004 | } | |
4005 | if(!empty($dateValueHigh)){ | |
4006 | $date = date('Ymd', strtotime($dateValueHigh[2])); | |
7c96365b | 4007 | $where[$grouping][] = "civicrm_relationship.$dateField <= $date"; |
ad682134 | 4008 | $this->_qill[$grouping][] = ( $dateField == 'end_date' ? ts('Relationship Ended on or Before') : ts('Relationship Recorded Start Date On or After')) . " " . CRM_Utils_Date::customFormat($date); |
4009 | } | |
4010 | } | |
4011 | } | |
6a488035 TO |
4012 | /** |
4013 | * default set of return properties | |
4014 | * | |
4015 | * @return void | |
4016 | * @access public | |
4017 | */ | |
4018 | static function &defaultReturnProperties($mode = 1) { | |
4019 | if (!isset(self::$_defaultReturnProperties)) { | |
4020 | self::$_defaultReturnProperties = array(); | |
4021 | } | |
4022 | ||
4023 | if (!isset(self::$_defaultReturnProperties[$mode])) { | |
4024 | // add activity return properties | |
4025 | if ($mode & CRM_Contact_BAO_Query::MODE_ACTIVITY) { | |
4026 | self::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query::defaultReturnProperties($mode, FALSE); | |
4027 | } | |
4028 | else { | |
4029 | self::$_defaultReturnProperties[$mode] = CRM_Core_Component::defaultReturnProperties($mode, FALSE); | |
4030 | } | |
4031 | ||
4032 | if (empty(self::$_defaultReturnProperties[$mode])) { | |
4033 | self::$_defaultReturnProperties[$mode] = array( | |
4034 | 'home_URL' => 1, | |
4035 | 'image_URL' => 1, | |
4036 | 'legal_identifier' => 1, | |
4037 | 'external_identifier' => 1, | |
4038 | 'contact_type' => 1, | |
4039 | 'contact_sub_type' => 1, | |
4040 | 'sort_name' => 1, | |
4041 | 'display_name' => 1, | |
4042 | 'preferred_mail_format' => 1, | |
4043 | 'nick_name' => 1, | |
4044 | 'first_name' => 1, | |
4045 | 'middle_name' => 1, | |
4046 | 'last_name' => 1, | |
04ffef8d CW |
4047 | 'prefix_id' => 1, |
4048 | 'suffix_id' => 1, | |
6a488035 | 4049 | 'birth_date' => 1, |
04ffef8d | 4050 | 'gender_id' => 1, |
6a488035 TO |
4051 | 'street_address' => 1, |
4052 | 'supplemental_address_1' => 1, | |
4053 | 'supplemental_address_2' => 1, | |
4054 | 'city' => 1, | |
4055 | 'postal_code' => 1, | |
4056 | 'postal_code_suffix' => 1, | |
4057 | 'state_province' => 1, | |
4058 | 'country' => 1, | |
4059 | 'world_region' => 1, | |
4060 | 'geo_code_1' => 1, | |
4061 | 'geo_code_2' => 1, | |
4062 | 'email' => 1, | |
4063 | 'on_hold' => 1, | |
4064 | 'phone' => 1, | |
4065 | 'im' => 1, | |
4066 | 'household_name' => 1, | |
4067 | 'organization_name' => 1, | |
4068 | 'deceased_date' => 1, | |
4069 | 'is_deceased' => 1, | |
4070 | 'job_title' => 1, | |
4071 | 'legal_name' => 1, | |
4072 | 'sic_code' => 1, | |
4073 | 'current_employer' => 1, | |
4074 | // FIXME: should we use defaultHierReturnProperties() for the below? | |
4075 | 'do_not_email' => 1, | |
4076 | 'do_not_mail' => 1, | |
4077 | 'do_not_sms' => 1, | |
4078 | 'do_not_phone' => 1, | |
4079 | 'do_not_trade' => 1, | |
4080 | 'is_opt_out' => 1, | |
4081 | 'contact_is_deleted' => 1, | |
b725488f CW |
4082 | 'preferred_communication_method' => 1, |
4083 | 'preferred_language' => 1, | |
6a488035 TO |
4084 | ); |
4085 | } | |
4086 | } | |
4087 | return self::$_defaultReturnProperties[$mode]; | |
4088 | } | |
4089 | ||
4090 | /** | |
4091 | * get primary condition for a sql clause | |
4092 | * | |
4093 | * @param int $value | |
4094 | * | |
4095 | * @return void | |
4096 | * @access public | |
4097 | */ | |
4098 | static function getPrimaryCondition($value) { | |
4099 | if (is_numeric($value)) { | |
4100 | $value = (int ) $value; | |
4101 | return ($value == 1) ? 'is_primary = 1' : 'is_primary = 0'; | |
4102 | } | |
4103 | return NULL; | |
4104 | } | |
4105 | ||
4106 | /** | |
4107 | * wrapper for a simple search query | |
4108 | * | |
4109 | * @param array $params | |
4110 | * @param array $returnProperties | |
837c4660 | 4111 | * @param \bolean|bool $count |
6a488035 TO |
4112 | * |
4113 | * @return void | |
4114 | * @access public | |
4115 | */ | |
4116 | static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) { | |
4117 | $query = new CRM_Contact_BAO_Query($params, $returnProperties); | |
4118 | list($select, $from, $where, $having) = $query->query(); | |
4119 | ||
4120 | return "$select $from $where $having"; | |
4121 | } | |
4122 | ||
4123 | /** | |
4124 | * These are stub comments as this function needs more explanation - particularly in terms of how it | |
4125 | * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery. | |
4126 | * | |
4127 | * This function was originally written as a wrapper for the api query but is called from multiple places | |
4128 | * in the core code directly so the name is misleading. This function does not use the searchQuery function | |
4129 | * but it is unclear as to whehter that is historical or there is a reason | |
4130 | * CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function | |
4131 | * | |
837c4660 E |
4132 | * @param array $params |
4133 | * @param array $returnProperties | |
4134 | * @param null $fields | |
6a488035 | 4135 | * @param string $sort |
837c4660 E |
4136 | * @param int $offset |
4137 | * @param int $row_count | |
4138 | * @param bool $smartGroupCache | |
6a488035 TO |
4139 | * @param bool $count return count obnly |
4140 | * @param bool $skipPermissions Should permissions be ignored or should the logged in user's permissions be applied | |
4141 | * | |
837c4660 E |
4142 | * @params bool $smartGroupCache ?? update smart group cache? |
4143 | * | |
b725488f | 4144 | * @return array |
6a488035 TO |
4145 | * @access public |
4146 | */ | |
4147 | static function apiQuery( | |
4148 | $params = NULL, | |
4149 | $returnProperties = NULL, | |
4150 | $fields = NULL, | |
4151 | $sort = NULL, | |
4152 | $offset = 0, | |
4153 | $row_count = 25, | |
4154 | $smartGroupCache = TRUE, | |
4155 | $count = FALSE, | |
d9ab802d | 4156 | $skipPermissions = TRUE |
6a488035 TO |
4157 | ) { |
4158 | ||
4159 | $query = new CRM_Contact_BAO_Query( | |
4160 | $params, $returnProperties, | |
4161 | NULL, TRUE, FALSE, 1, | |
4162 | $skipPermissions, | |
4163 | TRUE, $smartGroupCache | |
4164 | ); | |
4165 | ||
4166 | //this should add a check for view deleted if permissions are enabled | |
4167 | if ($skipPermissions){ | |
4168 | $query->_skipDeleteClause = TRUE; | |
4169 | } | |
4170 | $query->generatePermissionClause(FALSE, $count); | |
d9ab802d PJ |
4171 | |
4172 | // note : this modifies _fromClause and _simpleFromClause | |
4173 | $query->includePseudoFieldsJoin($sort); | |
4174 | ||
6a488035 TO |
4175 | list($select, $from, $where, $having) = $query->query($count); |
4176 | ||
4177 | $options = $query->_options; | |
4178 | if(!empty($query->_permissionWhereClause)){ | |
4179 | if (empty($where)) { | |
4180 | $where = "WHERE $query->_permissionWhereClause"; | |
4181 | } | |
4182 | else { | |
4183 | $where = "$where AND $query->_permissionWhereClause"; | |
4184 | } | |
4185 | } | |
4186 | ||
4187 | $sql = "$select $from $where $having"; | |
4188 | ||
4189 | // add group by | |
4190 | if ($query->_useGroupBy) { | |
4191 | $sql .= ' GROUP BY contact_a.id'; | |
4192 | } | |
4193 | if (!empty($sort)) { | |
bd9a3dd5 | 4194 | $sort = CRM_Utils_Type::escape($sort, 'String'); |
6a488035 TO |
4195 | $sql .= " ORDER BY $sort "; |
4196 | } | |
4197 | if ($row_count > 0 && $offset >= 0) { | |
bf00d1b6 | 4198 | $offset = CRM_Utils_Type::escape($offset, 'Int'); |
c95d144e | 4199 | $rowCount = CRM_Utils_Type::escape($row_count, 'Int'); |
6a488035 TO |
4200 | $sql .= " LIMIT $offset, $row_count "; |
4201 | } | |
4202 | ||
4203 | $dao = CRM_Core_DAO::executeQuery($sql); | |
4204 | ||
4205 | $values = array(); | |
4206 | while ($dao->fetch()) { | |
4207 | if ($count) { | |
4208 | $noRows = $dao->rowCount; | |
4209 | $dao->free(); | |
4210 | return array($noRows,NULL); | |
4211 | } | |
d9ab802d | 4212 | $val = $query->store($dao); |
b719f000 | 4213 | $convertedVals = $query->convertToPseudoNames($dao, TRUE); |
d9ab802d PJ |
4214 | |
4215 | if (!empty($convertedVals)) { | |
e3571aca | 4216 | $val = array_replace_recursive($val, $convertedVals); |
d9ab802d PJ |
4217 | } |
4218 | $values[$dao->contact_id] = $val; | |
6a488035 TO |
4219 | } |
4220 | $dao->free(); | |
4221 | return array($values, $options); | |
4222 | } | |
4223 | ||
4224 | /** | |
4225 | * create and query the db for an contact search | |
4226 | * | |
4227 | * @param int $offset the offset for the query | |
4228 | * @param int $rowCount the number of rows to return | |
4229 | * @param string $sort the order by string | |
4230 | * @param boolean $count is this a count only query ? | |
4231 | * @param boolean $includeContactIds should we include contact ids? | |
4232 | * @param boolean $sortByChar if true returns the distinct array of first characters for search results | |
4233 | * @param boolean $groupContacts if true, return only the contact ids | |
4234 | * @param boolean $returnQuery should we return the query as a string | |
4235 | * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components) | |
4236 | * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load. | |
4237 | * | |
4238 | * @return CRM_Contact_DAO_Contact | |
4239 | * @access public | |
4240 | */ | |
4241 | function searchQuery( | |
4242 | $offset = 0, $rowCount = 0, $sort = NULL, | |
4243 | $count = FALSE, $includeContactIds = FALSE, | |
4244 | $sortByChar = FALSE, $groupContacts = FALSE, | |
4245 | $returnQuery = FALSE, | |
4246 | $additionalWhereClause = NULL, $sortOrder = NULL, | |
4247 | $additionalFromClause = NULL, $skipOrderAndLimit = FALSE | |
4248 | ) { | |
4249 | ||
4250 | if ($includeContactIds) { | |
4251 | $this->_includeContactIds = TRUE; | |
4252 | $this->_whereClause = $this->whereClause(); | |
4253 | } | |
4254 | ||
6a488035 TO |
4255 | $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params); |
4256 | ||
f4bff68a | 4257 | // if we’re explicitly looking for a certain contact’s contribs, events, etc. |
6a488035 TO |
4258 | // and that contact happens to be deleted, set $onlyDeleted to true |
4259 | foreach ($this->_params as $values) { | |
4260 | $name = CRM_Utils_Array::value(0, $values); | |
4261 | $op = CRM_Utils_Array::value(1, $values); | |
4262 | $value = CRM_Utils_Array::value(2, $values); | |
4263 | if ($name == 'contact_id' and $op == '=') { | |
4264 | if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) { | |
4265 | $onlyDeleted = TRUE; | |
4266 | } | |
4267 | break; | |
4268 | } | |
4269 | } | |
4270 | $this->generatePermissionClause($onlyDeleted, $count); | |
4271 | ||
6a488035 TO |
4272 | // building the query string |
4273 | $groupBy = NULL; | |
4274 | if (!$count) { | |
4275 | if (isset($this->_groupByComponentClause)) { | |
4276 | $groupBy = $this->_groupByComponentClause; | |
4277 | } | |
4278 | elseif ($this->_useGroupBy) { | |
4279 | $groupBy = ' GROUP BY contact_a.id'; | |
4280 | } | |
4281 | } | |
4282 | if ($this->_mode & CRM_Contact_BAO_Query::MODE_ACTIVITY && (!$count)) { | |
4283 | $groupBy = 'GROUP BY civicrm_activity.id '; | |
4284 | } | |
4285 | ||
4286 | $order = $orderBy = $limit = ''; | |
4287 | if (!$count) { | |
4288 | $config = CRM_Core_Config::singleton(); | |
4289 | if ($config->includeOrderByClause || | |
4290 | isset($this->_distinctComponentClause) | |
4291 | ) { | |
4292 | if ($sort) { | |
4293 | if (is_string($sort)) { | |
4294 | $orderBy = $sort; | |
4295 | } | |
4296 | else { | |
4297 | $orderBy = trim($sort->orderBy()); | |
4298 | } | |
4299 | if (!empty($orderBy)) { | |
4300 | // this is special case while searching for | |
4301 | // changelog CRM-1718 | |
4302 | if (preg_match('/sort_name/i', $orderBy)) { | |
4303 | $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy); | |
4304 | } | |
4305 | ||
bd9a3dd5 | 4306 | $orderBy = CRM_Utils_Type::escape($orderBy, 'String'); |
6a488035 TO |
4307 | $order = " ORDER BY $orderBy"; |
4308 | ||
4309 | if ($sortOrder) { | |
bd9a3dd5 | 4310 | $sortOrder = CRM_Utils_Type::escape($sortOrder, 'String'); |
6a488035 TO |
4311 | $order .= " $sortOrder"; |
4312 | } | |
4313 | ||
4314 | // always add contact_a.id to the ORDER clause | |
4315 | // so the order is deterministic | |
4316 | if (strpos('contact_a.id', $order) === FALSE) { | |
4317 | $order .= ", contact_a.id"; | |
4318 | } | |
4319 | } | |
4320 | } | |
4321 | elseif ($sortByChar) { | |
4322 | $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc"; | |
4323 | } | |
4324 | else { | |
4325 | $order = " ORDER BY contact_a.sort_name asc, contact_a.id"; | |
4326 | } | |
4327 | } | |
4328 | ||
6a488035 TO |
4329 | // hack for order clause |
4330 | if ($order) { | |
4331 | $fieldStr = trim(str_replace('ORDER BY', '', $order)); | |
4332 | $fieldOrder = explode(' ', $fieldStr); | |
4333 | $field = $fieldOrder[0]; | |
4334 | ||
4335 | if ($field) { | |
4336 | switch ($field) { | |
6a488035 TO |
4337 | case 'city': |
4338 | case 'postal_code': | |
4339 | $this->_whereTables["civicrm_address"] = 1; | |
4340 | $order = str_replace($field, "civicrm_address.{$field}", $order); | |
4341 | break; | |
4342 | ||
4343 | case 'country': | |
4344 | case 'state_province': | |
4345 | $this->_whereTables["civicrm_{$field}"] = 1; | |
4346 | $order = str_replace($field, "civicrm_{$field}.name", $order); | |
4347 | break; | |
4348 | ||
4349 | case 'email': | |
4350 | $this->_whereTables["civicrm_email"] = 1; | |
4351 | $order = str_replace($field, "civicrm_email.{$field}", $order); | |
4352 | break; | |
6a488035 | 4353 | } |
4243847f CW |
4354 | $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode); |
4355 | $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode); | |
6a488035 TO |
4356 | } |
4357 | } | |
4358 | ||
6a488035 | 4359 | if ($rowCount > 0 && $offset >= 0) { |
bf00d1b6 DL |
4360 | $offset = CRM_Utils_Type::escape($offset, 'Int'); |
4361 | $rowCount = CRM_Utils_Type::escape($rowCount, 'Int'); | |
6a488035 | 4362 | $limit = " LIMIT $offset, $rowCount "; |
4243847f CW |
4363 | } |
4364 | } | |
6a488035 | 4365 | |
b1be45a0 | 4366 | // note : this modifies _fromClause and _simpleFromClause |
d9ab802d PJ |
4367 | $this->includePseudoFieldsJoin($sort); |
4368 | ||
4243847f | 4369 | list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts); |
6a488035 | 4370 | |
1939d296 | 4371 | if(!empty($this->_permissionWhereClause)){ |
4372 | if (empty($where)) { | |
4373 | $where = "WHERE $this->_permissionWhereClause"; | |
4374 | } | |
4375 | else { | |
4376 | $where = "$where AND $this->_permissionWhereClause"; | |
4377 | } | |
4378 | } | |
4379 | ||
4380 | if ($additionalWhereClause) { | |
4381 | $where = $where . ' AND ' . $additionalWhereClause; | |
4382 | } | |
4383 | ||
4384 | //additional from clause should be w/ proper joins. | |
4243847f CW |
4385 | if ($additionalFromClause) { |
4386 | $from .= "\n" . $additionalFromClause; | |
6a488035 TO |
4387 | } |
4388 | ||
4389 | // if we are doing a transform, do it here | |
4390 | // use the $from, $where and $having to get the contact ID | |
4391 | if ($this->_displayRelationshipType) { | |
4392 | $this->filterRelatedContacts($from, $where, $having); | |
4393 | } | |
4394 | ||
4395 | if ($skipOrderAndLimit) { | |
4396 | $query = "$select $from $where $having $groupBy"; | |
4397 | } | |
4398 | else { | |
4399 | $query = "$select $from $where $having $groupBy $order $limit"; | |
4400 | } | |
4401 | ||
4402 | if ($returnQuery) { | |
4403 | return $query; | |
4404 | } | |
6a488035 TO |
4405 | if ($count) { |
4406 | return CRM_Core_DAO::singleValueQuery($query); | |
4407 | } | |
4408 | ||
6a488035 TO |
4409 | $dao = CRM_Core_DAO::executeQuery($query); |
4410 | if ($groupContacts) { | |
4411 | $ids = array(); | |
4412 | while ($dao->fetch()) { | |
4413 | $ids[] = $dao->id; | |
4414 | } | |
4415 | return implode(',', $ids); | |
4416 | } | |
4417 | ||
4418 | return $dao; | |
4419 | } | |
4420 | ||
4243847f CW |
4421 | /** |
4422 | * Fetch a list of contacts from the prev/next cache for displaying a search results page | |
4423 | * | |
4424 | * @param string $cacheKey | |
4425 | * @param int $offset | |
4426 | * @param int $rowCount | |
4427 | * @param bool $includeContactIds | |
4428 | * @return CRM_Core_DAO | |
4429 | */ | |
4430 | function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) { | |
4431 | $this->_includeContactIds = $includeContactIds; | |
23379b49 | 4432 | list($select, $from, $where) = $this->query(); |
4243847f CW |
4433 | $from = " FROM civicrm_prevnext_cache pnc INNER JOIN civicrm_contact contact_a ON contact_a.id = pnc.entity_id1 AND pnc.cacheKey = '$cacheKey' " . substr($from, 31); |
4434 | $order = " ORDER BY pnc.id"; | |
1e7a8a53 | 4435 | $groupBy = " GROUP BY contact_a.id"; |
4243847f | 4436 | $limit = " LIMIT $offset, $rowCount"; |
23379b49 | 4437 | $query = "$select $from $where $groupBy $order $limit"; |
4438 | ||
4243847f CW |
4439 | return CRM_Core_DAO::executeQuery($query); |
4440 | } | |
4441 | ||
6a488035 TO |
4442 | /** |
4443 | * Populate $this->_permissionWhereClause with permission related clause and update other | |
4444 | * query related properties. | |
4445 | * | |
4446 | * Function calls ACL permission class and hooks to filter the query appropriately | |
4447 | * | |
4448 | * Note that these 2 params were in the code when extracted from another function | |
4449 | * and a second round extraction would be to make them properties of the class | |
4450 | * | |
4451 | * @param bool $onlyDeleted Only get deleted contacts | |
4452 | * @param bool $count Return Count only | |
4453 | * | |
4454 | * @return null | |
4455 | */ | |
4456 | function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) { | |
4457 | if (!$this->_skipPermission) { | |
4458 | $this->_permissionWhereClause = CRM_ACL_API::whereClause( | |
4459 | CRM_Core_Permission::VIEW, | |
4460 | $this->_tables, | |
4461 | $this->_whereTables, | |
4462 | NULL, | |
4463 | $onlyDeleted, | |
4464 | $this->_skipDeleteClause | |
4465 | ); | |
4466 | ||
4467 | // regenerate fromClause since permission might have added tables | |
4468 | if ($this->_permissionWhereClause) { | |
4469 | //fix for row count in qill (in contribute/membership find) | |
4470 | if (!$count) { | |
4471 | $this->_useDistinct = TRUE; | |
4472 | } | |
4473 | $this->_fromClause = self::fromClause($this->_tables, NULL, NULL, $this->_primaryLocation, $this->_mode); | |
4474 | $this->_simpleFromClause = self::fromClause($this->_whereTables, NULL, NULL, $this->_primaryLocation, $this->_mode); | |
4475 | } | |
4476 | } | |
4477 | else { | |
4478 | // add delete clause if needed even if we are skipping permission | |
4479 | // CRM-7639 | |
4480 | if (!$this->_skipDeleteClause) { | |
4481 | if (CRM_Core_Permission::check('access deleted contacts') and $onlyDeleted) { | |
4482 | $this->_permissionWhereClause = '(contact_a.is_deleted)'; | |
4483 | } | |
4484 | else { | |
4485 | // CRM-6181 | |
4486 | $this->_permissionWhereClause = '(contact_a.is_deleted = 0)'; | |
4487 | } | |
4488 | } | |
4489 | } | |
4490 | } | |
4491 | ||
4492 | function setSkipPermission($val) { | |
4493 | $this->_skipPermission = $val; | |
4494 | } | |
4495 | ||
4496 | function &summaryContribution($context = NULL) { | |
d7803ec1 | 4497 | list($innerselect, $from, $where, $having) = $this->query(TRUE); |
6a488035 TO |
4498 | |
4499 | // hack $select | |
4500 | $select = " | |
d7803ec1 EM |
4501 | SELECT COUNT( conts.total_amount ) as total_count, |
4502 | SUM( conts.total_amount ) as total_amount, | |
4503 | AVG( conts.total_amount ) as total_avg, | |
4504 | conts.currency as currency"; | |
4505 | if($this->_permissionWhereClause) { | |
4506 | $where .= " AND " . $this->_permissionWhereClause; | |
4507 | } | |
6a488035 TO |
4508 | if ($context == 'search') { |
4509 | $where .= " AND contact_a.is_deleted = 0 "; | |
4510 | } | |
4511 | ||
d7803ec1 EM |
4512 | // make sure contribution is completed - CRM-4989 |
4513 | $completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 "; | |
4514 | ||
4515 | ||
6a488035 TO |
4516 | $summary = array(); |
4517 | $summary['total'] = array(); | |
4518 | $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a"; | |
4519 | ||
d7803ec1 EM |
4520 | $query = "$select FROM ( |
4521 | SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $completedWhere | |
4522 | GROUP BY civicrm_contribution.id | |
4523 | ) as conts | |
4524 | GROUP BY currency"; | |
6a488035 | 4525 | |
d7803ec1 | 4526 | $dao = CRM_Core_DAO::executeQuery($query); |
6a488035 TO |
4527 | |
4528 | $summary['total']['count'] = 0; | |
4529 | $summary['total']['amount'] = $summary['total']['avg'] = array(); | |
4530 | while ($dao->fetch()) { | |
4531 | $summary['total']['count'] += $dao->total_count; | |
4532 | $summary['total']['amount'][] = CRM_Utils_Money::format($dao->total_amount, $dao->currency); | |
4533 | $summary['total']['avg'][] = CRM_Utils_Money::format($dao->total_avg, $dao->currency); | |
4534 | } | |
4535 | if (!empty($summary['total']['amount'])) { | |
4536 | $summary['total']['amount'] = implode(', ', $summary['total']['amount']); | |
4537 | $summary['total']['avg'] = implode(', ', $summary['total']['avg']); | |
4538 | } | |
4539 | else { | |
4540 | $summary['total']['amount'] = $summary['total']['avg'] = 0; | |
4541 | } | |
4542 | ||
4543 | // hack $select | |
d7803ec1 EM |
4544 | //@todo - this could be one query using the IF in mysql - eg |
4545 | // SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM ( | |
4546 | // SELECT civicrm_contribution.total_amount, civicrm_contribution.currency , | |
4547 | // IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed, | |
4548 | // IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed, | |
4549 | // IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled, | |
4550 | // IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled | |
4551 | // FROM civicrm_contact contact_a | |
4552 | // LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id | |
4553 | // WHERE ( ... where clause.... | |
4554 | // AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1) | |
4555 | // ) as conts | |
4556 | ||
6a488035 | 4557 | $select = " |
d7803ec1 EM |
4558 | SELECT COUNT( conts.total_amount ) as cancel_count, |
4559 | SUM( conts.total_amount ) as cancel_amount, | |
4560 | AVG( conts.total_amount ) as cancel_avg, | |
4561 | conts.currency as currency"; | |
6a488035 TO |
4562 | |
4563 | $where .= " AND civicrm_contribution.cancel_date IS NOT NULL "; | |
4564 | if ($context == 'search') { | |
4565 | $where .= " AND contact_a.is_deleted = 0 "; | |
4566 | } | |
4567 | ||
d7803ec1 EM |
4568 | $query = "$select FROM ( |
4569 | SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $where | |
4570 | GROUP BY civicrm_contribution.id | |
4571 | ) as conts | |
4572 | GROUP BY currency"; | |
4573 | ||
4574 | $dao = CRM_Core_DAO::executeQuery($query); | |
6a488035 TO |
4575 | |
4576 | if ($dao->N <= 1) { | |
4577 | if ($dao->fetch()) { | |
4578 | $summary['cancel']['count'] = $dao->cancel_count; | |
4579 | $summary['cancel']['amount'] = $dao->cancel_amount; | |
4580 | $summary['cancel']['avg'] = $dao->cancel_avg; | |
4581 | } | |
4582 | } | |
4583 | else { | |
4584 | $summary['cancel']['count'] = 0; | |
4585 | $summary['cancel']['amount'] = $summary['cancel']['avg'] = array(); | |
4586 | while ($dao->fetch()) { | |
4587 | $summary['cancel']['count'] += $dao->cancel_count; | |
4588 | $summary['cancel']['amount'][] = CRM_Utils_Money::format($dao->cancel_amount, $dao->currency); | |
4589 | $summary['cancel']['avg'][] = CRM_Utils_Money::format($dao->cancel_avg, $dao->currency); | |
4590 | } | |
4591 | $summary['cancel']['amount'] = implode(', ', $summary['cancel']['amount']); | |
4592 | $summary['cancel']['avg'] = implode(', ', $summary['cancel']['avg']); | |
4593 | } | |
4594 | ||
4595 | return $summary; | |
4596 | } | |
4597 | ||
4598 | /** | |
4599 | * getter for the qill object | |
4600 | * | |
4601 | * @return string | |
4602 | * @access public | |
4603 | */ | |
4604 | function qill() { | |
4605 | return $this->_qill; | |
4606 | } | |
4607 | ||
4608 | /** | |
4609 | * default set of return default hier return properties | |
4610 | * | |
4611 | * @return void | |
4612 | * @access public | |
4613 | */ | |
4614 | static function &defaultHierReturnProperties() { | |
4615 | if (!isset(self::$_defaultHierReturnProperties)) { | |
4616 | self::$_defaultHierReturnProperties = array( | |
4617 | 'home_URL' => 1, | |
4618 | 'image_URL' => 1, | |
4619 | 'legal_identifier' => 1, | |
4620 | 'external_identifier' => 1, | |
4621 | 'contact_type' => 1, | |
4622 | 'contact_sub_type' => 1, | |
4623 | 'sort_name' => 1, | |
4624 | 'display_name' => 1, | |
4625 | 'nick_name' => 1, | |
4626 | 'first_name' => 1, | |
4627 | 'middle_name' => 1, | |
4628 | 'last_name' => 1, | |
67744c4e CW |
4629 | 'prefix_id' => 1, |
4630 | 'suffix_id' => 1, | |
6a488035 TO |
4631 | 'email_greeting' => 1, |
4632 | 'postal_greeting' => 1, | |
4633 | 'addressee' => 1, | |
4634 | 'birth_date' => 1, | |
67744c4e | 4635 | 'gender_id' => 1, |
6a488035 TO |
4636 | 'preferred_communication_method' => 1, |
4637 | 'do_not_phone' => 1, | |
4638 | 'do_not_email' => 1, | |
4639 | 'do_not_mail' => 1, | |
4640 | 'do_not_sms' => 1, | |
4641 | 'do_not_trade' => 1, | |
4642 | 'location' => | |
4643 | array( | |
4644 | '1' => array('location_type' => 1, | |
4645 | 'street_address' => 1, | |
4646 | 'city' => 1, | |
4647 | 'state_province' => 1, | |
4648 | 'postal_code' => 1, | |
4649 | 'postal_code_suffix' => 1, | |
4650 | 'country' => 1, | |
4651 | 'phone-Phone' => 1, | |
4652 | 'phone-Mobile' => 1, | |
4653 | 'phone-Fax' => 1, | |
4654 | 'phone-1' => 1, | |
4655 | 'phone-2' => 1, | |
4656 | 'phone-3' => 1, | |
4657 | 'im-1' => 1, | |
4658 | 'im-2' => 1, | |
4659 | 'im-3' => 1, | |
4660 | 'email-1' => 1, | |
4661 | 'email-2' => 1, | |
4662 | 'email-3' => 1, | |
4663 | ), | |
4664 | '2' => array( | |
4665 | 'location_type' => 1, | |
4666 | 'street_address' => 1, | |
4667 | 'city' => 1, | |
4668 | 'state_province' => 1, | |
4669 | 'postal_code' => 1, | |
4670 | 'postal_code_suffix' => 1, | |
4671 | 'country' => 1, | |
4672 | 'phone-Phone' => 1, | |
4673 | 'phone-Mobile' => 1, | |
4674 | 'phone-1' => 1, | |
4675 | 'phone-2' => 1, | |
4676 | 'phone-3' => 1, | |
4677 | 'im-1' => 1, | |
4678 | 'im-2' => 1, | |
4679 | 'im-3' => 1, | |
4680 | 'email-1' => 1, | |
4681 | 'email-2' => 1, | |
4682 | 'email-3' => 1, | |
4683 | ), | |
4684 | ), | |
4685 | ); | |
4686 | } | |
4687 | return self::$_defaultHierReturnProperties; | |
4688 | } | |
4689 | ||
4690 | function dateQueryBuilder( | |
4691 | &$values, $tableName, $fieldName, | |
4692 | $dbFieldName, $fieldTitle, | |
4693 | $appendTimeStamp = TRUE | |
4694 | ) { | |
4695 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
4696 | ||
4697 | if (!$value) { | |
4698 | return; | |
4699 | } | |
4700 | ||
4701 | if ($name == "{$fieldName}_low" || | |
4702 | $name == "{$fieldName}_high" | |
4703 | ) { | |
4704 | if (isset($this->_rangeCache[$fieldName])) { | |
4705 | return; | |
4706 | } | |
4707 | $this->_rangeCache[$fieldName] = 1; | |
4708 | ||
4709 | $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL; | |
4710 | ||
4711 | if ($name == $fieldName . '_low') { | |
4712 | $firstOP = '>='; | |
228917cd | 4713 | $firstPhrase = ts('greater than or equal to'); |
6a488035 TO |
4714 | $firstDate = CRM_Utils_Date::processDate($value); |
4715 | ||
4716 | $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping); | |
228917cd | 4717 | if (!empty($secondValues) && $secondValues[2]) { |
6a488035 | 4718 | $secondOP = '<='; |
228917cd | 4719 | $secondPhrase = ts('less than or equal to'); |
6a488035 TO |
4720 | $secondValue = $secondValues[2]; |
4721 | ||
228917cd | 4722 | if ($appendTimeStamp && strlen($secondValue) == 10) { |
6a488035 TO |
4723 | $secondValue .= ' 23:59:59'; |
4724 | } | |
4725 | $secondDate = CRM_Utils_Date::processDate($secondValue); | |
4726 | } | |
4727 | } | |
4728 | elseif ($name == $fieldName . '_high') { | |
4729 | $firstOP = '<='; | |
228917cd | 4730 | $firstPhrase = ts('less than or equal to'); |
6a488035 | 4731 | |
228917cd | 4732 | if ($appendTimeStamp && strlen($value) == 10) { |
6a488035 TO |
4733 | $value .= ' 23:59:59'; |
4734 | } | |
4735 | $firstDate = CRM_Utils_Date::processDate($value); | |
4736 | ||
4737 | $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping); | |
228917cd | 4738 | if (!empty($secondValues) && $secondValues[2]) { |
6a488035 | 4739 | $secondOP = '>='; |
228917cd | 4740 | $secondPhrase = ts('greater than or equal to'); |
6a488035 TO |
4741 | $secondValue = $secondValues[2]; |
4742 | $secondDate = CRM_Utils_Date::processDate($secondValue); | |
4743 | } | |
4744 | } | |
4745 | ||
4746 | if (!$appendTimeStamp) { | |
4747 | $firstDate = substr($firstDate, 0, 8); | |
4748 | } | |
4749 | $firstDateFormat = CRM_Utils_Date::customFormat($firstDate); | |
4750 | ||
4751 | if ($secondDate) { | |
4752 | if (!$appendTimeStamp) { | |
4753 | $secondDate = substr($secondDate, 0, 8); | |
4754 | } | |
4755 | $secondDateFormat = CRM_Utils_Date::customFormat($secondDate); | |
4756 | } | |
4757 | ||
4758 | $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1; | |
4759 | if ($secondDate) { | |
4760 | $this->_where[$grouping][] = " | |
4761 | ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND | |
4762 | ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' ) | |
4763 | "; | |
4764 | $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\""; | |
4765 | } | |
4766 | else { | |
4767 | $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'"; | |
4768 | $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\""; | |
4769 | } | |
4770 | } | |
4771 | ||
4772 | if ($name == $fieldName) { | |
4773 | // $op = '='; | |
4774 | $phrase = $op; | |
4775 | ||
4776 | $date = CRM_Utils_Date::processDate($value); | |
4777 | ||
4778 | if (!$appendTimeStamp) { | |
4779 | $date = substr($date, 0, 8); | |
4780 | } | |
4781 | ||
4782 | $format = CRM_Utils_Date::customFormat($date); | |
4783 | ||
4784 | if ($date) { | |
4785 | $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op '$date'"; | |
4786 | } | |
4787 | else { | |
4788 | $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op"; | |
4789 | } | |
4790 | $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1; | |
4791 | $this->_qill[$grouping][] = "$fieldTitle - $phrase \"$format\""; | |
4792 | } | |
6a488035 TO |
4793 | } |
4794 | ||
4795 | function numberRangeBuilder(&$values, | |
4796 | $tableName, $fieldName, | |
4797 | $dbFieldName, $fieldTitle, | |
4798 | $options = NULL | |
4799 | ) { | |
4800 | list($name, $op, $value, $grouping, $wildcard) = $values; | |
4801 | ||
4802 | if ($name == "{$fieldName}_low" || | |
4803 | $name == "{$fieldName}_high" | |
4804 | ) { | |
4805 | if (isset($this->_rangeCache[$fieldName])) { | |
4806 | return; | |
4807 | } | |
4808 | $this->_rangeCache[$fieldName] = 1; | |
4809 | ||
4810 | $secondOP = $secondPhrase = $secondValue = NULL; | |
4811 | ||
4812 | if ($name == "{$fieldName}_low") { | |
4813 | $firstOP = '>='; | |
228917cd | 4814 | $firstPhrase = ts('greater than'); |
6a488035 TO |
4815 | |
4816 | $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping); | |
4817 | if (!empty($secondValues)) { | |
4818 | $secondOP = '<='; | |
228917cd | 4819 | $secondPhrase = ts('less than'); |
6a488035 TO |
4820 | $secondValue = $secondValues[2]; |
4821 | } | |
4822 | } | |
4823 | else { | |
4824 | $firstOP = '<='; | |
228917cd | 4825 | $firstPhrase = ts('less than'); |
6a488035 TO |
4826 | |
4827 | $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping); | |
4828 | if (!empty($secondValues)) { | |
4829 | $secondOP = '>='; | |
228917cd | 4830 | $secondPhrase = ts('greater than'); |
6a488035 TO |
4831 | $secondValue = $secondValues[2]; |
4832 | } | |
4833 | } | |
4834 | ||
4835 | if ($secondOP) { | |
4836 | $this->_where[$grouping][] = " | |
4837 | ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND | |
4838 | ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} ) | |
4839 | "; | |
4840 | $displayValue = $options ? $options[$value] : $value; | |
4841 | $secondDisplayValue = $options ? $options[$secondValue] : $secondValue; | |
4842 | ||
228917cd DL |
4843 | $this->_qill[$grouping][] = |
4844 | "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\""; | |
6a488035 TO |
4845 | } |
4846 | else { | |
4847 | $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}"; | |
4848 | $displayValue = $options ? $options[$value] : $value; | |
4849 | $this->_qill[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\""; | |
4850 | } | |
4851 | $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1; | |
4852 | ||
4853 | return; | |
4854 | } | |
4855 | ||
4856 | if ($name == $fieldName) { | |
4857 | $op = '='; | |
4858 | $phrase = '='; | |
4859 | ||
4860 | $this->_where[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}"; | |
4861 | ||
4862 | $this->_tables[$tableName] = $this->_whereTables[$tableName] = 1; | |
4863 | $displayValue = $options ? $options[$value] : $value; | |
4864 | $this->_qill[$grouping][] = "$fieldTitle - $phrase \"$displayValue\""; | |
4865 | } | |
4866 | ||
4867 | return; | |
4868 | } | |
4869 | ||
4870 | /** | |
4871 | * Given the field name, operator, value & its data type | |
4872 | * builds the where Clause for the query | |
4873 | * used for handling 'IS NULL'/'IS NOT NULL' operators | |
4874 | * | |
4875 | * @param string $field fieldname | |
4876 | * @param string $op operator | |
4877 | * @param string $value value | |
4878 | * @param string $dataType data type of the field | |
4879 | * | |
4880 | * @return where clause for the query | |
4881 | * @access public | |
4882 | */ | |
4883 | static function buildClause($field, $op, $value = NULL, $dataType = NULL) { | |
4884 | $op = trim($op); | |
4885 | $clause = "$field $op"; | |
4886 | ||
4887 | switch ($op) { | |
4888 | case 'IS NULL': | |
4889 | case 'IS NOT NULL': | |
4890 | return $clause; | |
4891 | ||
4892 | case 'IS EMPTY': | |
4893 | $clause = " ( $field IS NULL OR $field = '' ) "; | |
4894 | return $clause; | |
4895 | ||
4896 | case 'IS NOT EMPTY': | |
4897 | $clause = " ( $field IS NOT NULL AND $field <> '' ) "; | |
4898 | return $clause; | |
4899 | ||
4900 | case 'IN': | |
4901 | case 'NOT IN': | |
4902 | if (isset($dataType)) { | |
4903 | if (is_array($value)) { | |
4904 | $values = $value; | |
4905 | } | |
4906 | else { | |
4907 | $value = CRM_Utils_Type::escape($value, "String"); | |
4908 | $values = explode(',', CRM_Utils_Array::value(0, explode(')', CRM_Utils_Array::value(1, explode('(', $value))))); | |
4909 | } | |
4910 | // supporting multiple values in IN clause | |
4911 | $val = array(); | |
4912 | foreach ($values as $v) { | |
4913 | $v = trim($v); | |
4914 | $val[] = "'" . CRM_Utils_Type::escape($v, $dataType) . "'"; | |
4915 | } | |
4916 | $value = "(" . implode($val, ",") . ")"; | |
4917 | } | |
4918 | return "$clause $value"; | |
4919 | ||
4920 | default: | |
4921 | if (empty($dataType)) { | |
4922 | $dataType = 'String'; | |
4923 | } | |
4924 | ||
4925 | $value = CRM_Utils_Type::escape($value, $dataType); | |
6a488035 | 4926 | // if we dont have a dataType we should assume |
85bdc94e | 4927 | if ($dataType == 'String' || $dataType == 'Text') { |
6a488035 TO |
4928 | $value = "'" . strtolower($value) . "'"; |
4929 | } | |
4930 | return "$clause $value"; | |
4931 | } | |
4932 | } | |
4933 | ||
4934 | function openedSearchPanes($reset = FALSE) { | |
4935 | if (!$reset || empty($this->_whereTables)) { | |
4936 | return self::$_openedPanes; | |
4937 | } | |
4938 | ||
4939 | // pane name to table mapper | |
4940 | $panesMapper = array( | |
4941 | ts('Contributions') => 'civicrm_contribution', | |
4942 | ts('Memberships') => 'civicrm_membership', | |
4943 | ts('Events') => 'civicrm_participant', | |
4944 | ts('Relationships') => 'civicrm_relationship', | |
4945 | ts('Activities') => 'civicrm_activity', | |
4946 | ts('Pledges') => 'civicrm_pledge', | |
4947 | ts('Cases') => 'civicrm_case', | |
4948 | ts('Grants') => 'civicrm_grant', | |
4949 | ts('Address Fields') => 'civicrm_address', | |
4950 | ts('Notes') => 'civicrm_note', | |
4951 | ts('Change Log') => 'civicrm_log', | |
4952 | ts('Mailings') => 'civicrm_mailing_event_queue', | |
4953 | ); | |
066b4d4a | 4954 | CRM_Contact_BAO_Query_Hook::singleton()->getPanesMapper($panesMapper); |
6a488035 TO |
4955 | |
4956 | foreach (array_keys($this->_whereTables) as $table) { | |
4957 | if ($panName = array_search($table, $panesMapper)) { | |
4958 | self::$_openedPanes[$panName] = TRUE; | |
4959 | } | |
4960 | } | |
4961 | ||
4962 | return self::$_openedPanes; | |
4963 | } | |
4964 | ||
4965 | function setOperator($operator) { | |
4966 | $validOperators = array('AND', 'OR'); | |
4967 | if (!in_array($operator, $validOperators)) { | |
4968 | $operator = 'AND'; | |
4969 | } | |
4970 | $this->_operator = $operator; | |
4971 | } | |
4972 | ||
4973 | function getOperator() { | |
4974 | return $this->_operator; | |
4975 | } | |
4976 | ||
4977 | function filterRelatedContacts(&$from, &$where, &$having) { | |
4978 | static $_rTypeProcessed = NULL; | |
4979 | static $_rTypeFrom = NULL; | |
4980 | static $_rTypeWhere = NULL; | |
4981 | ||
4982 | if (!$_rTypeProcessed) { | |
4983 | $_rTypeProcessed = TRUE; | |
4984 | ||
4985 | // create temp table with contact ids | |
4986 | $tableName = CRM_Core_DAO::createTempTableName('civicrm_transform', TRUE); | |
4987 | $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP"; | |
4988 | CRM_Core_DAO::executeQuery($sql); | |
4989 | ||
4990 | $sql = " | |
4991 | REPLACE INTO $tableName ( contact_id ) | |
4992 | SELECT contact_a.id | |
4993 | $from | |
4994 | $where | |
4995 | $having | |
4996 | "; | |
4997 | CRM_Core_DAO::executeQuery($sql); | |
4998 | ||
4999 | $qillMessage = ts('Contacts with a Relationship Type of: '); | |
5000 | $rTypes = CRM_Core_PseudoConstant::relationshipType(); | |
5001 | ||
5002 | if (is_numeric($this->_displayRelationshipType)) { | |
5003 | $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType]['label_a_b']; | |
5004 | $_rTypeFrom = " | |
5005 | INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id ) | |
5006 | INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b ) | |
5007 | "; | |
5008 | $_rTypeWhere = " | |
5009 | WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType} | |
5010 | AND displayRelType.is_active = 1 | |
5011 | "; | |
5012 | } | |
5013 | else { | |
5014 | list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType); | |
5015 | if ($dirOne == 'a') { | |
5016 | $relationshipTypeLabel = $rTypes[$relType]['label_a_b']; | |
5017 | $_rTypeFrom .= " | |
5018 | INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id ) | |
5019 | INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b ) | |
5020 | "; | |
5021 | } | |
5022 | else { | |
5023 | $relationshipTypeLabel = $rTypes[$relType]['label_b_a']; | |
5024 | $_rTypeFrom .= " | |
5025 | INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id ) | |
5026 | INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a ) | |
5027 | "; | |
5028 | } | |
5029 | $_rTypeWhere = " | |
5030 | WHERE displayRelType.relationship_type_id = $relType | |
5031 | AND displayRelType.is_active = 1 | |
5032 | "; | |
5033 | } | |
6a488035 TO |
5034 | $this->_qill[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'"; |
5035 | } | |
5036 | ||
5037 | if (strpos($from, $_rTypeFrom) === FALSE) { | |
5038 | // lets replace all the INNER JOIN's in the $from so we dont exclude other data | |
5039 | // this happens when we have an event_type in the quert (CRM-7969) | |
5040 | $from = str_replace("INNER JOIN", "LEFT JOIN", $from); | |
5041 | $from .= $_rTypeFrom; | |
5042 | $where = $_rTypeWhere; | |
5043 | } | |
5044 | ||
5045 | $having = NULL; | |
5046 | } | |
5047 | ||
5048 | static function caseImportant( $op ) { | |
5049 | return | |
5050 | in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ? FALSE : TRUE; | |
5051 | } | |
5052 | ||
5053 | static function componentPresent( &$returnProperties, $prefix ) { | |
5054 | foreach ($returnProperties as $name => $dontCare ) { | |
5055 | if (substr($name, 0, strlen($prefix)) == $prefix) { | |
5056 | return TRUE; | |
5057 | } | |
5058 | } | |
5059 | return FALSE; | |
5060 | } | |
5061 | ||
5062 | /** | |
5063 | * Builds the necessary structures for all fields that are similar to option value lookups | |
5064 | * | |
5065 | * @param $name string the name of the field | |
5066 | * @param $op string the sql operator, this function should handle ALL SQL operators | |
5067 | * @param $value any string / integer / array depends on the operator and whos calling the query builder | |
5068 | * @param $grouping int the index where to place the where clause | |
837c4660 | 5069 | * @param $selectValues |
6a488035 TO |
5070 | * @param $field array an array that contains various properties of the field identified by $name |
5071 | * @param $label string The label for this field element | |
5072 | * @param $dataType string The data type for this element | |
5073 | * | |
837c4660 E |
5074 | * @param bool $useIDsOnly |
5075 | * | |
5076 | * @internal param array $selectValue the key value pairs for this element. This allows us to use this function for things besides option-value pairs | |
6a488035 TO |
5077 | * @return void adds the where clause and qill to the query object |
5078 | */ | |
5079 | function optionValueQuery( | |
5080 | $name, | |
5081 | $op, | |
5082 | $value, | |
5083 | $grouping, | |
5084 | $selectValues, | |
5085 | $field, | |
5086 | $label, | |
a30e57e0 DL |
5087 | $dataType = 'String', |
5088 | $useIDsOnly = FALSE | |
6a488035 | 5089 | ) { |
bd3728fb | 5090 | |
5091 | if (!empty($selectValues)) { | |
5092 | $qill = $selectValues[$value]; | |
5093 | } | |
5094 | else { | |
5095 | $qill = $value; | |
5096 | } | |
5097 | ||
04ffef8d | 5098 | $pseudoFields = array('email_greeting', 'postal_greeting', 'addressee', 'gender_id', 'prefix_id', 'suffix_id'); |
d9ab802d | 5099 | |
6a488035 | 5100 | if (is_numeric($value)) { |
a30e57e0 | 5101 | $qill = $selectValues[(int ) $value]; |
6a488035 TO |
5102 | } |
5103 | elseif ($op == 'IN' || $op == 'NOT IN') { | |
5104 | $values = self::parseSearchBuilderString($value); | |
5105 | if (is_array($values)) { | |
d9ab802d | 5106 | $intVals = array(); |
6a488035 TO |
5107 | $newValues = array(); |
5108 | foreach ($values as $v) { | |
d9ab802d | 5109 | $intVals[] = (int) $v; |
6a488035 TO |
5110 | $newValues[] = $selectValues[(int ) $v]; |
5111 | } | |
d9ab802d PJ |
5112 | |
5113 | $value = (in_array($name, $pseudoFields)) ? $intVals : $newValues; | |
5114 | $qill = implode(', ', $newValues); | |
6a488035 TO |
5115 | } |
5116 | } | |
9131c564 | 5117 | elseif (!array_key_exists($value, $selectValues)) { |
a30e57e0 DL |
5118 | // its a string, lets get the int value |
5119 | $value = array_search($value, $selectValues); | |
5120 | } | |
9df8a11d DL |
5121 | if ($useIDsOnly) { |
5122 | list($tableName, $fieldName) = explode('.', $field['where'], 2); | |
5123 | if ($tableName == 'civicrm_contact') { | |
5124 | $wc = "contact_a.$fieldName"; | |
5125 | } | |
8b695e91 CW |
5126 | else { |
5127 | $wc = "$tableName.id"; | |
5128 | } | |
9df8a11d DL |
5129 | } |
5130 | else { | |
5131 | $wc = self::caseImportant($op) ? "LOWER({$field['where']})" : "{$field['where']}"; | |
5132 | } | |
d9ab802d PJ |
5133 | |
5134 | if (in_array($name, $pseudoFields)) { | |
04ffef8d | 5135 | if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id'))) { |
d9ab802d PJ |
5136 | $wc = "contact_a.{$name}_id"; |
5137 | } | |
5138 | $dataType = 'Positive'; | |
5139 | $value = (!$value) ? 0 : $value; | |
5140 | } | |
5141 | ||
6a488035 | 5142 | $this->_qill[$grouping][] = $label . " $op '$qill'"; |
d9ab802d PJ |
5143 | $op = (in_array($name, $pseudoFields) && ($op == 'LIKE' || $op == 'RLIKE')) ? '=' : $op; |
5144 | $this->_where[$grouping][] = self::buildClause($wc, $op, $value, $dataType); | |
6a488035 TO |
5145 | } |
5146 | ||
a30e57e0 DL |
5147 | /** |
5148 | * function to check and explode a user defined numeric string into an array | |
6a488035 TO |
5149 | * this was the protocol used by search builder in the old old days before we had |
5150 | * super nice js widgets to do the hard work | |
5151 | * | |
837c4660 E |
5152 | * @param the $string |
5153 | * @param string $dataType the dataType we should check for the values, default integer | |
6a488035 TO |
5154 | * |
5155 | * @return FALSE if string does not match the patter | |
5156 | * array of numeric values if string does match the pattern | |
5157 | * @static | |
5158 | */ | |
5159 | static function parseSearchBuilderString($string, $dataType = 'Integer') { | |
5160 | $string = trim($string); | |
5161 | if (substr($string, 0, 1) != '(' || substr($string, -1, 1) != ')') { | |
5162 | Return FALSE; | |
5163 | } | |
5164 | ||
5165 | $string = substr($string, 1, -1); | |
5166 | $values = explode(',', $string); | |
5167 | if (empty($values)) { | |
5168 | return FALSE; | |
5169 | } | |
5170 | ||
5171 | $returnValues = array(); | |
5172 | foreach ($values as $v) { | |
5173 | if ($dataType == 'Integer' && ! is_numeric($v)) { | |
5174 | return FALSE; | |
5175 | } | |
5176 | else if ($dataType == 'String' && ! is_string($v)) { | |
5177 | return FALSE; | |
5178 | } | |
5179 | $returnValues[] = trim($v); | |
5180 | } | |
5181 | ||
5182 | if (empty($returnValues)) { | |
5183 | return FALSE; | |
5184 | } | |
5185 | ||
5186 | return $returnValues; | |
5187 | } | |
6a488035 | 5188 | |
d9ab802d PJ |
5189 | /** |
5190 | * convert the pseudo constants id's to their names | |
837c4660 | 5191 | * |
d9ab802d | 5192 | * @param reference parameter $dao |
837c4660 E |
5193 | * @param bool $return |
5194 | * | |
5195 | * @return array | |
d9ab802d | 5196 | */ |
b719f000 | 5197 | function convertToPseudoNames(&$dao, $return = FALSE) { |
d9ab802d PJ |
5198 | if (empty($this->_pseudoConstantsSelect)) { |
5199 | return; | |
5200 | } | |
d9ab802d PJ |
5201 | $values = array(); |
5202 | foreach ($this->_pseudoConstantsSelect as $key => $value) { | |
5203 | if (CRM_Utils_Array::value('sorting', $this->_pseudoConstantsSelect[$key])) { | |
5204 | continue; | |
5205 | } | |
5206 | ||
5207 | if (property_exists($dao, $value['idCol'])) { | |
5208 | $val = $dao->$value['idCol']; | |
5209 | ||
5210 | if (CRM_Utils_System::isNull($val)) { | |
5211 | $dao->$key = NULL; | |
d9ab802d | 5212 | } |
b719f000 | 5213 | elseif ($baoName = CRM_Utils_Array::value('bao', $value, NULL)) { |
827659b2 | 5214 | //preserve id value |
5215 | $idColumn = "{$key}_id"; | |
5216 | $dao->$idColumn = $val; | |
828c974f | 5217 | $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant::getLabel($baoName, $value['pseudoField'], $val); |
d9ab802d PJ |
5218 | } |
5219 | elseif ($value['pseudoField'] == 'state_province_abbreviation') { | |
5220 | $dao->$key = CRM_Core_PseudoConstant::stateProvinceAbbreviation($val); | |
5221 | } | |
d9ab802d PJ |
5222 | else { |
5223 | $labels = CRM_Core_OptionGroup::values($value['pseudoField']); | |
5224 | $dao->$key = $labels[$val]; | |
5225 | } | |
b719f000 PJ |
5226 | |
5227 | // return converted values in array format | |
5228 | if ($return) { | |
5229 | if (strpos($key, '-') !== FALSE) { | |
5230 | $keyVal = explode('-', $key); | |
5231 | $current = &$values; | |
5232 | $lastElement = array_pop($keyVal); | |
5233 | foreach ($keyVal as $v) { | |
5234 | if (!array_key_exists($v, $current)) { | |
5235 | $current[$v] = array(); | |
5236 | } | |
5237 | $current = &$current[$v]; | |
5238 | } | |
5239 | $current[$lastElement] = $dao->$key; | |
5240 | } | |
5241 | else { | |
5242 | $values[$key] = $dao->$key; | |
5243 | } | |
5244 | } | |
d9ab802d PJ |
5245 | } |
5246 | } | |
5247 | return $values; | |
5248 | } | |
5249 | ||
837c4660 | 5250 | /** |
d9ab802d PJ |
5251 | * include pseudo fields LEFT JOIN |
5252 | * @param $sort can be a object or string | |
5253 | * | |
837c4660 | 5254 | * @return array |
d9ab802d PJ |
5255 | */ |
5256 | function includePseudoFieldsJoin($sort) { | |
5257 | if (!$sort || empty($this->_pseudoConstantsSelect)) { | |
5258 | return; | |
5259 | } | |
5260 | $sort = is_string($sort) ? $sort : $sort->orderBy(); | |
5261 | $present = array(); | |
5262 | ||
5263 | foreach ($this->_pseudoConstantsSelect as $name => $value) { | |
5264 | if (CRM_Utils_Array::value('table', $value)) { | |
5265 | $regex = "/({$value['table']}\.|{$name})/"; | |
5266 | if (preg_match($regex, $sort)) { | |
5267 | $this->_elemnt[$value['element']] = 1; | |
5268 | $this->_select[$value['element']] = $value['select']; | |
5269 | $this->_pseudoConstantsSelect[$name]['sorting'] = 1; | |
5270 | $present[$value['table']] = $value['join']; | |
5271 | } | |
5272 | } | |
5273 | } | |
5274 | $presentSimpleFrom = $present; | |
5275 | ||
5276 | if (array_key_exists('civicrm_worldregion', $this->_whereTables) && | |
5277 | array_key_exists('civicrm_country', $presentSimpleFrom)) { | |
5278 | unset($presentSimpleFrom['civicrm_country']); | |
5279 | } | |
5280 | if (array_key_exists('civicrm_worldregion', $this->_tables) && | |
5281 | array_key_exists('civicrm_country', $present)) { | |
5282 | unset($present['civicrm_country']); | |
5283 | } | |
5284 | ||
5285 | $presentClause = $presentSimpleFromClause = NULL; | |
5286 | if (!empty($present)) { | |
5287 | $presentClause = implode(' ', $present); | |
5288 | } | |
5289 | if (!empty($presentSimpleFrom)) { | |
5290 | $presentSimpleFromClause = implode(' ', $presentSimpleFrom); | |
5291 | } | |
5292 | ||
5293 | $this->_fromClause = $this->_fromClause . $presentClause; | |
5294 | $this->_simpleFromClause = $this->_simpleFromClause . $presentSimpleFromClause; | |
5295 | ||
5296 | return array($presentClause, $presentSimpleFromClause); | |
5297 | } | |
e7830dbe | 5298 | } |