3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
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;
154 * additional permission from clause
159 public $_permissionFromClause;
162 * the from clause for the simple select and alphabetical
167 public $_simpleFromClause;
178 * The english language version of the query
185 * All the fields that could potentially be involved in
193 * The cache to translate the option values into labels
200 * are we in search mode
204 public $_search = TRUE;
207 * should we skip permission checking
211 public $_skipPermission = FALSE;
214 * should we skip adding of delete clause
218 public $_skipDeleteClause = FALSE;
221 * are we in strict mode (use equality over LIKE)
225 public $_strict = FALSE;
228 * What operator to use to group the clauses
232 public $_operator = 'AND';
237 * Should we only search on primary location
241 public $_primaryLocation = TRUE;
244 * are contact ids part of the query
248 public $_includeContactIds = FALSE;
251 * Should we use the smart group cache
255 public $_smartGroupCache = TRUE;
258 * Should we display contacts with a specific relationship type
262 public $_displayRelationshipType = NULL;
265 * reference to the query object for custom values
269 public $_customQuery;
272 * should we enable the distinct clause, used if we are including
273 * more than one group
277 public $_useDistinct = FALSE;
280 * Should we just display one contact record
282 public $_useGroupBy = FALSE;
285 * the relationship type direction
298 static $_activityRole;
301 * Consider the component activity type
302 * during activity search.
307 static $_considerCompActivities;
310 * Consider with contact activities only,
311 * during activity search.
316 static $_withContactActivitiesOnly;
319 * use distinct component clause for component searches
323 public $_distinctComponentClause;
326 * use groupBy component clause for component searches
330 public $_groupByComponentClause;
333 * Track open panes, useful in advance search
338 public static $_openedPanes = array();
341 * The tables which have a dependency on location and/or address
346 static $_dependencies = array(
347 'civicrm_state_province' => 1,
348 'civicrm_country' => 1,
349 'civicrm_county' => 1,
350 'civicrm_address' => 1,
351 'civicrm_location_type' => 1,
355 * List of location specific fields
357 static $_locationSpecificFields = array(
362 'supplemental_address_1',
363 'supplemental_address_2',
366 'postal_code_suffix',
379 * Rememeber if we handle either end of a number or date range
380 * so we can skip the other
382 protected $_rangeCache = array();
385 * class constructor which also does all the work
387 * @param array $params
388 * @param array $returnProperties
389 * @param array $fields
390 * @param boolean $includeContactIds
391 * @param boolean $strict
392 * @param boolean $mode - mode the search is operating on
397 function __construct(
398 $params = NULL, $returnProperties = NULL, $fields = NULL,
399 $includeContactIds = FALSE, $strict = FALSE, $mode = 1,
400 $skipPermission = FALSE, $searchDescendentGroups = TRUE,
401 $smartGroupCache = TRUE, $displayRelationshipType = NULL,
404 $this->_params
= &$params;
405 if ($this->_params
== NULL) {
406 $this->_params
= array();
409 if (empty($returnProperties)) {
410 $this->_returnProperties
= self
::defaultReturnProperties($mode);
413 $this->_returnProperties
= &$returnProperties;
416 $this->_includeContactIds
= $includeContactIds;
417 $this->_strict
= $strict;
418 $this->_mode
= $mode;
419 $this->_skipPermission
= $skipPermission;
420 $this->_smartGroupCache
= $smartGroupCache;
421 $this->_displayRelationshipType
= $displayRelationshipType;
422 $this->setOperator($operator);
425 $this->_fields
= &$fields;
426 $this->_search
= FALSE;
427 $this->_skipPermission
= TRUE;
430 $this->_fields
= CRM_Contact_BAO_Contact
::exportableFields('All', FALSE, TRUE, TRUE);
432 $fields = CRM_Core_Component
::getQueryFields();
433 unset($fields['note']);
434 $this->_fields
= array_merge($this->_fields
, $fields);
436 // add activity fields
437 $fields = CRM_Activity_BAO_Activity
::exportableFields();
438 $this->_fields
= array_merge($this->_fields
, $fields);
441 // basically do all the work once, and then reuse it
446 * function which actually does all the work for the constructor
451 function initialize() {
452 $this->_select
= array();
453 $this->_element
= array();
454 $this->_tables
= array();
455 $this->_whereTables
= array();
456 $this->_where
= array();
457 $this->_qill
= array();
458 $this->_options
= array();
459 $this->_cfIDs
= array();
460 $this->_paramLookup
= array();
461 $this->_having
= array();
463 $this->_customQuery
= NULL;
465 // reset cached static variables - CRM-5803
466 self
::$_activityRole = NULL;
467 self
::$_considerCompActivities = NULL;
468 self
::$_withContactActivitiesOnly = NULL;
470 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
471 $this->_element
['contact_id'] = 1;
472 $this->_tables
['civicrm_contact'] = 1;
474 if (!empty($this->_params
)) {
475 $this->buildParamsLookup();
478 $this->_whereTables
= $this->_tables
;
480 $this->selectClause();
481 $this->_whereClause
= $this->whereClause();
483 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
484 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
486 $this->openedSearchPanes(TRUE);
489 function buildParamsLookup() {
490 // first fix and handle contact deletion nicely
491 // this code is primarily for search builder use case
492 // where different clauses can specify if they want deleted
495 $trashParamExists = FALSE;
496 $paramByGroup = array();
497 foreach ( $this->_params
as $k => $param ) {
498 if (!empty($param[0]) && $param[0] == 'contact_is_deleted' ) {
499 $trashParamExists = TRUE;
501 if (!empty($param[3])) {
502 $paramByGroup[$param[3]][$k] = $param;
506 if ( $trashParamExists ) {
507 $this->_skipDeleteClause
= TRUE;
509 //cycle through group sets and explicitly add trash param if not set
510 foreach ( $paramByGroup as $setID => $set ) {
512 !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params
) &&
513 !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params
) ) {
514 $this->_params
[] = array(
515 'contact_is_deleted',
525 foreach ($this->_params
as $value) {
526 if (!CRM_Utils_Array
::value(0, $value)) {
529 $cfID = CRM_Core_BAO_CustomField
::getKeyID($value[0]);
531 if (!array_key_exists($cfID, $this->_cfIDs
)) {
532 $this->_cfIDs
[$cfID] = array();
534 $this->_cfIDs
[$cfID][] = $value;
537 if (!array_key_exists($value[0], $this->_paramLookup
)) {
538 $this->_paramLookup
[$value[0]] = array();
540 $this->_paramLookup
[$value[0]][] = $value;
545 * Some composite fields do not appear in the fields array
546 * hack to make them part of the query
551 function addSpecialFields() {
552 static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name');
553 foreach ($special as $name) {
554 if (CRM_Utils_Array
::value($name, $this->_returnProperties
)) {
555 $this->_select
[$name] = "contact_a.{$name} as $name";
556 $this->_element
[$name] = 1;
562 * Given a list of conditions in params and a list of desired
563 * return Properties generate the required select and from
564 * clauses. Note that since the where clause introduces new
565 * tables, the initial attempt also retrieves all variables used
571 function selectClause() {
572 $properties = array();
574 $this->addSpecialFields();
576 foreach ($this->_fields
as $name => $field) {
578 // skip component fields
579 // there are done by the alter query below
580 // and need not be done on every field
581 if ((substr($name, 0, 12) == 'participant_') ||
582 (substr($name, 0, 7) == 'pledge_') ||
583 (substr($name, 0, 5) == 'case_')
588 // redirect to activity select clause
589 if (substr($name, 0, 9) == 'activity_') {
590 CRM_Activity_BAO_Query
::select($this);
594 // if this is a hierarchical name, we ignore it
595 $names = explode('-', $name);
596 if (count($names > 1) && isset($names[1]) && is_numeric($names[1])) {
600 $cfID = CRM_Core_BAO_CustomField
::getKeyID($name);
602 if (CRM_Utils_Array
::value($name, $this->_paramLookup
) ||
603 CRM_Utils_Array
::value($name, $this->_returnProperties
)
607 // add to cfIDs array if not present
608 if (!array_key_exists($cfID, $this->_cfIDs
)) {
609 $this->_cfIDs
[$cfID] = array();
612 elseif (isset($field['where'])) {
613 list($tableName, $fieldName) = explode('.', $field['where'], 2);
614 if (isset($tableName)) {
616 if (CRM_Utils_Array
::value($tableName, self
::$_dependencies)) {
617 $this->_tables
['civicrm_address'] = 1;
618 $this->_select
['address_id'] = 'civicrm_address.id as address_id';
619 $this->_element
['address_id'] = 1;
622 if ($tableName == 'gender' ||
$tableName == 'individual_prefix'
623 ||
$tableName == 'individual_suffix' ||
$tableName == 'im_provider'
624 ||
$tableName == 'email_greeting' ||
$tableName == 'postal_greeting'
625 ||
$tableName == 'addressee'
627 CRM_Core_OptionValue
::select($this);
628 if (in_array($tableName, array(
629 'email_greeting', 'postal_greeting', 'addressee'))) {
631 $greetField = "{$name}_display";
632 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
633 $this->_element
[$greetField] = 1;
635 $greetField = "{$name}_custom";
636 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
637 $this->_element
[$greetField] = 1;
641 $this->_tables
[$tableName] = 1;
643 // also get the id of the tableName
644 $tName = substr($tableName, 8);
646 if ($tName != 'contact') {
647 $this->_select
["{$tName}_id"] = "{$tableName}.id as {$tName}_id";
648 $this->_element
["{$tName}_id"] = 1;
651 //special case for phone
652 if ($name == 'phone') {
653 $this->_select
['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id";
654 $this->_element
['phone_type_id'] = 1;
657 // if IM then select provider_id also
658 // to get "IM Service Provider" in a file to be exported, CRM-3140
660 $this->_select
['provider_id'] = "civicrm_im.provider_id as provider_id";
661 $this->_element
['provider_id'] = 1;
664 if ($name == 'state_province') {
665 $this->_select
[$name] = "civicrm_state_province.abbreviation as `$name`, civicrm_state_province.name as state_province_name";
666 $this->_element
['state_province_name'] = 1;
668 elseif ($tName == 'contact') {
669 // special case, when current employer is set for Individual contact
670 if ($fieldName == 'organization_name') {
671 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name";
673 elseif ($fieldName != 'id') {
674 $this->_select
[$name] = "contact_a.{$fieldName} as `$name`";
678 $this->_select
[$name] = "{$field['where']} as `$name`";
680 $this->_element
[$name] = 1;
684 elseif ($name === 'tags') {
685 $this->_useGroupBy
= TRUE;
686 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags";
687 $this->_element
[$name] = 1;
688 $this->_tables
['civicrm_tag'] = 1;
689 $this->_tables
['civicrm_entity_tag'] = 1;
691 elseif ($name === 'groups') {
692 $this->_useGroupBy
= TRUE;
693 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_group.title)) as groups";
694 $this->_element
[$name] = 1;
695 $this->_tables
['civicrm_group'] = 1;
697 elseif ($name === 'notes') {
698 $this->_useGroupBy
= TRUE;
699 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.note)) as notes";
700 $this->_element
[$name] = 1;
701 $this->_tables
['civicrm_note'] = 1;
703 elseif ($name === 'current_employer') {
704 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer";
705 $this->_element
[$name] = 1;
710 CRM_Utils_Array
::value('is_search_range', $field)
712 // this is a custom field with range search enabled, so we better check for two/from values
713 if (CRM_Utils_Array
::value($name . '_from', $this->_paramLookup
)) {
714 if (!array_key_exists($cfID, $this->_cfIDs
)) {
715 $this->_cfIDs
[$cfID] = array();
717 foreach ($this->_paramLookup
[$name . '_from'] as $pID => $p) {
718 // search in the cdID array for the same grouping
720 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
721 if ($c[3] == $p[3]) {
722 $this->_cfIDs
[$cfID][$cID][2]['from'] = $p[2];
727 $p[2] = array('from' => $p[2]);
728 $this->_cfIDs
[$cfID][] = $p;
732 if (CRM_Utils_Array
::value($name . '_to', $this->_paramLookup
)) {
733 if (!array_key_exists($cfID, $this->_cfIDs
)) {
734 $this->_cfIDs
[$cfID] = array();
736 foreach ($this->_paramLookup
[$name . '_to'] as $pID => $p) {
737 // search in the cdID array for the same grouping
739 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
740 if ($c[4] == $p[4]) {
741 $this->_cfIDs
[$cfID][$cID][2]['to'] = $p[2];
746 $p[2] = array('to' => $p[2]);
747 $this->_cfIDs
[$cfID][] = $p;
754 // add location as hierarchical elements
755 $this->addHierarchicalElements();
757 // add multiple field like website
758 $this->addMultipleElements();
761 CRM_Core_Component
::alterQuery($this, 'select');
763 if (!empty($this->_cfIDs
)) {
764 $this->_customQuery
= new CRM_Core_BAO_CustomQuery($this->_cfIDs
, TRUE);
765 $this->_customQuery
->query();
766 $this->_select
= array_merge($this->_select
, $this->_customQuery
->_select
);
767 $this->_element
= array_merge($this->_element
, $this->_customQuery
->_element
);
768 $this->_tables
= array_merge($this->_tables
, $this->_customQuery
->_tables
);
769 $this->_whereTables
= array_merge($this->_whereTables
, $this->_customQuery
->_whereTables
);
770 $this->_options
= $this->_customQuery
->_options
;
775 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
781 function addHierarchicalElements() {
782 if (!CRM_Utils_Array
::value('location', $this->_returnProperties
)) {
785 if (!is_array($this->_returnProperties
['location'])) {
789 $locationTypes = CRM_Core_PseudoConstant
::locationType();
790 $processed = array();
793 $addressCustomFields = CRM_Core_BAO_CustomField
::getFieldsForImport('Address');
794 $addressCustomFieldIds = array();
796 foreach ($this->_returnProperties
['location'] as $name => $elements) {
797 $lCond = self
::getPrimaryCondition($name);
800 $locationTypeId = array_search($name, $locationTypes);
801 if ($locationTypeId === FALSE) {
804 $lCond = "location_type_id = $locationTypeId";
805 $this->_useDistinct
= TRUE;
807 //commented for CRM-3256
808 $this->_useGroupBy
= TRUE;
811 $name = str_replace(' ', '_', $name);
813 $tName = "$name-location_type";
814 $ltName = "`$name-location_type`";
815 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
816 $this->_select
["{$tName}"] = "`$tName`.name as `{$tName}`";
817 $this->_element
["{$tName}_id"] = 1;
818 $this->_element
["{$tName}"] = 1;
820 $locationTypeName = $tName;
821 $locationTypeJoin = array();
825 foreach ($elements as $elementFullName => $dontCare) {
827 $elementName = $elementCmpName = $elementFullName;
829 if (substr($elementCmpName, 0, 5) == 'phone') {
830 $elementCmpName = 'phone';
833 if (in_array($elementCmpName, array_keys($addressCustomFields))) {
834 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($elementCmpName)) {
835 $addressCustomFieldIds[$cfID][$name] = 1;
838 //add address table only once
839 if ((in_array($elementCmpName, self
::$_locationSpecificFields) ||
!empty($addressCustomFieldIds))
841 && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid'))
843 $tName = "$name-address";
844 $aName = "`$name-address`";
845 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
846 $this->_element
["{$tName}_id"] = 1;
847 $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)";
848 $this->_tables
[$tName] = $addressJoin;
849 $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) ";
850 $processed[$aName] = 1;
854 $cond = $elementType = '';
855 if (strpos($elementName, '-') !== FALSE) {
856 // this is either phone, email or IM
857 list($elementName, $elementType) = explode('-', $elementName);
860 if (($elementName != 'phone') && ($elementName != 'im')) {
861 $cond = self
::getPrimaryCondition($elementType);
863 if ((!$cond) && ($elementName == 'phone')) {
864 $cond = "phone_type_id = '$elementType'";
866 elseif ((!$cond) && ($elementName == 'im')) {
867 // IM service provider id, CRM-3140
868 $cond = "provider_id = '$elementType'";
870 $elementType = '-' . $elementType;
873 $field = CRM_Utils_Array
::value($elementName, $this->_fields
);
875 // hack for profile, add location id
878 // fix for CRM-882( to handle phone types )
879 !is_numeric($elementType)
881 if (is_numeric($name)) {
882 $field = CRM_Utils_Array
::value($elementName . "-Primary$elementType", $this->_fields
);
885 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
888 elseif (is_numeric($name)) {
889 //this for phone type to work
890 if (in_array($elementName, array('phone', 'phone_ext'))) {
891 $field = CRM_Utils_Array
::value($elementName . "-Primary" . $elementType, $this->_fields
);
894 $field = CRM_Utils_Array
::value($elementName . "-Primary", $this->_fields
);
898 //this is for phone type to work for profile edit
899 if (in_array($elementName, array('phone', 'phone_ext'))) {
900 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
903 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId", $this->_fields
);
908 // check if there is a value, if so also add to where Clause
910 if ($this->_params
) {
912 if (isset($locationTypeId)) {
913 $nm .= "-$locationTypeId";
915 if (!is_numeric($elementType)) {
916 $nm .= "$elementType";
919 foreach ($this->_params
as $id => $values) {
920 if ($values[0] == $nm ||
921 (in_array($elementName, array('phone', 'im'))
922 && (strpos($values[0], $nm) !== FALSE)
932 if ($field && isset($field['where'])) {
933 list($tableName, $fieldName) = explode('.', $field['where'], 2);
934 $tName = $name . '-' . substr($tableName, 8) . $elementType;
935 if (isset($tableName)) {
936 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
937 $this->_element
["{$tName}_id"] = 1;
938 if (substr($tName, -15) == '-state_province') {
939 // FIXME: hack to fix CRM-1900
940 $a = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
944 if (substr_count($a, 'state_province_name') > 0) {
945 $this->_select
["{$name}-{$elementFullName}"] = "`$tName`.name as `{$name}-{$elementFullName}`";
948 $this->_select
["{$name}-{$elementFullName}"] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`";
952 if (substr($elementFullName, 0, 2) == 'im') {
953 $provider = "{$name}-{$elementFullName}-provider_id";
954 $this->_select
[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`";
955 $this->_element
[$provider] = 1;
958 $this->_select
["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
961 $this->_element
["{$name}-{$elementFullName}"] = 1;
962 if (!CRM_Utils_Array
::value("`$tName`", $processed)) {
963 $processed["`$tName`"] = 1;
964 $newName = $tableName . '_' . $index;
965 switch ($tableName) {
966 case 'civicrm_phone':
967 case 'civicrm_email':
969 case 'civicrm_openid':
971 $this->_tables
[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id AND `$tName`.$lCond";
972 // this special case to add phone type
974 $phoneTypeCondition = " AND `$tName`.$cond ";
975 //gross hack to pickup corrupted data also, CRM-7603
976 if (strpos($cond, 'phone_type_id') !== FALSE) {
977 $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) ";
979 $this->_tables
[$tName] .= $phoneTypeCondition;
982 //build locationType join
983 $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )";
986 $this->_whereTables
[$tName] = $this->_tables
[$tName];
990 case 'civicrm_state_province':
991 $this->_tables
[$tName] = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id";
993 $this->_whereTables
["{$name}-address"] = $addressJoin;
994 $this->_whereTables
[$tName] = $this->_tables
[$tName];
998 case 'civicrm_country':
999 $this->_tables
[$newName] = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id";
1001 $this->_whereTables
["{$name}-address"] = $addressJoin;
1002 $this->_whereTables
[$newName] = $this->_tables
[$newName];
1006 case 'civicrm_county':
1007 $this->_tables
[$newName] = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id";
1009 $this->_whereTables
["{$name}-address"] = $addressJoin;
1010 $this->_whereTables
[$newName] = $this->_tables
[$newName];
1016 $this->_whereTables
["{$name}-address"] = $addressJoin;
1025 // add location type join
1026 $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )";
1027 $this->_tables
[$locationTypeName] = $ltypeJoin;
1029 // table should be present in $this->_whereTables,
1030 // to add its condition in location type join, CRM-3939.
1031 if ($addWhereCount) {
1032 $locClause = array();
1033 foreach ($this->_whereTables
as $tableName => $clause) {
1034 if (CRM_Utils_Array
::value($tableName, $locationTypeJoin)) {
1035 $locClause[] = $locationTypeJoin[$tableName];
1039 if (!empty($locClause)) {
1040 $this->_whereTables
[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )";
1045 if (!empty($addressCustomFieldIds)) {
1046 $cfIDs = $addressCustomFieldIds;
1047 $customQuery = new CRM_Core_BAO_CustomQuery($cfIDs);
1048 foreach ($addressCustomFieldIds as $cfID => $locTypeName) {
1049 foreach ($locTypeName as $name => $dnc) {
1050 $fieldName = "$name-custom_{$cfID}";
1051 $tName = "$name-address-custom-{$cfID}";
1052 $aName = "`$name-address-custom-{$cfID}`";
1053 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1054 $this->_element
["{$tName}_id"] = 1;
1055 $this->_select
[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`";
1056 $this->_element
[$fieldName] = 1;
1057 $this->_tables
[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)";
1064 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
1070 function addMultipleElements() {
1071 if (!CRM_Utils_Array
::value('website', $this->_returnProperties
)) {
1074 if (!is_array($this->_returnProperties
['website'])) {
1078 foreach ($this->_returnProperties
['website'] as $key => $elements) {
1079 foreach ($elements as $elementFullName => $dontCare) {
1080 $tName = "website-{$key}-{$elementFullName}";
1081 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1082 $this->_select
["{$tName}"] = "`$tName`.url as `{$tName}`";
1083 $this->_element
["{$tName}_id"] = 1;
1084 $this->_element
["{$tName}"] = 1;
1086 $type = "website-{$key}-website_type_id";
1087 $this->_select
[$type] = "`$tName`.website_type_id as `{$type}`";
1088 $this->_element
[$type] = 1;
1089 $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id )";
1095 * generate the query based on what type of query we need
1097 * @param boolean $count
1098 * @param boolean $sortByChar
1099 * @param boolean $groupContacts
1101 * @return the sql string for that query (this will most likely
1105 function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE) {
1107 if (isset($this->_distinctComponentClause
)) {
1108 // we add distinct to get the right count for components
1109 // for the more complex result set, we use GROUP BY the same id
1111 $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} )";
1114 $select = 'SELECT count(DISTINCT contact_a.id) as rowCount';
1116 $from = $this->_simpleFromClause
;
1117 if ($this->_useDistinct
) {
1118 $this->_useGroupBy
= TRUE;
1121 elseif ($sortByChar) {
1122 $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name';
1123 $from = $this->_simpleFromClause
;
1125 elseif ($groupContacts) {
1126 $select = 'SELECT contact_a.id as id';
1127 if ($this->_useDistinct
) {
1128 $this->_useGroupBy
= TRUE;
1130 $from = $this->_simpleFromClause
;
1133 if (CRM_Utils_Array
::value('group', $this->_paramLookup
)) {
1134 // make sure there is only one element
1135 // this is used when we are running under smog and need to know
1136 // how the contact was added (CRM-1203)
1137 if ((count($this->_paramLookup
['group']) == 1) &&
1138 (count($this->_paramLookup
['group'][0][2]) == 1)
1140 $groups = array_keys($this->_paramLookup
['group'][0][2]);
1141 $groupId = $groups[0];
1143 //check if group is saved search
1144 $group = new CRM_Contact_BAO_Group();
1145 $group->id
= $groupId;
1148 if (!isset($group->saved_search_id
)) {
1149 $tbName = "`civicrm_group_contact-{$groupId}`";
1150 $this->_select
['group_contact_id'] = "$tbName.id as group_contact_id";
1151 $this->_element
['group_contact_id'] = 1;
1152 $this->_select
['status'] = "$tbName.status as status";
1153 $this->_element
['status'] = 1;
1154 $this->_tables
[$tbName] = 1;
1157 $this->_useGroupBy
= TRUE;
1159 if ($this->_useDistinct
&& !isset($this->_distinctComponentClause
)) {
1160 if (!($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
)) {
1162 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
1163 $this->_useDistinct
= FALSE;
1164 $this->_useGroupBy
= TRUE;
1168 $select = "SELECT ";
1169 if (isset($this->_distinctComponentClause
)) {
1170 $select .= "{$this->_distinctComponentClause}, ";
1172 $select .= implode(', ', $this->_select
);
1173 $from = $this->_fromClause
;
1177 if (!empty($this->_whereClause
)) {
1178 $where = "WHERE {$this->_whereClause}";
1182 if (!empty($this->_having
)) {
1183 foreach ($this->_having
as $havingsets) {
1184 foreach ($havingsets as $havingset) {
1185 $havingvalue[] = $havingset;
1188 $having = ' HAVING ' . implode(' AND ', $havingvalue);
1191 // if we are doing a transform, do it here
1192 // use the $from, $where and $having to get the contact ID
1193 if ($this->_displayRelationshipType
) {
1194 $this->filterRelatedContacts($from, $where, $having);
1197 return array($select, $from, $where, $having);
1200 function &getWhereValues($name, $grouping) {
1202 foreach ($this->_params
as $id => $values) {
1203 if ($values[0] == $name && $values[3] == $grouping) {
1211 static function fixDateValues($relative, &$from, &$to) {
1213 list($from, $to) = CRM_Utils_Date
::getFromTo($relative, $from, $to);
1217 static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE) {
1219 if (empty($formValues)) {
1223 foreach ($formValues as $id => $values) {
1224 if ($id == 'privacy') {
1225 if (is_array($formValues['privacy'])) {
1226 $op = CRM_Utils_Array
::value('do_not_toggle', $formValues['privacy']) ?
'=' : '!=';
1227 foreach ($formValues['privacy'] as $key => $value) {
1229 $params[] = array($key, $op, $value, 0, 0);
1234 elseif ($id == 'email_on_hold') {
1235 if ($formValues['email_on_hold']['on_hold']) {
1236 $params[] = array('on_hold', '=', $formValues['email_on_hold']['on_hold'], 0, 0);
1239 elseif (preg_match('/_date_relative$/', $id) ||
1240 $id == 'event_relative' ||
1241 $id == 'case_from_relative' ||
1242 $id == 'case_to_relative'
1244 if ($id == 'event_relative') {
1245 $fromRange = 'event_start_date_low';
1246 $toRange = 'event_end_date_high';
1248 else if ($id == 'case_from_relative') {
1249 $fromRange = 'case_from_start_date_low';
1250 $toRange = 'case_from_start_date_high';
1252 else if ($id == 'case_to_relative') {
1253 $fromRange = 'case_to_end_date_low';
1254 $toRange = 'case_to_end_date_high';
1257 $dateComponent = explode('_date_relative', $id);
1258 $fromRange = "{$dateComponent[0]}_date_low";
1259 $toRange = "{$dateComponent[0]}_date_high";
1262 if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) {
1263 CRM_Contact_BAO_Query
::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]);
1268 $values = CRM_Contact_BAO_Query
::fixWhereValues($id, $values, $wildcard, $useEquals);
1273 $params[] = $values;
1279 static function &fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE) {
1280 // skip a few search variables
1281 static $skipWhere = NULL;
1282 static $arrayValues = NULL;
1283 static $likeNames = NULL;
1286 if (CRM_Utils_System
::isNull($values)) {
1292 'task', 'radio_ts', 'uf_group_id',
1293 'component_mode', 'qfKey', 'operator',
1294 'display_relationship_type',
1298 if (in_array($id, $skipWhere) ||
1299 substr($id, 0, 4) == '_qf_' ||
1300 substr($id, 0, 7) == 'hidden_'
1306 $likeNames = array('sort_name', 'email', 'note', 'display_name');
1309 // email comes in via advanced search
1310 // so use wildcard always
1311 if ($id == 'email') {
1315 if (!$useEquals && in_array($id, $likeNames)) {
1316 $result = array($id, 'LIKE', $values, 0, 1);
1318 elseif (is_string($values) && strpos($values, '%') !== FALSE) {
1319 $result = array($id, 'LIKE', $values, 0, 0);
1321 elseif ($id == 'group') {
1322 if (is_array($values)) {
1323 foreach ($values as $groupIds => $val) {
1325 if (preg_match('/-(\d+)$/', $groupIds, $matches)) {
1326 if (strlen($matches[1]) > 0) {
1327 $values[$matches[1]] = 1;
1328 unset($values[$groupIds]);
1334 $groupIds = explode(',', $values);
1336 foreach ($groupIds as $groupId) {
1337 $values[$groupId] = 1;
1341 $result = array($id, 'IN', $values, 0, 0);
1343 elseif ($id == 'contact_tags' ||
$id == 'tag') {
1344 if (!is_array($values)) {
1345 $tagIds = explode(',', $values);
1347 foreach ($tagIds as $tagId) {
1348 $values[$tagId] = 1;
1351 $result = array($id, 'IN', $values, 0, 0);
1354 $result = array($id, '=', $values, 0, $wildcard);
1360 function whereClauseSingle(&$values) {
1361 // do not process custom fields or prefixed contact ids or component params
1362 if (CRM_Core_BAO_CustomField
::getKeyID($values[0]) ||
1363 (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) ||
1364 (substr($values[0], 0, 13) == 'contribution_') ||
1365 (substr($values[0], 0, 6) == 'event_') ||
1366 (substr($values[0], 0, 12) == 'participant_') ||
1367 (substr($values[0], 0, 7) == 'member_') ||
1368 (substr($values[0], 0, 6) == 'grant_') ||
1369 (substr($values[0], 0, 7) == 'pledge_') ||
1370 (substr($values[0], 0, 5) == 'case_') ||
1371 (substr($values[0], 0, 10) == 'financial_')
1376 switch ($values[0]) {
1377 case 'deleted_contacts':
1378 $this->deletedContacts($values);
1381 case 'contact_type':
1382 $this->contactType($values);
1385 case 'contact_sub_type':
1386 $this->contactSubType($values);
1390 list($name, $op, $value, $grouping, $wildcard) = $values;
1391 $this->group($values);
1394 // so we resolve this into a list of groups & proceed as if they had been
1396 list($name, $op, $value, $grouping, $wildcard) = $values;
1397 $values[0] = 'group';
1399 $this->_paramLookup
['group'][0][0] ='group';
1400 $this->_paramLookup
['group'][0][1] = 'IN';
1401 $this->_paramLookup
['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value);
1402 $this->group($values);
1404 // case tag comes from find contacts
1407 $this->tagSearch($values);
1411 case 'contact_tags':
1412 $this->tag($values);
1417 case 'note_subject':
1418 $this->notes($values);
1422 $this->ufUser($values);
1426 case 'display_name':
1427 $this->sortName($values);
1428 //force civicrm_activity_target, CRM-7812
1429 self
::$_withContactActivitiesOnly = TRUE;
1433 $this->email($values);
1436 case 'phone_numeric':
1437 $this->phone_numeric($values);
1440 case 'phone_phone_type_id':
1441 case 'phone_location_type_id':
1442 $this->phone_option_group($values);
1445 case 'street_address':
1446 $this->street_address($values);
1449 case 'street_number':
1450 $this->street_number($values);
1453 case 'sortByCharacter':
1454 $this->sortByCharacter($values);
1457 case 'location_type':
1458 $this->locationType($values);
1462 $this->county($values);
1465 case 'state_province':
1466 $this->stateProvince($values);
1470 $this->country($values, FALSE);
1474 case 'postal_code_low':
1475 case 'postal_code_high':
1476 $this->postalCode($values);
1479 case 'activity_date':
1480 case 'activity_date_low':
1481 case 'activity_date_high':
1482 case 'activity_role':
1483 case 'activity_status':
1484 case 'activity_subject':
1485 case 'test_activities':
1486 case 'activity_type_id':
1487 case 'activity_survey_id':
1488 case 'activity_tags':
1489 case 'activity_taglist':
1490 case 'activity_test':
1491 case 'activity_contact_name':
1492 case 'activity_campaign_id':
1493 case 'activity_engagement_level':
1495 case 'source_contact':
1496 CRM_Activity_BAO_Query
::whereClauseSingle($values, $this);
1499 case 'birth_date_low':
1500 case 'birth_date_high':
1501 case 'deceased_date_low':
1502 case 'deceased_date_high':
1503 $this->demographics($values);
1506 case 'log_date_low':
1507 case 'log_date_high':
1508 $this->modifiedDates($values);
1512 $this->changeLog($values);
1515 case 'do_not_phone':
1516 case 'do_not_email':
1519 case 'do_not_trade':
1521 $this->privacy($values);
1524 case 'privacy_options':
1525 $this->privacyOptions($values);
1528 case 'privacy_operator':
1529 case 'privacy_toggle':
1530 // these are handled by privacy options
1533 case 'preferred_communication_method':
1534 $this->preferredCommunication($values);
1537 case 'relation_type_id':
1538 $this->relationship($values);
1541 case 'relation_target_name':
1542 case 'relation_status':
1543 case 'relation_date_low':
1544 case 'relation_date_high':
1545 // since this case is handled with the above
1548 case 'task_status_id':
1549 $this->task($values);
1553 // since this case is handled with the above
1556 case 'prox_distance':
1557 CRM_Contact_BAO_ProximityQuery
::process($this, $values);
1560 case 'prox_street_address':
1562 case 'prox_postal_code':
1563 case 'prox_state_province_id':
1564 case 'prox_country_id':
1565 // handled by the proximity_distance clause
1569 $this->restWhere($values);
1575 * Given a list of conditions in params generate the required
1581 function whereClause() {
1582 $this->_where
[0] = array();
1583 $this->_qill
[0] = array();
1585 $config = CRM_Core_Config
::singleton();
1587 $this->includeContactIds();
1588 if (!empty($this->_params
)) {
1590 foreach (array_keys($this->_params
) as $id) {
1591 if (!CRM_Utils_Array
::value(0, $this->_params
[$id])) {
1594 // check for both id and contact_id
1595 if ($this->_params
[$id][0] == 'id' ||
$this->_params
[$id][0] == 'contact_id') {
1597 $this->_params
[$id][1] == 'IS NULL' ||
1598 $this->_params
[$id][1] == 'IS NOT NULL'
1600 $this->_where
[0][] = "contact_a.id {$this->_params[$id][1]}";
1602 elseif (is_array($this->_params
[$id][2])) {
1603 $idList = implode("','", $this->_params
[$id][2]);
1604 $this->_where
[0][] = "contact_a.id IN ({$idList})";
1607 $this->_where
[0][] = "contact_a.id {$this->_params[$id][1]} {$this->_params[$id][2]}";
1611 $this->whereClauseSingle($this->_params
[$id]);
1615 CRM_Core_Component
::alterQuery($this, 'where');
1618 if ($this->_customQuery
) {
1619 // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info.
1620 // Hope it wont affect the other part of civicrm.. if it does please remove it.
1621 if (!empty($this->_customQuery
->_where
)) {
1622 $this->_where
= CRM_Utils_Array
::crmArrayMerge($this->_where
, $this->_customQuery
->_where
);
1625 $this->_qill
= CRM_Utils_Array
::crmArrayMerge($this->_qill
, $this->_customQuery
->_qill
);
1629 $andClauses = array();
1632 if (!empty($this->_where
)) {
1633 foreach ($this->_where
as $grouping => $values) {
1634 if ($grouping > 0 && !empty($values)) {
1635 $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
1640 if (!empty($this->_where
[0])) {
1641 $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where
[0]) . ' ) ';
1643 if (!empty($clauses)) {
1644 $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
1647 if ($validClauses > 1) {
1648 $this->_useDistinct
= TRUE;
1652 return implode(' AND ', $andClauses);
1655 function restWhere(&$values) {
1656 $name = CRM_Utils_Array
::value(0, $values);
1657 $op = CRM_Utils_Array
::value(1, $values);
1658 $value = CRM_Utils_Array
::value(2, $values);
1659 $grouping = CRM_Utils_Array
::value(3, $values);
1660 $wildcard = CRM_Utils_Array
::value(4, $values);
1662 if (isset($grouping) && !CRM_Utils_Array
::value($grouping, $this->_where
)) {
1663 $this->_where
[$grouping] = array();
1666 $multipleFields = array('url');
1668 //check if the location type exits for fields
1670 $locType = explode('-', $name);
1672 if (!in_array($locType[0], $multipleFields)) {
1673 //add phone type if exists
1674 if (isset($locType[2]) && $locType[2]) {
1675 $locType[2] = CRM_Core_DAO
::escapeString($locType[2]);
1679 $field = CRM_Utils_Array
::value($name, $this->_fields
);
1682 $field = CRM_Utils_Array
::value($locType[0], $this->_fields
);
1691 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
1693 if (substr($name, 0, 14) === 'state_province') {
1694 if (isset($locType[1]) && is_numeric($locType[1])) {
1697 list($tName, $fldName) = self
::getLocationTableName($field['where'], $locType);
1698 $this->_whereTables
[$tName] = $this->_tables
[$tName];
1699 $where = "`$tName`.$fldName";
1702 $where = $field['where'];
1705 if (is_numeric($value)) {
1706 $where = str_replace('.name', '.id', $where);
1707 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1708 $states = CRM_Core_PseudoConstant
::stateProvince();
1709 $value = $states[(int ) $value];
1712 $wc = self
::caseImportant($op) ?
"LOWER($where)" : $where;
1713 $this->_where
[$grouping][] = self
::buildClause($wc, $op, $value, 'String');
1716 $this->_qill
[$grouping][] = ts('State') . " $op '$value'";
1719 $this->_qill
[$grouping][] = ts('State') . " ($lType) $op '$value'";
1722 elseif (substr($name, 0, 7) === 'country') {
1723 if (isset($locType[1]) && is_numeric($locType[1])) {
1726 list($tName, $fldName) = self
::getLocationTableName($field['where'], $locType);
1727 $this->_whereTables
[$tName] = $this->_tables
[$tName];
1728 $where = "`$tName`.$fldName";
1731 $where = $field['where'];
1734 if (is_numeric($value)) {
1735 $where = str_replace('.name', '.id', $where);
1736 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1737 $countries = CRM_Core_PseudoConstant
::country();
1738 $value = $countries[(int ) $value];
1741 $wc = self
::caseImportant($op) ?
"LOWER($where)" : $where;
1742 $this->_where
[$grouping][] = self
::buildClause($wc, $op, $value, 'String');
1745 $this->_qill
[$grouping][] = ts('Country') . " $op '$value'";
1748 $this->_qill
[$grouping][] = ts('Country') . " ($lType) $op '$value'";
1751 elseif (substr($name, 0, 6) === 'county') {
1752 if (isset($locType[1]) && is_numeric($locType[1])) {
1755 list($tName, $fldName) = self
::getLocationTableName($field['where'], $locType);
1756 $this->_whereTables
[$tName] = $this->_tables
[$tName];
1757 $where = "`$tName`.$fldName";
1760 $where = $field['where'];
1762 if (is_numeric($value)) {
1763 $where = str_replace('.name', '.id', $where);
1764 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1765 $counties = CRM_Core_PseudoConstant
::county();
1766 $value = $counties[(int ) $value];
1769 $wc = self
::caseImportant($op) ?
"LOWER($where)" : $where;
1770 $this->_where
[$grouping][] = self
::buildClause($wc, $op, $value, 'String');
1774 $this->_qill
[$grouping][] = ts('County') . " $op '$value'";
1777 $this->_qill
[$grouping][] = ts('County') . " ($lType) $op '$value'";
1780 elseif ($name === 'world_region') {
1781 $this->optionValueQuery(
1782 $name, $op, $value, $grouping,
1783 CRM_Core_PseudoConstant
::worldRegion(),
1788 elseif ($name === 'individual_prefix') {
1789 $this->optionValueQuery(
1790 $name, $op, $value, $grouping,
1791 CRM_Core_PseudoConstant
::individualPrefix(),
1793 ts('Individual Prefix')
1796 elseif ($name === 'individual_suffix') {
1797 $this->optionValueQuery(
1798 $name, $op, $value, $grouping,
1799 CRM_Core_PseudoConstant
::individualSuffix(),
1801 ts('Individual Suffix')
1804 elseif ($name === 'gender') {
1805 $this->optionValueQuery(
1806 $name, $op, $value, $grouping,
1807 CRM_Core_PseudoConstant
::gender(),
1811 self
::$_openedPanes[ts('Demographics')] = TRUE;
1813 elseif ($name === 'birth_date') {
1814 $date = CRM_Utils_Date
::processDate($value);
1815 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $date);
1818 $date = CRM_Utils_Date
::customFormat($date);
1819 $this->_qill
[$grouping][] = "$field[title] $op \"$date\"";
1822 $this->_qill
[$grouping][] = "$field[title] $op";
1824 self
::$_openedPanes[ts('Demographics')] = TRUE;
1826 elseif ($name === 'deceased_date') {
1827 $date = CRM_Utils_Date
::processDate($value);
1828 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $date);
1830 $date = CRM_Utils_Date
::customFormat($date);
1831 $this->_qill
[$grouping][] = "$field[title] $op \"$date\"";
1834 $this->_qill
[$grouping][] = "$field[title] $op";
1836 self
::$_openedPanes[ts('Demographics')] = TRUE;
1838 elseif ($name === 'is_deceased') {
1839 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $value);
1840 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1841 self
::$_openedPanes[ts('Demographics')] = TRUE;
1843 elseif ($name === 'contact_id') {
1844 if (is_int($value)) {
1845 $this->_where
[$grouping][] = self
::buildClause($field['where'], $op, $value);
1846 $this->_qill
[$grouping][] = "$field[title] $op $value";
1849 elseif ($name === 'name') {
1850 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
1852 $value = "%$value%";
1855 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
1856 $this->_where
[$grouping][] = self
::buildClause($wc, $op, "'$value'");
1857 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1859 elseif ($name === 'current_employer') {
1860 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
1862 $value = "%$value%";
1865 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.organization_name)" : "contact_a.organization_name";
1866 $this->_where
[$grouping][] = self
::buildClause($wc, $op,
1867 "'$value' AND contact_a.contact_type ='Individual'"
1869 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1871 elseif ($name === 'email_greeting') {
1872 $filterCondition = array('greeting_type' => 'email_greeting');
1873 $this->optionValueQuery(
1874 $name, $op, $value, $grouping,
1875 CRM_Core_PseudoConstant
::greeting($filterCondition),
1877 ts('Email Greeting')
1880 elseif ($name === 'postal_greeting') {
1881 $filterCondition = array('greeting_type' => 'postal_greeting');
1882 $this->optionValueQuery(
1883 $name, $op, $value, $grouping,
1884 CRM_Core_PseudoConstant
::greeting($filterCondition),
1886 ts('Postal Greeting')
1889 elseif ($name === 'addressee') {
1890 $filterCondition = array('greeting_type' => 'addressee');
1891 $this->optionValueQuery(
1892 $name, $op, $value, $grouping,
1893 CRM_Core_PseudoConstant
::greeting($filterCondition),
1898 elseif (substr($name, 0, 4) === 'url-') {
1899 $tName = 'civicrm_website';
1900 $this->_whereTables
[$tName] = $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
1901 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
1903 $value = "%$value%";
1907 $wc = 'civicrm_website.url';
1908 $this->_where
[$grouping][] = self
::buildClause($wc, $op, "'$value'");
1909 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1911 elseif ($name === 'contact_is_deleted') {
1912 $this->_where
[$grouping][] = self
::buildClause("contact_a.is_deleted", $op, $value);
1913 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1916 // sometime the value is an array, need to investigate and fix
1917 if (is_array($value)) {
1918 CRM_Core_Error
::fatal();
1921 if (!empty($field['where'])) {
1923 $value = $strtolower($value);
1926 $value = "%$value%";
1930 if (isset($locType[1]) &&
1931 is_numeric($locType[1])
1935 //get the location name
1936 $locationType = CRM_Core_PseudoConstant
::locationType();
1937 list($tName, $fldName) = self
::getLocationTableName($field['where'], $locType);
1939 $where = "`$tName`.$fldName";
1941 $this->_where
[$grouping][] = self
::buildClause("LOWER($where)", $op, $value);
1942 $this->_whereTables
[$tName] = $this->_tables
[$tName];
1943 $this->_qill
[$grouping][] = "$field[title] $op '$value'";
1946 list($tableName, $fieldName) = explode('.', $field['where'], 2);
1947 if ($tableName == 'civicrm_contact') {
1948 $fieldName = "LOWER(contact_a.{$fieldName})";
1951 if ($op != 'IN' && !is_numeric($value)) {
1952 $fieldName = "LOWER({$field['where']})";
1955 $fieldName = "{$field['where']}";
1960 if (CRM_Utils_Array
::value('type', $field)) {
1961 $type = CRM_Utils_Type
::typeToString($field['type']);
1964 $this->_where
[$grouping][] = self
::buildClause($fieldName, $op, $value, $type);
1965 $this->_qill
[$grouping][] = "$field[title] $op $value";
1970 if ($setTables && isset($field['where'])) {
1971 list($tableName, $fieldName) = explode('.', $field['where'], 2);
1972 if (isset($tableName)) {
1973 $this->_tables
[$tableName] = 1;
1974 $this->_whereTables
[$tableName] = 1;
1980 static function getLocationTableName(&$where, &$locType) {
1981 if (isset($locType[1]) && is_numeric($locType[1])) {
1982 list($tbName, $fldName) = explode(".", $where);
1984 //get the location name
1985 $locationType = CRM_Core_PseudoConstant
::locationType();
1986 $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
1987 if (in_array($locType[0], $specialFields)) {
1988 //hack to fix / special handing for phone_ext
1989 if ($locType[0] == 'phone_ext') {
1990 $locType[0] = 'phone';
1992 if (isset($locType[2]) && $locType[2]) {
1993 $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
1996 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
1999 elseif (in_array($locType[0],
2001 'address_name', 'street_address', 'supplemental_address_1', 'supplemental_address_2',
2002 'city', 'postal_code', 'postal_code_suffix', 'geo_code_1', 'geo_code_2',
2005 //fix for search by profile with address fields.
2006 $tName = "{$locationType[$locType[1]]}-address";
2008 elseif ($locType[0] == 'on_hold') {
2009 $tName = "{$locationType[$locType[1]]}-email";
2012 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2014 $tName = str_replace(' ', '_', $tName);
2015 return array($tName, $fldName);
2017 CRM_Core_Error
::fatal();
2021 * Given a result dao, extract the values and return that array
2023 * @param Object $dao
2025 * @return array values for this query
2027 function store($dao) {
2030 foreach ($this->_element
as $key => $dontCare) {
2031 if (property_exists($dao, $key)) {
2032 if (strpos($key, '-') !== FALSE) {
2033 $values = explode('-', $key);
2034 $lastElement = array_pop($values);
2036 $cnt = count($values);
2038 foreach ($values as $v) {
2039 if (!array_key_exists($v, $current)) {
2040 $current[$v] = array();
2042 //bad hack for im_provider
2043 if ($lastElement == 'provider_id') {
2044 if ($count < $cnt) {
2045 $current = &$current[$v];
2048 $lastElement = "{$v}_{$lastElement}";
2052 $current = &$current[$v];
2057 $current[$lastElement] = $dao->$key;
2060 $value[$key] = $dao->$key;
2068 * getter for tables array
2074 return $this->_tables
;
2077 function whereTables() {
2078 return $this->_whereTables
;
2082 * generate the where clause (used in match contacts and permissions)
2084 * @param array $params
2085 * @param array $fields
2086 * @param array $tables
2087 * @param boolean $strict
2093 static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2094 $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2098 $tables = array_merge($query->tables(), $tables);
2099 $whereTables = array_merge($query->whereTables(), $whereTables);
2101 return $query->_whereClause
;
2105 * create the from clause
2107 * @param array $tables tables that need to be included in this from clause
2108 * if null, return mimimal from clause (i.e. civicrm_contact)
2109 * @param array $inner tables that should be inner-joined
2110 * @param array $right tables that should be right-joined
2112 * @return string the from clause
2116 static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
2118 $from = ' FROM civicrm_contact contact_a';
2119 if (empty($tables)) {
2123 if (CRM_Utils_Array
::value('civicrm_worldregion', $tables)) {
2124 $tables = array_merge(array('civicrm_country' => 1), $tables);
2127 if ((CRM_Utils_Array
::value('civicrm_state_province', $tables) ||
2128 CRM_Utils_Array
::value('civicrm_country', $tables) ||
2129 CRM_Utils_Array
::value('civicrm_county', $tables)
2131 !CRM_Utils_Array
::value('civicrm_address', $tables)
2133 $tables = array_merge(array('civicrm_address' => 1),
2138 // add group_contact table if group table is present
2139 if (CRM_Utils_Array
::value('civicrm_group', $tables) &&
2140 !CRM_Utils_Array
::value('civicrm_group_contact', $tables)
2142 $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added'";
2145 // add group_contact and group table is subscription history is present
2146 if (CRM_Utils_Array
::value('civicrm_subscription_history', $tables)
2147 && !CRM_Utils_Array
::value('civicrm_group', $tables)
2149 $tables = array_merge(array(
2150 'civicrm_group' => 1,
2151 'civicrm_group_contact' => 1,
2157 // to handle table dependencies of components
2158 CRM_Core_Component
::tableNames($tables);
2160 //format the table list according to the weight
2161 $info = CRM_Core_TableHierarchy
::info();
2163 foreach ($tables as $key => $value) {
2165 if (strpos($key, '-') !== FALSE) {
2166 $keyArray = explode('-', $key);
2167 $k = CRM_Utils_Array
::value('civicrm_' . $keyArray[1], $info, 99);
2169 elseif (strpos($key, '_') !== FALSE) {
2170 $keyArray = explode('_', $key);
2171 if (is_numeric(array_pop($keyArray))) {
2172 $k = CRM_Utils_Array
::value(implode('_', $keyArray), $info, 99);
2175 $k = CRM_Utils_Array
::value($key, $info, 99);
2179 $k = CRM_Utils_Array
::value($key, $info, 99);
2181 $tempTable[$k . ".$key"] = $key;
2184 $newTables = array();
2185 foreach ($tempTable as $key) {
2186 $newTables[$key] = $tables[$key];
2189 $tables = $newTables;
2191 foreach ($tables as $name => $value) {
2196 if (CRM_Utils_Array
::value($name, $inner)) {
2199 elseif (CRM_Utils_Array
::value($name, $right)) {
2207 // if there is already a join statement in value, use value itself
2208 if (strpos($value, 'JOIN')) {
2209 $from .= " $value ";
2212 $from .= " $side JOIN $name ON ( $value ) ";
2217 case 'civicrm_address':
2218 if ($primaryLocation) {
2219 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )";
2222 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) ";
2226 case 'civicrm_phone':
2227 $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) ";
2230 case 'civicrm_email':
2231 $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) ";
2235 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) ";
2239 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2240 $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2241 $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)";
2244 case 'civicrm_openid':
2245 $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )";
2248 case 'civicrm_state_province':
2249 $from .= " $side JOIN civicrm_state_province ON civicrm_address.state_province_id = civicrm_state_province.id ";
2252 case 'civicrm_country':
2253 $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2256 case 'civicrm_worldregion':
2257 $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2260 case 'civicrm_county':
2261 $from .= " $side JOIN civicrm_county ON civicrm_address.county_id = civicrm_county.id ";
2264 case 'civicrm_location_type':
2265 $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2268 case 'civicrm_group':
2269 $from .= " $side JOIN civicrm_group ON civicrm_group.id = civicrm_group_contact.group_id ";
2272 case 'civicrm_group_contact':
2273 $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2276 case 'civicrm_activity':
2277 case 'civicrm_activity_tag':
2278 case 'activity_type':
2279 case 'activity_status':
2280 case 'civicrm_activity_contact':
2281 case 'source_contact':
2282 $from .= CRM_Activity_BAO_Query
::from($name, $mode, $side);
2285 case 'civicrm_entity_tag':
2286 $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2287 civicrm_entity_tag.entity_id = contact_a.id ) ";
2290 case 'civicrm_note':
2291 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2292 contact_a.id = civicrm_note.entity_id ) ";
2295 case 'civicrm_subscription_history':
2296 $from .= " $side JOIN civicrm_subscription_history
2297 ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2298 AND civicrm_group_contact.group_id = civicrm_subscription_history.group_id";
2301 case 'individual_prefix':
2302 $from .= " $side JOIN civicrm_option_group option_group_prefix ON (option_group_prefix.name = 'individual_prefix')";
2303 $from .= " $side JOIN civicrm_option_value individual_prefix ON (contact_a.prefix_id = individual_prefix.value AND option_group_prefix.id = individual_prefix.option_group_id ) ";
2306 case 'individual_suffix':
2307 $from .= " $side JOIN civicrm_option_group option_group_suffix ON (option_group_suffix.name = 'individual_suffix')";
2308 $from .= " $side JOIN civicrm_option_value individual_suffix ON (contact_a.suffix_id = individual_suffix.value AND option_group_suffix.id = individual_suffix.option_group_id ) ";
2312 $from .= " $side JOIN civicrm_option_group option_group_gender ON (option_group_gender.name = 'gender')";
2313 $from .= " $side JOIN civicrm_option_value gender ON (contact_a.gender_id = gender.value AND option_group_gender.id = gender.option_group_id) ";
2316 case 'civicrm_relationship':
2317 if (self
::$_relType == 'reciprocal') {
2318 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2319 $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)";
2321 elseif (self
::$_relType == 'b') {
2322 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2323 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2326 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2327 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2332 $from .= " $side JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2333 $from .= " $side JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2337 $from .= " $side JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2340 case 'civicrm_task_status':
2341 $from .= " $side JOIN civicrm_task_status ON ( civicrm_task_status.responsible_entity_table = 'civicrm_contact'
2342 AND contact_a.id = civicrm_task_status.responsible_entity_id )";
2345 case 'civicrm_grant':
2346 $from .= CRM_Grant_BAO_Query
::from($name, $mode, $side);
2349 //build fromClause for email greeting, postal greeting, addressee CRM-4575
2351 case 'email_greeting':
2352 $from .= " $side JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')";
2353 $from .= " $side 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 ) ";
2356 case 'postal_greeting':
2357 $from .= " $side JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')";
2358 $from .= " $side 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 ) ";
2362 $from .= " $side JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')";
2363 $from .= " $side JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) ";
2366 case 'civicrm_website':
2367 $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2371 $from .= CRM_Core_Component
::from($name, $mode, $side);
2380 * WHERE / QILL clause for deleted_contacts
2384 function deletedContacts($values) {
2385 list($_, $_, $value, $grouping, $_) = $values;
2387 // *prepend* to the relevant grouping as this is quite an important factor
2388 array_unshift($this->_qill
[$grouping], ts('Search in Trash'));
2393 * where / qill clause for contact_type
2398 function contactType(&$values) {
2399 list($name, $op, $value, $grouping, $wildcard) = $values;
2401 $subTypes = array();
2404 // account for search builder mapping multiple values
2405 if (!is_array($value)) {
2406 $values = self
::parseSearchBuilderString($value, 'String');
2407 if (is_array($values)) {
2408 $value = array_flip($values);
2412 if (is_array($value)) {
2413 foreach ($value as $k => $v) {
2418 if (strpos($k, CRM_Core_DAO
::VALUE_SEPARATOR
)) {
2419 list($contactType, $subType) = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $k, 2);
2422 if (!empty($subType)) {
2423 $subTypes[$subType] = 1;
2425 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2430 $contactTypeANDSubType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value, 2);
2431 $contactType = $contactTypeANDSubType[0];
2432 $subType = CRM_Utils_Array
::value(1, $contactTypeANDSubType);
2433 if (!empty($subType)) {
2434 $subTypes[$subType] = 1;
2436 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2440 if (!empty($clause)) {
2441 $this->_where
[$grouping][] = 'contact_a.contact_type IN (' . implode(',', $clause) . ')';
2442 $this->_qill
[$grouping][] = ts('Contact Type') . ' - ' . implode(' ' . ts('or') . ' ', $clause);
2444 if (!empty($subTypes)) {
2445 $this->includeContactSubTypes($subTypes, $grouping);
2451 * where / qill clause for contact_sub_type
2456 function contactSubType(&$values) {
2457 list($name, $op, $value, $grouping, $wildcard) = $values;
2458 $this->includeContactSubTypes($value, $grouping);
2461 function includeContactSubTypes($value, $grouping) {
2464 $alias = "contact_a.contact_sub_type";
2466 if (is_array($value)) {
2467 foreach ($value as $k => $v) {
2469 $clause[$k] = "($alias like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($k, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2474 $clause[$value] = "($alias like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($value, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2477 if (!empty($clause)) {
2478 $this->_where
[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2479 $this->_qill
[$grouping][] = ts('Contact Subtype') . ' - ' . implode(' ' . ts('or') . ' ', array_keys($clause));
2484 * where / qill clause for groups
2489 function group(&$values) {
2490 list($name, $op, $value, $grouping, $wildcard) = $values;
2492 if (count($value) > 1) {
2493 $this->_useDistinct
= TRUE;
2496 $groupNames = CRM_Core_PseudoConstant
::group();
2497 $groupIds = implode(',', array_keys($value));
2500 foreach ($value as $id => $dontCare) {
2501 if (array_key_exists($id, $groupNames) && $dontCare) {
2502 $names[] = $groupNames[$id];
2508 $gcsValues = &$this->getWhereValues('group_contact_status', $grouping);
2510 is_array($gcsValues[2])
2512 foreach ($gcsValues[2] as $k => $v) {
2514 if ($k == 'Added') {
2517 $statii[] = "'" . CRM_Utils_Type
::escape($k, 'String') . "'";
2522 $statii[] = '"Added"';
2527 if (count($value) == 1 &&
2528 count($statii) == 1 &&
2529 $statii[0] == '"Added"'
2531 // check if smart group, if so we can get rid of that one additional
2533 $groupIDs = array_keys($value);
2535 if (CRM_Utils_Array
::value(0, $groupIDs) &&
2536 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
2546 $gcTable = "`civicrm_group_contact-{$groupIds}`";
2547 $this->_tables
[$gcTable] = $this->_whereTables
[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON contact_a.id = {$gcTable}.contact_id ";
2550 $qill = ts('Contacts %1', array(1 => $op));
2551 $qill .= ' ' . implode(' ' . ts('or') . ' ', $names);
2553 $groupClause = NULL;
2556 $groupClause = "{$gcTable}.group_id $op ( $groupIds )";
2557 if (!empty($statii)) {
2558 $groupClause .= " AND {$gcTable}.status IN (" . implode(', ', $statii) . ")";
2559 $qill .= " " . ts('AND') . " " . ts('Group Status') . ' - ' . implode(' ' . ts('or') . ' ', $statii);
2564 $ssClause = $this->savedSearch($values);
2567 $groupClause = "( ( $groupClause ) OR ( $ssClause ) )";
2570 $groupClause = $ssClause;
2575 $this->_where
[$grouping][] = $groupClause;
2576 $this->_qill
[$grouping][] = $qill;
2579 * Function translates selection of group type into a list of groups
2581 function getGroupsFromTypeCriteria($value){
2582 $groupIds = array();
2583 foreach ($value as $groupTypeValue) {
2584 $groupList = CRM_Core_PseudoConstant
::group($groupTypeValue);
2585 $groupIds = ($groupIds +
$groupList);
2591 * where / qill clause for smart groups
2596 function savedSearch(&$values) {
2597 list($name, $op, $value, $grouping, $wildcard) = $values;
2598 return $this->addGroupContactCache(array_keys($value));
2601 function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a") {
2602 $config = CRM_Core_Config
::singleton();
2604 // find all the groups that are part of a saved search
2605 $groupIDs = implode(',', $groups);
2606 if (empty($groupIDs)) {
2611 SELECT id, cache_date, saved_search_id, children
2613 WHERE id IN ( $groupIDs )
2614 AND ( saved_search_id != 0
2615 OR saved_search_id IS NOT NULL
2616 OR children IS NOT NULL )
2618 $group = CRM_Core_DAO
::executeQuery($sql);
2620 while ($group->fetch()) {
2621 if ($tableAlias == NULL) {
2622 $alias = "`civicrm_group_contact_cache_{$group->id}`";
2625 $alias = $tableAlias;
2628 $this->_useDistinct
= TRUE;
2630 if (!$this->_smartGroupCache ||
$group->cache_date
== NULL) {
2631 CRM_Contact_BAO_GroupContactCache
::load($group);
2634 $this->_tables
[$alias] = $this->_whereTables
[$alias] = " LEFT JOIN civicrm_group_contact_cache {$alias} ON {$joinTable}.id = {$alias}.contact_id ";
2635 $ssWhere[] = "{$alias}.group_id = {$group->id}";
2638 if (!empty($ssWhere)) {
2639 return implode(' OR ', $ssWhere);
2645 * where / qill clause for cms users
2650 function ufUser(&$values) {
2651 list($name, $op, $value, $grouping, $wildcard) = $values;
2654 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2656 $this->_qill
[$grouping][] = ts('CMS User');
2658 elseif ($value == 0) {
2659 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2661 $this->_where
[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
2662 $this->_qill
[$grouping][] = ts('Not a CMS User');
2667 * all tag search specific
2672 function tagSearch(&$values) {
2673 list($name, $op, $value, $grouping, $wildcard) = $values;
2676 $value = "%{$value}%";
2679 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2680 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2682 $etTable = "`civicrm_entity_tag-" . $value . "`";
2683 $tTable = "`civicrm_tag-" . $value . "`";
2685 if ($useAllTagTypes[2]) {
2686 $this->_tables
[$etTable] =
2687 $this->_whereTables
[$etTable] =
2688 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
2689 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id )";
2691 // search tag in cases
2692 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2693 $tCaseTable = "`civicrm_case_tag-" . $value . "`";
2694 $this->_tables
[$etCaseTable] =
2695 $this->_whereTables
[$etCaseTable] =
2696 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2697 LEFT JOIN civicrm_case
2698 ON (civicrm_case_contact.case_id = civicrm_case.id
2699 AND civicrm_case.is_deleted = 0 )
2700 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
2701 LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id )";
2702 // search tag in activities
2703 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2704 $tActTable = "`civicrm_act_tag-" . $value . "`";
2705 $this->_tables
[$etActTable] =
2706 $this->_whereTables
[$etActTable] =
2707 " LEFT JOIN civicrm_activity_target
2708 ON ( civicrm_activity_target.target_contact_id = contact_a.id )
2709 LEFT JOIN civicrm_activity
2710 ON ( civicrm_activity.id = civicrm_activity_target.activity_id
2711 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2712 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
2713 LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id )";
2715 $this->_where
[$grouping][] = "({$tTable}.name $op '". $value . "' OR {$tCaseTable}.name $op '". $value . "' OR {$tActTable}.name $op '". $value . "')";
2716 $this->_qill
[$grouping][] = ts('Tag %1 %2 ', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
2718 $etTable = "`civicrm_entity_tag-" . $value . "`";
2719 $tTable = "`civicrm_tag-" . $value . "`";
2720 $this->_tables
[$etTable] = $this->_whereTables
[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND
2721 {$etTable}.entity_table = 'civicrm_contact' )
2722 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id ) ";
2724 $this->_where
[$grouping][] = self
::buildClause("{$tTable}.name", $op, $value, 'String');
2725 $this->_qill
[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
2730 * where / qill clause for tag
2735 function tag(&$values) {
2736 list($name, $op, $value, $grouping, $wildcard) = $values;
2738 $tagNames = CRM_Core_PseudoConstant
::tag();
2739 if (is_array($value)) {
2740 if (count($value) > 1) {
2741 $this->_useDistinct
= TRUE;
2743 foreach ($value as $id => $dontCare) {
2744 $names[] = CRM_Utils_Array
::value($id, $tagNames);
2746 $names = implode(' ' . ts('or') . ' ', $names);
2747 $value = implode(',', array_keys($value));
2750 $names = CRM_Utils_Array
::value($value, $tagNames);
2754 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2755 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2757 $etTable = "`civicrm_entity_tag-" . $value . "`";
2759 if ($useAllTagTypes[2]) {
2760 $this->_tables
[$etTable] =
2761 $this->_whereTables
[$etTable] =
2762 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2764 // search tag in cases
2765 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2766 $this->_tables
[$etCaseTable] =
2767 $this->_whereTables
[$etCaseTable] =
2768 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2769 LEFT JOIN civicrm_case
2770 ON (civicrm_case_contact.case_id = civicrm_case.id
2771 AND civicrm_case.is_deleted = 0 )
2772 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
2773 // search tag in activities
2774 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2775 $this->_tables
[$etActTable] =
2776 $this->_whereTables
[$etActTable] =
2777 " LEFT JOIN civicrm_activity_target
2778 ON ( civicrm_activity_target.target_contact_id = contact_a.id )
2779 LEFT JOIN civicrm_activity
2780 ON ( civicrm_activity.id = civicrm_activity_target.activity_id
2781 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2782 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
2785 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2786 $this->_where
[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
2789 $this->_where
[$grouping][] = "({$etTable}.tag_id $op (". $value . ") OR {$etCaseTable}.tag_id $op (". $value . ") OR {$etActTable}.tag_id $op (". $value . "))";
2791 $this->_qill
[$grouping][] = ts('Tag %1 %2', array(1 => $op, 2 => $tagTypesText[2])) . ' ' . $names;
2793 $this->_tables
[$etTable] =
2794 $this->_whereTables
[$etTable] =
2795 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2798 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2799 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
2800 $op = str_replace('EMPTY', 'NULL', $op);
2801 $this->_where
[$grouping][] = "{$etTable}.tag_id $op";
2804 $this->_where
[$grouping][] = "{$etTable}.tag_id $op (" . $value . ')';
2806 $this->_qill
[$grouping][] = ts('Tagged %1', array( 1 => $op)) . ' ' . $names;
2812 * where/qill clause for notes
2817 function notes(&$values) {
2818 list($name, $op, $value, $grouping, $wildcard) = $values;
2820 $noteOptionValues = $this->getWhereValues('note_option', $grouping);
2821 $noteOption = CRM_Utils_Array
::value('2', $noteOptionValues, '6');
2822 $noteOption = ($name == 'note_body') ?
2 : (($name == 'note_subject') ?
3 : $noteOption);
2824 $this->_useDistinct
= TRUE;
2826 $this->_tables
['civicrm_note'] =
2827 $this->_whereTables
['civicrm_note'] =
2828 " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
2830 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2832 $value = $strtolower(CRM_Core_DAO
::escapeString($n));
2833 if ($wildcard ||
$op == 'LIKE') {
2834 if (strpos($value, '%') === FALSE) {
2835 $value = "%$value%";
2839 elseif ($op == 'IS NULL' ||
$op == 'IS NOT NULL') {
2845 if ( $noteOption %
2 == 0 ) {
2846 $clauses[] = self
::buildClause('civicrm_note.note', $op, $value, 'String');
2847 $label = ts('Note: Body Only');
2849 if ( $noteOption %
3 == 0 ) {
2850 $clauses[] = self
::buildClause('civicrm_note.subject', $op, $value, 'String');
2851 $label = $label ?
ts('Note: Body and Subject') : ts('Note: Subject Only');
2853 $this->_where
[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
2854 $this->_qill
[$grouping][] = $label . " $op - '$n'";
2857 function nameNullOrEmptyOp($name, $op, $grouping) {
2861 $this->_where
[$grouping][] = "contact_a.$name $op";
2862 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2866 $this->_where
[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
2867 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2870 case 'IS NOT EMPTY':
2871 $this->_where
[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
2872 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2881 * where / qill clause for sort_name
2886 function sortName(&$values) {
2887 list($name, $op, $value, $grouping, $wildcard) = $values;
2889 // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
2890 if ( $this->nameNullOrEmptyOp( $name, $op, $grouping ) ) {
2895 $name = trim($value);
2901 $config = CRM_Core_Config
::singleton();
2905 //By default, $sub elements should be joined together with OR statements (don't change this variable).
2908 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2910 if (substr($name, 0, 1) == '"' &&
2911 substr($name, -1, 1) == '"'
2913 //If name is encased in double quotes, the value should be taken to be the string in entirety and the
2914 $value = substr($name, 1, -1);
2915 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
2916 $wc = ($newName == 'sort_name') ?
'LOWER(contact_a.sort_name)' : 'LOWER(contact_a.display_name)';
2917 $sub[] = " ( $wc = '$value' ) ";
2918 if ($config->includeEmailInName
) {
2919 $sub[] = " ( civicrm_email.email = '$value' ) ";
2922 elseif (strpos($name, ',') !== FALSE) {
2923 // if we have a comma in the string, search for the entire string
2924 $value = $strtolower(CRM_Core_DAO
::escapeString($name));
2926 if ($config->includeWildCardInName
) {
2927 $value = "'%$value%'";
2930 $value = "'$value%'";
2935 $value = "'$value'";
2937 if ($newName == 'sort_name') {
2938 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.sort_name)" : "contact_a.sort_name";
2941 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.display_name)" : "contact_a.display_name";
2943 $sub[] = " ( $wc $op $value )";
2944 if ($config->includeNickNameInName
) {
2945 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.nick_name)" : "contact_a.nick_name";
2946 $sub[] = " ( $wc $op $value )";
2948 if ($config->includeEmailInName
) {
2949 $sub[] = " ( civicrm_email.email $op $value ) ";
2953 // the string should be treated as a series of keywords to be matched with match ANY OR
2954 // match ALL depending on Civi config settings (see CiviAdmin)
2956 // The Civi configuration setting can be overridden if the string *starts* with the case
2957 // insenstive strings 'AND:' or 'OR:'TO THINK ABOUT: what happens when someone searches
2958 // for the following "AND: 'a string in quotes'"? - probably nothing - it would make the
2959 // AND OR variable reduntant because there is only one search string?
2961 // Check to see if the $subGlue is overridden in the search text
2962 if (strtolower(substr($name, 0, 4)) == 'and:') {
2963 $name = substr($name, 4);
2966 if (strtolower(substr($name, 0, 3)) == 'or:') {
2967 $name = substr($name, 3);
2971 $firstChar = substr($name, 0, 1);
2972 $lastChar = substr($name, -1, 1);
2973 $quotes = array("'", '"');
2974 if ((strlen($name) > 2) && in_array($firstChar, $quotes) &&
2975 in_array($lastChar, $quotes)
2977 $name = substr($name, 1);
2978 $name = substr($name, 0, -1);
2979 $pieces = array($name);
2982 $pieces = explode(' ', $name);
2984 foreach ($pieces as $piece) {
2985 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($piece)));
2986 if (strlen($value)) {
2987 // Added If as a sanitization - without it, when you do an OR search, any string with
2988 // double spaces (i.e. " ") or that has a space after the keyword (e.g. "OR: ") will
2989 // return all contacts because it will include a condition similar to "OR contact
2990 // name LIKE '%'". It might be better to replace this with array_filter.
2991 $fieldsub = array();
2993 if ($config->includeWildCardInName
) {
2994 $value = "'%$value%'";
2997 $value = "'$value%'";
3002 $value = "'$value'";
3004 if ($newName == 'sort_name') {
3005 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3008 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.display_name)" : "contact_a.display_name";
3010 $fieldsub[] = " ( $wc $op $value )";
3011 if ($config->includeNickNameInName
) {
3012 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3013 $fieldsub[] = " ( $wc $op $value )";
3015 if ($config->includeEmailInName
) {
3016 $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3018 $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3019 // I seperated the glueing in two. The first stage should always be OR because we are searching for matches in *ANY* of these fields
3024 $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3026 $this->_where
[$grouping][] = $sub;
3027 if ($config->includeEmailInName
) {
3028 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3029 $this->_qill
[$grouping][] = ts('Name or Email ') . "$op - '$name'";
3032 $this->_qill
[$grouping][] = ts('Name like') . " - '$name'";
3037 * where / qill clause for email
3042 function email(&$values) {
3043 list($name, $op, $value, $grouping, $wildcard) = $values;
3047 $config = CRM_Core_Config
::singleton();
3049 if (substr($n, 0, 1) == '"' &&
3050 substr($n, -1, 1) == '"'
3052 $n = substr($n, 1, -1);
3053 $value = strtolower(CRM_Core_DAO
::escapeString($n));
3054 $value = "'$value'";
3058 $value = strtolower($n);
3060 if (strpos($value, '%') === FALSE) {
3061 $value = "%{$value}%";
3066 $this->_qill
[$grouping][] = ts('Email') . " $op '$n'";
3067 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, $value, 'String');
3070 $this->_qill
[$grouping][] = ts('Email') . " $op ";
3071 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, NULL, 'String');
3074 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3078 * where / qill clause for phone number
3083 function phone_numeric(&$values) {
3084 list($name, $op, $value, $grouping, $wildcard) = $values;
3085 // Strip non-numeric characters
3086 $number = preg_replace('/[^\d]/', '', $value);
3088 $this->_qill
[$grouping][] = ts('Phone number contains') . " $number";
3089 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.phone_numeric', 'LIKE', "%$number%", 'String');
3090 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3095 * where / qill clause for phone type/location
3100 function phone_option_group($values) {
3101 list($name, $op, $value, $grouping, $wildcard) = $values;
3102 $option = $name == 'phone_phone_type_id' ?
'phoneType' : 'locationType';
3103 $options = CRM_Core_PseudoConstant
::$option();
3104 $optionName = $options[$value];
3105 $this->_qill
[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ?
ts('type') : ('location')) . " $op $optionName";
3106 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3107 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3111 * where / qill clause for street_address
3116 function street_address(&$values) {
3117 list($name, $op, $value, $grouping, $wildcard) = $values;
3126 $value = strtolower($n);
3127 if (strpos($value, '%') === FALSE) {
3128 // only add wild card if not there
3129 $value = "%{$value}%";
3132 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String');
3133 $this->_qill
[$grouping][] = ts('Street') . " $op '$n'";
3136 $this->_where
[$grouping][] = self
::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3137 $this->_qill
[$grouping][] = ts('Street') . " $op ";
3140 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3144 * where / qill clause for street_unit
3149 function street_number(&$values) {
3150 list($name, $op, $value, $grouping, $wildcard) = $values;
3158 if (strtolower($n) == 'odd') {
3159 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3160 $this->_qill
[$grouping][] = ts('Street Number is odd');
3162 elseif (strtolower($n) == 'even') {
3163 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3164 $this->_qill
[$grouping][] = ts('Street Number is even');
3167 $value = strtolower($n);
3169 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3170 $this->_qill
[$grouping][] = ts('Street Number') . " $op '$n'";
3173 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3177 * where / qill clause for sorting by character
3182 function sortByCharacter(&$values) {
3183 list($name, $op, $value, $grouping, $wildcard) = $values;
3185 $name = trim($value);
3186 $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($name)) . "%'";
3187 $this->_where
[$grouping][] = $cond;
3188 $this->_qill
[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3192 * where / qill clause for including contact ids
3197 function includeContactIDs() {
3198 if (!$this->_includeContactIds ||
empty($this->_params
)) {
3202 $contactIds = array();
3203 foreach ($this->_params
as $id => $values) {
3204 if (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
3205 $contactIds[] = substr($values[0], CRM_Core_Form
::CB_PREFIX_LEN
);
3208 if (!empty($contactIds)) {
3209 $this->_where
[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3214 * where / qill clause for postal code
3219 function postalCode(&$values) {
3220 // skip if the fields dont have anything to do with postal_code
3221 if (!CRM_Utils_Array
::value('postal_code', $this->_fields
)) {
3225 list($name, $op, $value, $grouping, $wildcard) = $values;
3227 // Handle numeric postal code range searches properly by casting the column as numeric
3228 if (is_numeric($value)) {
3229 $field = 'ROUND(civicrm_address.postal_code)';
3230 $val = CRM_Utils_Type
::escape($value, 'Integer');
3233 $field = 'civicrm_address.postal_code';
3234 $val = CRM_Utils_Type
::escape($value, 'String');
3237 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3239 if ($name == 'postal_code') {
3240 $this->_where
[$grouping][] = self
::buildClause($field, $op, $val, 'String');
3241 $this->_qill
[$grouping][] = ts('Postal code') . " {$op} {$value}";
3243 elseif ($name == 'postal_code_low') {
3244 $this->_where
[$grouping][] = " ( $field >= '$val' ) ";
3245 $this->_qill
[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3247 elseif ($name == 'postal_code_high') {
3248 $this->_where
[$grouping][] = " ( $field <= '$val' ) ";
3249 $this->_qill
[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3254 * where / qill clause for location type
3259 function locationType(&$values, $status = NULL) {
3260 list($name, $op, $value, $grouping, $wildcard) = $values;
3262 if (is_array($value)) {
3263 $this->_where
[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', array_keys($value)) . ')';
3264 $this->_tables
['civicrm_address'] = 1;
3265 $this->_whereTables
['civicrm_address'] = 1;
3267 $locationType = CRM_Core_PseudoConstant
::locationType();
3269 foreach (array_keys($value) as $id) {
3270 $names[] = $locationType[$id];
3273 $this->_primaryLocation
= FALSE;
3276 $this->_qill
[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3279 return implode(' ' . ts('or') . ' ', $names);
3284 function country(&$values, $fromStateProvince = TRUE) {
3285 list($name, $op, $value, $grouping, $wildcard) = $values;
3287 if (!$fromStateProvince) {
3288 $stateValues = $this->getWhereValues('state_province', $grouping);
3289 if (!empty($stateValues)) {
3290 // return back to caller if there are state province values
3291 // since that handles this case
3296 $countryClause = $countryQill = NULL;
3301 $this->_tables
['civicrm_country'] = 1;
3302 $this->_whereTables
['civicrm_country'] = 1;
3304 $countries = CRM_Core_PseudoConstant
::country();
3305 if (is_numeric($value)) {
3306 $countryClause = self
::buildClause(
3307 'civicrm_country.id',
3312 $countryName = $countries[(int ) $value];
3316 $intValues = self
::parseSearchBuilderString($value);
3317 if ($intValues && ($op == 'IN' ||
$op == 'NOT IN')) {
3318 $countryClause = self
::buildClause(
3319 'civicrm_country.id',
3324 $countryNames = array();
3325 foreach ($intValues as $v) {
3326 $countryNames[] = $countries[$v];
3328 $countryName = implode(',', $countryNames);
3331 $wc = ($op != 'LIKE') ?
"LOWER('civicrm_country.name')" : 'civicrm_country.name';
3332 $countryClause = self
::buildClause(
3333 'civicrm_country.name',
3338 $countryName = $value;
3341 $countryQill = ts('Country') . " {$op} '$countryName'";
3343 if (!$fromStateProvince) {
3344 $this->_where
[$grouping][] = $countryClause;
3345 $this->_qill
[$grouping][] = $countryQill;
3349 if ($fromStateProvince) {
3350 if (!empty($countryClause)) {
3353 " ...AND... " . $countryQill,
3357 return array(NULL, NULL);
3363 * where / qill clause for county (if present)
3368 function county(&$values, $status = null) {
3369 list($name, $op, $value, $grouping, $wildcard) = $values;
3371 if (! is_array($value)) {
3372 // force the county to be an array
3373 $value = array($value);
3376 // check if the values are ids OR names of the counties
3377 $inputFormat = 'id';
3378 foreach ($value as $v) {
3379 if (!is_numeric($v)) {
3380 $inputFormat = 'name';
3385 if ($inputFormat == 'id') {
3386 $clause = 'civicrm_county.id IN (' . implode(',', $value) . ')';
3388 $county = CRM_Core_PseudoConstant
::county();
3389 foreach ($value as $id) {
3390 $names[] = CRM_Utils_Array
::value($id, $county);
3394 $inputClause = array();
3395 foreach ($value as $name) {
3396 $name = trim($name);
3397 $inputClause[] = "'$name'";
3399 $clause = 'civicrm_county.name IN (' . implode(',', $inputClause) . ')';
3402 $this->_tables
['civicrm_county'] = 1;
3403 $this->_whereTables
['civicrm_county'] = 1;
3405 $this->_where
[$grouping][] = $clause;
3407 $this->_qill
[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3409 return implode(' ' . ts('or') . ' ', $names);
3414 * where / qill clause for state/province AND country (if present)
3419 function stateProvince(&$values, $status = NULL) {
3420 list($name, $op, $value, $grouping, $wildcard) = $values;
3422 // quick escape for IS NULL
3423 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3426 else if (!is_array($value)) {
3427 // force the state to be an array
3428 // check if its in the mapper format!
3429 $values = self
::parseSearchBuilderString($value);
3430 if (is_array($values)) {
3434 $value = array($value);
3438 // check if the values are ids OR names of the states
3439 $inputFormat = 'id';
3441 foreach ($value as $v) {
3442 if (!is_numeric($v)) {
3443 $inputFormat = 'name';
3453 else if ($op == '!=') {
3457 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3458 $op = str_replace('EMPTY', 'NULL', $op);
3460 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3461 $stateClause = "civicrm_state_province.id $op";
3463 else if ($inputFormat == 'id') {
3464 if ($op != 'NOT IN') {
3467 $stateClause = "civicrm_state_province.id $op (" . implode(',', $value) . ')';
3469 $stateProvince = CRM_Core_PseudoConstant
::stateProvince();
3470 foreach ($value as $id) {
3471 $names[] = CRM_Utils_Array
::value($id, $stateProvince);
3475 $inputClause = array();
3476 foreach ($value as $name) {
3477 $name = trim($name);
3478 $inputClause[] = "'$name'";
3480 $stateClause = "civicrm_state_province.name $op (" . implode(',', $inputClause) . ')';
3484 $this->_tables
['civicrm_state_province'] = 1;
3485 $this->_whereTables
['civicrm_state_province'] = 1;
3487 $countryValues = $this->getWhereValues('country', $grouping);
3488 list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3490 if ($countryClause) {
3491 $clause = "( $stateClause AND $countryClause )";
3494 $clause = $stateClause;
3497 $this->_where
[$grouping][] = $clause;
3499 $this->_qill
[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill;
3502 return implode(' ' . ts('or') . ' ', $names) . $countryQill;;
3507 * where / qill clause for change log
3512 function changeLog(&$values) {
3513 list($name, $op, $value, $grouping, $wildcard) = $values;
3515 $targetName = $this->getWhereValues('changed_by', $grouping);
3520 $name = trim($targetName[2]);
3521 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3522 $name = $targetName[4] ?
"%$name%" : $name;
3523 $this->_where
[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3524 $this->_tables
['civicrm_log'] = $this->_whereTables
['civicrm_log'] = 1;
3525 $this->_qill
[$grouping][] = ts('Changed by') . ": $name";
3528 function modifiedDates($values) {
3529 $this->_useDistinct
= TRUE;
3531 // CRM-11281, default to added date if not set
3532 $fieldTitle = ts('Added Date');
3534 foreach (array_keys($this->_params
) as $id) {
3535 if ($this->_params
[$id][0] == 'log_date') {
3536 if ($this->_params
[$id][2] == 2) {
3537 $fieldTitle = ts('Modified Date');
3542 $this->dateQueryBuilder($values,
3543 'civicrm_log', 'log_date', 'modified_date', $fieldTitle
3547 function demographics(&$values) {
3548 list($name, $op, $value, $grouping, $wildcard) = $values;
3550 if (($name == 'birth_date_low') ||
($name == 'birth_date_high')) {
3552 $this->dateQueryBuilder($values,
3553 'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3556 elseif (($name == 'deceased_date_low') ||
($name == 'deceased_date_high')) {
3558 $this->dateQueryBuilder($values,
3559 'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3563 self
::$_openedPanes[ts('Demographics')] = TRUE;
3566 function privacy(&$values) {
3567 list($name, $op, $value, $grouping, $wildcard) = $values;
3568 //fixed for profile search listing CRM-4633
3569 if (strpbrk($value, "[")) {
3570 $value = "'{$value}'";
3572 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3575 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3577 $field = CRM_Utils_Array
::value($name, $this->_fields
);
3578 $title = $field ?
$field['title'] : $name;
3579 $this->_qill
[$grouping][] = "$title $op $value";
3582 function privacyOptions($values) {
3583 list($name, $op, $value, $grouping, $wildcard) = $values;
3585 if (empty($value) ||
3591 // get the operator and toggle values
3592 $opValues = $this->getWhereValues('privacy_operator', $grouping);
3595 strtolower($opValues[2] == 'AND')
3600 $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3602 if ($toggleValues &&
3603 $toggleValues[2] == 2
3610 foreach ($value as $dontCare => $pOption) {
3611 $clauses[] = " ( contact_a.{$pOption} $compareOP 1 ) ";
3612 $field = CRM_Utils_Array
::value($pOption, $this->_fields
);
3613 $title = $field ?
$field['title'] : $pOption;
3614 $qill[] = " $title $compareOP 1 ";
3617 $this->_where
[$grouping][] = '( ' . implode($operator, $clauses) . ' )';
3618 $this->_qill
[$grouping][] = implode($operator, $qill);
3621 function preferredCommunication(&$values) {
3622 list($name, $op, $value, $grouping, $wildcard) = $values;
3625 if (!is_array($value)) {
3627 $value = trim($value, ' ()');
3628 if (strpos($value, CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
3629 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
3632 $v = explode(",", $value);
3635 foreach ($v as $item) {
3642 foreach ($value as $key => $checked) {
3649 $commPref = CRM_Core_PseudoConstant
::pcm();
3651 $sqlValue = array();
3652 $sql = "contact_a.preferred_communication_method";
3653 foreach ($pref as $val) {
3654 $sqlValue[] = "( $sql like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. $val . CRM_Core_DAO
::VALUE_SEPARATOR
. "%' ) ";
3655 $showValue[] = $commPref[$val];
3657 $this->_where
[$grouping][] = "( " . implode(' OR ', $sqlValue) . " )";
3658 $this->_qill
[$grouping][] = ts('Preferred Communication Method') . " $op " . implode(' ' . ts('or') . ' ', $showValue);
3662 * where / qill clause for task / task status
3667 function task(&$values) {
3668 list($name, $op, $value, $grouping, $wildcard) = $values;
3670 $targetName = $this->getWhereValues('task_id', $grouping);
3675 $taskID = CRM_Utils_Type
::escape($targetName[2], 'Integer');
3676 $clause = "civicrm_task_status.task_id = $taskID ";
3680 $statusID = CRM_Utils_Type
::escape($value, 'Integer');
3681 $clause .= " AND civicrm_task_status.status_id = $statusID";
3684 $this->_where
[$grouping][] = "civicrm_task_status.task_id = $taskID AND civicrm_task_status.status_id = $statusID";
3685 $this->_tables
['civicrm_task_status'] = $this->_whereTables
['civicrm_task_status'] = 1;
3687 $taskSelect = CRM_Core_PseudoConstant
::tasks();
3688 $this->_qill
[$grouping][] = ts('Task') . ": $taskSelect[$taskID]";
3690 $statusSelect = CRM_Core_OptionGroup
::values('task_status');
3691 $this->_qill
[$grouping][] = ts('Task Status') . ": $statusSelect[$statusID]";
3696 * where / qill clause for relationship
3701 function relationship(&$values) {
3702 list($name, $op, $value, $grouping, $wildcard) = $values;
3704 // also get values array for relation_target_name
3705 // for relatinship search we always do wildcard
3706 $targetName = $this->getWhereValues('relation_target_name', $grouping);
3707 $relStatus = $this->getWhereValues('relation_status', $grouping);
3708 $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
3709 $start = $this->getWhereValues('relation_date_low', $grouping);
3710 $end = $this->getWhereValues('relation_date_high', $grouping);
3712 $nameClause = $name = NULL;
3714 $name = trim($targetName[2]);
3715 if (substr($name, 0, 1) == '"' &&
3716 substr($name, -1, 1) == '"'
3718 $name = substr($name, 1, -1);
3719 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3720 $nameClause = "= '$name'";
3723 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3724 $nameClause = "LIKE '%{$name}%'";
3728 $rel = explode('_', $value);
3730 self
::$_relType = $rel[1];
3732 $params = array('id' => $rel[0]);
3733 $rTypeValues = array();
3734 $rType = CRM_Contact_BAO_RelationshipType
::retrieve($params, $rTypeValues);
3739 if ($rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) {
3740 self
::$_relType = 'reciprocal';
3744 $this->_where
[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
3747 $relTypeInd = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Individual');
3748 $relTypeOrg = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Organization');
3749 $relTypeHou = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Household');
3750 $allRelationshipType = array();
3751 $allRelationshipType = array_merge($relTypeInd, $relTypeOrg);
3752 $allRelationshipType = array_merge($allRelationshipType, $relTypeHou);
3754 if ($nameClause ||
!$targetGroup) {
3755 $this->_qill
[$grouping][] = "$allRelationshipType[$value] $name";
3759 //check to see if the target contact is in specified group
3761 //add contacts from static groups
3762 $this->_tables
['civicrm_relationship_group_contact'] =
3763 $this->_whereTables
['civicrm_relationship_group_contact'] =
3764 " LEFT JOIN civicrm_group_contact civicrm_relationship_group_contact ON civicrm_relationship_group_contact.contact_id = contact_b.id";
3765 $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN (" . implode(",", $targetGroup[2]) . ") )";
3767 //add contacts from saved searches
3768 $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b");
3770 //set the group where clause
3772 $groupWhere[] = "( " . $ssWhere . " )";
3774 $this->_where
[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
3776 //Get the names of the target groups for the qill
3777 $groupNames = &CRM_Core_PseudoConstant
::group();
3778 $qillNames = array();
3779 foreach ($targetGroup[2] as $groupId) {
3780 if (array_key_exists($groupId, $groupNames)) {
3781 $qillNames[] = $groupNames[$groupId];
3784 $this->_qill
[$grouping][] = "$allRelationshipType[$value] ( " . implode(", ", $qillNames) . " )";
3788 //check for active, inactive and all relation status
3789 if ($relStatus[2] == 0) {
3790 $this->_where
[$grouping][] = "(
3791 civicrm_relationship.is_active = 1 AND
3792 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= CURDATE() ) AND
3793 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= CURDATE() )
3795 $this->_qill
[$grouping][] = ts('Relationship - Active and Current');
3797 elseif ($relStatus[2] == 1) {
3798 $this->_where
[$grouping][] = "(
3799 civicrm_relationship.is_active = 0 OR
3800 civicrm_relationship.end_date < CURDATE() OR
3801 civicrm_relationship.start_date > CURDATE()
3803 $this->_qill
[$grouping][] = ts('Relationship - Inactive or not Current');
3807 if ($start ||
$end) {
3808 foreach (array('start' => '>=', 'end' => '<=') as $d => $op) {
3809 if (!empty($
{$d}[2])) {
3810 $date = date('Ymd', strtotime($
{$d}[2]));
3811 $this->_where
[$grouping][] = "civicrm_relationship.{$d}_date $op $date";
3812 $this->_qill
[$grouping][] = ($d == 'end' ?
ts('Relationship Ended by') : ts('Relationship Started On or After')) . " " . CRM_Utils_Date
::customFormat($date);
3817 $this->_where
[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rel[0];
3818 $this->_tables
['civicrm_relationship'] = $this->_whereTables
['civicrm_relationship'] = 1;
3819 $this->_useDistinct
= TRUE;
3823 * default set of return properties
3828 static function &defaultReturnProperties($mode = 1) {
3829 if (!isset(self
::$_defaultReturnProperties)) {
3830 self
::$_defaultReturnProperties = array();
3833 if (!isset(self
::$_defaultReturnProperties[$mode])) {
3834 // add activity return properties
3835 if ($mode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
3836 self
::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query
::defaultReturnProperties($mode, FALSE);
3839 self
::$_defaultReturnProperties[$mode] = CRM_Core_Component
::defaultReturnProperties($mode, FALSE);
3842 if (empty(self
::$_defaultReturnProperties[$mode])) {
3843 self
::$_defaultReturnProperties[$mode] = array(
3846 'legal_identifier' => 1,
3847 'external_identifier' => 1,
3848 'contact_type' => 1,
3849 'contact_sub_type' => 1,
3851 'display_name' => 1,
3852 'preferred_mail_format' => 1,
3857 'individual_prefix' => 1,
3858 'individual_suffix' => 1,
3861 'street_address' => 1,
3862 'supplemental_address_1' => 1,
3863 'supplemental_address_2' => 1,
3866 'postal_code_suffix' => 1,
3867 'state_province' => 1,
3869 'world_region' => 1,
3876 'household_name' => 1,
3877 'organization_name' => 1,
3878 'deceased_date' => 1,
3883 'current_employer' => 1,
3884 // FIXME: should we use defaultHierReturnProperties() for the below?
3885 'do_not_email' => 1,
3888 'do_not_phone' => 1,
3889 'do_not_trade' => 1,
3891 'contact_is_deleted' => 1,
3895 return self
::$_defaultReturnProperties[$mode];
3899 * get primary condition for a sql clause
3906 static function getPrimaryCondition($value) {
3907 if (is_numeric($value)) {
3908 $value = (int ) $value;
3909 return ($value == 1) ?
'is_primary = 1' : 'is_primary = 0';
3915 * wrapper for a simple search query
3917 * @param array $params
3918 * @param array $returnProperties
3919 * @param bolean $count
3924 static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
3925 $query = new CRM_Contact_BAO_Query($params, $returnProperties);
3926 list($select, $from, $where, $having) = $query->query();
3928 return "$select $from $where $having";
3932 * These are stub comments as this function needs more explanation - particularly in terms of how it
3933 * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
3935 * This function was originally written as a wrapper for the api query but is called from multiple places
3936 * in the core code directly so the name is misleading. This function does not use the searchQuery function
3937 * but it is unclear as to whehter that is historical or there is a reason
3938 * CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
3940 * @param array $params
3941 * @param array $returnProperties
3942 * @param string $sort
3943 * @param int $offset
3944 * @param int $row_count
3945 * @params bool $smartGroupCache ?? update smart group cache?
3946 * @param bool $count return count obnly
3947 * @param bool $skipPermissions Should permissions be ignored or should the logged in user's permissions be applied
3952 static function apiQuery(
3954 $returnProperties = NULL,
3959 $smartGroupCache = TRUE,
3961 $skipPermissions = True
3964 $query = new CRM_Contact_BAO_Query(
3965 $params, $returnProperties,
3966 NULL, TRUE, FALSE, 1,
3968 TRUE, $smartGroupCache
3971 //this should add a check for view deleted if permissions are enabled
3972 if ($skipPermissions){
3973 $query->_skipDeleteClause
= TRUE;
3975 $query->generatePermissionClause(FALSE, $count);
3976 list($select, $from, $where, $having) = $query->query($count);
3978 $options = $query->_options
;
3979 if(!empty($query->_permissionWhereClause
)){
3980 if (empty($where)) {
3981 $where = "WHERE $query->_permissionWhereClause";
3984 $where = "$where AND $query->_permissionWhereClause";
3988 $sql = "$select $from $where $having";
3991 if ($query->_useGroupBy
) {
3992 $sql .= ' GROUP BY contact_a.id';
3994 if (!empty($sort)) {
3995 $sql .= " ORDER BY $sort ";
3997 if ($row_count > 0 && $offset >= 0) {
3998 $sql .= " LIMIT $offset, $row_count ";
4001 $dao = CRM_Core_DAO
::executeQuery($sql);
4004 while ($dao->fetch()) {
4006 $noRows = $dao->rowCount
;
4008 return array($noRows,NULL);
4010 $values[$dao->contact_id
] = $query->store($dao);
4013 return array($values, $options);
4017 * create and query the db for an contact search
4019 * @param int $offset the offset for the query
4020 * @param int $rowCount the number of rows to return
4021 * @param string $sort the order by string
4022 * @param boolean $count is this a count only query ?
4023 * @param boolean $includeContactIds should we include contact ids?
4024 * @param boolean $sortByChar if true returns the distinct array of first characters for search results
4025 * @param boolean $groupContacts if true, return only the contact ids
4026 * @param boolean $returnQuery should we return the query as a string
4027 * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components)
4028 * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load.
4030 * @return CRM_Contact_DAO_Contact
4033 function searchQuery(
4034 $offset = 0, $rowCount = 0, $sort = NULL,
4035 $count = FALSE, $includeContactIds = FALSE,
4036 $sortByChar = FALSE, $groupContacts = FALSE,
4037 $returnQuery = FALSE,
4038 $additionalWhereClause = NULL, $sortOrder = NULL,
4039 $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4042 if ($includeContactIds) {
4043 $this->_includeContactIds
= TRUE;
4044 $this->_whereClause
= $this->whereClause();
4047 // hack for now, add permission only if we are in search
4048 // FIXME: we should actually filter out deleted contacts (unless requested to do the opposite)
4049 $permission = ' ( 1 ) ';
4050 $onlyDeleted = FALSE;
4051 $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
);
4053 // if we’re explicitely looking for a certain contact’s contribs, events, etc.
4054 // and that contact happens to be deleted, set $onlyDeleted to true
4055 foreach ($this->_params
as $values) {
4056 $name = CRM_Utils_Array
::value(0, $values);
4057 $op = CRM_Utils_Array
::value(1, $values);
4058 $value = CRM_Utils_Array
::value(2, $values);
4059 if ($name == 'contact_id' and $op == '=') {
4060 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4061 $onlyDeleted = TRUE;
4066 $this->generatePermissionClause($onlyDeleted, $count);
4068 list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts);
4070 //additional from clause should be w/ proper joins.
4071 if ($additionalFromClause) {
4072 $from .= "\n" . $additionalFromClause;
4075 if (empty($where)) {
4076 $where = "WHERE $this->_permissionWhereClause";
4079 $where = "$where AND $this->_permissionWhereClause";
4082 if ($additionalWhereClause) {
4083 $where = $where . ' AND ' . $additionalWhereClause;
4086 // building the query string
4089 if (isset($this->_groupByComponentClause
)) {
4090 $groupBy = $this->_groupByComponentClause
;
4092 elseif ($this->_useGroupBy
) {
4093 $groupBy = ' GROUP BY contact_a.id';
4096 if ($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
&& (!$count)) {
4097 $groupBy = 'GROUP BY civicrm_activity.id ';
4100 $order = $orderBy = $limit = '';
4102 $config = CRM_Core_Config
::singleton();
4103 if ($config->includeOrderByClause ||
4104 isset($this->_distinctComponentClause
)
4107 if (is_string($sort)) {
4111 $orderBy = trim($sort->orderBy());
4113 if (!empty($orderBy)) {
4114 // this is special case while searching for
4115 // changelog CRM-1718
4116 if (preg_match('/sort_name/i', $orderBy)) {
4117 $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
4120 $order = " ORDER BY $orderBy";
4123 $order .= " $sortOrder";
4126 // always add contact_a.id to the ORDER clause
4127 // so the order is deterministic
4128 if (strpos('contact_a.id', $order) === FALSE) {
4129 $order .= ", contact_a.id";
4133 elseif ($sortByChar) {
4134 $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc";
4137 $order = " ORDER BY contact_a.sort_name asc, contact_a.id";
4142 // hack for order clause
4144 $fieldStr = trim(str_replace('ORDER BY', '', $order));
4145 $fieldOrder = explode(' ', $fieldStr);
4146 $field = $fieldOrder[0];
4152 case 'contact_a.sort_name':
4153 case 'contact_a.id':
4158 $this->_whereTables
["civicrm_address"] = 1;
4159 $order = str_replace($field, "civicrm_address.{$field}", $order);
4163 case 'state_province':
4164 $this->_whereTables
["civicrm_{$field}"] = 1;
4165 $order = str_replace($field, "civicrm_{$field}.name", $order);
4169 $this->_whereTables
["civicrm_email"] = 1;
4170 $order = str_replace($field, "civicrm_email.{$field}", $order);
4180 if ($rowCount > 0 && $offset >= 0) {
4181 $limit = " LIMIT $offset, $rowCount ";
4183 // ok here is a first hack at an optimization, lets get all the contact ids
4184 // that are restricted and we'll then do the final clause with it
4186 if (isset($this->_distinctComponentClause
)) {
4187 if (strpos($this->_distinctComponentClause
, 'DISTINCT') == FALSE) {
4188 $limitSelect = "SELECT DISTINCT {$this->_distinctComponentClause}";
4191 $limitSelect = "SELECT {$this->_distinctComponentClause}";
4195 $limitSelect = 'SELECT DISTINCT contact_a.id as id';
4199 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL,
4200 $this->_primaryLocation
, $this->_mode
4203 if ($additionalFromClause) {
4204 $this->_simpleFromClause
.= "\n" . $additionalFromClause;
4206 // if we are doing a transform, do it here
4209 if ($this->_displayRelationshipType
) {
4210 $this->filterRelatedContacts($this->_simpleFromClause
, $where, $having);
4213 $limitQuery = "$limitSelect {$this->_simpleFromClause} $where $groupBy $order $limit";
4214 $limitDAO = CRM_Core_DAO
::executeQuery($limitQuery);
4215 $limitIDs = array();
4216 while ($limitDAO->fetch()) {
4217 if ($limitDAO->id
) {
4218 $limitIDs[] = $limitDAO->id
;
4221 if (empty($limitIDs)) {
4222 $limitClause = ' AND ( 0 ) ';
4225 if (isset($this->_distinctComponentClause
)) {
4226 $limitClause = " AND {$this->_distinctComponentClause} IN ( ";
4229 $limitClause = ' AND contact_a.id IN ( ';
4231 $limitClause .= implode(',', $limitIDs) . ' ) ';
4233 $where .= $limitClause;
4234 // reset limit clause since we already restrict what records we want
4240 // if we are doing a transform, do it here
4241 // use the $from, $where and $having to get the contact ID
4242 if ($this->_displayRelationshipType
) {
4243 $this->filterRelatedContacts($from, $where, $having);
4246 if ($skipOrderAndLimit) {
4247 $query = "$select $from $where $having $groupBy";
4250 $query = "$select $from $where $having $groupBy $order $limit";
4258 return CRM_Core_DAO
::singleValueQuery($query);
4261 //crm_core_error::debug('$query', $query); //exit;
4263 $dao = CRM_Core_DAO
::executeQuery($query);
4264 if ($groupContacts) {
4266 while ($dao->fetch()) {
4269 return implode(',', $ids);
4276 * Populate $this->_permissionWhereClause with permission related clause and update other
4277 * query related properties.
4279 * Function calls ACL permission class and hooks to filter the query appropriately
4281 * Note that these 2 params were in the code when extracted from another function
4282 * and a second round extraction would be to make them properties of the class
4284 * @param bool $onlyDeleted Only get deleted contacts
4285 * @param bool $count Return Count only
4289 function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
4290 if (!$this->_skipPermission
) {
4291 $this->_permissionWhereClause
= CRM_ACL_API
::whereClause(
4292 CRM_Core_Permission
::VIEW
,
4294 $this->_whereTables
,
4297 $this->_skipDeleteClause
4300 // regenerate fromClause since permission might have added tables
4301 if ($this->_permissionWhereClause
) {
4302 //fix for row count in qill (in contribute/membership find)
4304 $this->_useDistinct
= TRUE;
4306 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4307 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4311 // add delete clause if needed even if we are skipping permission
4313 if (!$this->_skipDeleteClause
) {
4314 if (CRM_Core_Permission
::check('access deleted contacts') and $onlyDeleted) {
4315 $this->_permissionWhereClause
= '(contact_a.is_deleted)';
4319 $this->_permissionWhereClause
= '(contact_a.is_deleted = 0)';
4325 function setSkipPermission($val) {
4326 $this->_skipPermission
= $val;
4329 function &summaryContribution($context = NULL) {
4330 list($select, $from, $where, $having) = $this->query(TRUE);
4334 SELECT COUNT( civicrm_contribution.total_amount ) as total_count,
4335 SUM( civicrm_contribution.total_amount ) as total_amount,
4336 AVG( civicrm_contribution.total_amount ) as total_avg,
4337 civicrm_contribution.currency as currency";
4339 // make sure contribution is completed - CRM-4989
4340 $where .= " AND civicrm_contribution.contribution_status_id = 1 ";
4341 if ($context == 'search') {
4342 $where .= " AND contact_a.is_deleted = 0 ";
4346 $summary['total'] = array();
4347 $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
4349 $query = "$select $from $where GROUP BY currency";
4352 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4354 $summary['total']['count'] = 0;
4355 $summary['total']['amount'] = $summary['total']['avg'] = array();
4356 while ($dao->fetch()) {
4357 $summary['total']['count'] +
= $dao->total_count
;
4358 $summary['total']['amount'][] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
4359 $summary['total']['avg'][] = CRM_Utils_Money
::format($dao->total_avg
, $dao->currency
);
4361 if (!empty($summary['total']['amount'])) {
4362 $summary['total']['amount'] = implode(', ', $summary['total']['amount']);
4363 $summary['total']['avg'] = implode(', ', $summary['total']['avg']);
4366 $summary['total']['amount'] = $summary['total']['avg'] = 0;
4371 SELECT COUNT( civicrm_contribution.total_amount ) as cancel_count,
4372 SUM( civicrm_contribution.total_amount ) as cancel_amount,
4373 AVG( civicrm_contribution.total_amount ) as cancel_avg,
4374 civicrm_contribution.currency as currency";
4376 $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
4377 if ($context == 'search') {
4378 $where .= " AND contact_a.is_deleted = 0 ";
4381 $query = "$select $from $where GROUP BY currency";
4382 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4385 if ($dao->fetch()) {
4386 $summary['cancel']['count'] = $dao->cancel_count
;
4387 $summary['cancel']['amount'] = $dao->cancel_amount
;
4388 $summary['cancel']['avg'] = $dao->cancel_avg
;
4392 $summary['cancel']['count'] = 0;
4393 $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
4394 while ($dao->fetch()) {
4395 $summary['cancel']['count'] +
= $dao->cancel_count
;
4396 $summary['cancel']['amount'][] = CRM_Utils_Money
::format($dao->cancel_amount
, $dao->currency
);
4397 $summary['cancel']['avg'][] = CRM_Utils_Money
::format($dao->cancel_avg
, $dao->currency
);
4399 $summary['cancel']['amount'] = implode(', ', $summary['cancel']['amount']);
4400 $summary['cancel']['avg'] = implode(', ', $summary['cancel']['avg']);
4407 * getter for the qill object
4413 return $this->_qill
;
4417 * default set of return default hier return properties
4422 static function &defaultHierReturnProperties() {
4423 if (!isset(self
::$_defaultHierReturnProperties)) {
4424 self
::$_defaultHierReturnProperties = array(
4427 'legal_identifier' => 1,
4428 'external_identifier' => 1,
4429 'contact_type' => 1,
4430 'contact_sub_type' => 1,
4432 'display_name' => 1,
4437 'individual_prefix' => 1,
4438 'individual_suffix' => 1,
4439 'email_greeting' => 1,
4440 'postal_greeting' => 1,
4444 'preferred_communication_method' => 1,
4445 'do_not_phone' => 1,
4446 'do_not_email' => 1,
4449 'do_not_trade' => 1,
4452 '1' => array('location_type' => 1,
4453 'street_address' => 1,
4455 'state_province' => 1,
4457 'postal_code_suffix' => 1,
4460 'phone-Mobile' => 1,
4473 'location_type' => 1,
4474 'street_address' => 1,
4476 'state_province' => 1,
4478 'postal_code_suffix' => 1,
4481 'phone-Mobile' => 1,
4495 return self
::$_defaultHierReturnProperties;
4498 function dateQueryBuilder(
4499 &$values, $tableName, $fieldName,
4500 $dbFieldName, $fieldTitle,
4501 $appendTimeStamp = TRUE
4503 list($name, $op, $value, $grouping, $wildcard) = $values;
4509 if ($name == "{$fieldName}_low" ||
4510 $name == "{$fieldName}_high"
4512 if (isset($this->_rangeCache
[$fieldName])) {
4515 $this->_rangeCache
[$fieldName] = 1;
4517 $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
4519 if ($name == $fieldName . '_low') {
4521 $firstPhrase = ts('greater than or equal to');
4522 $firstDate = CRM_Utils_Date
::processDate($value);
4524 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4525 if (!empty($secondValues) && $secondValues[2]) {
4527 $secondPhrase = ts('less than or equal to');
4528 $secondValue = $secondValues[2];
4530 if ($appendTimeStamp && strlen($secondValue) == 10) {
4531 $secondValue .= ' 23:59:59';
4533 $secondDate = CRM_Utils_Date
::processDate($secondValue);
4536 elseif ($name == $fieldName . '_high') {
4538 $firstPhrase = ts('less than or equal to');
4540 if ($appendTimeStamp && strlen($value) == 10) {
4541 $value .= ' 23:59:59';
4543 $firstDate = CRM_Utils_Date
::processDate($value);
4545 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4546 if (!empty($secondValues) && $secondValues[2]) {
4548 $secondPhrase = ts('greater than or equal to');
4549 $secondValue = $secondValues[2];
4550 $secondDate = CRM_Utils_Date
::processDate($secondValue);
4554 if (!$appendTimeStamp) {
4555 $firstDate = substr($firstDate, 0, 8);
4557 $firstDateFormat = CRM_Utils_Date
::customFormat($firstDate);
4560 if (!$appendTimeStamp) {
4561 $secondDate = substr($secondDate, 0, 8);
4563 $secondDateFormat = CRM_Utils_Date
::customFormat($secondDate);
4566 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4568 $this->_where
[$grouping][] = "
4569 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
4570 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
4572 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
4575 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
4576 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
4580 if ($name == $fieldName) {
4584 $date = CRM_Utils_Date
::processDate($value);
4586 if (!$appendTimeStamp) {
4587 $date = substr($date, 0, 8);
4590 $format = CRM_Utils_Date
::customFormat($date);
4593 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op '$date'";
4596 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op";
4598 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4599 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$format\"";
4603 $tableName == 'civicrm_log' &&
4604 $fieldTitle == ts('Added Date')
4606 //CRM-6903 --hack to check modified date of first record.
4607 //as added date means first modified date of object.
4608 $addedDateQuery = 'select id from civicrm_log group by entity_id order by id';
4609 $this->_where
[$grouping][] = "civicrm_log.id IN ( {$addedDateQuery} )";
4613 function numberRangeBuilder(&$values,
4614 $tableName, $fieldName,
4615 $dbFieldName, $fieldTitle,
4618 list($name, $op, $value, $grouping, $wildcard) = $values;
4620 if ($name == "{$fieldName}_low" ||
4621 $name == "{$fieldName}_high"
4623 if (isset($this->_rangeCache
[$fieldName])) {
4626 $this->_rangeCache
[$fieldName] = 1;
4628 $secondOP = $secondPhrase = $secondValue = NULL;
4630 if ($name == "{$fieldName}_low") {
4632 $firstPhrase = ts('greater than');
4634 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4635 if (!empty($secondValues)) {
4637 $secondPhrase = ts('less than');
4638 $secondValue = $secondValues[2];
4643 $firstPhrase = ts('less than');
4645 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4646 if (!empty($secondValues)) {
4648 $secondPhrase = ts('greater than');
4649 $secondValue = $secondValues[2];
4654 $this->_where
[$grouping][] = "
4655 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
4656 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
4658 $displayValue = $options ?
$options[$value] : $value;
4659 $secondDisplayValue = $options ?
$options[$secondValue] : $secondValue;
4661 $this->_qill
[$grouping][] =
4662 "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
4665 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
4666 $displayValue = $options ?
$options[$value] : $value;
4667 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
4669 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4674 if ($name == $fieldName) {
4678 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
4680 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4681 $displayValue = $options ?
$options[$value] : $value;
4682 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
4689 * Given the field name, operator, value & its data type
4690 * builds the where Clause for the query
4691 * used for handling 'IS NULL'/'IS NOT NULL' operators
4693 * @param string $field fieldname
4694 * @param string $op operator
4695 * @param string $value value
4696 * @param string $dataType data type of the field
4698 * @return where clause for the query
4701 static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
4703 $clause = "$field $op";
4711 $clause = " ( $field IS NULL OR $field = '' ) ";
4714 case 'IS NOT EMPTY':
4715 $clause = " ( $field IS NOT NULL AND $field <> '' ) ";
4720 if (isset($dataType)) {
4721 if (is_array($value)) {
4725 $value = CRM_Utils_Type
::escape($value, "String");
4726 $values = explode(',', CRM_Utils_Array
::value(0, explode(')', CRM_Utils_Array
::value(1, explode('(', $value)))));
4728 // supporting multiple values in IN clause
4730 foreach ($values as $v) {
4732 $val[] = "'" . CRM_Utils_Type
::escape($v, $dataType) . "'";
4734 $value = "(" . implode($val, ",") . ")";
4736 return "$clause $value";
4739 if (empty($dataType)) {
4740 $dataType = 'String';
4743 $value = CRM_Utils_Type
::escape($value, $dataType);
4745 // if we dont have a dataType we should assume
4746 if ($dataType == 'String') {
4747 $value = "'" . strtolower($value) . "'";
4749 return "$clause $value";
4753 function openedSearchPanes($reset = FALSE) {
4754 if (!$reset ||
empty($this->_whereTables
)) {
4755 return self
::$_openedPanes;
4758 // pane name to table mapper
4759 $panesMapper = array(
4760 ts('Contributions') => 'civicrm_contribution',
4761 ts('Memberships') => 'civicrm_membership',
4762 ts('Events') => 'civicrm_participant',
4763 ts('Relationships') => 'civicrm_relationship',
4764 ts('Activities') => 'civicrm_activity',
4765 ts('Pledges') => 'civicrm_pledge',
4766 ts('Cases') => 'civicrm_case',
4767 ts('Grants') => 'civicrm_grant',
4768 ts('Address Fields') => 'civicrm_address',
4769 ts('Notes') => 'civicrm_note',
4770 ts('Change Log') => 'civicrm_log',
4771 ts('Mailings') => 'civicrm_mailing_event_queue',
4774 foreach (array_keys($this->_whereTables
) as $table) {
4775 if ($panName = array_search($table, $panesMapper)) {
4776 self
::$_openedPanes[$panName] = TRUE;
4780 return self
::$_openedPanes;
4783 function setOperator($operator) {
4784 $validOperators = array('AND', 'OR');
4785 if (!in_array($operator, $validOperators)) {
4788 $this->_operator
= $operator;
4791 function getOperator() {
4792 return $this->_operator
;
4795 function filterRelatedContacts(&$from, &$where, &$having) {
4796 static $_rTypeProcessed = NULL;
4797 static $_rTypeFrom = NULL;
4798 static $_rTypeWhere = NULL;
4800 if (!$_rTypeProcessed) {
4801 $_rTypeProcessed = TRUE;
4803 // create temp table with contact ids
4804 $tableName = CRM_Core_DAO
::createTempTableName('civicrm_transform', TRUE);
4805 $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
4806 CRM_Core_DAO
::executeQuery($sql);
4809 REPLACE INTO $tableName ( contact_id )
4815 CRM_Core_DAO
::executeQuery($sql);
4817 $qillMessage = ts('Contacts with a Relationship Type of: ');
4818 $rTypes = CRM_Core_PseudoConstant
::relationshipType();
4820 if (is_numeric($this->_displayRelationshipType
)) {
4821 $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType
]['label_a_b'];
4823 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
4824 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
4827 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
4828 AND displayRelType.is_active = 1
4832 list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType
);
4833 if ($dirOne == 'a') {
4834 $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
4836 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
4837 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
4841 $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
4843 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
4844 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
4848 WHERE displayRelType.relationship_type_id = $relType
4849 AND displayRelType.is_active = 1
4852 $this->_qill
[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'";
4855 if (strpos($from, $_rTypeFrom) === FALSE) {
4856 // lets replace all the INNER JOIN's in the $from so we dont exclude other data
4857 // this happens when we have an event_type in the quert (CRM-7969)
4858 $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
4859 $from .= $_rTypeFrom;
4860 $where = $_rTypeWhere;
4866 static function caseImportant( $op ) {
4868 in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ?
FALSE : TRUE;
4871 static function componentPresent( &$returnProperties, $prefix ) {
4872 foreach ($returnProperties as $name => $dontCare ) {
4873 if (substr($name, 0, strlen($prefix)) == $prefix) {
4881 * Builds the necessary structures for all fields that are similar to option value lookups
4883 * @param $name string the name of the field
4884 * @param $op string the sql operator, this function should handle ALL SQL operators
4885 * @param $value any string / integer / array depends on the operator and whos calling the query builder
4886 * @param $grouping int the index where to place the where clause
4887 * @param $selectValue array the key value pairs for this element. This allows us to use this function for things besides option-value pairs
4888 * @param $field array an array that contains various properties of the field identified by $name
4889 * @param $label string The label for this field element
4890 * @param $dataType string The data type for this element
4892 * @return void adds the where clause and qill to the query object
4894 function optionValueQuery(
4902 $dataType = 'String'
4905 if (is_numeric($value)) {
4906 $qill = $value = $selectValues[(int ) $value];
4908 elseif ($op == 'IN' ||
$op == 'NOT IN') {
4909 $values = self
::parseSearchBuilderString($value);
4910 if (is_array($values)) {
4911 $newValues = array();
4912 foreach ($values as $v) {
4913 $newValues[] = $selectValues[(int ) $v];
4915 $value = $newValues;
4916 $qill = implode(', ', $value);
4919 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
4920 $this->_where
[$grouping][] = self
::buildClause($wc, $op, $value, $dataType);
4921 $this->_qill
[$grouping][] = $label . " $op '$qill'";
4924 /** function to check and explode a user defined numeric string into an array
4925 * this was the protocol used by search builder in the old old days before we had
4926 * super nice js widgets to do the hard work
4928 * @param string the string to check
4929 * @param string the dataType we should check for the values, default integer
4931 * @return FALSE if string does not match the patter
4932 * array of numeric values if string does match the pattern
4935 static function parseSearchBuilderString($string, $dataType = 'Integer') {
4936 $string = trim($string);
4937 if (substr($string, 0, 1) != '(' ||
substr($string, -1, 1) != ')') {
4941 $string = substr($string, 1, -1);
4942 $values = explode(',', $string);
4943 if (empty($values)) {
4947 $returnValues = array();
4948 foreach ($values as $v) {
4949 if ($dataType == 'Integer' && ! is_numeric($v)) {
4952 else if ($dataType == 'String' && ! is_string($v)) {
4955 $returnValues[] = trim($v);
4958 if (empty($returnValues)) {
4962 return $returnValues;