3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * This class is a heart of search query building mechanism.
39 class CRM_Contact_BAO_Query
{
42 * The various search modes
52 MODE_PLEDGEBANK
= 256,
61 * the default set of return properties
66 static $_defaultReturnProperties = NULL;
69 * the default set of hier return properties
74 static $_defaultHierReturnProperties;
77 * the set of input params
88 * the set of output params
92 public $_returnProperties;
102 * the name of the elements that are in the select clause
103 * used to extract the values
110 * the tables involved in the query
117 * the table involved in the where clause
121 public $_whereTables;
136 public $_whereClause;
139 * additional permission Where Clause
144 public $_permissionWhereClause;
155 * additional permission from clause
160 public $_permissionFromClause;
163 * the from clause for the simple select and alphabetical
168 public $_simpleFromClause;
179 * The english language version of the query
186 * All the fields that could potentially be involved in
194 * The cache to translate the option values into labels
201 * are we in search mode
205 public $_search = TRUE;
208 * should we skip permission checking
212 public $_skipPermission = FALSE;
215 * should we skip adding of delete clause
219 public $_skipDeleteClause = FALSE;
222 * are we in strict mode (use equality over LIKE)
226 public $_strict = FALSE;
229 * What operator to use to group the clauses
233 public $_operator = 'AND';
238 * Should we only search on primary location
242 public $_primaryLocation = TRUE;
245 * are contact ids part of the query
249 public $_includeContactIds = FALSE;
252 * Should we use the smart group cache
256 public $_smartGroupCache = TRUE;
259 * Should we display contacts with a specific relationship type
263 public $_displayRelationshipType = NULL;
266 * reference to the query object for custom values
270 public $_customQuery;
273 * should we enable the distinct clause, used if we are including
274 * more than one group
278 public $_useDistinct = FALSE;
281 * Should we just display one contact record
283 public $_useGroupBy = FALSE;
286 * the relationship type direction
299 static $_activityRole;
302 * Consider the component activity type
303 * during activity search.
308 static $_considerCompActivities;
311 * Consider with contact activities only,
312 * during activity search.
317 static $_withContactActivitiesOnly;
320 * use distinct component clause for component searches
324 public $_distinctComponentClause;
327 * use groupBy component clause for component searches
331 public $_groupByComponentClause;
334 * Track open panes, useful in advance search
339 public static $_openedPanes = array();
342 * The tables which have a dependency on location and/or address
347 static $_dependencies = array(
348 'civicrm_state_province' => 1,
349 'civicrm_country' => 1,
350 'civicrm_county' => 1,
351 'civicrm_address' => 1,
352 'civicrm_location_type' => 1,
356 * List of location specific fields
358 static $_locationSpecificFields = array(
363 'supplemental_address_1',
364 'supplemental_address_2',
367 'postal_code_suffix',
380 * Rememeber if we handle either end of a number or date range
381 * so we can skip the other
383 protected $_rangeCache = array();
385 * Set to true when $this->relationship is run to avoid adding twice
388 protected $_relationshipValuesAdded = FALSE;
391 * Set to the name of the temp table if one has been created
394 static $_relationshipTempTable = NULL;
396 public $_pseudoConstantsSelect = array();
399 * class constructor which also does all the work
401 * @param array $params
402 * @param array $returnProperties
403 * @param array $fields
404 * @param boolean $includeContactIds
405 * @param boolean $strict
406 * @param boolean $mode - mode the search is operating on
411 function __construct(
412 $params = NULL, $returnProperties = NULL, $fields = NULL,
413 $includeContactIds = FALSE, $strict = FALSE, $mode = 1,
414 $skipPermission = FALSE, $searchDescendentGroups = TRUE,
415 $smartGroupCache = TRUE, $displayRelationshipType = NULL,
418 $this->_params
= &$params;
419 if ($this->_params
== NULL) {
420 $this->_params
= array();
423 if (empty($returnProperties)) {
424 $this->_returnProperties
= self
::defaultReturnProperties($mode);
427 $this->_returnProperties
= &$returnProperties;
430 $this->_includeContactIds
= $includeContactIds;
431 $this->_strict
= $strict;
432 $this->_mode
= $mode;
433 $this->_skipPermission
= $skipPermission;
434 $this->_smartGroupCache
= $smartGroupCache;
435 $this->_displayRelationshipType
= $displayRelationshipType;
436 $this->setOperator($operator);
439 $this->_fields
= &$fields;
440 $this->_search
= FALSE;
441 $this->_skipPermission
= TRUE;
444 $this->_fields
= CRM_Contact_BAO_Contact
::exportableFields('All', FALSE, TRUE, TRUE);
446 $fields = CRM_Core_Component
::getQueryFields();
447 unset($fields['note']);
448 $this->_fields
= array_merge($this->_fields
, $fields);
450 // add activity fields
451 $fields = CRM_Activity_BAO_Activity
::exportableFields();
452 $this->_fields
= array_merge($this->_fields
, $fields);
454 // add any fields provided by hook implementers
455 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
456 $this->_fields
= array_merge($this->_fields
, $extFields);
459 // basically do all the work once, and then reuse it
464 * function which actually does all the work for the constructor
469 function initialize() {
470 $this->_select
= array();
471 $this->_element
= array();
472 $this->_tables
= array();
473 $this->_whereTables
= array();
474 $this->_where
= array();
475 $this->_qill
= array();
476 $this->_options
= array();
477 $this->_cfIDs
= array();
478 $this->_paramLookup
= array();
479 $this->_having
= array();
481 $this->_customQuery
= NULL;
483 // reset cached static variables - CRM-5803
484 self
::$_activityRole = NULL;
485 self
::$_considerCompActivities = NULL;
486 self
::$_withContactActivitiesOnly = NULL;
488 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
489 $this->_element
['contact_id'] = 1;
490 $this->_tables
['civicrm_contact'] = 1;
492 if (!empty($this->_params
)) {
493 $this->buildParamsLookup();
496 $this->_whereTables
= $this->_tables
;
498 $this->selectClause();
499 $this->_whereClause
= $this->whereClause();
501 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
502 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
504 $this->openedSearchPanes(TRUE);
507 function buildParamsLookup() {
508 // first fix and handle contact deletion nicely
509 // this code is primarily for search builder use case
510 // where different clauses can specify if they want deleted
513 $trashParamExists = FALSE;
514 $paramByGroup = array();
515 foreach ( $this->_params
as $k => $param ) {
516 if (!empty($param[0]) && $param[0] == 'contact_is_deleted' ) {
517 $trashParamExists = TRUE;
519 if (!empty($param[3])) {
520 $paramByGroup[$param[3]][$k] = $param;
524 if ( $trashParamExists ) {
525 $this->_skipDeleteClause
= TRUE;
527 //cycle through group sets and explicitly add trash param if not set
528 foreach ( $paramByGroup as $setID => $set ) {
530 !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params
) &&
531 !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params
) ) {
532 $this->_params
[] = array(
533 'contact_is_deleted',
543 foreach ($this->_params
as $value) {
544 if (!CRM_Utils_Array
::value(0, $value)) {
547 $cfID = CRM_Core_BAO_CustomField
::getKeyID($value[0]);
549 if (!array_key_exists($cfID, $this->_cfIDs
)) {
550 $this->_cfIDs
[$cfID] = array();
552 $this->_cfIDs
[$cfID][] = $value;
555 if (!array_key_exists($value[0], $this->_paramLookup
)) {
556 $this->_paramLookup
[$value[0]] = array();
558 $this->_paramLookup
[$value[0]][] = $value;
563 * Some composite fields do not appear in the fields array
564 * hack to make them part of the query
569 function addSpecialFields() {
570 static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name');
571 foreach ($special as $name) {
572 if (CRM_Utils_Array
::value($name, $this->_returnProperties
)) {
573 $this->_select
[$name] = "contact_a.{$name} as $name";
574 $this->_element
[$name] = 1;
580 * Given a list of conditions in params and a list of desired
581 * return Properties generate the required select and from
582 * clauses. Note that since the where clause introduces new
583 * tables, the initial attempt also retrieves all variables used
589 function selectClause() {
591 $this->addSpecialFields();
593 foreach ($this->_fields
as $name => $field) {
594 // skip component fields
595 // there are done by the alter query below
596 // and need not be done on every field
598 (substr($name, 0, 12) == 'participant_') ||
599 (substr($name, 0, 7) == 'pledge_') ||
600 (substr($name, 0, 5) == 'case_')
605 // redirect to activity select clause
606 if (substr($name, 0, 9) == 'activity_') {
607 CRM_Activity_BAO_Query
::select($this);
611 // if this is a hierarchical name, we ignore it
612 $names = explode('-', $name);
613 if (count($names > 1) && isset($names[1]) && is_numeric($names[1])) {
617 // make an exception for special cases, to add the field in select clause
618 $makeException = FALSE;
620 //special handling for groups/tags
621 if (in_array($name, array('groups', 'tags', 'notes'))
622 && isset($this->_returnProperties
[substr($name, 0, -1)])
624 $makeException = TRUE;
627 // since note has 3 different options we need special handling
628 // note / note_subject / note_body
629 if ($name == 'notes') {
630 foreach (array('note', 'note_subject', 'note_body') as $noteField) {
631 if (isset($this->_returnProperties
[$noteField])) {
632 $makeException = TRUE;
638 $cfID = CRM_Core_BAO_CustomField
::getKeyID($name);
640 CRM_Utils_Array
::value($name, $this->_paramLookup
) ||
641 CRM_Utils_Array
::value($name, $this->_returnProperties
) ||
645 // add to cfIDs array if not present
646 if (!array_key_exists($cfID, $this->_cfIDs
)) {
647 $this->_cfIDs
[$cfID] = array();
650 elseif (isset($field['where'])) {
651 list($tableName, $fieldName) = explode('.', $field['where'], 2);
652 if (isset($tableName)) {
653 if (CRM_Utils_Array
::value($tableName, self
::$_dependencies)) {
654 $this->_tables
['civicrm_address'] = 1;
655 $this->_select
['address_id'] = 'civicrm_address.id as address_id';
656 $this->_element
['address_id'] = 1;
659 if ($tableName == 'im_provider' ||
$tableName == 'email_greeting' ||
660 $tableName == 'postal_greeting' ||
$tableName == 'addressee'
662 if ($tableName == 'im_provider') {
663 CRM_Core_OptionValue
::select($this);
666 if (in_array($tableName,
667 array('email_greeting', 'postal_greeting', 'addressee'))) {
668 $this->_element
["{$name}_id"] = 1;
669 $this->_select
["{$name}_id"] = "contact_a.{$name}_id as {$name}_id";
670 $this->_pseudoConstantsSelect
[$name] = array('pseudoField' => $tableName, 'idCol' => "{$name}_id");
671 $this->_pseudoConstantsSelect
[$name]['select'] = "{$name}.{$fieldName} as $name";
672 $this->_pseudoConstantsSelect
[$name]['element'] = $name;
674 if ($tableName == 'email_greeting') {
675 $this->_pseudoConstantsSelect
[$name]['join'] =
676 " LEFT JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')";
677 $this->_pseudoConstantsSelect
[$name]['join'] .=
678 " 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 ) ";
680 elseif ($tableName == 'postal_greeting') {
681 $this->_pseudoConstantsSelect
[$name]['join'] =
682 " LEFT JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')";
683 $this->_pseudoConstantsSelect
[$name]['join'] .=
684 " 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 ) ";
686 elseif ($tableName == 'addressee') {
687 $this->_pseudoConstantsSelect
[$name]['join'] =
688 " LEFT JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')";
689 $this->_pseudoConstantsSelect
[$name]['join'] .=
690 " LEFT JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) ";
692 $this->_pseudoConstantsSelect
[$name]['table'] = $tableName;
695 $greetField = "{$name}_display";
696 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
697 $this->_element
[$greetField] = 1;
699 $greetField = "{$name}_custom";
700 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
701 $this->_element
[$greetField] = 1;
705 if (!in_array($tableName, array('civicrm_state_province', 'civicrm_country', 'civicrm_county'))) {
706 $this->_tables
[$tableName] = 1;
709 // also get the id of the tableName
710 $tName = substr($tableName, 8);
711 if (in_array($tName, array('country', 'state_province', 'county'))) {
712 $pf = ($tName == 'state_province') ?
'state_province_name' : $name;
713 $this->_pseudoConstantsSelect
[$pf] =
714 array('pseudoField' => "{$tName}_id", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address',
715 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ");
717 if ($tName == 'state_province') {
718 $this->_pseudoConstantsSelect
[$tName] =
719 array('pseudoField' => 'state_province_abbreviation', 'idCol' => "{$tName}_id",
720 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ");
723 $this->_select
["{$tName}_id"] = "civicrm_address.{$tName}_id as {$tName}_id";
724 $this->_element
["{$tName}_id"] = 1;
726 elseif ($tName != 'contact') {
727 $this->_select
["{$tName}_id"] = "{$tableName}.id as {$tName}_id";
728 $this->_element
["{$tName}_id"] = 1;
731 //special case for phone
732 if ($name == 'phone') {
733 $this->_select
['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id";
734 $this->_element
['phone_type_id'] = 1;
737 // if IM then select provider_id also
738 // to get "IM Service Provider" in a file to be exported, CRM-3140
740 $this->_select
['provider_id'] = "civicrm_im.provider_id as provider_id";
741 $this->_element
['provider_id'] = 1;
744 if ($tName == 'contact') {
745 // special case, when current employer is set for Individual contact
746 if ($fieldName == 'organization_name') {
747 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name";
749 elseif ($fieldName != 'id') {
750 if ($fieldName == 'prefix_id') {
751 $this->_pseudoConstantsSelect
['individual_prefix'] = array('pseudoField' => 'prefix_id', 'idCol' => "prefix_id", 'bao' => 'CRM_Contact_BAO_Contact');
753 if ($fieldName == 'suffix_id') {
754 $this->_pseudoConstantsSelect
['individual_suffix'] = array('pseudoField' => 'suffix_id', 'idCol' => "suffix_id", 'bao' => 'CRM_Contact_BAO_Contact');
756 if ($fieldName == 'gender_id') {
757 $this->_pseudoConstantsSelect
['gender'] = array('pseudoField' => 'gender_id', 'idCol' => "gender_id", 'bao' => 'CRM_Contact_BAO_Contact');
759 if ($name == 'communication_style_id') {
760 $this->_pseudoConstantsSelect
['communication_style'] = array('pseudoField' => 'communication_style_id', 'idCol' => "communication_style_id", 'bao' => 'CRM_Contact_BAO_Contact');
762 $this->_select
[$name] = "contact_a.{$fieldName} as `$name`";
765 elseif (in_array($tName, array('state_province', 'country', 'county'))) {
766 $this->_pseudoConstantsSelect
[$pf]['select'] = "{$field['where']} as `$name`";
767 $this->_pseudoConstantsSelect
[$pf]['element'] = $name;
768 if ($tName == 'state_province') {
769 $this->_pseudoConstantsSelect
[$tName]['select'] = "{$field['where']} as `$name`";
770 $this->_pseudoConstantsSelect
[$tName]['element'] = $name;
774 $this->_select
[$name] = "{$field['where']} as `$name`";
776 if (!in_array($tName, array('state_province', 'country', 'county'))) {
777 $this->_element
[$name] = 1;
782 elseif ($name === 'tags') {
783 $this->_useGroupBy
= TRUE;
784 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags";
785 $this->_element
[$name] = 1;
786 $this->_tables
['civicrm_tag'] = 1;
787 $this->_tables
['civicrm_entity_tag'] = 1;
789 elseif ($name === 'groups') {
790 $this->_useGroupBy
= TRUE;
791 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_group.title)) as groups";
792 $this->_element
[$name] = 1;
793 $this->_tables
['civicrm_group'] = 1;
795 elseif ($name === 'notes') {
796 // if note field is subject then return subject else body of the note
797 $noteColumn = 'note';
798 if (isset($noteField) && $noteField == 'note_subject') {
799 $noteColumn = 'subject';
802 $this->_useGroupBy
= TRUE;
803 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.$noteColumn)) as notes";
804 $this->_element
[$name] = 1;
805 $this->_tables
['civicrm_note'] = 1;
807 elseif ($name === 'current_employer') {
808 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer";
809 $this->_element
[$name] = 1;
814 CRM_Utils_Array
::value('is_search_range', $field)
816 // this is a custom field with range search enabled, so we better check for two/from values
817 if (CRM_Utils_Array
::value($name . '_from', $this->_paramLookup
)) {
818 if (!array_key_exists($cfID, $this->_cfIDs
)) {
819 $this->_cfIDs
[$cfID] = array();
821 foreach ($this->_paramLookup
[$name . '_from'] as $pID => $p) {
822 // search in the cdID array for the same grouping
824 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
825 if ($c[3] == $p[3]) {
826 $this->_cfIDs
[$cfID][$cID][2]['from'] = $p[2];
831 $p[2] = array('from' => $p[2]);
832 $this->_cfIDs
[$cfID][] = $p;
836 if (CRM_Utils_Array
::value($name . '_to', $this->_paramLookup
)) {
837 if (!array_key_exists($cfID, $this->_cfIDs
)) {
838 $this->_cfIDs
[$cfID] = array();
840 foreach ($this->_paramLookup
[$name . '_to'] as $pID => $p) {
841 // search in the cdID array for the same grouping
843 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
844 if ($c[4] == $p[4]) {
845 $this->_cfIDs
[$cfID][$cID][2]['to'] = $p[2];
850 $p[2] = array('to' => $p[2]);
851 $this->_cfIDs
[$cfID][] = $p;
858 // add location as hierarchical elements
859 $this->addHierarchicalElements();
861 // add multiple field like website
862 $this->addMultipleElements();
865 CRM_Core_Component
::alterQuery($this, 'select');
867 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'select');
869 if (!empty($this->_cfIDs
)) {
870 $this->_customQuery
= new CRM_Core_BAO_CustomQuery($this->_cfIDs
, TRUE);
871 $this->_customQuery
->query();
872 $this->_select
= array_merge($this->_select
, $this->_customQuery
->_select
);
873 $this->_element
= array_merge($this->_element
, $this->_customQuery
->_element
);
874 $this->_tables
= array_merge($this->_tables
, $this->_customQuery
->_tables
);
875 $this->_whereTables
= array_merge($this->_whereTables
, $this->_customQuery
->_whereTables
);
876 $this->_options
= $this->_customQuery
->_options
;
881 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
887 function addHierarchicalElements() {
888 if (!CRM_Utils_Array
::value('location', $this->_returnProperties
)) {
891 if (!is_array($this->_returnProperties
['location'])) {
895 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
896 $processed = array();
899 $addressCustomFields = CRM_Core_BAO_CustomField
::getFieldsForImport('Address');
900 $addressCustomFieldIds = array();
902 foreach ($this->_returnProperties
['location'] as $name => $elements) {
903 $lCond = self
::getPrimaryCondition($name);
906 $locationTypeId = array_search($name, $locationTypes);
907 if ($locationTypeId === FALSE) {
910 $lCond = "location_type_id = $locationTypeId";
911 $this->_useDistinct
= TRUE;
913 //commented for CRM-3256
914 $this->_useGroupBy
= TRUE;
917 $name = str_replace(' ', '_', $name);
919 $tName = "$name-location_type";
920 $ltName = "`$name-location_type`";
921 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
922 $this->_select
["{$tName}"] = "`$tName`.name as `{$tName}`";
923 $this->_element
["{$tName}_id"] = 1;
924 $this->_element
["{$tName}"] = 1;
926 $locationTypeName = $tName;
927 $locationTypeJoin = array();
931 foreach ($elements as $elementFullName => $dontCare) {
933 $elementName = $elementCmpName = $elementFullName;
935 if (substr($elementCmpName, 0, 5) == 'phone') {
936 $elementCmpName = 'phone';
939 if (in_array($elementCmpName, array_keys($addressCustomFields))) {
940 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($elementCmpName)) {
941 $addressCustomFieldIds[$cfID][$name] = 1;
944 //add address table only once
945 if ((in_array($elementCmpName, self
::$_locationSpecificFields) ||
!empty($addressCustomFieldIds))
947 && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid'))
949 $tName = "$name-address";
950 $aName = "`$name-address`";
951 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
952 $this->_element
["{$tName}_id"] = 1;
953 $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)";
954 $this->_tables
[$tName] = $addressJoin;
955 $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) ";
956 $processed[$aName] = 1;
960 $cond = $elementType = '';
961 if (strpos($elementName, '-') !== FALSE) {
962 // this is either phone, email or IM
963 list($elementName, $elementType) = explode('-', $elementName);
966 if (($elementName != 'phone') && ($elementName != 'im')) {
967 $cond = self
::getPrimaryCondition($elementType);
969 // CRM-13011 : If location type is primary, do not restrict search to the phone
970 // type id - we want the primary phone, regardless of what type it is.
971 // Otherwise, restrict to the specified phone type for the given field.
972 if ((!$cond) && ($elementName == 'phone') && $elements['location_type'] != 'Primary') {
973 $cond = "phone_type_id = '$elementType'";
975 elseif ((!$cond) && ($elementName == 'im')) {
976 // IM service provider id, CRM-3140
977 $cond = "provider_id = '$elementType'";
979 $elementType = '-' . $elementType;
982 $field = CRM_Utils_Array
::value($elementName, $this->_fields
);
984 // hack for profile, add location id
987 // fix for CRM-882( to handle phone types )
988 !is_numeric($elementType)
990 if (is_numeric($name)) {
991 $field = CRM_Utils_Array
::value($elementName . "-Primary$elementType", $this->_fields
);
994 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
997 elseif (is_numeric($name)) {
998 //this for phone type to work
999 if (in_array($elementName, array('phone', 'phone_ext'))) {
1000 $field = CRM_Utils_Array
::value($elementName . "-Primary" . $elementType, $this->_fields
);
1003 $field = CRM_Utils_Array
::value($elementName . "-Primary", $this->_fields
);
1007 //this is for phone type to work for profile edit
1008 if (in_array($elementName, array('phone', 'phone_ext'))) {
1009 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
1012 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId", $this->_fields
);
1017 // Check if there is a value, if so also add to where Clause
1019 if ($this->_params
) {
1021 if (isset($locationTypeId)) {
1022 $nm .= "-$locationTypeId";
1024 if (!is_numeric($elementType)) {
1025 $nm .= "$elementType";
1028 foreach ($this->_params
as $id => $values) {
1029 if ($values[0] == $nm ||
1030 (in_array($elementName, array('phone', 'im'))
1031 && (strpos($values[0], $nm) !== FALSE)
1041 if ($field && isset($field['where'])) {
1042 list($tableName, $fieldName) = explode('.', $field['where'], 2);
1043 $pf = substr($tableName, 8);
1044 $tName = $name . '-' . $pf . $elementType;
1045 if (isset($tableName)) {
1046 if ($tableName == 'civicrm_state_province' ||
$tableName == 'civicrm_country' ||
$tableName == 'civicrm_county') {
1047 $this->_select
["{$tName}_id"] = "{$aName}.{$pf}_id as `{$tName}_id`";
1050 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1053 $this->_element
["{$tName}_id"] = 1;
1054 if (substr($tName, -15) == '-state_province') {
1055 // FIXME: hack to fix CRM-1900
1056 $a = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1060 if (substr_count($a, 'state_province_name') > 0) {
1061 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] =
1062 array('pseudoField' => '{$pf}_id', 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address');
1063 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.name as `{$name}-{$elementFullName}`";
1066 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] =
1067 array('pseudoField' => 'state_province_abbreviation', 'idCol' => "{$tName}_id");
1068 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`";
1072 if (substr($elementFullName, 0, 2) == 'im') {
1073 $provider = "{$name}-{$elementFullName}-provider_id";
1074 $this->_select
[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`";
1075 $this->_element
[$provider] = 1;
1077 if ($pf == 'country' ||
$pf == 'county') {
1078 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] = array('pseudoField' => "{$pf}_id", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address');
1079 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1082 $this->_select
["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1086 if (in_array($pf, array('state_province', 'country', 'county'))) {
1087 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['element'] = "{$name}-{$elementFullName}";
1090 $this->_element
["{$name}-{$elementFullName}"] = 1;
1093 if (!CRM_Utils_Array
::value("`$tName`", $processed)) {
1094 $processed["`$tName`"] = 1;
1095 $newName = $tableName . '_' . $index;
1096 switch ($tableName) {
1097 case 'civicrm_phone':
1098 case 'civicrm_email':
1100 case 'civicrm_openid':
1102 $this->_tables
[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id AND `$tName`.$lCond";
1103 // this special case to add phone type
1105 $phoneTypeCondition = " AND `$tName`.$cond ";
1106 //gross hack to pickup corrupted data also, CRM-7603
1107 if (strpos($cond, 'phone_type_id') !== FALSE) {
1108 $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) ";
1110 $this->_tables
[$tName] .= $phoneTypeCondition;
1113 //build locationType join
1114 $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )";
1117 $this->_whereTables
[$tName] = $this->_tables
[$tName];
1121 case 'civicrm_state_province':
1122 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $tName;
1123 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join'] =
1124 "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id";
1126 $this->_whereTables
["{$name}-address"] = $addressJoin;
1130 case 'civicrm_country':
1131 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1132 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join'] =
1133 "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id";
1135 $this->_whereTables
["{$name}-address"] = $addressJoin;
1139 case 'civicrm_county':
1140 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1141 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join'] =
1142 "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id";
1144 $this->_whereTables
["{$name}-address"] = $addressJoin;
1150 $this->_whereTables
["{$name}-address"] = $addressJoin;
1159 // add location type join
1160 $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )";
1161 $this->_tables
[$locationTypeName] = $ltypeJoin;
1163 // table should be present in $this->_whereTables,
1164 // to add its condition in location type join, CRM-3939.
1165 if ($addWhereCount) {
1166 $locClause = array();
1167 foreach ($this->_whereTables
as $tableName => $clause) {
1168 if (CRM_Utils_Array
::value($tableName, $locationTypeJoin)) {
1169 $locClause[] = $locationTypeJoin[$tableName];
1173 if (!empty($locClause)) {
1174 $this->_whereTables
[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )";
1179 if (!empty($addressCustomFieldIds)) {
1180 $cfIDs = $addressCustomFieldIds;
1181 $customQuery = new CRM_Core_BAO_CustomQuery($cfIDs);
1182 foreach ($addressCustomFieldIds as $cfID => $locTypeName) {
1183 foreach ($locTypeName as $name => $dnc) {
1184 $fieldName = "$name-custom_{$cfID}";
1185 $tName = "$name-address-custom-{$cfID}";
1186 $aName = "`$name-address-custom-{$cfID}`";
1187 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1188 $this->_element
["{$tName}_id"] = 1;
1189 $this->_select
[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`";
1190 $this->_element
[$fieldName] = 1;
1191 $this->_tables
[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)";
1198 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
1204 function addMultipleElements() {
1205 if (!CRM_Utils_Array
::value('website', $this->_returnProperties
)) {
1208 if (!is_array($this->_returnProperties
['website'])) {
1212 foreach ($this->_returnProperties
['website'] as $key => $elements) {
1213 foreach ($elements as $elementFullName => $dontCare) {
1214 $tName = "website-{$key}-{$elementFullName}";
1215 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1216 $this->_select
["{$tName}"] = "`$tName`.url as `{$tName}`";
1217 $this->_element
["{$tName}_id"] = 1;
1218 $this->_element
["{$tName}"] = 1;
1220 $type = "website-{$key}-website_type_id";
1221 $this->_select
[$type] = "`$tName`.website_type_id as `{$type}`";
1222 $this->_element
[$type] = 1;
1223 $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id )";
1229 * generate the query based on what type of query we need
1231 * @param boolean $count
1232 * @param boolean $sortByChar
1233 * @param boolean $groupContacts
1235 * @return the sql string for that query (this will most likely
1239 function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE) {
1241 if (isset($this->_distinctComponentClause
)) {
1242 // we add distinct to get the right count for components
1243 // for the more complex result set, we use GROUP BY the same id
1245 $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} )";
1248 $select = 'SELECT count(DISTINCT contact_a.id) as rowCount';
1250 $from = $this->_simpleFromClause
;
1251 if ($this->_useDistinct
) {
1252 $this->_useGroupBy
= TRUE;
1255 elseif ($sortByChar) {
1256 $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name';
1257 $from = $this->_simpleFromClause
;
1259 elseif ($groupContacts) {
1260 $select = 'SELECT contact_a.id as id';
1261 if ($this->_useDistinct
) {
1262 $this->_useGroupBy
= TRUE;
1264 $from = $this->_simpleFromClause
;
1267 if (CRM_Utils_Array
::value('group', $this->_paramLookup
)) {
1268 // make sure there is only one element
1269 // this is used when we are running under smog and need to know
1270 // how the contact was added (CRM-1203)
1271 if ((count($this->_paramLookup
['group']) == 1) &&
1272 (count($this->_paramLookup
['group'][0][2]) == 1)
1274 $groups = array_keys($this->_paramLookup
['group'][0][2]);
1275 $groupId = $groups[0];
1277 //check if group is saved search
1278 $group = new CRM_Contact_BAO_Group();
1279 $group->id
= $groupId;
1282 if (!isset($group->saved_search_id
)) {
1283 $tbName = "`civicrm_group_contact-{$groupId}`";
1284 $this->_select
['group_contact_id'] = "$tbName.id as group_contact_id";
1285 $this->_element
['group_contact_id'] = 1;
1286 $this->_select
['status'] = "$tbName.status as status";
1287 $this->_element
['status'] = 1;
1290 $this->_useGroupBy
= TRUE;
1292 if ($this->_useDistinct
&& !isset($this->_distinctComponentClause
)) {
1293 if (!($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
)) {
1295 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
1296 $this->_useDistinct
= FALSE;
1297 $this->_useGroupBy
= TRUE;
1301 $select = "SELECT ";
1302 if (isset($this->_distinctComponentClause
)) {
1303 $select .= "{$this->_distinctComponentClause}, ";
1305 $select .= implode(', ', $this->_select
);
1306 $from = $this->_fromClause
;
1310 if (!empty($this->_whereClause
)) {
1311 $where = "WHERE {$this->_whereClause}";
1315 if (!empty($this->_having
)) {
1316 foreach ($this->_having
as $havingsets) {
1317 foreach ($havingsets as $havingset) {
1318 $havingvalue[] = $havingset;
1321 $having = ' HAVING ' . implode(' AND ', $havingvalue);
1324 // if we are doing a transform, do it here
1325 // use the $from, $where and $having to get the contact ID
1326 if ($this->_displayRelationshipType
) {
1327 $this->filterRelatedContacts($from, $where, $having);
1330 return array($select, $from, $where, $having);
1333 function &getWhereValues($name, $grouping) {
1335 foreach ($this->_params
as $values) {
1336 if ($values[0] == $name && $values[3] == $grouping) {
1344 static function fixDateValues($relative, &$from, &$to) {
1346 list($from, $to) = CRM_Utils_Date
::getFromTo($relative, $from, $to);
1350 static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE) {
1352 if (empty($formValues)) {
1356 foreach ($formValues as $id => $values) {
1357 if ($id == 'privacy') {
1358 if (is_array($formValues['privacy'])) {
1359 $op = CRM_Utils_Array
::value('do_not_toggle', $formValues['privacy']) ?
'=' : '!=';
1360 foreach ($formValues['privacy'] as $key => $value) {
1362 $params[] = array($key, $op, $value, 0, 0);
1367 elseif ($id == 'email_on_hold') {
1368 if ($formValues['email_on_hold']['on_hold']) {
1369 $params[] = array('on_hold', '=', $formValues['email_on_hold']['on_hold'], 0, 0);
1372 elseif (preg_match('/_date_relative$/', $id) ||
1373 $id == 'event_relative' ||
1374 $id == 'case_from_relative' ||
1375 $id == 'case_to_relative'
1377 if ($id == 'event_relative') {
1378 $fromRange = 'event_start_date_low';
1379 $toRange = 'event_end_date_high';
1381 else if ($id == 'case_from_relative') {
1382 $fromRange = 'case_from_start_date_low';
1383 $toRange = 'case_from_start_date_high';
1385 else if ($id == 'case_to_relative') {
1386 $fromRange = 'case_to_end_date_low';
1387 $toRange = 'case_to_end_date_high';
1390 $dateComponent = explode('_date_relative', $id);
1391 $fromRange = "{$dateComponent[0]}_date_low";
1392 $toRange = "{$dateComponent[0]}_date_high";
1395 if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) {
1396 CRM_Contact_BAO_Query
::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]);
1401 $values = CRM_Contact_BAO_Query
::fixWhereValues($id, $values, $wildcard, $useEquals);
1406 $params[] = $values;
1412 static function &fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE) {
1413 // skip a few search variables
1414 static $skipWhere = NULL;
1415 static $arrayValues = NULL;
1416 static $likeNames = NULL;
1419 if (CRM_Utils_System
::isNull($values)) {
1425 'task', 'radio_ts', 'uf_group_id',
1426 'component_mode', 'qfKey', 'operator',
1427 'display_relationship_type',
1431 if (in_array($id, $skipWhere) ||
1432 substr($id, 0, 4) == '_qf_' ||
1433 substr($id, 0, 7) == 'hidden_'
1439 $likeNames = array('sort_name', 'email', 'note', 'display_name');
1442 // email comes in via advanced search
1443 // so use wildcard always
1444 if ($id == 'email') {
1448 if (!$useEquals && in_array($id, $likeNames)) {
1449 $result = array($id, 'LIKE', $values, 0, 1);
1451 elseif (is_string($values) && strpos($values, '%') !== FALSE) {
1452 $result = array($id, 'LIKE', $values, 0, 0);
1454 elseif ($id == 'group') {
1455 if (is_array($values)) {
1456 foreach ($values as $groupIds => $val) {
1458 if (preg_match('/-(\d+)$/', $groupIds, $matches)) {
1459 if (strlen($matches[1]) > 0) {
1460 $values[$matches[1]] = 1;
1461 unset($values[$groupIds]);
1467 $groupIds = explode(',', $values);
1469 foreach ($groupIds as $groupId) {
1470 $values[$groupId] = 1;
1474 $result = array($id, 'IN', $values, 0, 0);
1476 elseif ($id == 'contact_tags' ||
$id == 'tag') {
1477 if (!is_array($values)) {
1478 $tagIds = explode(',', $values);
1480 foreach ($tagIds as $tagId) {
1481 $values[$tagId] = 1;
1484 $result = array($id, 'IN', $values, 0, 0);
1487 $result = array($id, '=', $values, 0, $wildcard);
1493 function whereClauseSingle(&$values) {
1494 // do not process custom fields or prefixed contact ids or component params
1495 if (CRM_Core_BAO_CustomField
::getKeyID($values[0]) ||
1496 (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) ||
1497 (substr($values[0], 0, 13) == 'contribution_') ||
1498 (substr($values[0], 0, 6) == 'event_') ||
1499 (substr($values[0], 0, 12) == 'participant_') ||
1500 (substr($values[0], 0, 7) == 'member_') ||
1501 (substr($values[0], 0, 6) == 'grant_') ||
1502 (substr($values[0], 0, 7) == 'pledge_') ||
1503 (substr($values[0], 0, 5) == 'case_') ||
1504 (substr($values[0], 0, 10) == 'financial_') ||
1505 (substr($values[0], 0, 11) == 'membership_')
1510 // skip for hook injected fields / params
1511 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
1512 if (array_key_exists($values[0], $extFields)) {
1516 switch ($values[0]) {
1517 case 'deleted_contacts':
1518 $this->deletedContacts($values);
1521 case 'contact_type':
1522 $this->contactType($values);
1525 case 'contact_sub_type':
1526 $this->contactSubType($values);
1530 $this->group($values);
1534 // so we resolve this into a list of groups & proceed as if they had been
1536 list($name, $op, $value, $grouping, $wildcard) = $values;
1537 $values[0] = 'group';
1539 $this->_paramLookup
['group'][0][0] ='group';
1540 $this->_paramLookup
['group'][0][1] = 'IN';
1541 $this->_paramLookup
['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value);
1542 $this->group($values);
1545 // case tag comes from find contacts
1547 $this->tagSearch($values);
1551 case 'contact_tags':
1552 $this->tag($values);
1557 case 'note_subject':
1558 $this->notes($values);
1562 $this->ufUser($values);
1566 case 'display_name':
1567 $this->sortName($values);
1571 $this->email($values);
1574 case 'phone_numeric':
1575 $this->phone_numeric($values);
1578 case 'phone_phone_type_id':
1579 case 'phone_location_type_id':
1580 $this->phone_option_group($values);
1583 case 'street_address':
1584 $this->street_address($values);
1587 case 'street_number':
1588 $this->street_number($values);
1591 case 'sortByCharacter':
1592 $this->sortByCharacter($values);
1595 case 'location_type':
1596 $this->locationType($values);
1600 $this->county($values);
1603 case 'state_province':
1604 $this->stateProvince($values);
1608 $this->country($values, FALSE);
1612 case 'postal_code_low':
1613 case 'postal_code_high':
1614 $this->postalCode($values);
1617 case 'activity_date':
1618 case 'activity_date_low':
1619 case 'activity_date_high':
1620 case 'activity_role':
1621 case 'activity_status':
1622 case 'activity_subject':
1623 case 'test_activities':
1624 case 'activity_type_id':
1625 case 'activity_survey_id':
1626 case 'activity_tags':
1627 case 'activity_taglist':
1628 case 'activity_test':
1629 case 'activity_campaign_id':
1630 case 'activity_engagement_level':
1632 case 'source_contact':
1633 CRM_Activity_BAO_Query
::whereClauseSingle($values, $this);
1636 case 'birth_date_low':
1637 case 'birth_date_high':
1638 case 'deceased_date_low':
1639 case 'deceased_date_high':
1640 $this->demographics($values);
1643 case 'log_date_low':
1644 case 'log_date_high':
1645 $this->modifiedDates($values);
1649 $this->changeLog($values);
1652 case 'do_not_phone':
1653 case 'do_not_email':
1656 case 'do_not_trade':
1658 $this->privacy($values);
1661 case 'privacy_options':
1662 $this->privacyOptions($values);
1665 case 'privacy_operator':
1666 case 'privacy_toggle':
1667 // these are handled by privacy options
1670 case 'preferred_communication_method':
1671 $this->preferredCommunication($values);
1674 case 'relation_type_id':
1675 case 'relation_start_date_high':
1676 case 'relation_start_date_low':
1677 case 'relation_end_date_high':
1678 case 'relation_end_date_low':
1679 case 'relation_target_name':
1680 case 'relation_status':
1681 case 'relation_date_low':
1682 case 'relation_date_high':
1683 $this->relationship($values);
1684 $this->_relationshipValuesAdded
= TRUE;
1687 case 'task_status_id':
1688 $this->task($values);
1692 // since this case is handled with the above
1695 case 'prox_distance':
1696 CRM_Contact_BAO_ProximityQuery
::process($this, $values);
1699 case 'prox_street_address':
1701 case 'prox_postal_code':
1702 case 'prox_state_province_id':
1703 case 'prox_country_id':
1704 // handled by the proximity_distance clause
1708 $this->restWhere($values);
1714 * Given a list of conditions in params generate the required
1720 function whereClause() {
1721 $this->_where
[0] = array();
1722 $this->_qill
[0] = array();
1724 $this->includeContactIds();
1725 if (!empty($this->_params
)) {
1726 foreach (array_keys($this->_params
) as $id) {
1727 if (!CRM_Utils_Array
::value(0, $this->_params
[$id])) {
1730 // check for both id and contact_id
1731 if ($this->_params
[$id][0] == 'id' ||
$this->_params
[$id][0] == 'contact_id') {
1733 $this->_params
[$id][1] == 'IS NULL' ||
1734 $this->_params
[$id][1] == 'IS NOT NULL'
1736 $this->_where
[0][] = "contact_a.id {$this->_params[$id][1]}";
1738 elseif (is_array($this->_params
[$id][2])) {
1739 $idList = implode("','", $this->_params
[$id][2]);
1740 //why on earth do they put ' in the middle & not on the outside? We have to assume it's
1741 //to support 'something' so lets add them conditionally to support the api (which is a tested flow
1742 // so if you are looking to alter this check api test results
1743 if(strpos(trim($idList), "'") > 0) {
1744 $idList = "'" . $idList . "'";
1747 $this->_where
[0][] = "contact_a.id IN ({$idList})";
1750 $this->_where
[0][] = "contact_a.id {$this->_params[$id][1]} {$this->_params[$id][2]}";
1754 $this->whereClauseSingle($this->_params
[$id]);
1758 CRM_Core_Component
::alterQuery($this, 'where');
1760 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'where');
1763 if ($this->_customQuery
) {
1764 // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info.
1765 // Hope it wont affect the other part of civicrm.. if it does please remove it.
1766 if (!empty($this->_customQuery
->_where
)) {
1767 $this->_where
= CRM_Utils_Array
::crmArrayMerge($this->_where
, $this->_customQuery
->_where
);
1770 $this->_qill
= CRM_Utils_Array
::crmArrayMerge($this->_qill
, $this->_customQuery
->_qill
);
1774 $andClauses = array();
1777 if (!empty($this->_where
)) {
1778 foreach ($this->_where
as $grouping => $values) {
1779 if ($grouping > 0 && !empty($values)) {
1780 $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
1785 if (!empty($this->_where
[0])) {
1786 $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where
[0]) . ' ) ';
1788 if (!empty($clauses)) {
1789 $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
1792 if ($validClauses > 1) {
1793 $this->_useDistinct
= TRUE;
1797 return implode(' AND ', $andClauses);
1800 function restWhere(&$values) {
1801 $name = CRM_Utils_Array
::value(0, $values);
1802 $op = CRM_Utils_Array
::value(1, $values);
1803 $value = CRM_Utils_Array
::value(2, $values);
1804 $grouping = CRM_Utils_Array
::value(3, $values);
1805 $wildcard = CRM_Utils_Array
::value(4, $values);
1807 if (isset($grouping) && !CRM_Utils_Array
::value($grouping, $this->_where
)) {
1808 $this->_where
[$grouping] = array();
1811 $multipleFields = array('url');
1813 //check if the location type exits for fields
1815 $locType = explode('-', $name);
1817 if (!in_array($locType[0], $multipleFields)) {
1818 //add phone type if exists
1819 if (isset($locType[2]) && $locType[2]) {
1820 $locType[2] = CRM_Core_DAO
::escapeString($locType[2]);
1824 $field = CRM_Utils_Array
::value($name, $this->_fields
);
1827 $field = CRM_Utils_Array
::value($locType[0], $this->_fields
);
1836 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
1837 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1839 if (substr($name, 0, 14) === 'state_province') {
1840 if (isset($locType[1]) && is_numeric($locType[1])) {
1842 $aName = "{$locationType[$locType[1]]}-address";
1843 $where = "`$aName`.state_province_id";
1846 $where = "civicrm_address.state_province_id";
1849 $states = CRM_Core_PseudoConstant
::stateProvince();
1850 if (is_numeric($value)) {
1851 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1852 $value = $states[(int ) $value];
1855 $intVal = CRM_Utils_Array
::key($value, $states);
1856 $this->_where
[$grouping][] = self
::buildClause($where, $op, $intVal, 'Positive');
1859 $this->_qill
[$grouping][] = ts('State') . " $op '$value'";
1862 $this->_qill
[$grouping][] = ts('State') . " ($lType) $op '$value'";
1865 elseif (!empty($field['pseudoconstant'])) {
1866 $this->optionValueQuery(
1867 $name, $op, $value, $grouping,
1868 CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', $field['name']),
1874 if ($name == 'gender_id') {
1875 self
::$_openedPanes[ts('Demographics')] = TRUE;
1878 elseif (substr($name, 0, 7) === 'country') {
1879 if (isset($locType[1]) && is_numeric($locType[1])) {
1881 $aName = "{$locationType[$locType[1]]}-address";
1882 $where = "`$aName`.country_id";
1885 $where = "civicrm_address.country_id";
1888 $countries = CRM_Core_PseudoConstant
::country();
1889 if (is_numeric($value)) {
1890 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1891 $value = $countries[(int ) $value];
1894 $intVal = CRM_Utils_Array
::key($value, $countries);
1895 $this->_where
[$grouping][] = self
::buildClause($where, $op, $intVal, 'Positive');
1899 $this->_qill
[$grouping][] = ts('Country') . " $op '$value'";
1902 $this->_qill
[$grouping][] = ts('Country') . " ($lType) $op '$value'";
1905 elseif (substr($name, 0, 6) === 'county') {
1906 if (isset($locType[1]) && is_numeric($locType[1])) {
1908 $aName = "{$locationType[$locType[1]]}-address";
1909 $where = "`$aName`.county_id";
1912 $where = "civicrm_address.county_id";
1915 $counties = CRM_Core_PseudoConstant
::county();
1916 if (is_numeric($value)) {
1917 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1918 $value = $counties[(int ) $value];
1921 $intVal = CRM_Utils_Array
::key($value, $counties);
1922 $this->_where
[$grouping][] = self
::buildClause($where, $op, $intVal, 'Positive');
1926 $this->_qill
[$grouping][] = ts('County') . " $op '$value'";
1929 $this->_qill
[$grouping][] = ts('County') . " ($lType) $op '$value'";
1932 elseif ($name === 'world_region') {
1933 $field['where'] = 'civicrm_worldregion.id';
1934 $this->optionValueQuery(
1935 $name, $op, $value, $grouping,
1936 CRM_Core_PseudoConstant
::worldRegion(),
1941 elseif ($name === 'birth_date') {
1942 $date = CRM_Utils_Date
::processDate($value);
1943 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $date);
1946 $date = CRM_Utils_Date
::customFormat($date);
1947 $this->_qill
[$grouping][] = "$field[title] $op \"$date\"";
1950 $this->_qill
[$grouping][] = "$field[title] $op";
1952 self
::$_openedPanes[ts('Demographics')] = TRUE;
1954 elseif ($name === 'deceased_date') {
1955 $date = CRM_Utils_Date
::processDate($value);
1956 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $date);
1958 $date = CRM_Utils_Date
::customFormat($date);
1959 $this->_qill
[$grouping][] = "$field[title] $op \"$date\"";
1962 $this->_qill
[$grouping][] = "$field[title] $op";
1964 self
::$_openedPanes[ts('Demographics')] = TRUE;
1966 elseif ($name === 'is_deceased') {
1967 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $value);
1968 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1969 self
::$_openedPanes[ts('Demographics')] = TRUE;
1971 elseif ($name === 'contact_id') {
1972 if (is_int($value)) {
1973 $this->_where
[$grouping][] = self
::buildClause($field['where'], $op, $value);
1974 $this->_qill
[$grouping][] = "$field[title] $op $value";
1977 elseif ($name === 'name') {
1978 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
1980 $value = "%$value%";
1983 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
1984 $this->_where
[$grouping][] = self
::buildClause($wc, $op, "'$value'");
1985 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1987 elseif ($name === 'current_employer') {
1988 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
1990 $value = "%$value%";
1993 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.organization_name)" : "contact_a.organization_name";
1994 $ceWhereClause = self
::buildClause($wc, $op,
1997 $ceWhereClause .= " AND contact_a.contact_type = 'Individual'";
1998 $this->_where
[$grouping][] = $ceWhereClause;
1999 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2001 elseif ($name === 'email_greeting') {
2002 $filterCondition = array('greeting_type' => 'email_greeting');
2003 $this->optionValueQuery(
2004 $name, $op, $value, $grouping,
2005 CRM_Core_PseudoConstant
::greeting($filterCondition),
2007 ts('Email Greeting')
2010 elseif ($name === 'postal_greeting') {
2011 $filterCondition = array('greeting_type' => 'postal_greeting');
2012 $this->optionValueQuery(
2013 $name, $op, $value, $grouping,
2014 CRM_Core_PseudoConstant
::greeting($filterCondition),
2016 ts('Postal Greeting')
2019 elseif ($name === 'addressee') {
2020 $filterCondition = array('greeting_type' => 'addressee');
2021 $this->optionValueQuery(
2022 $name, $op, $value, $grouping,
2023 CRM_Core_PseudoConstant
::greeting($filterCondition),
2028 elseif (substr($name, 0, 4) === 'url-') {
2029 $tName = 'civicrm_website';
2030 $this->_whereTables
[$tName] = $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2031 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
2033 $value = "%$value%";
2037 $wc = 'civicrm_website.url';
2038 $this->_where
[$grouping][] = $d = self
::buildClause($wc, $op, $value);
2039 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2041 elseif ($name === 'contact_is_deleted') {
2042 $this->_where
[$grouping][] = self
::buildClause("contact_a.is_deleted", $op, $value);
2043 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2046 // sometime the value is an array, need to investigate and fix
2047 if (is_array($value)) {
2048 CRM_Core_Error
::fatal();
2051 if (!empty($field['where'])) {
2053 $value = $strtolower($value);
2056 $value = "%$value%";
2060 if (isset($locType[1]) &&
2061 is_numeric($locType[1])
2065 //get the location name
2066 list($tName, $fldName) = self
::getLocationTableName($field['where'], $locType);
2068 $where = "`$tName`.$fldName";
2070 $this->_where
[$grouping][] = self
::buildClause("LOWER($where)", $op, $value);
2071 $this->_whereTables
[$tName] = $this->_tables
[$tName];
2072 $this->_qill
[$grouping][] = "$field[title] $op '$value'";
2075 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2076 if ($tableName == 'civicrm_contact') {
2077 $fieldName = "LOWER(contact_a.{$fieldName})";
2080 if ($op != 'IN' && !is_numeric($value)) {
2081 $fieldName = "LOWER({$field['where']})";
2084 $fieldName = "{$field['where']}";
2089 if (CRM_Utils_Array
::value('type', $field)) {
2090 $type = CRM_Utils_Type
::typeToString($field['type']);
2093 $this->_where
[$grouping][] = self
::buildClause($fieldName, $op, $value, $type);
2094 $this->_qill
[$grouping][] = "$field[title] $op $value";
2099 if ($setTables && isset($field['where'])) {
2100 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2101 if (isset($tableName)) {
2102 $this->_tables
[$tableName] = 1;
2103 $this->_whereTables
[$tableName] = 1;
2109 static function getLocationTableName(&$where, &$locType) {
2110 if (isset($locType[1]) && is_numeric($locType[1])) {
2111 list($tbName, $fldName) = explode(".", $where);
2113 //get the location name
2114 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
2115 $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2116 if (in_array($locType[0], $specialFields)) {
2117 //hack to fix / special handing for phone_ext
2118 if ($locType[0] == 'phone_ext') {
2119 $locType[0] = 'phone';
2121 if (isset($locType[2]) && $locType[2]) {
2122 $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2125 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2128 elseif (in_array($locType[0],
2130 'address_name', 'street_address', 'supplemental_address_1', 'supplemental_address_2',
2131 'city', 'postal_code', 'postal_code_suffix', 'geo_code_1', 'geo_code_2',
2134 //fix for search by profile with address fields.
2135 $tName = "{$locationType[$locType[1]]}-address";
2137 elseif ($locType[0] == 'on_hold') {
2138 $tName = "{$locationType[$locType[1]]}-email";
2141 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2143 $tName = str_replace(' ', '_', $tName);
2144 return array($tName, $fldName);
2146 CRM_Core_Error
::fatal();
2150 * Given a result dao, extract the values and return that array
2152 * @param Object $dao
2154 * @return array values for this query
2156 function store($dao) {
2159 foreach ($this->_element
as $key => $dontCare) {
2160 if (property_exists($dao, $key)) {
2161 if (strpos($key, '-') !== FALSE) {
2162 $values = explode('-', $key);
2163 $lastElement = array_pop($values);
2165 $cnt = count($values);
2167 foreach ($values as $v) {
2168 if (!array_key_exists($v, $current)) {
2169 $current[$v] = array();
2171 //bad hack for im_provider
2172 if ($lastElement == 'provider_id') {
2173 if ($count < $cnt) {
2174 $current = &$current[$v];
2177 $lastElement = "{$v}_{$lastElement}";
2181 $current = &$current[$v];
2186 $current[$lastElement] = $dao->$key;
2189 $value[$key] = $dao->$key;
2197 * getter for tables array
2203 return $this->_tables
;
2206 function whereTables() {
2207 return $this->_whereTables
;
2211 * generate the where clause (used in match contacts and permissions)
2213 * @param array $params
2214 * @param array $fields
2215 * @param array $tables
2216 * @param boolean $strict
2222 static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2223 $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2227 $tables = array_merge($query->tables(), $tables);
2228 $whereTables = array_merge($query->whereTables(), $whereTables);
2230 return $query->_whereClause
;
2234 * create the from clause
2236 * @param array $tables tables that need to be included in this from clause
2237 * if null, return mimimal from clause (i.e. civicrm_contact)
2238 * @param array $inner tables that should be inner-joined
2239 * @param array $right tables that should be right-joined
2241 * @return string the from clause
2245 static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
2247 $from = ' FROM civicrm_contact contact_a';
2248 if (empty($tables)) {
2252 if (CRM_Utils_Array
::value('civicrm_worldregion', $tables)) {
2253 $tables = array_merge(array('civicrm_country' => 1), $tables);
2256 if ((CRM_Utils_Array
::value('civicrm_state_province', $tables) ||
2257 CRM_Utils_Array
::value('civicrm_country', $tables) ||
2258 CRM_Utils_Array
::value('civicrm_county', $tables)
2260 !CRM_Utils_Array
::value('civicrm_address', $tables)
2262 $tables = array_merge(array('civicrm_address' => 1),
2267 // add group_contact table if group table is present
2268 if (CRM_Utils_Array
::value('civicrm_group', $tables) &&
2269 !CRM_Utils_Array
::value('civicrm_group_contact', $tables)
2271 $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added'";
2274 // add group_contact and group table is subscription history is present
2275 if (CRM_Utils_Array
::value('civicrm_subscription_history', $tables)
2276 && !CRM_Utils_Array
::value('civicrm_group', $tables)
2278 $tables = array_merge(array(
2279 'civicrm_group' => 1,
2280 'civicrm_group_contact' => 1,
2286 // to handle table dependencies of components
2287 CRM_Core_Component
::tableNames($tables);
2288 // to handle table dependencies of hook injected tables
2289 CRM_Contact_BAO_Query_Hook
::singleton()->setTableDependency($tables);
2291 //format the table list according to the weight
2292 $info = CRM_Core_TableHierarchy
::info();
2294 foreach ($tables as $key => $value) {
2296 if (strpos($key, '-') !== FALSE) {
2297 $keyArray = explode('-', $key);
2298 $k = CRM_Utils_Array
::value('civicrm_' . $keyArray[1], $info, 99);
2300 elseif (strpos($key, '_') !== FALSE) {
2301 $keyArray = explode('_', $key);
2302 if (is_numeric(array_pop($keyArray))) {
2303 $k = CRM_Utils_Array
::value(implode('_', $keyArray), $info, 99);
2306 $k = CRM_Utils_Array
::value($key, $info, 99);
2310 $k = CRM_Utils_Array
::value($key, $info, 99);
2312 $tempTable[$k . ".$key"] = $key;
2315 $newTables = array();
2316 foreach ($tempTable as $key) {
2317 $newTables[$key] = $tables[$key];
2320 $tables = $newTables;
2322 foreach ($tables as $name => $value) {
2327 if (CRM_Utils_Array
::value($name, $inner)) {
2330 elseif (CRM_Utils_Array
::value($name, $right)) {
2338 // if there is already a join statement in value, use value itself
2339 if (strpos($value, 'JOIN')) {
2340 $from .= " $value ";
2343 $from .= " $side JOIN $name ON ( $value ) ";
2348 case 'civicrm_address':
2349 if ($primaryLocation) {
2350 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )";
2353 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) ";
2357 case 'civicrm_phone':
2358 $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) ";
2361 case 'civicrm_email':
2362 $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) ";
2366 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) ";
2370 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2371 $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2372 $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)";
2375 case 'civicrm_openid':
2376 $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )";
2379 case 'civicrm_worldregion':
2380 $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2381 $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2384 case 'civicrm_location_type':
2385 $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2388 case 'civicrm_group':
2389 $from .= " $side JOIN civicrm_group ON civicrm_group.id = civicrm_group_contact.group_id ";
2392 case 'civicrm_group_contact':
2393 $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2396 case 'civicrm_activity':
2397 case 'civicrm_activity_tag':
2398 case 'activity_type':
2399 case 'activity_status':
2400 case 'civicrm_activity_contact':
2401 case 'source_contact':
2402 $from .= CRM_Activity_BAO_Query
::from($name, $mode, $side);
2405 case 'civicrm_entity_tag':
2406 $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2407 civicrm_entity_tag.entity_id = contact_a.id ) ";
2410 case 'civicrm_note':
2411 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2412 contact_a.id = civicrm_note.entity_id ) ";
2415 case 'civicrm_subscription_history':
2416 $from .= " $side JOIN civicrm_subscription_history
2417 ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2418 AND civicrm_group_contact.group_id = civicrm_subscription_history.group_id";
2421 case 'civicrm_relationship':
2422 if (self
::$_relType == 'reciprocal') {
2423 if(self
::$_relationshipTempTable) {
2424 // we have a temptable to join on
2425 $tbl = self
::$_relationshipTempTable;
2426 $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2429 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2430 $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)";
2433 elseif (self
::$_relType == 'b') {
2434 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2435 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2438 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2439 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2444 $from .= " $side JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2445 $from .= " $side JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2449 $from .= " $side JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2452 case 'civicrm_grant':
2453 $from .= CRM_Grant_BAO_Query
::from($name, $mode, $side);
2456 case 'civicrm_website':
2457 $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2461 $from .= CRM_Core_Component
::from($name, $mode, $side);
2462 $from .= CRM_Contact_BAO_Query_Hook
::singleton()->buildSearchfrom($name, $mode, $side);
2472 * WHERE / QILL clause for deleted_contacts
2476 function deletedContacts($values) {
2477 list($_, $_, $value, $grouping, $_) = $values;
2479 // *prepend* to the relevant grouping as this is quite an important factor
2480 array_unshift($this->_qill
[$grouping], ts('Search in Trash'));
2485 * where / qill clause for contact_type
2490 function contactType(&$values) {
2491 list($name, $op, $value, $grouping, $wildcard) = $values;
2493 $subTypes = array();
2496 // account for search builder mapping multiple values
2497 if (!is_array($value)) {
2498 $values = self
::parseSearchBuilderString($value, 'String');
2499 if (is_array($values)) {
2500 $value = array_flip($values);
2504 if (is_array($value)) {
2505 foreach ($value as $k => $v) {
2510 if (strpos($k, CRM_Core_DAO
::VALUE_SEPARATOR
)) {
2511 list($contactType, $subType) = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $k, 2);
2514 if (!empty($subType)) {
2515 $subTypes[$subType] = 1;
2517 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2522 $contactTypeANDSubType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value, 2);
2523 $contactType = $contactTypeANDSubType[0];
2524 $subType = CRM_Utils_Array
::value(1, $contactTypeANDSubType);
2525 if (!empty($subType)) {
2526 $subTypes[$subType] = 1;
2528 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2532 if (!empty($clause)) {
2533 if ($op == 'IN' ||
$op == 'NOT IN') {
2534 $this->_where
[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2538 $type = array_pop($clause);
2539 $this->_where
[$grouping][] = "contact_a.contact_type $op $type";
2542 $this->_qill
[$grouping][] = ts('Contact Type') . ' - ' . implode(' ' . ts('or') . ' ', $quill);
2544 if (!empty($subTypes)) {
2545 $this->includeContactSubTypes($subTypes, $grouping);
2551 * where / qill clause for contact_sub_type
2556 function contactSubType(&$values) {
2557 list($name, $op, $value, $grouping, $wildcard) = $values;
2558 $this->includeContactSubTypes($value, $grouping);
2561 function includeContactSubTypes($value, $grouping) {
2564 $alias = "contact_a.contact_sub_type";
2566 if (is_array($value)) {
2567 foreach ($value as $k => $v) {
2569 $clause[$k] = "($alias like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($k, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2574 $clause[$value] = "($alias like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($value, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2577 if (!empty($clause)) {
2578 $this->_where
[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2579 $this->_qill
[$grouping][] = ts('Contact Subtype') . ' - ' . implode(' ' . ts('or') . ' ', array_keys($clause));
2584 * where / qill clause for groups
2589 function group(&$values) {
2590 list($name, $op, $value, $grouping, $wildcard) = $values;
2592 if (count($value) > 1) {
2593 $this->_useDistinct
= TRUE;
2596 $groupNames = CRM_Core_PseudoConstant
::group();
2597 $groupIds = implode(',', array_keys($value));
2600 foreach ($value as $id => $dontCare) {
2601 if (array_key_exists($id, $groupNames) && $dontCare) {
2602 $names[] = $groupNames[$id];
2608 $gcsValues = &$this->getWhereValues('group_contact_status', $grouping);
2610 is_array($gcsValues[2])
2612 foreach ($gcsValues[2] as $k => $v) {
2614 if ($k == 'Added') {
2617 $statii[] = "'" . CRM_Utils_Type
::escape($k, 'String') . "'";
2622 $statii[] = '"Added"';
2627 if (count($value) == 1 &&
2628 count($statii) == 1 &&
2629 $statii[0] == '"Added"'
2631 // check if smart group, if so we can get rid of that one additional
2633 $groupIDs = array_keys($value);
2635 if (CRM_Utils_Array
::value(0, $groupIDs) &&
2636 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
2646 $gcTable = "`civicrm_group_contact-{$groupIds}`";
2647 $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 ) )";
2650 $qill = ts('Contacts %1', array(1 => $op));
2651 $qill .= ' ' . implode(' ' . ts('or') . ' ', $names);
2653 $groupClause = NULL;
2656 $groupClause = "{$gcTable}.group_id $op ( $groupIds )";
2657 if (!empty($statii)) {
2658 $groupClause .= " AND {$gcTable}.status IN (" . implode(', ', $statii) . ")";
2659 $qill .= " " . ts('AND') . " " . ts('Group Status') . ' - ' . implode(' ' . ts('or') . ' ', $statii);
2664 $ssClause = $this->savedSearch($values);
2667 $groupClause = "( ( $groupClause ) OR ( $ssClause ) )";
2670 $groupClause = $ssClause;
2675 $this->_where
[$grouping][] = $groupClause;
2676 $this->_qill
[$grouping][] = $qill;
2679 * Function translates selection of group type into a list of groups
2681 function getGroupsFromTypeCriteria($value){
2682 $groupIds = array();
2683 foreach ($value as $groupTypeValue) {
2684 $groupList = CRM_Core_PseudoConstant
::group($groupTypeValue);
2685 $groupIds = ($groupIds +
$groupList);
2691 * where / qill clause for smart groups
2696 function savedSearch(&$values) {
2697 list($name, $op, $value, $grouping, $wildcard) = $values;
2698 return $this->addGroupContactCache(array_keys($value));
2702 * @param array $groups
2703 * @param string $tableAlias
2704 * @param string $joinTable
2706 * @return null|string
2708 function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a") {
2709 $config = CRM_Core_Config
::singleton();
2711 // Find all the groups that are part of a saved search.
2712 $groupIDs = implode(',', $groups);
2713 if (empty($groupIDs)) {
2718 SELECT id, cache_date, saved_search_id, children
2720 WHERE id IN ( $groupIDs )
2721 AND ( saved_search_id != 0
2722 OR saved_search_id IS NOT NULL
2723 OR children IS NOT NULL )
2726 $group = CRM_Core_DAO
::executeQuery($sql);
2727 $groupsFiltered = array();
2729 while ($group->fetch()) {
2730 $groupsFiltered[] = $group->id
;
2732 $this->_useDistinct
= TRUE;
2734 if (!$this->_smartGroupCache ||
$group->cache_date
== NULL) {
2735 CRM_Contact_BAO_GroupContactCache
::load($group);
2739 if (count($groupsFiltered)) {
2740 $groupIDsFiltered = implode(',', $groupsFiltered);
2742 if ($tableAlias == NULL) {
2743 $tableAlias = "civicrm_group_contact_cache_{$groupIDsFiltered}";
2746 $this->_tables
[$tableAlias] = $this->_whereTables
[$tableAlias] = " LEFT JOIN civicrm_group_contact_cache `{$tableAlias}` ON {$joinTable}.id = `{$tableAlias}`.contact_id ";
2748 return "`{$tableAlias}`.group_id IN (" . $groupIDsFiltered . ")";
2755 * where / qill clause for cms users
2760 function ufUser(&$values) {
2761 list($name, $op, $value, $grouping, $wildcard) = $values;
2764 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2766 $this->_qill
[$grouping][] = ts('CMS User');
2768 elseif ($value == 0) {
2769 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2771 $this->_where
[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
2772 $this->_qill
[$grouping][] = ts('Not a CMS User');
2777 * all tag search specific
2782 function tagSearch(&$values) {
2783 list($name, $op, $value, $grouping, $wildcard) = $values;
2786 $value = "%{$value}%";
2789 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2790 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2792 $etTable = "`civicrm_entity_tag-" . $value . "`";
2793 $tTable = "`civicrm_tag-" . $value . "`";
2795 if ($useAllTagTypes[2]) {
2796 $this->_tables
[$etTable] =
2797 $this->_whereTables
[$etTable] =
2798 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
2799 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id )";
2801 // search tag in cases
2802 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2803 $tCaseTable = "`civicrm_case_tag-" . $value . "`";
2804 $this->_tables
[$etCaseTable] =
2805 $this->_whereTables
[$etCaseTable] =
2806 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2807 LEFT JOIN civicrm_case
2808 ON (civicrm_case_contact.case_id = civicrm_case.id
2809 AND civicrm_case.is_deleted = 0 )
2810 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
2811 LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id )";
2812 // search tag in activities
2813 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2814 $tActTable = "`civicrm_act_tag-" . $value . "`";
2815 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2816 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2818 $this->_tables
[$etActTable] =
2819 $this->_whereTables
[$etActTable] =
2820 " LEFT JOIN civicrm_activity_contact
2821 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
2822 LEFT JOIN civicrm_activity
2823 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
2824 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2825 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
2826 LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id )";
2828 $this->_where
[$grouping][] = "({$tTable}.name $op '". $value . "' OR {$tCaseTable}.name $op '". $value . "' OR {$tActTable}.name $op '". $value . "')";
2829 $this->_qill
[$grouping][] = ts('Tag %1 %2 ', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
2831 $etTable = "`civicrm_entity_tag-" . $value . "`";
2832 $tTable = "`civicrm_tag-" . $value . "`";
2833 $this->_tables
[$etTable] = $this->_whereTables
[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND
2834 {$etTable}.entity_table = 'civicrm_contact' )
2835 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id ) ";
2837 $this->_where
[$grouping][] = self
::buildClause("{$tTable}.name", $op, $value, 'String');
2838 $this->_qill
[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
2843 * where / qill clause for tag
2848 function tag(&$values) {
2849 list($name, $op, $value, $grouping, $wildcard) = $values;
2851 $tagNames = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
2852 if (is_array($value)) {
2853 if (count($value) > 1) {
2854 $this->_useDistinct
= TRUE;
2856 foreach ($value as $id => $dontCare) {
2857 $names[] = CRM_Utils_Array
::value($id, $tagNames);
2859 $names = implode(' ' . ts('or') . ' ', $names);
2860 $value = implode(',', array_keys($value));
2863 $names = CRM_Utils_Array
::value($value, $tagNames);
2867 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2868 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2870 $etTable = "`civicrm_entity_tag-" . $value . "`";
2872 if ($useAllTagTypes[2]) {
2873 $this->_tables
[$etTable] =
2874 $this->_whereTables
[$etTable] =
2875 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2877 // search tag in cases
2878 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2879 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2880 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2882 $this->_tables
[$etCaseTable] =
2883 $this->_whereTables
[$etCaseTable] =
2884 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2885 LEFT JOIN civicrm_case
2886 ON (civicrm_case_contact.case_id = civicrm_case.id
2887 AND civicrm_case.is_deleted = 0 )
2888 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
2889 // search tag in activities
2890 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2891 $this->_tables
[$etActTable] =
2892 $this->_whereTables
[$etActTable] =
2893 " LEFT JOIN civicrm_activity_contact
2894 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
2895 LEFT JOIN civicrm_activity
2896 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
2897 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2898 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
2901 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2902 $this->_where
[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
2905 $this->_where
[$grouping][] = "({$etTable}.tag_id $op (". $value . ") OR {$etCaseTable}.tag_id $op (". $value . ") OR {$etActTable}.tag_id $op (". $value . "))";
2907 $this->_qill
[$grouping][] = ts('Tag %1 %2', array(1 => $op, 2 => $tagTypesText[2])) . ' ' . $names;
2909 $this->_tables
[$etTable] =
2910 $this->_whereTables
[$etTable] =
2911 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2914 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2915 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
2916 $op = str_replace('EMPTY', 'NULL', $op);
2917 $this->_where
[$grouping][] = "{$etTable}.tag_id $op";
2920 $this->_where
[$grouping][] = "{$etTable}.tag_id $op (" . $value . ')';
2922 $this->_qill
[$grouping][] = ts('Tagged %1', array( 1 => $op)) . ' ' . $names;
2928 * where/qill clause for notes
2933 function notes(&$values) {
2934 list($name, $op, $value, $grouping, $wildcard) = $values;
2936 $noteOptionValues = $this->getWhereValues('note_option', $grouping);
2937 $noteOption = CRM_Utils_Array
::value('2', $noteOptionValues, '6');
2938 $noteOption = ($name == 'note_body') ?
2 : (($name == 'note_subject') ?
3 : $noteOption);
2940 $this->_useDistinct
= TRUE;
2942 $this->_tables
['civicrm_note'] =
2943 $this->_whereTables
['civicrm_note'] =
2944 " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
2946 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2948 $value = $strtolower(CRM_Core_DAO
::escapeString($n));
2949 if ($wildcard ||
$op == 'LIKE') {
2950 if (strpos($value, '%') === FALSE) {
2951 $value = "%$value%";
2955 elseif ($op == 'IS NULL' ||
$op == 'IS NOT NULL') {
2961 if ( $noteOption %
2 == 0 ) {
2962 $clauses[] = self
::buildClause('civicrm_note.note', $op, $value, 'String');
2963 $label = ts('Note: Body Only');
2965 if ( $noteOption %
3 == 0 ) {
2966 $clauses[] = self
::buildClause('civicrm_note.subject', $op, $value, 'String');
2967 $label = $label ?
ts('Note: Body and Subject') : ts('Note: Subject Only');
2969 $this->_where
[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
2970 $this->_qill
[$grouping][] = $label . " $op - '$n'";
2973 function nameNullOrEmptyOp($name, $op, $grouping) {
2977 $this->_where
[$grouping][] = "contact_a.$name $op";
2978 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2982 $this->_where
[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
2983 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2986 case 'IS NOT EMPTY':
2987 $this->_where
[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
2988 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2997 * where / qill clause for sort_name
3002 function sortName(&$values) {
3003 list($name, $op, $value, $grouping, $wildcard) = $values;
3005 // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
3006 if ( $this->nameNullOrEmptyOp( $name, $op, $grouping ) ) {
3011 $name = trim($value);
3017 $config = CRM_Core_Config
::singleton();
3021 //By default, $sub elements should be joined together with OR statements (don't change this variable).
3024 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
3025 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
3027 if (substr($name, 0, 1) == '"' &&
3028 substr($name, -1, 1) == '"'
3030 //If name is encased in double quotes, the value should be taken to be the string in entirety and the
3031 $value = substr($name, 1, -1);
3032 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
3033 $wc = ($newName == 'sort_name') ?
'LOWER(contact_a.sort_name)' : 'LOWER(contact_a.display_name)';
3034 $sub[] = " ( $wc = '$value' ) ";
3035 if ($config->includeEmailInName
) {
3036 $sub[] = " ( civicrm_email.email = '$value' ) ";
3039 elseif (strpos($name, ',') !== FALSE) {
3040 // if we have a comma in the string, search for the entire string
3041 $value = $strtolower(CRM_Core_DAO
::escapeString($name));
3043 if ($config->includeWildCardInName
) {
3044 $value = "'%$value%'";
3047 $value = "'$value%'";
3052 $value = "'$value'";
3054 if ($newName == 'sort_name') {
3055 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3058 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.display_name)" : "contact_a.display_name";
3060 $sub[] = " ( $wc $op $value )";
3061 if ($config->includeNickNameInName
) {
3062 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3063 $sub[] = " ( $wc $op $value )";
3065 if ($config->includeEmailInName
) {
3066 $sub[] = " ( civicrm_email.email $op $value ) ";
3070 // the string should be treated as a series of keywords to be matched with match ANY OR
3071 // match ALL depending on Civi config settings (see CiviAdmin)
3073 // The Civi configuration setting can be overridden if the string *starts* with the case
3074 // insenstive strings 'AND:' or 'OR:'TO THINK ABOUT: what happens when someone searches
3075 // for the following "AND: 'a string in quotes'"? - probably nothing - it would make the
3076 // AND OR variable reduntant because there is only one search string?
3078 // Check to see if the $subGlue is overridden in the search text
3079 if (strtolower(substr($name, 0, 4)) == 'and:') {
3080 $name = substr($name, 4);
3083 if (strtolower(substr($name, 0, 3)) == 'or:') {
3084 $name = substr($name, 3);
3088 $firstChar = substr($name, 0, 1);
3089 $lastChar = substr($name, -1, 1);
3090 $quotes = array("'", '"');
3091 if ((strlen($name) > 2) && in_array($firstChar, $quotes) &&
3092 in_array($lastChar, $quotes)
3094 $name = substr($name, 1);
3095 $name = substr($name, 0, -1);
3096 $pieces = array($name);
3099 $pieces = explode(' ', $name);
3101 foreach ($pieces as $piece) {
3102 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($piece)));
3103 if (strlen($value)) {
3104 // Added If as a sanitization - without it, when you do an OR search, any string with
3105 // double spaces (i.e. " ") or that has a space after the keyword (e.g. "OR: ") will
3106 // return all contacts because it will include a condition similar to "OR contact
3107 // name LIKE '%'". It might be better to replace this with array_filter.
3108 $fieldsub = array();
3110 if ($config->includeWildCardInName
) {
3111 $value = "'%$value%'";
3114 $value = "'$value%'";
3119 $value = "'$value'";
3121 if ($newName == 'sort_name') {
3122 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3125 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.display_name)" : "contact_a.display_name";
3127 $fieldsub[] = " ( $wc $op $value )";
3128 if ($config->includeNickNameInName
) {
3129 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3130 $fieldsub[] = " ( $wc $op $value )";
3132 if ($config->includeEmailInName
) {
3133 $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3135 $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3136 // I seperated the glueing in two. The first stage should always be OR because we are searching for matches in *ANY* of these fields
3141 $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3143 $this->_where
[$grouping][] = $sub;
3144 if ($config->includeEmailInName
) {
3145 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3146 $this->_qill
[$grouping][] = ts('Name or Email ') . "$op - '$name'";
3149 $this->_qill
[$grouping][] = ts('Name like') . " - '$name'";
3154 * where / qill clause for email
3159 function email(&$values) {
3160 list($name, $op, $value, $grouping, $wildcard) = $values;
3164 $config = CRM_Core_Config
::singleton();
3166 if (substr($n, 0, 1) == '"' &&
3167 substr($n, -1, 1) == '"'
3169 $n = substr($n, 1, -1);
3170 $value = strtolower(CRM_Core_DAO
::escapeString($n));
3171 $value = "'$value'";
3175 $value = strtolower($n);
3177 if (strpos($value, '%') === FALSE) {
3178 $value = "%{$value}%";
3183 $this->_qill
[$grouping][] = ts('Email') . " $op '$n'";
3184 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, $value, 'String');
3187 $this->_qill
[$grouping][] = ts('Email') . " $op ";
3188 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, NULL, 'String');
3191 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3195 * where / qill clause for phone number
3200 function phone_numeric(&$values) {
3201 list($name, $op, $value, $grouping, $wildcard) = $values;
3202 // Strip non-numeric characters; allow wildcards
3203 $number = preg_replace('/[^\d%]/', '', $value);
3205 if ( strpos($number, '%') === FALSE ) {
3206 $number = "%$number%";
3209 $this->_qill
[$grouping][] = ts('Phone number contains') . " $number";
3210 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String');
3211 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3216 * where / qill clause for phone type/location
3221 function phone_option_group($values) {
3222 list($name, $op, $value, $grouping, $wildcard) = $values;
3223 $option = ($name == 'phone_phone_type_id' ?
'phone_type_id' : 'location_type_id');
3224 $options = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', $option);
3225 $optionName = $options[$value];
3226 $this->_qill
[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ?
ts('type') : ('location')) . " $op $optionName";
3227 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3228 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3232 * where / qill clause for street_address
3237 function street_address(&$values) {
3238 list($name, $op, $value, $grouping, $wildcard) = $values;
3247 $value = strtolower($n);
3248 if (strpos($value, '%') === FALSE) {
3249 // only add wild card if not there
3250 $value = "%{$value}%";
3253 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String');
3254 $this->_qill
[$grouping][] = ts('Street') . " $op '$n'";
3257 $this->_where
[$grouping][] = self
::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3258 $this->_qill
[$grouping][] = ts('Street') . " $op ";
3261 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3265 * where / qill clause for street_unit
3270 function street_number(&$values) {
3271 list($name, $op, $value, $grouping, $wildcard) = $values;
3279 if (strtolower($n) == 'odd') {
3280 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3281 $this->_qill
[$grouping][] = ts('Street Number is odd');
3283 elseif (strtolower($n) == 'even') {
3284 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3285 $this->_qill
[$grouping][] = ts('Street Number is even');
3288 $value = strtolower($n);
3290 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3291 $this->_qill
[$grouping][] = ts('Street Number') . " $op '$n'";
3294 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3298 * where / qill clause for sorting by character
3303 function sortByCharacter(&$values) {
3304 list($name, $op, $value, $grouping, $wildcard) = $values;
3306 $name = trim($value);
3307 $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($name)) . "%'";
3308 $this->_where
[$grouping][] = $cond;
3309 $this->_qill
[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3313 * where / qill clause for including contact ids
3318 function includeContactIDs() {
3319 if (!$this->_includeContactIds ||
empty($this->_params
)) {
3323 $contactIds = array();
3324 foreach ($this->_params
as $id => $values) {
3325 if (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
3326 $contactIds[] = substr($values[0], CRM_Core_Form
::CB_PREFIX_LEN
);
3329 if (!empty($contactIds)) {
3330 $this->_where
[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3335 * where / qill clause for postal code
3340 function postalCode(&$values) {
3341 // skip if the fields dont have anything to do with postal_code
3342 if (!CRM_Utils_Array
::value('postal_code', $this->_fields
)) {
3346 list($name, $op, $value, $grouping, $wildcard) = $values;
3348 // Handle numeric postal code range searches properly by casting the column as numeric
3349 if (is_numeric($value)) {
3350 $field = 'ROUND(civicrm_address.postal_code)';
3351 $val = CRM_Utils_Type
::escape($value, 'Integer');
3354 $field = 'civicrm_address.postal_code';
3355 $val = CRM_Utils_Type
::escape($value, 'String');
3358 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3360 if ($name == 'postal_code') {
3361 $this->_where
[$grouping][] = self
::buildClause($field, $op, $val, 'String');
3362 $this->_qill
[$grouping][] = ts('Postal code') . " {$op} {$value}";
3364 elseif ($name == 'postal_code_low') {
3365 $this->_where
[$grouping][] = " ( $field >= '$val' ) ";
3366 $this->_qill
[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3368 elseif ($name == 'postal_code_high') {
3369 $this->_where
[$grouping][] = " ( $field <= '$val' ) ";
3370 $this->_qill
[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3375 * where / qill clause for location type
3380 function locationType(&$values, $status = NULL) {
3381 list($name, $op, $value, $grouping, $wildcard) = $values;
3383 if (is_array($value)) {
3384 $this->_where
[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', array_keys($value)) . ')';
3385 $this->_tables
['civicrm_address'] = 1;
3386 $this->_whereTables
['civicrm_address'] = 1;
3388 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
3390 foreach (array_keys($value) as $id) {
3391 $names[] = $locationType[$id];
3394 $this->_primaryLocation
= FALSE;
3397 $this->_qill
[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3400 return implode(' ' . ts('or') . ' ', $names);
3405 function country(&$values, $fromStateProvince = TRUE) {
3406 list($name, $op, $value, $grouping, $wildcard) = $values;
3408 if (!$fromStateProvince) {
3409 $stateValues = $this->getWhereValues('state_province', $grouping);
3410 if (!empty($stateValues)) {
3411 // return back to caller if there are state province values
3412 // since that handles this case
3417 $countryClause = $countryQill = NULL;
3423 $this->_tables
['civicrm_address'] = 1;
3424 $this->_whereTables
['civicrm_address'] = 1;
3426 $countries = CRM_Core_PseudoConstant
::country();
3427 if (is_numeric($value)) {
3428 $countryClause = self
::buildClause(
3429 'civicrm_address.country_id',
3434 $countryName = $countries[(int ) $value];
3438 $intValues = self
::parseSearchBuilderString($value);
3439 if ($intValues && ($op == 'IN' ||
$op == 'NOT IN')) {
3440 $countryClause = self
::buildClause(
3441 'civicrm_address.country_id',
3446 $countryNames = array();
3447 foreach ($intValues as $v) {
3448 $countryNames[] = $countries[$v];
3450 $countryName = implode(',', $countryNames);
3453 $countries = CRM_Core_PseudoConstant
::country();
3454 $intVal = CRM_Utils_Array
::key($value, $countries);
3455 $countryClause = self
::buildClause(
3456 'civicrm_address.country_id',
3461 $countryName = $value;
3464 $countryQill = ts('Country') . " {$op} '$countryName'";
3466 if (!$fromStateProvince) {
3467 $this->_where
[$grouping][] = $countryClause;
3468 $this->_qill
[$grouping][] = $countryQill;
3472 if ($fromStateProvince) {
3473 if (!empty($countryClause)) {
3476 " ...AND... " . $countryQill,
3480 return array(NULL, NULL);
3486 * where / qill clause for county (if present)
3491 function county(&$values, $status = null) {
3492 list($name, $op, $value, $grouping, $wildcard) = $values;
3494 if (! is_array($value)) {
3495 // force the county to be an array
3496 $value = array($value);
3499 // check if the values are ids OR names of the counties
3500 $inputFormat = 'id';
3501 foreach ($value as $v) {
3502 if (!is_numeric($v)) {
3503 $inputFormat = 'name';
3511 else if ($op == '!=') {
3515 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3516 $op = str_replace('EMPTY', 'NULL', $op);
3519 if (in_array( $op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3520 $clause = "civicrm_address.county_id $op";
3522 elseif ($inputFormat == 'id') {
3523 $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3525 $county = CRM_Core_PseudoConstant
::county();
3526 foreach ($value as $id) {
3527 $names[] = CRM_Utils_Array
::value($id, $county);
3531 $inputClause = array();
3532 $county = CRM_Core_PseudoConstant
::county();
3533 foreach ($value as $name) {
3534 $name = trim($name);
3535 $inputClause[] = CRM_Utils_Array
::key($name, $county);
3537 $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3540 $this->_tables
['civicrm_address'] = 1;
3541 $this->_whereTables
['civicrm_address'] = 1;
3543 $this->_where
[$grouping][] = $clause;
3545 $this->_qill
[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3547 return implode(' ' . ts('or') . ' ', $names);
3552 * where / qill clause for state/province AND country (if present)
3557 function stateProvince(&$values, $status = NULL) {
3558 list($name, $op, $value, $grouping, $wildcard) = $values;
3560 // quick escape for IS NULL
3561 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3564 else if (!is_array($value)) {
3565 // force the state to be an array
3566 // check if its in the mapper format!
3567 $values = self
::parseSearchBuilderString($value);
3568 if (is_array($values)) {
3572 $value = array($value);
3576 // check if the values are ids OR names of the states
3577 $inputFormat = 'id';
3579 foreach ($value as $v) {
3580 if (!is_numeric($v)) {
3581 $inputFormat = 'name';
3591 else if ($op == '!=') {
3595 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3596 $op = str_replace('EMPTY', 'NULL', $op);
3598 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3599 $stateClause = "civicrm_address.state_province_id $op";
3601 else if ($inputFormat == 'id') {
3602 if ($op != 'NOT IN') {
3605 $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $value) . ')';
3607 $stateProvince = CRM_Core_PseudoConstant
::stateProvince();
3608 foreach ($value as $id) {
3609 $names[] = CRM_Utils_Array
::value($id, $stateProvince);
3613 $inputClause = array();
3614 $stateProvince = CRM_Core_PseudoConstant
::stateProvince();
3615 foreach ($value as $name) {
3616 $name = trim($name);
3617 $inputClause[] = CRM_Utils_Array
::key($name, $stateProvince);
3619 $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $inputClause) . ')';
3622 $this->_tables
['civicrm_address'] = 1;
3623 $this->_whereTables
['civicrm_address'] = 1;
3625 $countryValues = $this->getWhereValues('country', $grouping);
3626 list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3628 if ($countryClause) {
3629 $clause = "( $stateClause AND $countryClause )";
3632 $clause = $stateClause;
3635 $this->_where
[$grouping][] = $clause;
3637 $this->_qill
[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill;
3640 return implode(' ' . ts('or') . ' ', $names) . $countryQill;
3645 * where / qill clause for change log
3650 function changeLog(&$values) {
3651 list($name, $op, $value, $grouping, $wildcard) = $values;
3653 $targetName = $this->getWhereValues('changed_by', $grouping);
3658 $name = trim($targetName[2]);
3659 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3660 $name = $targetName[4] ?
"%$name%" : $name;
3661 $this->_where
[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3662 $this->_tables
['civicrm_log'] = $this->_whereTables
['civicrm_log'] = 1;
3663 $this->_qill
[$grouping][] = ts('Changed by') . ": $name";
3666 function modifiedDates($values) {
3667 $this->_useDistinct
= TRUE;
3669 // CRM-11281, default to added date if not set
3670 $fieldTitle = ts('Added Date');
3672 foreach (array_keys($this->_params
) as $id) {
3673 if ($this->_params
[$id][0] == 'log_date') {
3674 if ($this->_params
[$id][2] == 2) {
3675 $fieldTitle = ts('Modified Date');
3680 $this->dateQueryBuilder($values,
3681 'civicrm_log', 'log_date', 'modified_date', $fieldTitle
3685 function demographics(&$values) {
3686 list($name, $op, $value, $grouping, $wildcard) = $values;
3688 if (($name == 'birth_date_low') ||
($name == 'birth_date_high')) {
3690 $this->dateQueryBuilder($values,
3691 'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3694 elseif (($name == 'deceased_date_low') ||
($name == 'deceased_date_high')) {
3696 $this->dateQueryBuilder($values,
3697 'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3701 self
::$_openedPanes[ts('Demographics')] = TRUE;
3704 function privacy(&$values) {
3705 list($name, $op, $value, $grouping, $wildcard) = $values;
3706 //fixed for profile search listing CRM-4633
3707 if (strpbrk($value, "[")) {
3708 $value = "'{$value}'";
3710 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3713 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3715 $field = CRM_Utils_Array
::value($name, $this->_fields
);
3716 $title = $field ?
$field['title'] : $name;
3717 $this->_qill
[$grouping][] = "$title $op $value";
3720 function privacyOptions($values) {
3721 list($name, $op, $value, $grouping, $wildcard) = $values;
3723 if (empty($value) ||
!is_array($value)) {
3727 // get the operator and toggle values
3728 $opValues = $this->getWhereValues('privacy_operator', $grouping);
3731 strtolower($opValues[2] == 'AND')
3736 $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3738 if ($toggleValues &&
3739 $toggleValues[2] == 2
3746 foreach ($value as $dontCare => $pOption) {
3747 $clauses[] = " ( contact_a.{$pOption} $compareOP 1 ) ";
3748 $field = CRM_Utils_Array
::value($pOption, $this->_fields
);
3749 $title = $field ?
$field['title'] : $pOption;
3750 $qill[] = " $title $compareOP 1 ";
3753 $this->_where
[$grouping][] = '( ' . implode($operator, $clauses) . ' )';
3754 $this->_qill
[$grouping][] = implode($operator, $qill);
3757 function preferredCommunication(&$values) {
3758 list($name, $op, $value, $grouping, $wildcard) = $values;
3761 if (!is_array($value)) {
3763 $value = trim($value, ' ()');
3764 if (strpos($value, CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
3765 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
3768 $v = explode(",", $value);
3771 foreach ($v as $item) {
3778 foreach ($value as $key => $checked) {
3785 $commPref = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
3787 $sqlValue = array();
3788 $sql = "contact_a.preferred_communication_method";
3789 foreach ($pref as $val) {
3790 $sqlValue[] = "( $sql like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. $val . CRM_Core_DAO
::VALUE_SEPARATOR
. "%' ) ";
3791 $showValue[] = $commPref[$val];
3793 $this->_where
[$grouping][] = "( " . implode(' OR ', $sqlValue) . " )";
3794 $this->_qill
[$grouping][] = ts('Preferred Communication Method') . " $op " . implode(' ' . ts('or') . ' ', $showValue);
3798 * where / qill clause for relationship
3803 function relationship(&$values) {
3804 list($name, $op, $value, $grouping, $wildcard) = $values;
3805 if($this->_relationshipValuesAdded
){
3808 // also get values array for relation_target_name
3809 // for relatinship search we always do wildcard
3810 $targetName = $this->getWhereValues('relation_target_name', $grouping);
3811 $relStatus = $this->getWhereValues('relation_status', $grouping);
3812 $relPermission = $this->getWhereValues('relation_permission', $grouping);
3813 $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
3815 $nameClause = $name = NULL;
3817 $name = trim($targetName[2]);
3818 if (substr($name, 0, 1) == '"' &&
3819 substr($name, -1, 1) == '"'
3821 $name = substr($name, 1, -1);
3822 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3823 $nameClause = "= '$name'";
3826 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3827 $nameClause = "LIKE '%{$name}%'";
3831 $rel = explode('_', $value);
3833 self
::$_relType = $rel[1];
3834 $params = array('id' => $rel[0]);
3835 $rTypeValues = array();
3836 $rType = CRM_Contact_BAO_RelationshipType
::retrieve($params, $rTypeValues);
3837 if ($rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) {
3838 // if we don't know which end of the relationship we are dealing with we'll create a temp table
3839 //@todo unless we are dealing with a target group
3840 self
::$_relType = 'reciprocal';
3842 // if we are creating a temp table we build our own where for the relationship table
3843 $relationshipTempTable = NULL;
3844 if(self
::$_relType == 'reciprocal' && empty($targetGroup)) {
3846 self
::$_relationshipTempTable =
3847 $relationshipTempTable =
3848 CRM_Core_DAO
::createTempTableName( 'civicrm_rel');
3850 $where[$grouping][] = " sort_name $nameClause ";
3854 $where = &$this->_where
;
3856 $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
3861 $relTypeInd = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Individual');
3862 $relTypeOrg = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Organization');
3863 $relTypeHou = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Household');
3864 $allRelationshipType = array();
3865 $allRelationshipType = array_merge($relTypeInd, $relTypeOrg);
3866 $allRelationshipType = array_merge($allRelationshipType, $relTypeHou);
3868 if ($nameClause ||
!$targetGroup) {
3869 $this->_qill
[$grouping][] = "$allRelationshipType[$value] $name";
3873 //check to see if the target contact is in specified group
3875 //add contacts from static groups
3876 $this->_tables
['civicrm_relationship_group_contact'] =
3877 $this->_whereTables
['civicrm_relationship_group_contact'] =
3878 " 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'";
3880 "( civicrm_relationship_group_contact.group_id IN (" .
3881 implode(",", $targetGroup[2]) . ") ) ";
3883 //add contacts from saved searches
3884 $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b");
3886 //set the group where clause
3888 $groupWhere[] = "( " . $ssWhere . " )";
3890 $this->_where
[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
3892 //Get the names of the target groups for the qill
3893 $groupNames = CRM_Core_PseudoConstant
::group();
3894 $qillNames = array();
3895 foreach ($targetGroup[2] as $groupId) {
3896 if (array_key_exists($groupId, $groupNames)) {
3897 $qillNames[] = $groupNames[$groupId];
3900 $this->_qill
[$grouping][] = "$allRelationshipType[$value] ( " . implode(", ", $qillNames) . " )";
3903 // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
3904 $today = date('Ymd');
3905 //check for active, inactive and all relation status
3906 if ($relStatus[2] == 0) {
3907 $where[$grouping][] = "(
3908 civicrm_relationship.is_active = 1 AND
3909 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
3910 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
3912 $this->_qill
[$grouping][] = ts('Relationship - Active and Current');
3914 elseif ($relStatus[2] == 1) {
3915 $where[$grouping][] = "(
3916 civicrm_relationship.is_active = 0 OR
3917 civicrm_relationship.end_date < {$today} OR
3918 civicrm_relationship.start_date > {$today}
3920 $this->_qill
[$grouping][] = ts('Relationship - Inactive or not Current');
3923 //check for permissioned, non-permissioned and all permissioned relations
3924 if ($relPermission[2] == 1) {
3925 $this->_where
[$grouping][] = "(
3926 civicrm_relationship.is_permission_a_b = 1
3928 $this->_qill
[$grouping][] = ts('Relationship - Permissioned');
3929 } elseif ($relPermission[2] == 2) {
3930 //non-allowed permission relationship.
3931 $this->_where
[$grouping][] = "(
3932 civicrm_relationship.is_permission_a_b = 0
3934 $this->_qill
[$grouping][] = ts('Relationship - Non-permissioned');
3937 $this->addRelationshipDateClauses($grouping, $where);
3938 if(!empty($rType) && isset($rType->id
)){
3939 $where[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rType->id
;
3941 $this->_tables
['civicrm_relationship'] = $this->_whereTables
['civicrm_relationship'] = 1;
3942 $this->_useDistinct
= TRUE;
3943 $this->_relationshipValuesAdded
= TRUE;
3944 // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
3946 // @todo creating a temp table could be expanded to group filter
3947 // as even creating a temp table of all relationships is much much more efficient than
3948 // an OR in the join
3949 if($relationshipTempTable) {
3950 $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
3952 CREATE TEMPORARY TABLE {$relationshipTempTable}
3953 (SELECT contact_id_b as contact_id, civicrm_relationship.id
3954 FROM civicrm_relationship
3955 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
3958 (SELECT contact_id_a as contact_id, civicrm_relationship.id
3959 FROM civicrm_relationship
3960 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
3963 CRM_Core_DAO
::executeQuery($sql);
3968 * Add start & end date criteria in
3969 * @param string $grouping
3970 * @param array $where = array to add where clauses to, in case you are generating a temp table
3971 * not the main query.
3973 function addRelationshipDateClauses($grouping, &$where){
3974 $dateValues = array();
3980 foreach ($dateTypes as $dateField){
3981 $dateValueLow = $this->getWhereValues('relation_'. $dateField .'_low', $grouping);
3982 $dateValueHigh= $this->getWhereValues('relation_'. $dateField .'_high', $grouping);
3983 if(!empty($dateValueLow)){
3984 $date = date('Ymd', strtotime($dateValueLow[2]));
3985 $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
3986 $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);
3988 if(!empty($dateValueHigh)){
3989 $date = date('Ymd', strtotime($dateValueHigh[2]));
3990 $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
3991 $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);
3996 * default set of return properties
4001 static function &defaultReturnProperties($mode = 1) {
4002 if (!isset(self
::$_defaultReturnProperties)) {
4003 self
::$_defaultReturnProperties = array();
4006 if (!isset(self
::$_defaultReturnProperties[$mode])) {
4007 // add activity return properties
4008 if ($mode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
4009 self
::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query
::defaultReturnProperties($mode, FALSE);
4012 self
::$_defaultReturnProperties[$mode] = CRM_Core_Component
::defaultReturnProperties($mode, FALSE);
4015 if (empty(self
::$_defaultReturnProperties[$mode])) {
4016 self
::$_defaultReturnProperties[$mode] = array(
4019 'legal_identifier' => 1,
4020 'external_identifier' => 1,
4021 'contact_type' => 1,
4022 'contact_sub_type' => 1,
4024 'display_name' => 1,
4025 'preferred_mail_format' => 1,
4032 'formal_title' => 1,
4033 'communication_style_id' => 1,
4036 'street_address' => 1,
4037 'supplemental_address_1' => 1,
4038 'supplemental_address_2' => 1,
4041 'postal_code_suffix' => 1,
4042 'state_province' => 1,
4044 'world_region' => 1,
4051 'household_name' => 1,
4052 'organization_name' => 1,
4053 'deceased_date' => 1,
4058 'current_employer' => 1,
4059 // FIXME: should we use defaultHierReturnProperties() for the below?
4060 'do_not_email' => 1,
4063 'do_not_phone' => 1,
4064 'do_not_trade' => 1,
4066 'contact_is_deleted' => 1,
4067 'preferred_communication_method' => 1,
4068 'preferred_language' => 1,
4072 return self
::$_defaultReturnProperties[$mode];
4076 * get primary condition for a sql clause
4083 static function getPrimaryCondition($value) {
4084 if (is_numeric($value)) {
4085 $value = (int ) $value;
4086 return ($value == 1) ?
'is_primary = 1' : 'is_primary = 0';
4092 * wrapper for a simple search query
4094 * @param array $params
4095 * @param array $returnProperties
4096 * @param \bolean|bool $count
4101 static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4102 $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4103 list($select, $from, $where, $having) = $query->query();
4105 return "$select $from $where $having";
4109 * These are stub comments as this function needs more explanation - particularly in terms of how it
4110 * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4112 * This function was originally written as a wrapper for the api query but is called from multiple places
4113 * in the core code directly so the name is misleading. This function does not use the searchQuery function
4114 * but it is unclear as to whehter that is historical or there is a reason
4115 * CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4117 * @param array $params
4118 * @param array $returnProperties
4119 * @param null $fields
4120 * @param string $sort
4121 * @param int $offset
4122 * @param int $row_count
4123 * @param bool $smartGroupCache
4124 * @param bool $count return count obnly
4125 * @param bool $skipPermissions Should permissions be ignored or should the logged in user's permissions be applied
4127 * @params bool $smartGroupCache ?? update smart group cache?
4132 static function apiQuery(
4134 $returnProperties = NULL,
4139 $smartGroupCache = TRUE,
4141 $skipPermissions = TRUE
4144 $query = new CRM_Contact_BAO_Query(
4145 $params, $returnProperties,
4146 NULL, TRUE, FALSE, 1,
4148 TRUE, $smartGroupCache
4151 //this should add a check for view deleted if permissions are enabled
4152 if ($skipPermissions){
4153 $query->_skipDeleteClause
= TRUE;
4155 $query->generatePermissionClause(FALSE, $count);
4157 // note : this modifies _fromClause and _simpleFromClause
4158 $query->includePseudoFieldsJoin($sort);
4160 list($select, $from, $where, $having) = $query->query($count);
4162 $options = $query->_options
;
4163 if(!empty($query->_permissionWhereClause
)){
4164 if (empty($where)) {
4165 $where = "WHERE $query->_permissionWhereClause";
4168 $where = "$where AND $query->_permissionWhereClause";
4172 $sql = "$select $from $where $having";
4175 if ($query->_useGroupBy
) {
4176 $sql .= ' GROUP BY contact_a.id';
4178 if (!empty($sort)) {
4179 $sort = CRM_Utils_Type
::escape($sort, 'String');
4180 $sql .= " ORDER BY $sort ";
4182 if ($row_count > 0 && $offset >= 0) {
4183 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4184 $rowCount = CRM_Utils_Type
::escape($row_count, 'Int');
4185 $sql .= " LIMIT $offset, $row_count ";
4188 $dao = CRM_Core_DAO
::executeQuery($sql);
4191 while ($dao->fetch()) {
4193 $noRows = $dao->rowCount
;
4195 return array($noRows,NULL);
4197 $val = $query->store($dao);
4198 $convertedVals = $query->convertToPseudoNames($dao, TRUE);
4200 if (!empty($convertedVals)) {
4201 $val = array_replace_recursive($val, $convertedVals);
4203 $values[$dao->contact_id
] = $val;
4206 return array($values, $options);
4210 * create and query the db for an contact search
4212 * @param int $offset the offset for the query
4213 * @param int $rowCount the number of rows to return
4214 * @param string $sort the order by string
4215 * @param boolean $count is this a count only query ?
4216 * @param boolean $includeContactIds should we include contact ids?
4217 * @param boolean $sortByChar if true returns the distinct array of first characters for search results
4218 * @param boolean $groupContacts if true, return only the contact ids
4219 * @param boolean $returnQuery should we return the query as a string
4220 * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components)
4221 * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load.
4223 * @return CRM_Contact_DAO_Contact
4226 function searchQuery(
4227 $offset = 0, $rowCount = 0, $sort = NULL,
4228 $count = FALSE, $includeContactIds = FALSE,
4229 $sortByChar = FALSE, $groupContacts = FALSE,
4230 $returnQuery = FALSE,
4231 $additionalWhereClause = NULL, $sortOrder = NULL,
4232 $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4235 if ($includeContactIds) {
4236 $this->_includeContactIds
= TRUE;
4237 $this->_whereClause
= $this->whereClause();
4240 $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
);
4242 // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4243 // and that contact happens to be deleted, set $onlyDeleted to true
4244 foreach ($this->_params
as $values) {
4245 $name = CRM_Utils_Array
::value(0, $values);
4246 $op = CRM_Utils_Array
::value(1, $values);
4247 $value = CRM_Utils_Array
::value(2, $values);
4248 if ($name == 'contact_id' and $op == '=') {
4249 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4250 $onlyDeleted = TRUE;
4255 $this->generatePermissionClause($onlyDeleted, $count);
4257 // building the query string
4260 if (isset($this->_groupByComponentClause
)) {
4261 $groupBy = $this->_groupByComponentClause
;
4263 elseif ($this->_useGroupBy
) {
4264 $groupBy = ' GROUP BY contact_a.id';
4267 if ($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
&& (!$count)) {
4268 $groupBy = 'GROUP BY civicrm_activity.id ';
4271 $order = $orderBy = $limit = '';
4273 $config = CRM_Core_Config
::singleton();
4274 if ($config->includeOrderByClause ||
4275 isset($this->_distinctComponentClause
)
4278 if (is_string($sort)) {
4282 $orderBy = trim($sort->orderBy());
4284 if (!empty($orderBy)) {
4285 // this is special case while searching for
4286 // changelog CRM-1718
4287 if (preg_match('/sort_name/i', $orderBy)) {
4288 $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
4291 $orderBy = CRM_Utils_Type
::escape($orderBy, 'String');
4292 $order = " ORDER BY $orderBy";
4295 $sortOrder = CRM_Utils_Type
::escape($sortOrder, 'String');
4296 $order .= " $sortOrder";
4299 // always add contact_a.id to the ORDER clause
4300 // so the order is deterministic
4301 if (strpos('contact_a.id', $order) === FALSE) {
4302 $order .= ", contact_a.id";
4306 elseif ($sortByChar) {
4307 $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc";
4310 $order = " ORDER BY contact_a.sort_name asc, contact_a.id";
4314 // hack for order clause
4316 $fieldStr = trim(str_replace('ORDER BY', '', $order));
4317 $fieldOrder = explode(' ', $fieldStr);
4318 $field = $fieldOrder[0];
4324 $this->_whereTables
["civicrm_address"] = 1;
4325 $order = str_replace($field, "civicrm_address.{$field}", $order);
4329 case 'state_province':
4330 $this->_whereTables
["civicrm_{$field}"] = 1;
4331 $order = str_replace($field, "civicrm_{$field}.name", $order);
4335 $this->_whereTables
["civicrm_email"] = 1;
4336 $order = str_replace($field, "civicrm_email.{$field}", $order);
4339 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4340 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4344 if ($rowCount > 0 && $offset >= 0) {
4345 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4346 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
4347 $limit = " LIMIT $offset, $rowCount ";
4351 // note : this modifies _fromClause and _simpleFromClause
4352 $this->includePseudoFieldsJoin($sort);
4354 list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts);
4356 if(!empty($this->_permissionWhereClause
)){
4357 if (empty($where)) {
4358 $where = "WHERE $this->_permissionWhereClause";
4361 $where = "$where AND $this->_permissionWhereClause";
4365 if ($additionalWhereClause) {
4366 $where = $where . ' AND ' . $additionalWhereClause;
4369 //additional from clause should be w/ proper joins.
4370 if ($additionalFromClause) {
4371 $from .= "\n" . $additionalFromClause;
4374 // if we are doing a transform, do it here
4375 // use the $from, $where and $having to get the contact ID
4376 if ($this->_displayRelationshipType
) {
4377 $this->filterRelatedContacts($from, $where, $having);
4380 if ($skipOrderAndLimit) {
4381 $query = "$select $from $where $having $groupBy";
4384 $query = "$select $from $where $having $groupBy $order $limit";
4392 return CRM_Core_DAO
::singleValueQuery($query);
4395 $dao = CRM_Core_DAO
::executeQuery($query);
4396 if ($groupContacts) {
4398 while ($dao->fetch()) {
4401 return implode(',', $ids);
4408 * Fetch a list of contacts from the prev/next cache for displaying a search results page
4410 * @param string $cacheKey
4411 * @param int $offset
4412 * @param int $rowCount
4413 * @param bool $includeContactIds
4414 * @return CRM_Core_DAO
4416 function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
4417 $this->_includeContactIds
= $includeContactIds;
4418 list($select, $from, $where) = $this->query();
4419 $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);
4420 $order = " ORDER BY pnc.id";
4421 $groupBy = " GROUP BY contact_a.id";
4422 $limit = " LIMIT $offset, $rowCount";
4423 $query = "$select $from $where $groupBy $order $limit";
4425 return CRM_Core_DAO
::executeQuery($query);
4429 * Populate $this->_permissionWhereClause with permission related clause and update other
4430 * query related properties.
4432 * Function calls ACL permission class and hooks to filter the query appropriately
4434 * Note that these 2 params were in the code when extracted from another function
4435 * and a second round extraction would be to make them properties of the class
4437 * @param bool $onlyDeleted Only get deleted contacts
4438 * @param bool $count Return Count only
4442 function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
4443 if (!$this->_skipPermission
) {
4444 $this->_permissionWhereClause
= CRM_ACL_API
::whereClause(
4445 CRM_Core_Permission
::VIEW
,
4447 $this->_whereTables
,
4450 $this->_skipDeleteClause
4453 // regenerate fromClause since permission might have added tables
4454 if ($this->_permissionWhereClause
) {
4455 //fix for row count in qill (in contribute/membership find)
4457 $this->_useDistinct
= TRUE;
4459 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4460 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4464 // add delete clause if needed even if we are skipping permission
4466 if (!$this->_skipDeleteClause
) {
4467 if (CRM_Core_Permission
::check('access deleted contacts') and $onlyDeleted) {
4468 $this->_permissionWhereClause
= '(contact_a.is_deleted)';
4472 $this->_permissionWhereClause
= '(contact_a.is_deleted = 0)';
4478 function setSkipPermission($val) {
4479 $this->_skipPermission
= $val;
4482 function &summaryContribution($context = NULL) {
4483 list($select, $from, $where, $having) = $this->query(TRUE);
4487 SELECT COUNT( civicrm_contribution.total_amount ) as total_count,
4488 SUM( civicrm_contribution.total_amount ) as total_amount,
4489 AVG( civicrm_contribution.total_amount ) as total_avg,
4490 civicrm_contribution.currency as currency";
4492 // make sure contribution is completed - CRM-4989
4493 $where .= " AND civicrm_contribution.contribution_status_id = 1 ";
4494 if ($context == 'search') {
4495 $where .= " AND contact_a.is_deleted = 0 ";
4499 $summary['total'] = array();
4500 $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
4502 $query = "$select $from $where GROUP BY currency";
4505 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4507 $summary['total']['count'] = 0;
4508 $summary['total']['amount'] = $summary['total']['avg'] = array();
4509 while ($dao->fetch()) {
4510 $summary['total']['count'] +
= $dao->total_count
;
4511 $summary['total']['amount'][] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
4512 $summary['total']['avg'][] = CRM_Utils_Money
::format($dao->total_avg
, $dao->currency
);
4514 if (!empty($summary['total']['amount'])) {
4515 $summary['total']['amount'] = implode(', ', $summary['total']['amount']);
4516 $summary['total']['avg'] = implode(', ', $summary['total']['avg']);
4519 $summary['total']['amount'] = $summary['total']['avg'] = 0;
4524 SELECT COUNT( civicrm_contribution.total_amount ) as cancel_count,
4525 SUM( civicrm_contribution.total_amount ) as cancel_amount,
4526 AVG( civicrm_contribution.total_amount ) as cancel_avg,
4527 civicrm_contribution.currency as currency";
4529 $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
4530 if ($context == 'search') {
4531 $where .= " AND contact_a.is_deleted = 0 ";
4534 $query = "$select $from $where GROUP BY currency";
4535 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4538 if ($dao->fetch()) {
4539 $summary['cancel']['count'] = $dao->cancel_count
;
4540 $summary['cancel']['amount'] = $dao->cancel_amount
;
4541 $summary['cancel']['avg'] = $dao->cancel_avg
;
4545 $summary['cancel']['count'] = 0;
4546 $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
4547 while ($dao->fetch()) {
4548 $summary['cancel']['count'] +
= $dao->cancel_count
;
4549 $summary['cancel']['amount'][] = CRM_Utils_Money
::format($dao->cancel_amount
, $dao->currency
);
4550 $summary['cancel']['avg'][] = CRM_Utils_Money
::format($dao->cancel_avg
, $dao->currency
);
4552 $summary['cancel']['amount'] = implode(', ', $summary['cancel']['amount']);
4553 $summary['cancel']['avg'] = implode(', ', $summary['cancel']['avg']);
4560 * getter for the qill object
4566 return $this->_qill
;
4570 * default set of return default hier return properties
4575 static function &defaultHierReturnProperties() {
4576 if (!isset(self
::$_defaultHierReturnProperties)) {
4577 self
::$_defaultHierReturnProperties = array(
4580 'legal_identifier' => 1,
4581 'external_identifier' => 1,
4582 'contact_type' => 1,
4583 'contact_sub_type' => 1,
4585 'display_name' => 1,
4592 'formal_title' => 1,
4593 'communication_style_id' => 1,
4594 'email_greeting' => 1,
4595 'postal_greeting' => 1,
4599 'preferred_communication_method' => 1,
4600 'do_not_phone' => 1,
4601 'do_not_email' => 1,
4604 'do_not_trade' => 1,
4607 '1' => array('location_type' => 1,
4608 'street_address' => 1,
4610 'state_province' => 1,
4612 'postal_code_suffix' => 1,
4615 'phone-Mobile' => 1,
4628 'location_type' => 1,
4629 'street_address' => 1,
4631 'state_province' => 1,
4633 'postal_code_suffix' => 1,
4636 'phone-Mobile' => 1,
4650 return self
::$_defaultHierReturnProperties;
4653 function dateQueryBuilder(
4654 &$values, $tableName, $fieldName,
4655 $dbFieldName, $fieldTitle,
4656 $appendTimeStamp = TRUE
4658 list($name, $op, $value, $grouping, $wildcard) = $values;
4664 if ($name == "{$fieldName}_low" ||
4665 $name == "{$fieldName}_high"
4667 if (isset($this->_rangeCache
[$fieldName])) {
4670 $this->_rangeCache
[$fieldName] = 1;
4672 $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
4674 if ($name == $fieldName . '_low') {
4676 $firstPhrase = ts('greater than or equal to');
4677 $firstDate = CRM_Utils_Date
::processDate($value);
4679 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4680 if (!empty($secondValues) && $secondValues[2]) {
4682 $secondPhrase = ts('less than or equal to');
4683 $secondValue = $secondValues[2];
4685 if ($appendTimeStamp && strlen($secondValue) == 10) {
4686 $secondValue .= ' 23:59:59';
4688 $secondDate = CRM_Utils_Date
::processDate($secondValue);
4691 elseif ($name == $fieldName . '_high') {
4693 $firstPhrase = ts('less than or equal to');
4695 if ($appendTimeStamp && strlen($value) == 10) {
4696 $value .= ' 23:59:59';
4698 $firstDate = CRM_Utils_Date
::processDate($value);
4700 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4701 if (!empty($secondValues) && $secondValues[2]) {
4703 $secondPhrase = ts('greater than or equal to');
4704 $secondValue = $secondValues[2];
4705 $secondDate = CRM_Utils_Date
::processDate($secondValue);
4709 if (!$appendTimeStamp) {
4710 $firstDate = substr($firstDate, 0, 8);
4712 $firstDateFormat = CRM_Utils_Date
::customFormat($firstDate);
4715 if (!$appendTimeStamp) {
4716 $secondDate = substr($secondDate, 0, 8);
4718 $secondDateFormat = CRM_Utils_Date
::customFormat($secondDate);
4721 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4723 $this->_where
[$grouping][] = "
4724 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
4725 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
4727 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
4730 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
4731 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
4735 if ($name == $fieldName) {
4739 $date = CRM_Utils_Date
::processDate($value);
4741 if (!$appendTimeStamp) {
4742 $date = substr($date, 0, 8);
4745 $format = CRM_Utils_Date
::customFormat($date);
4748 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op '$date'";
4751 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op";
4753 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4754 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$format\"";
4758 $tableName == 'civicrm_log' &&
4759 $fieldTitle == ts('Added Date')
4761 //CRM-6903 --hack to check modified date of first record.
4762 //as added date means first modified date of object.
4763 $addedDateQuery = 'select id from civicrm_log group by entity_id order by id';
4764 $this->_where
[$grouping][] = "civicrm_log.id IN ( {$addedDateQuery} )";
4768 function numberRangeBuilder(&$values,
4769 $tableName, $fieldName,
4770 $dbFieldName, $fieldTitle,
4773 list($name, $op, $value, $grouping, $wildcard) = $values;
4775 if ($name == "{$fieldName}_low" ||
4776 $name == "{$fieldName}_high"
4778 if (isset($this->_rangeCache
[$fieldName])) {
4781 $this->_rangeCache
[$fieldName] = 1;
4783 $secondOP = $secondPhrase = $secondValue = NULL;
4785 if ($name == "{$fieldName}_low") {
4787 $firstPhrase = ts('greater than');
4789 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4790 if (!empty($secondValues)) {
4792 $secondPhrase = ts('less than');
4793 $secondValue = $secondValues[2];
4798 $firstPhrase = ts('less than');
4800 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4801 if (!empty($secondValues)) {
4803 $secondPhrase = ts('greater than');
4804 $secondValue = $secondValues[2];
4809 $this->_where
[$grouping][] = "
4810 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
4811 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
4813 $displayValue = $options ?
$options[$value] : $value;
4814 $secondDisplayValue = $options ?
$options[$secondValue] : $secondValue;
4816 $this->_qill
[$grouping][] =
4817 "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
4820 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
4821 $displayValue = $options ?
$options[$value] : $value;
4822 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
4824 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4829 if ($name == $fieldName) {
4833 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
4835 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4836 $displayValue = $options ?
$options[$value] : $value;
4837 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
4844 * Given the field name, operator, value & its data type
4845 * builds the where Clause for the query
4846 * used for handling 'IS NULL'/'IS NOT NULL' operators
4848 * @param string $field fieldname
4849 * @param string $op operator
4850 * @param string $value value
4851 * @param string $dataType data type of the field
4853 * @return where clause for the query
4856 static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
4858 $clause = "$field $op";
4866 $clause = " ( $field IS NULL OR $field = '' ) ";
4869 case 'IS NOT EMPTY':
4870 $clause = " ( $field IS NOT NULL AND $field <> '' ) ";
4875 if (isset($dataType)) {
4876 if (is_array($value)) {
4880 $value = CRM_Utils_Type
::escape($value, "String");
4881 $values = explode(',', CRM_Utils_Array
::value(0, explode(')', CRM_Utils_Array
::value(1, explode('(', $value)))));
4883 // supporting multiple values in IN clause
4885 foreach ($values as $v) {
4887 $val[] = "'" . CRM_Utils_Type
::escape($v, $dataType) . "'";
4889 $value = "(" . implode($val, ",") . ")";
4891 return "$clause $value";
4894 if (empty($dataType)) {
4895 $dataType = 'String';
4898 $value = CRM_Utils_Type
::escape($value, $dataType);
4899 // if we dont have a dataType we should assume
4900 if ($dataType == 'String' ||
$dataType == 'Text') {
4901 $value = "'" . strtolower($value) . "'";
4903 return "$clause $value";
4907 function openedSearchPanes($reset = FALSE) {
4908 if (!$reset ||
empty($this->_whereTables
)) {
4909 return self
::$_openedPanes;
4912 // pane name to table mapper
4913 $panesMapper = array(
4914 ts('Contributions') => 'civicrm_contribution',
4915 ts('Memberships') => 'civicrm_membership',
4916 ts('Events') => 'civicrm_participant',
4917 ts('Relationships') => 'civicrm_relationship',
4918 ts('Activities') => 'civicrm_activity',
4919 ts('Pledges') => 'civicrm_pledge',
4920 ts('Cases') => 'civicrm_case',
4921 ts('Grants') => 'civicrm_grant',
4922 ts('Address Fields') => 'civicrm_address',
4923 ts('Notes') => 'civicrm_note',
4924 ts('Change Log') => 'civicrm_log',
4925 ts('Mailings') => 'civicrm_mailing_event_queue',
4927 CRM_Contact_BAO_Query_Hook
::singleton()->getPanesMapper($panesMapper);
4929 foreach (array_keys($this->_whereTables
) as $table) {
4930 if ($panName = array_search($table, $panesMapper)) {
4931 self
::$_openedPanes[$panName] = TRUE;
4935 return self
::$_openedPanes;
4938 function setOperator($operator) {
4939 $validOperators = array('AND', 'OR');
4940 if (!in_array($operator, $validOperators)) {
4943 $this->_operator
= $operator;
4946 function getOperator() {
4947 return $this->_operator
;
4950 function filterRelatedContacts(&$from, &$where, &$having) {
4951 static $_rTypeProcessed = NULL;
4952 static $_rTypeFrom = NULL;
4953 static $_rTypeWhere = NULL;
4955 if (!$_rTypeProcessed) {
4956 $_rTypeProcessed = TRUE;
4958 // create temp table with contact ids
4959 $tableName = CRM_Core_DAO
::createTempTableName('civicrm_transform', TRUE);
4960 $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
4961 CRM_Core_DAO
::executeQuery($sql);
4964 REPLACE INTO $tableName ( contact_id )
4970 CRM_Core_DAO
::executeQuery($sql);
4972 $qillMessage = ts('Contacts with a Relationship Type of: ');
4973 $rTypes = CRM_Core_PseudoConstant
::relationshipType();
4975 if (is_numeric($this->_displayRelationshipType
)) {
4976 $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType
]['label_a_b'];
4978 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
4979 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
4982 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
4983 AND displayRelType.is_active = 1
4987 list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType
);
4988 if ($dirOne == 'a') {
4989 $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
4991 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
4992 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
4996 $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
4998 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
4999 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
5003 WHERE displayRelType.relationship_type_id = $relType
5004 AND displayRelType.is_active = 1
5007 $this->_qill
[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'";
5010 if (strpos($from, $_rTypeFrom) === FALSE) {
5011 // lets replace all the INNER JOIN's in the $from so we dont exclude other data
5012 // this happens when we have an event_type in the quert (CRM-7969)
5013 $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
5014 $from .= $_rTypeFrom;
5015 $where = $_rTypeWhere;
5021 static function caseImportant( $op ) {
5023 in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ?
FALSE : TRUE;
5026 static function componentPresent( &$returnProperties, $prefix ) {
5027 foreach ($returnProperties as $name => $dontCare ) {
5028 if (substr($name, 0, strlen($prefix)) == $prefix) {
5036 * Builds the necessary structures for all fields that are similar to option value lookups
5038 * @param $name string the name of the field
5039 * @param $op string the sql operator, this function should handle ALL SQL operators
5040 * @param $value any string / integer / array depends on the operator and whos calling the query builder
5041 * @param $grouping int the index where to place the where clause
5042 * @param $selectValues
5043 * @param $field array an array that contains various properties of the field identified by $name
5044 * @param $label string The label for this field element
5045 * @param $dataType string The data type for this element
5047 * @param bool $useIDsOnly
5049 * @internal param array $selectValue the key value pairs for this element. This allows us to use this function for things besides option-value pairs
5050 * @return void adds the where clause and qill to the query object
5052 function optionValueQuery(
5060 $dataType = 'String',
5064 if (!empty($selectValues)) {
5065 $qill = $selectValues[$value];
5071 $pseudoFields = array('email_greeting', 'postal_greeting', 'addressee', 'gender_id', 'prefix_id', 'suffix_id', 'communication_style_id');
5073 if (is_numeric($value)) {
5074 $qill = $selectValues[(int ) $value];
5076 elseif ($op == 'IN' ||
$op == 'NOT IN') {
5077 $values = self
::parseSearchBuilderString($value);
5078 if (is_array($values)) {
5080 $newValues = array();
5081 foreach ($values as $v) {
5082 $intVals[] = (int) $v;
5083 $newValues[] = $selectValues[(int ) $v];
5086 $value = (in_array($name, $pseudoFields)) ?
$intVals : $newValues;
5087 $qill = implode(', ', $newValues);
5090 elseif (!array_key_exists($value, $selectValues)) {
5091 // its a string, lets get the int value
5092 $value = array_search($value, $selectValues);
5095 list($tableName, $fieldName) = explode('.', $field['where'], 2);
5096 if ($tableName == 'civicrm_contact') {
5097 $wc = "contact_a.$fieldName";
5101 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
5104 if (in_array($name, $pseudoFields)) {
5105 if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id', 'communication_style_id'))) {
5106 $wc = "contact_a.{$name}_id";
5108 $dataType = 'Positive';
5109 $value = (!$value) ?
0 : $value;
5112 $this->_qill
[$grouping][] = $label . " $op '$qill'";
5113 $op = (in_array($name, $pseudoFields) && ($op == 'LIKE' ||
$op == 'RLIKE')) ?
'=' : $op;
5114 $this->_where
[$grouping][] = self
::buildClause($wc, $op, $value, $dataType);
5118 * function to check and explode a user defined numeric string into an array
5119 * this was the protocol used by search builder in the old old days before we had
5120 * super nice js widgets to do the hard work
5122 * @param the $string
5123 * @param string $dataType the dataType we should check for the values, default integer
5125 * @return FALSE if string does not match the patter
5126 * array of numeric values if string does match the pattern
5129 static function parseSearchBuilderString($string, $dataType = 'Integer') {
5130 $string = trim($string);
5131 if (substr($string, 0, 1) != '(' ||
substr($string, -1, 1) != ')') {
5135 $string = substr($string, 1, -1);
5136 $values = explode(',', $string);
5137 if (empty($values)) {
5141 $returnValues = array();
5142 foreach ($values as $v) {
5143 if ($dataType == 'Integer' && ! is_numeric($v)) {
5146 else if ($dataType == 'String' && ! is_string($v)) {
5149 $returnValues[] = trim($v);
5152 if (empty($returnValues)) {
5156 return $returnValues;
5160 * convert the pseudo constants id's to their names
5162 * @param reference parameter $dao
5163 * @param bool $return
5167 function convertToPseudoNames(&$dao, $return = FALSE) {
5168 if (empty($this->_pseudoConstantsSelect
)) {
5172 foreach ($this->_pseudoConstantsSelect
as $key => $value) {
5173 if (CRM_Utils_Array
::value('sorting', $this->_pseudoConstantsSelect
[$key])) {
5177 if (property_exists($dao, $value['idCol'])) {
5178 $val = $dao->$value['idCol'];
5180 if (CRM_Utils_System
::isNull($val)) {
5183 elseif ($baoName = CRM_Utils_Array
::value('bao', $value, NULL)) {
5185 $idColumn = "{$key}_id";
5186 $dao->$idColumn = $val;
5187 $dao->$key = CRM_Core_PseudoConstant
::getLabel($baoName, $value['pseudoField'], $val);
5189 elseif ($value['pseudoField'] == 'state_province_abbreviation') {
5190 $dao->$key = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($val);
5193 $labels = CRM_Core_OptionGroup
::values($value['pseudoField']);
5194 $dao->$key = $labels[$val];
5197 // return converted values in array format
5199 if (strpos($key, '-') !== FALSE) {
5200 $keyVal = explode('-', $key);
5201 $current = &$values;
5202 $lastElement = array_pop($keyVal);
5203 foreach ($keyVal as $v) {
5204 if (!array_key_exists($v, $current)) {
5205 $current[$v] = array();
5207 $current = &$current[$v];
5209 $current[$lastElement] = $dao->$key;
5212 $values[$key] = $dao->$key;
5221 * include pseudo fields LEFT JOIN
5222 * @param $sort can be a object or string
5226 function includePseudoFieldsJoin($sort) {
5227 if (!$sort ||
empty($this->_pseudoConstantsSelect
)) {
5230 $sort = is_string($sort) ?
$sort : $sort->orderBy();
5233 foreach ($this->_pseudoConstantsSelect
as $name => $value) {
5234 if (CRM_Utils_Array
::value('table', $value)) {
5235 $regex = "/({$value['table']}\.|{$name})/";
5236 if (preg_match($regex, $sort)) {
5237 $this->_elemnt
[$value['element']] = 1;
5238 $this->_select
[$value['element']] = $value['select'];
5239 $this->_pseudoConstantsSelect
[$name]['sorting'] = 1;
5240 $present[$value['table']] = $value['join'];
5244 $presentSimpleFrom = $present;
5246 if (array_key_exists('civicrm_worldregion', $this->_whereTables
) &&
5247 array_key_exists('civicrm_country', $presentSimpleFrom)) {
5248 unset($presentSimpleFrom['civicrm_country']);
5250 if (array_key_exists('civicrm_worldregion', $this->_tables
) &&
5251 array_key_exists('civicrm_country', $present)) {
5252 unset($present['civicrm_country']);
5255 $presentClause = $presentSimpleFromClause = NULL;
5256 if (!empty($present)) {
5257 $presentClause = implode(' ', $present);
5259 if (!empty($presentSimpleFrom)) {
5260 $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
5263 $this->_fromClause
= $this->_fromClause
. $presentClause;
5264 $this->_simpleFromClause
= $this->_simpleFromClause
. $presentSimpleFromClause;
5266 return array($presentClause, $presentSimpleFromClause);