3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * This class is a heart of search query building mechanism.
39 class CRM_Contact_BAO_Query
{
42 * The various search modes
52 MODE_PLEDGEBANK
= 256,
61 * the default set of return properties
66 static $_defaultReturnProperties = NULL;
69 * the default set of hier return properties
74 static $_defaultHierReturnProperties;
77 * the set of input params
88 * the set of output params
92 public $_returnProperties;
102 * the name of the elements that are in the select clause
103 * used to extract the values
110 * the tables involved in the query
117 * the table involved in the where clause
121 public $_whereTables;
136 public $_whereClause;
139 * additional permission Where Clause
144 public $_permissionWhereClause;
155 * additional permission from clause
160 public $_permissionFromClause;
163 * the from clause for the simple select and alphabetical
168 public $_simpleFromClause;
179 * The english language version of the query
186 * All the fields that could potentially be involved in
194 * The cache to translate the option values into labels
201 * are we in search mode
205 public $_search = TRUE;
208 * should we skip permission checking
212 public $_skipPermission = FALSE;
215 * should we skip adding of delete clause
219 public $_skipDeleteClause = FALSE;
222 * are we in strict mode (use equality over LIKE)
226 public $_strict = FALSE;
229 * What operator to use to group the clauses
233 public $_operator = 'AND';
238 * Should we only search on primary location
242 public $_primaryLocation = TRUE;
245 * are contact ids part of the query
249 public $_includeContactIds = FALSE;
252 * Should we use the smart group cache
256 public $_smartGroupCache = TRUE;
259 * Should we display contacts with a specific relationship type
263 public $_displayRelationshipType = NULL;
266 * reference to the query object for custom values
270 public $_customQuery;
273 * should we enable the distinct clause, used if we are including
274 * more than one group
278 public $_useDistinct = FALSE;
281 * Should we just display one contact record
283 public $_useGroupBy = FALSE;
286 * the relationship type direction
299 static $_activityRole;
302 * Consider the component activity type
303 * during activity search.
308 static $_considerCompActivities;
311 * Consider with contact activities only,
312 * during activity search.
317 static $_withContactActivitiesOnly;
320 * use distinct component clause for component searches
324 public $_distinctComponentClause;
327 * use groupBy component clause for component searches
331 public $_groupByComponentClause;
334 * Track open panes, useful in advance search
339 public static $_openedPanes = array();
342 * The tables which have a dependency on location and/or address
347 static $_dependencies = array(
348 'civicrm_state_province' => 1,
349 'civicrm_country' => 1,
350 'civicrm_county' => 1,
351 'civicrm_address' => 1,
352 'civicrm_location_type' => 1,
356 * List of location specific fields
358 static $_locationSpecificFields = array(
363 'supplemental_address_1',
364 'supplemental_address_2',
367 'postal_code_suffix',
380 * Rememeber if we handle either end of a number or date range
381 * so we can skip the other
383 protected $_rangeCache = array();
385 * Set to true when $this->relationship is run to avoid adding twice
388 protected $_relationshipValuesAdded = FALSE;
391 * Set to the name of the temp table if one has been created
394 static $_relationshipTempTable = NULL;
396 public $_pseudoConstantsSelect = array();
399 * class constructor which also does all the work
401 * @param array $params
402 * @param array $returnProperties
403 * @param array $fields
404 * @param boolean $includeContactIds
405 * @param boolean $strict
406 * @param boolean $mode - mode the search is operating on
411 function __construct(
412 $params = NULL, $returnProperties = NULL, $fields = NULL,
413 $includeContactIds = FALSE, $strict = FALSE, $mode = 1,
414 $skipPermission = FALSE, $searchDescendentGroups = TRUE,
415 $smartGroupCache = TRUE, $displayRelationshipType = NULL,
418 $this->_params
= &$params;
419 if ($this->_params
== NULL) {
420 $this->_params
= array();
423 if (empty($returnProperties)) {
424 $this->_returnProperties
= self
::defaultReturnProperties($mode);
427 $this->_returnProperties
= &$returnProperties;
430 $this->_includeContactIds
= $includeContactIds;
431 $this->_strict
= $strict;
432 $this->_mode
= $mode;
433 $this->_skipPermission
= $skipPermission;
434 $this->_smartGroupCache
= $smartGroupCache;
435 $this->_displayRelationshipType
= $displayRelationshipType;
436 $this->setOperator($operator);
439 $this->_fields
= &$fields;
440 $this->_search
= FALSE;
441 $this->_skipPermission
= TRUE;
444 $this->_fields
= CRM_Contact_BAO_Contact
::exportableFields('All', FALSE, TRUE, TRUE);
446 $fields = CRM_Core_Component
::getQueryFields();
447 unset($fields['note']);
448 $this->_fields
= array_merge($this->_fields
, $fields);
450 // add activity fields
451 $fields = CRM_Activity_BAO_Activity
::exportableFields();
452 $this->_fields
= array_merge($this->_fields
, $fields);
454 // add any fields provided by hook implementers
455 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
456 $this->_fields
= array_merge($this->_fields
, $extFields);
459 // basically do all the work once, and then reuse it
464 * function which actually does all the work for the constructor
469 function initialize() {
470 $this->_select
= array();
471 $this->_element
= array();
472 $this->_tables
= array();
473 $this->_whereTables
= array();
474 $this->_where
= array();
475 $this->_qill
= array();
476 $this->_options
= array();
477 $this->_cfIDs
= array();
478 $this->_paramLookup
= array();
479 $this->_having
= array();
481 $this->_customQuery
= NULL;
483 // reset cached static variables - CRM-5803
484 self
::$_activityRole = NULL;
485 self
::$_considerCompActivities = NULL;
486 self
::$_withContactActivitiesOnly = NULL;
488 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
489 $this->_element
['contact_id'] = 1;
490 $this->_tables
['civicrm_contact'] = 1;
492 if (!empty($this->_params
)) {
493 $this->buildParamsLookup();
496 $this->_whereTables
= $this->_tables
;
498 $this->selectClause();
499 $this->_whereClause
= $this->whereClause();
501 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
502 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
504 $this->openedSearchPanes(TRUE);
507 function buildParamsLookup() {
508 // first fix and handle contact deletion nicely
509 // this code is primarily for search builder use case
510 // where different clauses can specify if they want deleted
513 $trashParamExists = FALSE;
514 $paramByGroup = array();
515 foreach ( $this->_params
as $k => $param ) {
516 if (!empty($param[0]) && $param[0] == 'contact_is_deleted' ) {
517 $trashParamExists = TRUE;
519 if (!empty($param[3])) {
520 $paramByGroup[$param[3]][$k] = $param;
524 if ( $trashParamExists ) {
525 $this->_skipDeleteClause
= TRUE;
527 //cycle through group sets and explicitly add trash param if not set
528 foreach ( $paramByGroup as $setID => $set ) {
530 !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params
) &&
531 !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params
) ) {
532 $this->_params
[] = array(
533 'contact_is_deleted',
543 foreach ($this->_params
as $value) {
544 if (!CRM_Utils_Array
::value(0, $value)) {
547 $cfID = CRM_Core_BAO_CustomField
::getKeyID($value[0]);
549 if (!array_key_exists($cfID, $this->_cfIDs
)) {
550 $this->_cfIDs
[$cfID] = array();
552 $this->_cfIDs
[$cfID][] = $value;
555 if (!array_key_exists($value[0], $this->_paramLookup
)) {
556 $this->_paramLookup
[$value[0]] = array();
558 $this->_paramLookup
[$value[0]][] = $value;
563 * Some composite fields do not appear in the fields array
564 * hack to make them part of the query
569 function addSpecialFields() {
570 static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name');
571 foreach ($special as $name) {
572 if (CRM_Utils_Array
::value($name, $this->_returnProperties
)) {
573 $this->_select
[$name] = "contact_a.{$name} as $name";
574 $this->_element
[$name] = 1;
580 * Given a list of conditions in params and a list of desired
581 * return Properties generate the required select and from
582 * clauses. Note that since the where clause introduces new
583 * tables, the initial attempt also retrieves all variables used
589 function selectClause() {
591 $this->addSpecialFields();
593 foreach ($this->_fields
as $name => $field) {
594 // skip component fields
595 // there are done by the alter query below
596 // and need not be done on every field
598 (substr($name, 0, 12) == 'participant_') ||
599 (substr($name, 0, 7) == 'pledge_') ||
600 (substr($name, 0, 5) == 'case_')
605 // redirect to activity select clause
606 if (substr($name, 0, 9) == 'activity_') {
607 CRM_Activity_BAO_Query
::select($this);
611 // if this is a hierarchical name, we ignore it
612 $names = explode('-', $name);
613 if (count($names > 1) && isset($names[1]) && is_numeric($names[1])) {
617 // make an exception for special cases, to add the field in select clause
618 $makeException = FALSE;
620 //special handling for groups/tags
621 if (in_array($name, array('groups', 'tags', 'notes'))
622 && isset($this->_returnProperties
[substr($name, 0, -1)])
624 $makeException = TRUE;
627 // since note has 3 different options we need special handling
628 // note / note_subject / note_body
629 if ($name == 'notes') {
630 foreach (array('note', 'note_subject', 'note_body') as $noteField) {
631 if (isset($this->_returnProperties
[$noteField])) {
632 $makeException = TRUE;
638 $cfID = CRM_Core_BAO_CustomField
::getKeyID($name);
640 CRM_Utils_Array
::value($name, $this->_paramLookup
) ||
641 CRM_Utils_Array
::value($name, $this->_returnProperties
) ||
645 // add to cfIDs array if not present
646 if (!array_key_exists($cfID, $this->_cfIDs
)) {
647 $this->_cfIDs
[$cfID] = array();
650 elseif (isset($field['where'])) {
651 list($tableName, $fieldName) = explode('.', $field['where'], 2);
652 if (isset($tableName)) {
653 if (CRM_Utils_Array
::value($tableName, self
::$_dependencies)) {
654 $this->_tables
['civicrm_address'] = 1;
655 $this->_select
['address_id'] = 'civicrm_address.id as address_id';
656 $this->_element
['address_id'] = 1;
659 if ($tableName == 'im_provider' ||
$tableName == 'email_greeting' ||
660 $tableName == 'postal_greeting' ||
$tableName == 'addressee'
662 if ($tableName == 'im_provider') {
663 CRM_Core_OptionValue
::select($this);
666 if (in_array($tableName,
667 array('email_greeting', 'postal_greeting', 'addressee'))) {
668 $this->_element
["{$name}_id"] = 1;
669 $this->_select
["{$name}_id"] = "contact_a.{$name}_id as {$name}_id";
670 $this->_pseudoConstantsSelect
[$name] = array('pseudoField' => $tableName, 'idCol' => "{$name}_id");
671 $this->_pseudoConstantsSelect
[$name]['select'] = "{$name}.{$fieldName} as $name";
672 $this->_pseudoConstantsSelect
[$name]['element'] = $name;
674 if ($tableName == 'email_greeting') {
675 $this->_pseudoConstantsSelect
[$name]['join'] =
676 " LEFT JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')";
677 $this->_pseudoConstantsSelect
[$name]['join'] .=
678 " LEFT JOIN civicrm_option_value email_greeting ON (contact_a.email_greeting_id = email_greeting.value AND option_group_email_greeting.id = email_greeting.option_group_id ) ";
680 elseif ($tableName == 'postal_greeting') {
681 $this->_pseudoConstantsSelect
[$name]['join'] =
682 " LEFT JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')";
683 $this->_pseudoConstantsSelect
[$name]['join'] .=
684 " LEFT JOIN civicrm_option_value postal_greeting ON (contact_a.postal_greeting_id = postal_greeting.value AND option_group_postal_greeting.id = postal_greeting.option_group_id ) ";
686 elseif ($tableName == 'addressee') {
687 $this->_pseudoConstantsSelect
[$name]['join'] =
688 " LEFT JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')";
689 $this->_pseudoConstantsSelect
[$name]['join'] .=
690 " LEFT JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) ";
692 $this->_pseudoConstantsSelect
[$name]['table'] = $tableName;
695 $greetField = "{$name}_display";
696 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
697 $this->_element
[$greetField] = 1;
699 $greetField = "{$name}_custom";
700 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
701 $this->_element
[$greetField] = 1;
705 if (!in_array($tableName, array('civicrm_state_province', 'civicrm_country', 'civicrm_county'))) {
706 $this->_tables
[$tableName] = 1;
709 // also get the id of the tableName
710 $tName = substr($tableName, 8);
711 if (in_array($tName, array('country', 'state_province', 'county'))) {
712 $pf = ($tName == 'state_province') ?
'state_province_name' : $name;
713 $this->_pseudoConstantsSelect
[$pf] =
714 array('pseudoField' => "{$tName}_id", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address',
715 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ");
717 if ($tName == 'state_province') {
718 $this->_pseudoConstantsSelect
[$tName] =
719 array('pseudoField' => 'state_province_abbreviation', 'idCol' => "{$tName}_id",
720 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ");
723 $this->_select
["{$tName}_id"] = "civicrm_address.{$tName}_id as {$tName}_id";
724 $this->_element
["{$tName}_id"] = 1;
726 elseif ($tName != 'contact') {
727 $this->_select
["{$tName}_id"] = "{$tableName}.id as {$tName}_id";
728 $this->_element
["{$tName}_id"] = 1;
731 //special case for phone
732 if ($name == 'phone') {
733 $this->_select
['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id";
734 $this->_element
['phone_type_id'] = 1;
737 // if IM then select provider_id also
738 // to get "IM Service Provider" in a file to be exported, CRM-3140
740 $this->_select
['provider_id'] = "civicrm_im.provider_id as provider_id";
741 $this->_element
['provider_id'] = 1;
744 if ($tName == 'contact') {
745 // special case, when current employer is set for Individual contact
746 if ($fieldName == 'organization_name') {
747 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name";
749 elseif ($fieldName != 'id') {
750 if ($fieldName == 'prefix_id') {
751 $this->_pseudoConstantsSelect
['individual_prefix'] = array('pseudoField' => 'prefix_id', 'idCol' => "prefix_id", 'bao' => 'CRM_Contact_BAO_Contact');
753 if ($fieldName == 'suffix_id') {
754 $this->_pseudoConstantsSelect
['individual_suffix'] = array('pseudoField' => 'suffix_id', 'idCol' => "suffix_id", 'bao' => 'CRM_Contact_BAO_Contact');
756 if ($fieldName == 'gender_id') {
757 $this->_pseudoConstantsSelect
['gender'] = array('pseudoField' => 'gender_id', 'idCol' => "gender_id", 'bao' => 'CRM_Contact_BAO_Contact');
759 $this->_select
[$name] = "contact_a.{$fieldName} as `$name`";
762 elseif (in_array($tName, array('state_province', 'country', 'county'))) {
763 $this->_pseudoConstantsSelect
[$pf]['select'] = "{$field['where']} as `$name`";
764 $this->_pseudoConstantsSelect
[$pf]['element'] = $name;
765 if ($tName == 'state_province') {
766 $this->_pseudoConstantsSelect
[$tName]['select'] = "{$field['where']} as `$name`";
767 $this->_pseudoConstantsSelect
[$tName]['element'] = $name;
771 $this->_select
[$name] = "{$field['where']} as `$name`";
773 if (!in_array($tName, array('state_province', 'country', 'county'))) {
774 $this->_element
[$name] = 1;
779 elseif ($name === 'tags') {
780 $this->_useGroupBy
= TRUE;
781 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags";
782 $this->_element
[$name] = 1;
783 $this->_tables
['civicrm_tag'] = 1;
784 $this->_tables
['civicrm_entity_tag'] = 1;
786 elseif ($name === 'groups') {
787 $this->_useGroupBy
= TRUE;
788 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_group.title)) as groups";
789 $this->_element
[$name] = 1;
790 $this->_tables
['civicrm_group'] = 1;
792 elseif ($name === 'notes') {
793 // if note field is subject then return subject else body of the note
794 $noteColumn = 'note';
795 if (isset($noteField) && $noteField == 'note_subject') {
796 $noteColumn = 'subject';
799 $this->_useGroupBy
= TRUE;
800 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.$noteColumn)) as notes";
801 $this->_element
[$name] = 1;
802 $this->_tables
['civicrm_note'] = 1;
804 elseif ($name === 'current_employer') {
805 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer";
806 $this->_element
[$name] = 1;
811 CRM_Utils_Array
::value('is_search_range', $field)
813 // this is a custom field with range search enabled, so we better check for two/from values
814 if (CRM_Utils_Array
::value($name . '_from', $this->_paramLookup
)) {
815 if (!array_key_exists($cfID, $this->_cfIDs
)) {
816 $this->_cfIDs
[$cfID] = array();
818 foreach ($this->_paramLookup
[$name . '_from'] as $pID => $p) {
819 // search in the cdID array for the same grouping
821 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
822 if ($c[3] == $p[3]) {
823 $this->_cfIDs
[$cfID][$cID][2]['from'] = $p[2];
828 $p[2] = array('from' => $p[2]);
829 $this->_cfIDs
[$cfID][] = $p;
833 if (CRM_Utils_Array
::value($name . '_to', $this->_paramLookup
)) {
834 if (!array_key_exists($cfID, $this->_cfIDs
)) {
835 $this->_cfIDs
[$cfID] = array();
837 foreach ($this->_paramLookup
[$name . '_to'] as $pID => $p) {
838 // search in the cdID array for the same grouping
840 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
841 if ($c[4] == $p[4]) {
842 $this->_cfIDs
[$cfID][$cID][2]['to'] = $p[2];
847 $p[2] = array('to' => $p[2]);
848 $this->_cfIDs
[$cfID][] = $p;
855 // add location as hierarchical elements
856 $this->addHierarchicalElements();
858 // add multiple field like website
859 $this->addMultipleElements();
862 CRM_Core_Component
::alterQuery($this, 'select');
864 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'select');
866 if (!empty($this->_cfIDs
)) {
867 $this->_customQuery
= new CRM_Core_BAO_CustomQuery($this->_cfIDs
, TRUE);
868 $this->_customQuery
->query();
869 $this->_select
= array_merge($this->_select
, $this->_customQuery
->_select
);
870 $this->_element
= array_merge($this->_element
, $this->_customQuery
->_element
);
871 $this->_tables
= array_merge($this->_tables
, $this->_customQuery
->_tables
);
872 $this->_whereTables
= array_merge($this->_whereTables
, $this->_customQuery
->_whereTables
);
873 $this->_options
= $this->_customQuery
->_options
;
878 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
884 function addHierarchicalElements() {
885 if (!CRM_Utils_Array
::value('location', $this->_returnProperties
)) {
888 if (!is_array($this->_returnProperties
['location'])) {
892 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
893 $processed = array();
896 $addressCustomFields = CRM_Core_BAO_CustomField
::getFieldsForImport('Address');
897 $addressCustomFieldIds = array();
899 foreach ($this->_returnProperties
['location'] as $name => $elements) {
900 $lCond = self
::getPrimaryCondition($name);
903 $locationTypeId = array_search($name, $locationTypes);
904 if ($locationTypeId === FALSE) {
907 $lCond = "location_type_id = $locationTypeId";
908 $this->_useDistinct
= TRUE;
910 //commented for CRM-3256
911 $this->_useGroupBy
= TRUE;
914 $name = str_replace(' ', '_', $name);
916 $tName = "$name-location_type";
917 $ltName = "`$name-location_type`";
918 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
919 $this->_select
["{$tName}"] = "`$tName`.name as `{$tName}`";
920 $this->_element
["{$tName}_id"] = 1;
921 $this->_element
["{$tName}"] = 1;
923 $locationTypeName = $tName;
924 $locationTypeJoin = array();
928 foreach ($elements as $elementFullName => $dontCare) {
930 $elementName = $elementCmpName = $elementFullName;
932 if (substr($elementCmpName, 0, 5) == 'phone') {
933 $elementCmpName = 'phone';
936 if (in_array($elementCmpName, array_keys($addressCustomFields))) {
937 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($elementCmpName)) {
938 $addressCustomFieldIds[$cfID][$name] = 1;
941 //add address table only once
942 if ((in_array($elementCmpName, self
::$_locationSpecificFields) ||
!empty($addressCustomFieldIds))
944 && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid'))
946 $tName = "$name-address";
947 $aName = "`$name-address`";
948 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
949 $this->_element
["{$tName}_id"] = 1;
950 $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)";
951 $this->_tables
[$tName] = $addressJoin;
952 $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) ";
953 $processed[$aName] = 1;
957 $cond = $elementType = '';
958 if (strpos($elementName, '-') !== FALSE) {
959 // this is either phone, email or IM
960 list($elementName, $elementType) = explode('-', $elementName);
963 if (($elementName != 'phone') && ($elementName != 'im')) {
964 $cond = self
::getPrimaryCondition($elementType);
966 // CRM-13011 : If location type is primary, do not restrict search to the phone
967 // type id - we want the primary phone, regardless of what type it is.
968 // Otherwise, restrict to the specified phone type for the given field.
969 if ((!$cond) && ($elementName == 'phone') && $elements['location_type'] != 'Primary') {
970 $cond = "phone_type_id = '$elementType'";
972 elseif ((!$cond) && ($elementName == 'im')) {
973 // IM service provider id, CRM-3140
974 $cond = "provider_id = '$elementType'";
976 $elementType = '-' . $elementType;
979 $field = CRM_Utils_Array
::value($elementName, $this->_fields
);
981 // hack for profile, add location id
984 // fix for CRM-882( to handle phone types )
985 !is_numeric($elementType)
987 if (is_numeric($name)) {
988 $field = CRM_Utils_Array
::value($elementName . "-Primary$elementType", $this->_fields
);
991 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
994 elseif (is_numeric($name)) {
995 //this for phone type to work
996 if (in_array($elementName, array('phone', 'phone_ext'))) {
997 $field = CRM_Utils_Array
::value($elementName . "-Primary" . $elementType, $this->_fields
);
1000 $field = CRM_Utils_Array
::value($elementName . "-Primary", $this->_fields
);
1004 //this is for phone type to work for profile edit
1005 if (in_array($elementName, array('phone', 'phone_ext'))) {
1006 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
1009 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId", $this->_fields
);
1014 // Check if there is a value, if so also add to where Clause
1016 if ($this->_params
) {
1018 if (isset($locationTypeId)) {
1019 $nm .= "-$locationTypeId";
1021 if (!is_numeric($elementType)) {
1022 $nm .= "$elementType";
1025 foreach ($this->_params
as $id => $values) {
1026 if ($values[0] == $nm ||
1027 (in_array($elementName, array('phone', 'im'))
1028 && (strpos($values[0], $nm) !== FALSE)
1038 if ($field && isset($field['where'])) {
1039 list($tableName, $fieldName) = explode('.', $field['where'], 2);
1040 $pf = substr($tableName, 8);
1041 $tName = $name . '-' . $pf . $elementType;
1042 if (isset($tableName)) {
1043 if ($tableName == 'civicrm_state_province' ||
$tableName == 'civicrm_country' ||
$tableName == 'civicrm_county') {
1044 $this->_select
["{$tName}_id"] = "{$aName}.{$pf}_id as `{$tName}_id`";
1047 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1050 $this->_element
["{$tName}_id"] = 1;
1051 if (substr($tName, -15) == '-state_province') {
1052 // FIXME: hack to fix CRM-1900
1053 $a = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1057 if (substr_count($a, 'state_province_name') > 0) {
1058 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] =
1059 array('pseudoField' => '{$pf}_id', 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address');
1060 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.name as `{$name}-{$elementFullName}`";
1063 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] =
1064 array('pseudoField' => 'state_province_abbreviation', 'idCol' => "{$tName}_id");
1065 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`";
1069 if (substr($elementFullName, 0, 2) == 'im') {
1070 $provider = "{$name}-{$elementFullName}-provider_id";
1071 $this->_select
[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`";
1072 $this->_element
[$provider] = 1;
1074 if ($pf == 'country' ||
$pf == 'county') {
1075 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] = array('pseudoField' => "{$pf}_id", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address');
1076 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1079 $this->_select
["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1083 if (in_array($pf, array('state_province', 'country', 'county'))) {
1084 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['element'] = "{$name}-{$elementFullName}";
1087 $this->_element
["{$name}-{$elementFullName}"] = 1;
1090 if (!CRM_Utils_Array
::value("`$tName`", $processed)) {
1091 $processed["`$tName`"] = 1;
1092 $newName = $tableName . '_' . $index;
1093 switch ($tableName) {
1094 case 'civicrm_phone':
1095 case 'civicrm_email':
1097 case 'civicrm_openid':
1099 $this->_tables
[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id AND `$tName`.$lCond";
1100 // this special case to add phone type
1102 $phoneTypeCondition = " AND `$tName`.$cond ";
1103 //gross hack to pickup corrupted data also, CRM-7603
1104 if (strpos($cond, 'phone_type_id') !== FALSE) {
1105 $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) ";
1107 $this->_tables
[$tName] .= $phoneTypeCondition;
1110 //build locationType join
1111 $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )";
1114 $this->_whereTables
[$tName] = $this->_tables
[$tName];
1118 case 'civicrm_state_province':
1119 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $tName;
1120 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join'] =
1121 "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id";
1123 $this->_whereTables
["{$name}-address"] = $addressJoin;
1127 case 'civicrm_country':
1128 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1129 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join'] =
1130 "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id";
1132 $this->_whereTables
["{$name}-address"] = $addressJoin;
1136 case 'civicrm_county':
1137 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1138 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join'] =
1139 "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id";
1141 $this->_whereTables
["{$name}-address"] = $addressJoin;
1147 $this->_whereTables
["{$name}-address"] = $addressJoin;
1156 // add location type join
1157 $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )";
1158 $this->_tables
[$locationTypeName] = $ltypeJoin;
1160 // table should be present in $this->_whereTables,
1161 // to add its condition in location type join, CRM-3939.
1162 if ($addWhereCount) {
1163 $locClause = array();
1164 foreach ($this->_whereTables
as $tableName => $clause) {
1165 if (CRM_Utils_Array
::value($tableName, $locationTypeJoin)) {
1166 $locClause[] = $locationTypeJoin[$tableName];
1170 if (!empty($locClause)) {
1171 $this->_whereTables
[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )";
1176 if (!empty($addressCustomFieldIds)) {
1177 $cfIDs = $addressCustomFieldIds;
1178 $customQuery = new CRM_Core_BAO_CustomQuery($cfIDs);
1179 foreach ($addressCustomFieldIds as $cfID => $locTypeName) {
1180 foreach ($locTypeName as $name => $dnc) {
1181 $fieldName = "$name-custom_{$cfID}";
1182 $tName = "$name-address-custom-{$cfID}";
1183 $aName = "`$name-address-custom-{$cfID}`";
1184 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1185 $this->_element
["{$tName}_id"] = 1;
1186 $this->_select
[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`";
1187 $this->_element
[$fieldName] = 1;
1188 $this->_tables
[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)";
1195 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
1201 function addMultipleElements() {
1202 if (!CRM_Utils_Array
::value('website', $this->_returnProperties
)) {
1205 if (!is_array($this->_returnProperties
['website'])) {
1209 foreach ($this->_returnProperties
['website'] as $key => $elements) {
1210 foreach ($elements as $elementFullName => $dontCare) {
1211 $tName = "website-{$key}-{$elementFullName}";
1212 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1213 $this->_select
["{$tName}"] = "`$tName`.url as `{$tName}`";
1214 $this->_element
["{$tName}_id"] = 1;
1215 $this->_element
["{$tName}"] = 1;
1217 $type = "website-{$key}-website_type_id";
1218 $this->_select
[$type] = "`$tName`.website_type_id as `{$type}`";
1219 $this->_element
[$type] = 1;
1220 $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id )";
1226 * generate the query based on what type of query we need
1228 * @param boolean $count
1229 * @param boolean $sortByChar
1230 * @param boolean $groupContacts
1232 * @return the sql string for that query (this will most likely
1236 function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE) {
1238 if (isset($this->_distinctComponentClause
)) {
1239 // we add distinct to get the right count for components
1240 // for the more complex result set, we use GROUP BY the same id
1242 $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} )";
1245 $select = 'SELECT count(DISTINCT contact_a.id) as rowCount';
1247 $from = $this->_simpleFromClause
;
1248 if ($this->_useDistinct
) {
1249 $this->_useGroupBy
= TRUE;
1252 elseif ($sortByChar) {
1253 $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name';
1254 $from = $this->_simpleFromClause
;
1256 elseif ($groupContacts) {
1257 $select = 'SELECT contact_a.id as id';
1258 if ($this->_useDistinct
) {
1259 $this->_useGroupBy
= TRUE;
1261 $from = $this->_simpleFromClause
;
1264 if (CRM_Utils_Array
::value('group', $this->_paramLookup
)) {
1265 // make sure there is only one element
1266 // this is used when we are running under smog and need to know
1267 // how the contact was added (CRM-1203)
1268 if ((count($this->_paramLookup
['group']) == 1) &&
1269 (count($this->_paramLookup
['group'][0][2]) == 1)
1271 $groups = array_keys($this->_paramLookup
['group'][0][2]);
1272 $groupId = $groups[0];
1274 //check if group is saved search
1275 $group = new CRM_Contact_BAO_Group();
1276 $group->id
= $groupId;
1279 if (!isset($group->saved_search_id
)) {
1280 $tbName = "`civicrm_group_contact-{$groupId}`";
1281 $this->_select
['group_contact_id'] = "$tbName.id as group_contact_id";
1282 $this->_element
['group_contact_id'] = 1;
1283 $this->_select
['status'] = "$tbName.status as status";
1284 $this->_element
['status'] = 1;
1287 $this->_useGroupBy
= TRUE;
1289 if ($this->_useDistinct
&& !isset($this->_distinctComponentClause
)) {
1290 if (!($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
)) {
1292 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
1293 $this->_useDistinct
= FALSE;
1294 $this->_useGroupBy
= TRUE;
1298 $select = "SELECT ";
1299 if (isset($this->_distinctComponentClause
)) {
1300 $select .= "{$this->_distinctComponentClause}, ";
1302 $select .= implode(', ', $this->_select
);
1303 $from = $this->_fromClause
;
1307 if (!empty($this->_whereClause
)) {
1308 $where = "WHERE {$this->_whereClause}";
1312 if (!empty($this->_having
)) {
1313 foreach ($this->_having
as $havingsets) {
1314 foreach ($havingsets as $havingset) {
1315 $havingvalue[] = $havingset;
1318 $having = ' HAVING ' . implode(' AND ', $havingvalue);
1321 // if we are doing a transform, do it here
1322 // use the $from, $where and $having to get the contact ID
1323 if ($this->_displayRelationshipType
) {
1324 $this->filterRelatedContacts($from, $where, $having);
1327 return array($select, $from, $where, $having);
1330 function &getWhereValues($name, $grouping) {
1332 foreach ($this->_params
as $values) {
1333 if ($values[0] == $name && $values[3] == $grouping) {
1341 static function fixDateValues($relative, &$from, &$to) {
1343 list($from, $to) = CRM_Utils_Date
::getFromTo($relative, $from, $to);
1347 static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE) {
1349 if (empty($formValues)) {
1353 foreach ($formValues as $id => $values) {
1354 if ($id == 'privacy') {
1355 if (is_array($formValues['privacy'])) {
1356 $op = CRM_Utils_Array
::value('do_not_toggle', $formValues['privacy']) ?
'=' : '!=';
1357 foreach ($formValues['privacy'] as $key => $value) {
1359 $params[] = array($key, $op, $value, 0, 0);
1364 elseif ($id == 'email_on_hold') {
1365 if ($formValues['email_on_hold']['on_hold']) {
1366 $params[] = array('on_hold', '=', $formValues['email_on_hold']['on_hold'], 0, 0);
1369 elseif (preg_match('/_date_relative$/', $id) ||
1370 $id == 'event_relative' ||
1371 $id == 'case_from_relative' ||
1372 $id == 'case_to_relative'
1374 if ($id == 'event_relative') {
1375 $fromRange = 'event_start_date_low';
1376 $toRange = 'event_end_date_high';
1378 else if ($id == 'case_from_relative') {
1379 $fromRange = 'case_from_start_date_low';
1380 $toRange = 'case_from_start_date_high';
1382 else if ($id == 'case_to_relative') {
1383 $fromRange = 'case_to_end_date_low';
1384 $toRange = 'case_to_end_date_high';
1387 $dateComponent = explode('_date_relative', $id);
1388 $fromRange = "{$dateComponent[0]}_date_low";
1389 $toRange = "{$dateComponent[0]}_date_high";
1392 if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) {
1393 CRM_Contact_BAO_Query
::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]);
1398 $values = CRM_Contact_BAO_Query
::fixWhereValues($id, $values, $wildcard, $useEquals);
1403 $params[] = $values;
1409 static function &fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE) {
1410 // skip a few search variables
1411 static $skipWhere = NULL;
1412 static $arrayValues = NULL;
1413 static $likeNames = NULL;
1416 if (CRM_Utils_System
::isNull($values)) {
1422 'task', 'radio_ts', 'uf_group_id',
1423 'component_mode', 'qfKey', 'operator',
1424 'display_relationship_type',
1428 if (in_array($id, $skipWhere) ||
1429 substr($id, 0, 4) == '_qf_' ||
1430 substr($id, 0, 7) == 'hidden_'
1436 $likeNames = array('sort_name', 'email', 'note', 'display_name');
1439 // email comes in via advanced search
1440 // so use wildcard always
1441 if ($id == 'email') {
1445 if (!$useEquals && in_array($id, $likeNames)) {
1446 $result = array($id, 'LIKE', $values, 0, 1);
1448 elseif (is_string($values) && strpos($values, '%') !== FALSE) {
1449 $result = array($id, 'LIKE', $values, 0, 0);
1451 elseif ($id == 'group') {
1452 if (is_array($values)) {
1453 foreach ($values as $groupIds => $val) {
1455 if (preg_match('/-(\d+)$/', $groupIds, $matches)) {
1456 if (strlen($matches[1]) > 0) {
1457 $values[$matches[1]] = 1;
1458 unset($values[$groupIds]);
1464 $groupIds = explode(',', $values);
1466 foreach ($groupIds as $groupId) {
1467 $values[$groupId] = 1;
1471 $result = array($id, 'IN', $values, 0, 0);
1473 elseif ($id == 'contact_tags' ||
$id == 'tag') {
1474 if (!is_array($values)) {
1475 $tagIds = explode(',', $values);
1477 foreach ($tagIds as $tagId) {
1478 $values[$tagId] = 1;
1481 $result = array($id, 'IN', $values, 0, 0);
1484 $result = array($id, '=', $values, 0, $wildcard);
1490 function whereClauseSingle(&$values) {
1491 // do not process custom fields or prefixed contact ids or component params
1492 if (CRM_Core_BAO_CustomField
::getKeyID($values[0]) ||
1493 (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) ||
1494 (substr($values[0], 0, 13) == 'contribution_') ||
1495 (substr($values[0], 0, 6) == 'event_') ||
1496 (substr($values[0], 0, 12) == 'participant_') ||
1497 (substr($values[0], 0, 7) == 'member_') ||
1498 (substr($values[0], 0, 6) == 'grant_') ||
1499 (substr($values[0], 0, 7) == 'pledge_') ||
1500 (substr($values[0], 0, 5) == 'case_') ||
1501 (substr($values[0], 0, 10) == 'financial_') ||
1502 (substr($values[0], 0, 11) == 'membership_')
1507 // skip for hook injected fields / params
1508 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
1509 if (array_key_exists($values[0], $extFields)) {
1513 switch ($values[0]) {
1514 case 'deleted_contacts':
1515 $this->deletedContacts($values);
1518 case 'contact_type':
1519 $this->contactType($values);
1522 case 'contact_sub_type':
1523 $this->contactSubType($values);
1527 $this->group($values);
1530 // so we resolve this into a list of groups & proceed as if they had been
1532 list($name, $op, $value, $grouping, $wildcard) = $values;
1533 $values[0] = 'group';
1535 $this->_paramLookup
['group'][0][0] ='group';
1536 $this->_paramLookup
['group'][0][1] = 'IN';
1537 $this->_paramLookup
['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value);
1538 $this->group($values);
1540 // case tag comes from find contacts
1543 $this->tagSearch($values);
1547 case 'contact_tags':
1548 $this->tag($values);
1553 case 'note_subject':
1554 $this->notes($values);
1558 $this->ufUser($values);
1562 case 'display_name':
1563 $this->sortName($values);
1567 $this->email($values);
1570 case 'phone_numeric':
1571 $this->phone_numeric($values);
1574 case 'phone_phone_type_id':
1575 case 'phone_location_type_id':
1576 $this->phone_option_group($values);
1579 case 'street_address':
1580 $this->street_address($values);
1583 case 'street_number':
1584 $this->street_number($values);
1587 case 'sortByCharacter':
1588 $this->sortByCharacter($values);
1591 case 'location_type':
1592 $this->locationType($values);
1596 $this->county($values);
1599 case 'state_province':
1600 $this->stateProvince($values);
1604 $this->country($values, FALSE);
1608 case 'postal_code_low':
1609 case 'postal_code_high':
1610 $this->postalCode($values);
1613 case 'activity_date':
1614 case 'activity_date_low':
1615 case 'activity_date_high':
1616 case 'activity_role':
1617 case 'activity_status':
1618 case 'activity_subject':
1619 case 'test_activities':
1620 case 'activity_type_id':
1621 case 'activity_survey_id':
1622 case 'activity_tags':
1623 case 'activity_taglist':
1624 case 'activity_test':
1625 case 'activity_campaign_id':
1626 case 'activity_engagement_level':
1628 case 'source_contact':
1629 CRM_Activity_BAO_Query
::whereClauseSingle($values, $this);
1632 case 'birth_date_low':
1633 case 'birth_date_high':
1634 case 'deceased_date_low':
1635 case 'deceased_date_high':
1636 $this->demographics($values);
1639 case 'log_date_low':
1640 case 'log_date_high':
1641 $this->modifiedDates($values);
1645 $this->changeLog($values);
1648 case 'do_not_phone':
1649 case 'do_not_email':
1652 case 'do_not_trade':
1654 $this->privacy($values);
1657 case 'privacy_options':
1658 $this->privacyOptions($values);
1661 case 'privacy_operator':
1662 case 'privacy_toggle':
1663 // these are handled by privacy options
1666 case 'preferred_communication_method':
1667 $this->preferredCommunication($values);
1670 case 'relation_type_id':
1671 case 'relation_start_date_high':
1672 case 'relation_start_date_low':
1673 case 'relation_end_date_high':
1674 case 'relation_end_date_low':
1675 case 'relation_target_name':
1676 case 'relation_status':
1677 case 'relation_date_low':
1678 case 'relation_date_high':
1679 $this->relationship($values);
1680 $this->_relationshipValuesAdded
= TRUE;
1683 case 'task_status_id':
1684 $this->task($values);
1688 // since this case is handled with the above
1691 case 'prox_distance':
1692 CRM_Contact_BAO_ProximityQuery
::process($this, $values);
1695 case 'prox_street_address':
1697 case 'prox_postal_code':
1698 case 'prox_state_province_id':
1699 case 'prox_country_id':
1700 // handled by the proximity_distance clause
1704 $this->restWhere($values);
1710 * Given a list of conditions in params generate the required
1716 function whereClause() {
1717 $this->_where
[0] = array();
1718 $this->_qill
[0] = array();
1720 $this->includeContactIds();
1721 if (!empty($this->_params
)) {
1722 foreach (array_keys($this->_params
) as $id) {
1723 if (!CRM_Utils_Array
::value(0, $this->_params
[$id])) {
1726 // check for both id and contact_id
1727 if ($this->_params
[$id][0] == 'id' ||
$this->_params
[$id][0] == 'contact_id') {
1729 $this->_params
[$id][1] == 'IS NULL' ||
1730 $this->_params
[$id][1] == 'IS NOT NULL'
1732 $this->_where
[0][] = "contact_a.id {$this->_params[$id][1]}";
1734 elseif (is_array($this->_params
[$id][2])) {
1735 $idList = implode("','", $this->_params
[$id][2]);
1736 //why on earth do they put ' in the middle & not on the outside? We have to assume it's
1737 //to support 'something' so lets add them conditionally to support the api (which is a tested flow
1738 // so if you are looking to alter this check api test results
1739 if(strpos(trim($idList), "'") > 0) {
1740 $idList = "'" . $idList . "'";
1743 $this->_where
[0][] = "contact_a.id IN ({$idList})";
1746 $this->_where
[0][] = "contact_a.id {$this->_params[$id][1]} {$this->_params[$id][2]}";
1750 $this->whereClauseSingle($this->_params
[$id]);
1754 CRM_Core_Component
::alterQuery($this, 'where');
1756 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'where');
1759 if ($this->_customQuery
) {
1760 // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info.
1761 // Hope it wont affect the other part of civicrm.. if it does please remove it.
1762 if (!empty($this->_customQuery
->_where
)) {
1763 $this->_where
= CRM_Utils_Array
::crmArrayMerge($this->_where
, $this->_customQuery
->_where
);
1766 $this->_qill
= CRM_Utils_Array
::crmArrayMerge($this->_qill
, $this->_customQuery
->_qill
);
1770 $andClauses = array();
1773 if (!empty($this->_where
)) {
1774 foreach ($this->_where
as $grouping => $values) {
1775 if ($grouping > 0 && !empty($values)) {
1776 $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
1781 if (!empty($this->_where
[0])) {
1782 $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where
[0]) . ' ) ';
1784 if (!empty($clauses)) {
1785 $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
1788 if ($validClauses > 1) {
1789 $this->_useDistinct
= TRUE;
1793 return implode(' AND ', $andClauses);
1796 function restWhere(&$values) {
1797 $name = CRM_Utils_Array
::value(0, $values);
1798 $op = CRM_Utils_Array
::value(1, $values);
1799 $value = CRM_Utils_Array
::value(2, $values);
1800 $grouping = CRM_Utils_Array
::value(3, $values);
1801 $wildcard = CRM_Utils_Array
::value(4, $values);
1803 if (isset($grouping) && !CRM_Utils_Array
::value($grouping, $this->_where
)) {
1804 $this->_where
[$grouping] = array();
1807 $multipleFields = array('url');
1809 //check if the location type exits for fields
1811 $locType = explode('-', $name);
1813 if (!in_array($locType[0], $multipleFields)) {
1814 //add phone type if exists
1815 if (isset($locType[2]) && $locType[2]) {
1816 $locType[2] = CRM_Core_DAO
::escapeString($locType[2]);
1820 $field = CRM_Utils_Array
::value($name, $this->_fields
);
1823 $field = CRM_Utils_Array
::value($locType[0], $this->_fields
);
1832 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
1833 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1835 if (substr($name, 0, 14) === 'state_province') {
1837 if (isset($locType[1]) && is_numeric($locType[1])) {
1838 $aName = "{$locationType[$locType[1]]}-address";
1839 $where = "`$aName`.state_province_id";
1842 $where = "civicrm_address.state_province_id";
1845 $states = CRM_Core_PseudoConstant
::stateProvince();
1846 if (is_numeric($value)) {
1847 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1848 $value = $states[(int ) $value];
1851 $intVal = CRM_Utils_Array
::key($value, $states);
1852 $this->_where
[$grouping][] = self
::buildClause($where, $op, $intVal, 'Positive');
1855 $this->_qill
[$grouping][] = ts('State') . " $op '$value'";
1858 $this->_qill
[$grouping][] = ts('State') . " ($lType) $op '$value'";
1861 elseif (!empty($field['pseudoconstant'])) {
1862 $this->optionValueQuery(
1863 $name, $op, $value, $grouping,
1864 CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', $field['name']),
1870 if ($name == 'gender_id') {
1871 self
::$_openedPanes[ts('Demographics')] = TRUE;
1874 elseif (substr($name, 0, 7) === 'country') {
1876 if (isset($locType[1]) && is_numeric($locType[1])) {
1877 $aName = "{$locationType[$locType[1]]}-address";
1878 $where = "`$aName`.country_id";
1881 $where = "civicrm_address.country_id";
1884 $countries = CRM_Core_PseudoConstant
::country();
1885 if (is_numeric($value)) {
1886 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1887 $value = $countries[(int ) $value];
1890 $intVal = CRM_Utils_Array
::key($value, $countries);
1891 $this->_where
[$grouping][] = self
::buildClause($where, $op, $intVal, 'Positive');
1894 $this->_qill
[$grouping][] = ts('Country') . " $op '$value'";
1897 $this->_qill
[$grouping][] = ts('Country') . " ($lType) $op '$value'";
1900 elseif (substr($name, 0, 6) === 'county') {
1902 if (isset($locType[1]) && is_numeric($locType[1])) {
1903 $aName = "{$locationType[$locType[1]]}-address";
1904 $where = "`$aName`.county_id";
1907 $where = "civicrm_address.county_id";
1910 $counties = CRM_Core_PseudoConstant
::county();
1911 if (is_numeric($value)) {
1912 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1913 $value = $counties[(int ) $value];
1916 $intVal = CRM_Utils_Array
::key($value, $counties);
1917 $this->_where
[$grouping][] = self
::buildClause($where, $op, $intVal, 'Positive');
1921 $this->_qill
[$grouping][] = ts('County') . " $op '$value'";
1924 $this->_qill
[$grouping][] = ts('County') . " ($lType) $op '$value'";
1927 elseif ($name === 'world_region') {
1928 $this->optionValueQuery(
1929 $name, $op, $value, $grouping,
1930 CRM_Core_PseudoConstant
::worldRegion(),
1935 elseif ($name === 'birth_date') {
1936 $date = CRM_Utils_Date
::processDate($value);
1937 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $date);
1940 $date = CRM_Utils_Date
::customFormat($date);
1941 $this->_qill
[$grouping][] = "$field[title] $op \"$date\"";
1944 $this->_qill
[$grouping][] = "$field[title] $op";
1946 self
::$_openedPanes[ts('Demographics')] = TRUE;
1948 elseif ($name === 'deceased_date') {
1949 $date = CRM_Utils_Date
::processDate($value);
1950 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $date);
1952 $date = CRM_Utils_Date
::customFormat($date);
1953 $this->_qill
[$grouping][] = "$field[title] $op \"$date\"";
1956 $this->_qill
[$grouping][] = "$field[title] $op";
1958 self
::$_openedPanes[ts('Demographics')] = TRUE;
1960 elseif ($name === 'is_deceased') {
1961 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $value);
1962 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1963 self
::$_openedPanes[ts('Demographics')] = TRUE;
1965 elseif ($name === 'contact_id') {
1966 if (is_int($value)) {
1967 $this->_where
[$grouping][] = self
::buildClause($field['where'], $op, $value);
1968 $this->_qill
[$grouping][] = "$field[title] $op $value";
1971 elseif ($name === 'name') {
1972 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
1974 $value = "%$value%";
1977 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
1978 $this->_where
[$grouping][] = self
::buildClause($wc, $op, "'$value'");
1979 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1981 elseif ($name === 'current_employer') {
1982 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
1984 $value = "%$value%";
1987 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.organization_name)" : "contact_a.organization_name";
1988 $this->_where
[$grouping][] = self
::buildClause($wc, $op,
1989 "'$value' AND contact_a.contact_type ='Individual'"
1991 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1993 elseif ($name === 'email_greeting') {
1994 $filterCondition = array('greeting_type' => 'email_greeting');
1995 $this->optionValueQuery(
1996 $name, $op, $value, $grouping,
1997 CRM_Core_PseudoConstant
::greeting($filterCondition),
1999 ts('Email Greeting')
2002 elseif ($name === 'postal_greeting') {
2003 $filterCondition = array('greeting_type' => 'postal_greeting');
2004 $this->optionValueQuery(
2005 $name, $op, $value, $grouping,
2006 CRM_Core_PseudoConstant
::greeting($filterCondition),
2008 ts('Postal Greeting')
2011 elseif ($name === 'addressee') {
2012 $filterCondition = array('greeting_type' => 'addressee');
2013 $this->optionValueQuery(
2014 $name, $op, $value, $grouping,
2015 CRM_Core_PseudoConstant
::greeting($filterCondition),
2020 elseif (substr($name, 0, 4) === 'url-') {
2021 $tName = 'civicrm_website';
2022 $this->_whereTables
[$tName] = $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2023 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
2025 $value = "%$value%";
2029 $wc = 'civicrm_website.url';
2030 $this->_where
[$grouping][] = self
::buildClause($wc, $op, "'$value'");
2031 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2033 elseif ($name === 'contact_is_deleted') {
2034 $this->_where
[$grouping][] = self
::buildClause("contact_a.is_deleted", $op, $value);
2035 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2038 // sometime the value is an array, need to investigate and fix
2039 if (is_array($value)) {
2040 CRM_Core_Error
::fatal();
2043 if (!empty($field['where'])) {
2045 $value = $strtolower($value);
2048 $value = "%$value%";
2052 if (isset($locType[1]) &&
2053 is_numeric($locType[1])
2057 //get the location name
2058 list($tName, $fldName) = self
::getLocationTableName($field['where'], $locType);
2060 $where = "`$tName`.$fldName";
2062 $this->_where
[$grouping][] = self
::buildClause("LOWER($where)", $op, $value);
2063 $this->_whereTables
[$tName] = $this->_tables
[$tName];
2064 $this->_qill
[$grouping][] = "$field[title] $op '$value'";
2067 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2068 if ($tableName == 'civicrm_contact') {
2069 $fieldName = "LOWER(contact_a.{$fieldName})";
2072 if ($op != 'IN' && !is_numeric($value)) {
2073 $fieldName = "LOWER({$field['where']})";
2076 $fieldName = "{$field['where']}";
2081 if (CRM_Utils_Array
::value('type', $field)) {
2082 $type = CRM_Utils_Type
::typeToString($field['type']);
2085 $this->_where
[$grouping][] = self
::buildClause($fieldName, $op, $value, $type);
2086 $this->_qill
[$grouping][] = "$field[title] $op $value";
2091 if ($setTables && isset($field['where'])) {
2092 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2093 if (isset($tableName)) {
2094 $this->_tables
[$tableName] = 1;
2095 $this->_whereTables
[$tableName] = 1;
2101 static function getLocationTableName(&$where, &$locType) {
2102 if (isset($locType[1]) && is_numeric($locType[1])) {
2103 list($tbName, $fldName) = explode(".", $where);
2105 //get the location name
2106 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
2107 $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2108 if (in_array($locType[0], $specialFields)) {
2109 //hack to fix / special handing for phone_ext
2110 if ($locType[0] == 'phone_ext') {
2111 $locType[0] = 'phone';
2113 if (isset($locType[2]) && $locType[2]) {
2114 $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2117 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2120 elseif (in_array($locType[0],
2122 'address_name', 'street_address', 'supplemental_address_1', 'supplemental_address_2',
2123 'city', 'postal_code', 'postal_code_suffix', 'geo_code_1', 'geo_code_2',
2126 //fix for search by profile with address fields.
2127 $tName = "{$locationType[$locType[1]]}-address";
2129 elseif ($locType[0] == 'on_hold') {
2130 $tName = "{$locationType[$locType[1]]}-email";
2133 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2135 $tName = str_replace(' ', '_', $tName);
2136 return array($tName, $fldName);
2138 CRM_Core_Error
::fatal();
2142 * Given a result dao, extract the values and return that array
2144 * @param Object $dao
2146 * @return array values for this query
2148 function store($dao) {
2151 foreach ($this->_element
as $key => $dontCare) {
2152 if (property_exists($dao, $key)) {
2153 if (strpos($key, '-') !== FALSE) {
2154 $values = explode('-', $key);
2155 $lastElement = array_pop($values);
2157 $cnt = count($values);
2159 foreach ($values as $v) {
2160 if (!array_key_exists($v, $current)) {
2161 $current[$v] = array();
2163 //bad hack for im_provider
2164 if ($lastElement == 'provider_id') {
2165 if ($count < $cnt) {
2166 $current = &$current[$v];
2169 $lastElement = "{$v}_{$lastElement}";
2173 $current = &$current[$v];
2178 $current[$lastElement] = $dao->$key;
2181 $value[$key] = $dao->$key;
2189 * getter for tables array
2195 return $this->_tables
;
2198 function whereTables() {
2199 return $this->_whereTables
;
2203 * generate the where clause (used in match contacts and permissions)
2205 * @param array $params
2206 * @param array $fields
2207 * @param array $tables
2208 * @param boolean $strict
2214 static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2215 $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2219 $tables = array_merge($query->tables(), $tables);
2220 $whereTables = array_merge($query->whereTables(), $whereTables);
2222 return $query->_whereClause
;
2226 * create the from clause
2228 * @param array $tables tables that need to be included in this from clause
2229 * if null, return mimimal from clause (i.e. civicrm_contact)
2230 * @param array $inner tables that should be inner-joined
2231 * @param array $right tables that should be right-joined
2233 * @return string the from clause
2237 static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
2239 $from = ' FROM civicrm_contact contact_a';
2240 if (empty($tables)) {
2244 if (CRM_Utils_Array
::value('civicrm_worldregion', $tables)) {
2245 $tables = array_merge(array('civicrm_country' => 1), $tables);
2248 if ((CRM_Utils_Array
::value('civicrm_state_province', $tables) ||
2249 CRM_Utils_Array
::value('civicrm_country', $tables) ||
2250 CRM_Utils_Array
::value('civicrm_county', $tables)
2252 !CRM_Utils_Array
::value('civicrm_address', $tables)
2254 $tables = array_merge(array('civicrm_address' => 1),
2259 // add group_contact table if group table is present
2260 if (CRM_Utils_Array
::value('civicrm_group', $tables) &&
2261 !CRM_Utils_Array
::value('civicrm_group_contact', $tables)
2263 $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added'";
2266 // add group_contact and group table is subscription history is present
2267 if (CRM_Utils_Array
::value('civicrm_subscription_history', $tables)
2268 && !CRM_Utils_Array
::value('civicrm_group', $tables)
2270 $tables = array_merge(array(
2271 'civicrm_group' => 1,
2272 'civicrm_group_contact' => 1,
2278 // to handle table dependencies of components
2279 CRM_Core_Component
::tableNames($tables);
2280 // to handle table dependencies of hook injected tables
2281 CRM_Contact_BAO_Query_Hook
::singleton()->setTableDependency($tables);
2283 //format the table list according to the weight
2284 $info = CRM_Core_TableHierarchy
::info();
2286 foreach ($tables as $key => $value) {
2288 if (strpos($key, '-') !== FALSE) {
2289 $keyArray = explode('-', $key);
2290 $k = CRM_Utils_Array
::value('civicrm_' . $keyArray[1], $info, 99);
2292 elseif (strpos($key, '_') !== FALSE) {
2293 $keyArray = explode('_', $key);
2294 if (is_numeric(array_pop($keyArray))) {
2295 $k = CRM_Utils_Array
::value(implode('_', $keyArray), $info, 99);
2298 $k = CRM_Utils_Array
::value($key, $info, 99);
2302 $k = CRM_Utils_Array
::value($key, $info, 99);
2304 $tempTable[$k . ".$key"] = $key;
2307 $newTables = array();
2308 foreach ($tempTable as $key) {
2309 $newTables[$key] = $tables[$key];
2312 $tables = $newTables;
2314 foreach ($tables as $name => $value) {
2319 if (CRM_Utils_Array
::value($name, $inner)) {
2322 elseif (CRM_Utils_Array
::value($name, $right)) {
2330 // if there is already a join statement in value, use value itself
2331 if (strpos($value, 'JOIN')) {
2332 $from .= " $value ";
2335 $from .= " $side JOIN $name ON ( $value ) ";
2340 case 'civicrm_address':
2341 if ($primaryLocation) {
2342 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )";
2345 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) ";
2349 case 'civicrm_phone':
2350 $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) ";
2353 case 'civicrm_email':
2354 $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) ";
2358 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) ";
2362 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2363 $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2364 $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)";
2367 case 'civicrm_openid':
2368 $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )";
2371 case 'civicrm_worldregion':
2372 $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2373 $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2376 case 'civicrm_location_type':
2377 $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2380 case 'civicrm_group':
2381 $from .= " $side JOIN civicrm_group ON civicrm_group.id = civicrm_group_contact.group_id ";
2384 case 'civicrm_group_contact':
2385 $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2388 case 'civicrm_activity':
2389 case 'civicrm_activity_tag':
2390 case 'activity_type':
2391 case 'activity_status':
2392 case 'civicrm_activity_contact':
2393 case 'source_contact':
2394 $from .= CRM_Activity_BAO_Query
::from($name, $mode, $side);
2397 case 'civicrm_entity_tag':
2398 $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2399 civicrm_entity_tag.entity_id = contact_a.id ) ";
2402 case 'civicrm_note':
2403 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2404 contact_a.id = civicrm_note.entity_id ) ";
2407 case 'civicrm_subscription_history':
2408 $from .= " $side JOIN civicrm_subscription_history
2409 ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2410 AND civicrm_group_contact.group_id = civicrm_subscription_history.group_id";
2413 case 'civicrm_relationship':
2414 if (self
::$_relType == 'reciprocal') {
2415 if(self
::$_relationshipTempTable) {
2416 // we have a temptable to join on
2417 $tbl = self
::$_relationshipTempTable;
2418 $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2421 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2422 $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)";
2425 elseif (self
::$_relType == 'b') {
2426 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2427 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2430 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2431 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2436 $from .= " $side JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2437 $from .= " $side JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2441 $from .= " $side JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2444 case 'civicrm_grant':
2445 $from .= CRM_Grant_BAO_Query
::from($name, $mode, $side);
2448 case 'civicrm_website':
2449 $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2453 $from .= CRM_Core_Component
::from($name, $mode, $side);
2454 $from .= CRM_Contact_BAO_Query_Hook
::singleton()->buildSearchfrom($name, $mode, $side);
2464 * WHERE / QILL clause for deleted_contacts
2468 function deletedContacts($values) {
2469 list($_, $_, $value, $grouping, $_) = $values;
2471 // *prepend* to the relevant grouping as this is quite an important factor
2472 array_unshift($this->_qill
[$grouping], ts('Search in Trash'));
2477 * where / qill clause for contact_type
2482 function contactType(&$values) {
2483 list($name, $op, $value, $grouping, $wildcard) = $values;
2485 $subTypes = array();
2488 // account for search builder mapping multiple values
2489 if (!is_array($value)) {
2490 $values = self
::parseSearchBuilderString($value, 'String');
2491 if (is_array($values)) {
2492 $value = array_flip($values);
2496 if (is_array($value)) {
2497 foreach ($value as $k => $v) {
2502 if (strpos($k, CRM_Core_DAO
::VALUE_SEPARATOR
)) {
2503 list($contactType, $subType) = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $k, 2);
2506 if (!empty($subType)) {
2507 $subTypes[$subType] = 1;
2509 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2514 $contactTypeANDSubType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value, 2);
2515 $contactType = $contactTypeANDSubType[0];
2516 $subType = CRM_Utils_Array
::value(1, $contactTypeANDSubType);
2517 if (!empty($subType)) {
2518 $subTypes[$subType] = 1;
2520 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2524 if (!empty($clause)) {
2525 if ($op == 'IN' ||
$op == 'NOT IN') {
2526 $this->_where
[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2530 $type = array_pop($clause);
2531 $this->_where
[$grouping][] = "contact_a.contact_type $op $type";
2534 $this->_qill
[$grouping][] = ts('Contact Type') . ' - ' . implode(' ' . ts('or') . ' ', $quill);
2536 if (!empty($subTypes)) {
2537 $this->includeContactSubTypes($subTypes, $grouping);
2543 * where / qill clause for contact_sub_type
2548 function contactSubType(&$values) {
2549 list($name, $op, $value, $grouping, $wildcard) = $values;
2550 $this->includeContactSubTypes($value, $grouping);
2553 function includeContactSubTypes($value, $grouping) {
2556 $alias = "contact_a.contact_sub_type";
2558 if (is_array($value)) {
2559 foreach ($value as $k => $v) {
2561 $clause[$k] = "($alias like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($k, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2566 $clause[$value] = "($alias like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($value, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2569 if (!empty($clause)) {
2570 $this->_where
[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2571 $this->_qill
[$grouping][] = ts('Contact Subtype') . ' - ' . implode(' ' . ts('or') . ' ', array_keys($clause));
2576 * where / qill clause for groups
2581 function group(&$values) {
2582 list($name, $op, $value, $grouping, $wildcard) = $values;
2584 if (count($value) > 1) {
2585 $this->_useDistinct
= TRUE;
2588 $groupNames = CRM_Core_PseudoConstant
::group();
2589 $groupIds = implode(',', array_keys($value));
2592 foreach ($value as $id => $dontCare) {
2593 if (array_key_exists($id, $groupNames) && $dontCare) {
2594 $names[] = $groupNames[$id];
2600 $gcsValues = &$this->getWhereValues('group_contact_status', $grouping);
2602 is_array($gcsValues[2])
2604 foreach ($gcsValues[2] as $k => $v) {
2606 if ($k == 'Added') {
2609 $statii[] = "'" . CRM_Utils_Type
::escape($k, 'String') . "'";
2614 $statii[] = '"Added"';
2619 if (count($value) == 1 &&
2620 count($statii) == 1 &&
2621 $statii[0] == '"Added"'
2623 // check if smart group, if so we can get rid of that one additional
2625 $groupIDs = array_keys($value);
2627 if (CRM_Utils_Array
::value(0, $groupIDs) &&
2628 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
2638 $gcTable = "`civicrm_group_contact-{$groupIds}`";
2639 $this->_tables
[$gcTable] = $this->_whereTables
[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON contact_a.id = {$gcTable}.contact_id ";
2642 $qill = ts('Contacts %1', array(1 => $op));
2643 $qill .= ' ' . implode(' ' . ts('or') . ' ', $names);
2645 $groupClause = NULL;
2648 $groupClause = "{$gcTable}.group_id $op ( $groupIds )";
2649 if (!empty($statii)) {
2650 $groupClause .= " AND {$gcTable}.status IN (" . implode(', ', $statii) . ")";
2651 $qill .= " " . ts('AND') . " " . ts('Group Status') . ' - ' . implode(' ' . ts('or') . ' ', $statii);
2656 $ssClause = $this->savedSearch($values);
2659 $groupClause = "( ( $groupClause ) OR ( $ssClause ) )";
2662 $groupClause = $ssClause;
2667 $this->_where
[$grouping][] = $groupClause;
2668 $this->_qill
[$grouping][] = $qill;
2671 * Function translates selection of group type into a list of groups
2673 function getGroupsFromTypeCriteria($value){
2674 $groupIds = array();
2675 foreach ($value as $groupTypeValue) {
2676 $groupList = CRM_Core_PseudoConstant
::group($groupTypeValue);
2677 $groupIds = ($groupIds +
$groupList);
2683 * where / qill clause for smart groups
2688 function savedSearch(&$values) {
2689 list($name, $op, $value, $grouping, $wildcard) = $values;
2690 return $this->addGroupContactCache(array_keys($value));
2693 function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a") {
2694 $config = CRM_Core_Config
::singleton();
2696 // find all the groups that are part of a saved search
2697 $groupIDs = implode(',', $groups);
2698 if (empty($groupIDs)) {
2703 SELECT id, cache_date, saved_search_id, children
2705 WHERE id IN ( $groupIDs )
2706 AND ( saved_search_id != 0
2707 OR saved_search_id IS NOT NULL
2708 OR children IS NOT NULL )
2710 $group = CRM_Core_DAO
::executeQuery($sql);
2712 while ($group->fetch()) {
2713 if ($tableAlias == NULL) {
2714 $alias = "`civicrm_group_contact_cache_{$group->id}`";
2717 $alias = $tableAlias;
2720 $this->_useDistinct
= TRUE;
2722 if (!$this->_smartGroupCache ||
$group->cache_date
== NULL) {
2723 CRM_Contact_BAO_GroupContactCache
::load($group);
2726 $this->_tables
[$alias] = $this->_whereTables
[$alias] = " LEFT JOIN civicrm_group_contact_cache {$alias} ON {$joinTable}.id = {$alias}.contact_id ";
2727 $ssWhere[] = "{$alias}.group_id = {$group->id}";
2730 if (!empty($ssWhere)) {
2731 return implode(' OR ', $ssWhere);
2737 * where / qill clause for cms users
2742 function ufUser(&$values) {
2743 list($name, $op, $value, $grouping, $wildcard) = $values;
2746 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2748 $this->_qill
[$grouping][] = ts('CMS User');
2750 elseif ($value == 0) {
2751 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2753 $this->_where
[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
2754 $this->_qill
[$grouping][] = ts('Not a CMS User');
2759 * all tag search specific
2764 function tagSearch(&$values) {
2765 list($name, $op, $value, $grouping, $wildcard) = $values;
2768 $value = "%{$value}%";
2771 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2772 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2774 $etTable = "`civicrm_entity_tag-" . $value . "`";
2775 $tTable = "`civicrm_tag-" . $value . "`";
2777 if ($useAllTagTypes[2]) {
2778 $this->_tables
[$etTable] =
2779 $this->_whereTables
[$etTable] =
2780 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
2781 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id )";
2783 // search tag in cases
2784 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2785 $tCaseTable = "`civicrm_case_tag-" . $value . "`";
2786 $this->_tables
[$etCaseTable] =
2787 $this->_whereTables
[$etCaseTable] =
2788 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2789 LEFT JOIN civicrm_case
2790 ON (civicrm_case_contact.case_id = civicrm_case.id
2791 AND civicrm_case.is_deleted = 0 )
2792 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
2793 LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id )";
2794 // search tag in activities
2795 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2796 $tActTable = "`civicrm_act_tag-" . $value . "`";
2797 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2798 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2800 $this->_tables
[$etActTable] =
2801 $this->_whereTables
[$etActTable] =
2802 " LEFT JOIN civicrm_activity_contact
2803 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
2804 LEFT JOIN civicrm_activity
2805 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
2806 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2807 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
2808 LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id )";
2810 $this->_where
[$grouping][] = "({$tTable}.name $op '". $value . "' OR {$tCaseTable}.name $op '". $value . "' OR {$tActTable}.name $op '". $value . "')";
2811 $this->_qill
[$grouping][] = ts('Tag %1 %2 ', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
2813 $etTable = "`civicrm_entity_tag-" . $value . "`";
2814 $tTable = "`civicrm_tag-" . $value . "`";
2815 $this->_tables
[$etTable] = $this->_whereTables
[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND
2816 {$etTable}.entity_table = 'civicrm_contact' )
2817 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id ) ";
2819 $this->_where
[$grouping][] = self
::buildClause("{$tTable}.name", $op, $value, 'String');
2820 $this->_qill
[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
2825 * where / qill clause for tag
2830 function tag(&$values) {
2831 list($name, $op, $value, $grouping, $wildcard) = $values;
2833 $tagNames = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
2834 if (is_array($value)) {
2835 if (count($value) > 1) {
2836 $this->_useDistinct
= TRUE;
2838 foreach ($value as $id => $dontCare) {
2839 $names[] = CRM_Utils_Array
::value($id, $tagNames);
2841 $names = implode(' ' . ts('or') . ' ', $names);
2842 $value = implode(',', array_keys($value));
2845 $names = CRM_Utils_Array
::value($value, $tagNames);
2849 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2850 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2852 $etTable = "`civicrm_entity_tag-" . $value . "`";
2854 if ($useAllTagTypes[2]) {
2855 $this->_tables
[$etTable] =
2856 $this->_whereTables
[$etTable] =
2857 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2859 // search tag in cases
2860 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2861 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2862 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2864 $this->_tables
[$etCaseTable] =
2865 $this->_whereTables
[$etCaseTable] =
2866 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2867 LEFT JOIN civicrm_case
2868 ON (civicrm_case_contact.case_id = civicrm_case.id
2869 AND civicrm_case.is_deleted = 0 )
2870 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
2871 // search tag in activities
2872 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2873 $this->_tables
[$etActTable] =
2874 $this->_whereTables
[$etActTable] =
2875 " LEFT JOIN civicrm_activity_contact
2876 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
2877 LEFT JOIN civicrm_activity
2878 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
2879 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2880 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
2883 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2884 $this->_where
[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
2887 $this->_where
[$grouping][] = "({$etTable}.tag_id $op (". $value . ") OR {$etCaseTable}.tag_id $op (". $value . ") OR {$etActTable}.tag_id $op (". $value . "))";
2889 $this->_qill
[$grouping][] = ts('Tag %1 %2', array(1 => $op, 2 => $tagTypesText[2])) . ' ' . $names;
2891 $this->_tables
[$etTable] =
2892 $this->_whereTables
[$etTable] =
2893 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2896 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2897 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
2898 $op = str_replace('EMPTY', 'NULL', $op);
2899 $this->_where
[$grouping][] = "{$etTable}.tag_id $op";
2902 $this->_where
[$grouping][] = "{$etTable}.tag_id $op (" . $value . ')';
2904 $this->_qill
[$grouping][] = ts('Tagged %1', array( 1 => $op)) . ' ' . $names;
2910 * where/qill clause for notes
2915 function notes(&$values) {
2916 list($name, $op, $value, $grouping, $wildcard) = $values;
2918 $noteOptionValues = $this->getWhereValues('note_option', $grouping);
2919 $noteOption = CRM_Utils_Array
::value('2', $noteOptionValues, '6');
2920 $noteOption = ($name == 'note_body') ?
2 : (($name == 'note_subject') ?
3 : $noteOption);
2922 $this->_useDistinct
= TRUE;
2924 $this->_tables
['civicrm_note'] =
2925 $this->_whereTables
['civicrm_note'] =
2926 " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
2928 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2930 $value = $strtolower(CRM_Core_DAO
::escapeString($n));
2931 if ($wildcard ||
$op == 'LIKE') {
2932 if (strpos($value, '%') === FALSE) {
2933 $value = "%$value%";
2937 elseif ($op == 'IS NULL' ||
$op == 'IS NOT NULL') {
2943 if ( $noteOption %
2 == 0 ) {
2944 $clauses[] = self
::buildClause('civicrm_note.note', $op, $value, 'String');
2945 $label = ts('Note: Body Only');
2947 if ( $noteOption %
3 == 0 ) {
2948 $clauses[] = self
::buildClause('civicrm_note.subject', $op, $value, 'String');
2949 $label = $label ?
ts('Note: Body and Subject') : ts('Note: Subject Only');
2951 $this->_where
[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
2952 $this->_qill
[$grouping][] = $label . " $op - '$n'";
2955 function nameNullOrEmptyOp($name, $op, $grouping) {
2959 $this->_where
[$grouping][] = "contact_a.$name $op";
2960 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2964 $this->_where
[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
2965 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2968 case 'IS NOT EMPTY':
2969 $this->_where
[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
2970 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2979 * where / qill clause for sort_name
2984 function sortName(&$values) {
2985 list($name, $op, $value, $grouping, $wildcard) = $values;
2987 // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
2988 if ( $this->nameNullOrEmptyOp( $name, $op, $grouping ) ) {
2993 $name = trim($value);
2999 $config = CRM_Core_Config
::singleton();
3003 //By default, $sub elements should be joined together with OR statements (don't change this variable).
3006 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
3007 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
3009 if (substr($name, 0, 1) == '"' &&
3010 substr($name, -1, 1) == '"'
3012 //If name is encased in double quotes, the value should be taken to be the string in entirety and the
3013 $value = substr($name, 1, -1);
3014 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
3015 $wc = ($newName == 'sort_name') ?
'LOWER(contact_a.sort_name)' : 'LOWER(contact_a.display_name)';
3016 $sub[] = " ( $wc = '$value' ) ";
3017 if ($config->includeEmailInName
) {
3018 $sub[] = " ( civicrm_email.email = '$value' ) ";
3021 elseif (strpos($name, ',') !== FALSE) {
3022 // if we have a comma in the string, search for the entire string
3023 $value = $strtolower(CRM_Core_DAO
::escapeString($name));
3025 if ($config->includeWildCardInName
) {
3026 $value = "'%$value%'";
3029 $value = "'$value%'";
3034 $value = "'$value'";
3036 if ($newName == 'sort_name') {
3037 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3040 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.display_name)" : "contact_a.display_name";
3042 $sub[] = " ( $wc $op $value )";
3043 if ($config->includeNickNameInName
) {
3044 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3045 $sub[] = " ( $wc $op $value )";
3047 if ($config->includeEmailInName
) {
3048 $sub[] = " ( civicrm_email.email $op $value ) ";
3052 // the string should be treated as a series of keywords to be matched with match ANY OR
3053 // match ALL depending on Civi config settings (see CiviAdmin)
3055 // The Civi configuration setting can be overridden if the string *starts* with the case
3056 // insenstive strings 'AND:' or 'OR:'TO THINK ABOUT: what happens when someone searches
3057 // for the following "AND: 'a string in quotes'"? - probably nothing - it would make the
3058 // AND OR variable reduntant because there is only one search string?
3060 // Check to see if the $subGlue is overridden in the search text
3061 if (strtolower(substr($name, 0, 4)) == 'and:') {
3062 $name = substr($name, 4);
3065 if (strtolower(substr($name, 0, 3)) == 'or:') {
3066 $name = substr($name, 3);
3070 $firstChar = substr($name, 0, 1);
3071 $lastChar = substr($name, -1, 1);
3072 $quotes = array("'", '"');
3073 if ((strlen($name) > 2) && in_array($firstChar, $quotes) &&
3074 in_array($lastChar, $quotes)
3076 $name = substr($name, 1);
3077 $name = substr($name, 0, -1);
3078 $pieces = array($name);
3081 $pieces = explode(' ', $name);
3083 foreach ($pieces as $piece) {
3084 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($piece)));
3085 if (strlen($value)) {
3086 // Added If as a sanitization - without it, when you do an OR search, any string with
3087 // double spaces (i.e. " ") or that has a space after the keyword (e.g. "OR: ") will
3088 // return all contacts because it will include a condition similar to "OR contact
3089 // name LIKE '%'". It might be better to replace this with array_filter.
3090 $fieldsub = array();
3092 if ($config->includeWildCardInName
) {
3093 $value = "'%$value%'";
3096 $value = "'$value%'";
3101 $value = "'$value'";
3103 if ($newName == 'sort_name') {
3104 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3107 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.display_name)" : "contact_a.display_name";
3109 $fieldsub[] = " ( $wc $op $value )";
3110 if ($config->includeNickNameInName
) {
3111 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3112 $fieldsub[] = " ( $wc $op $value )";
3114 if ($config->includeEmailInName
) {
3115 $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3117 $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3118 // I seperated the glueing in two. The first stage should always be OR because we are searching for matches in *ANY* of these fields
3123 $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3125 $this->_where
[$grouping][] = $sub;
3126 if ($config->includeEmailInName
) {
3127 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3128 $this->_qill
[$grouping][] = ts('Name or Email ') . "$op - '$name'";
3131 $this->_qill
[$grouping][] = ts('Name like') . " - '$name'";
3136 * where / qill clause for email
3141 function email(&$values) {
3142 list($name, $op, $value, $grouping, $wildcard) = $values;
3146 $config = CRM_Core_Config
::singleton();
3148 if (substr($n, 0, 1) == '"' &&
3149 substr($n, -1, 1) == '"'
3151 $n = substr($n, 1, -1);
3152 $value = strtolower(CRM_Core_DAO
::escapeString($n));
3153 $value = "'$value'";
3157 $value = strtolower($n);
3159 if (strpos($value, '%') === FALSE) {
3160 $value = "%{$value}%";
3165 $this->_qill
[$grouping][] = ts('Email') . " $op '$n'";
3166 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, $value, 'String');
3169 $this->_qill
[$grouping][] = ts('Email') . " $op ";
3170 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, NULL, 'String');
3173 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3177 * where / qill clause for phone number
3182 function phone_numeric(&$values) {
3183 list($name, $op, $value, $grouping, $wildcard) = $values;
3184 // Strip non-numeric characters
3185 $number = preg_replace('/[^\d]/', '', $value);
3187 $this->_qill
[$grouping][] = ts('Phone number contains') . " $number";
3188 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.phone_numeric', 'LIKE', "%$number%", 'String');
3189 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3194 * where / qill clause for phone type/location
3199 function phone_option_group($values) {
3200 list($name, $op, $value, $grouping, $wildcard) = $values;
3201 $option = ($name == 'phone_phone_type_id' ?
'phone_type_id' : 'location_type_id');
3202 $options = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', $option);
3203 $optionName = $options[$value];
3204 $this->_qill
[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ?
ts('type') : ('location')) . " $op $optionName";
3205 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3206 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3210 * where / qill clause for street_address
3215 function street_address(&$values) {
3216 list($name, $op, $value, $grouping, $wildcard) = $values;
3225 $value = strtolower($n);
3226 if (strpos($value, '%') === FALSE) {
3227 // only add wild card if not there
3228 $value = "%{$value}%";
3231 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String');
3232 $this->_qill
[$grouping][] = ts('Street') . " $op '$n'";
3235 $this->_where
[$grouping][] = self
::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3236 $this->_qill
[$grouping][] = ts('Street') . " $op ";
3239 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3243 * where / qill clause for street_unit
3248 function street_number(&$values) {
3249 list($name, $op, $value, $grouping, $wildcard) = $values;
3257 if (strtolower($n) == 'odd') {
3258 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3259 $this->_qill
[$grouping][] = ts('Street Number is odd');
3261 elseif (strtolower($n) == 'even') {
3262 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3263 $this->_qill
[$grouping][] = ts('Street Number is even');
3266 $value = strtolower($n);
3268 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3269 $this->_qill
[$grouping][] = ts('Street Number') . " $op '$n'";
3272 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3276 * where / qill clause for sorting by character
3281 function sortByCharacter(&$values) {
3282 list($name, $op, $value, $grouping, $wildcard) = $values;
3284 $name = trim($value);
3285 $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($name)) . "%'";
3286 $this->_where
[$grouping][] = $cond;
3287 $this->_qill
[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3291 * where / qill clause for including contact ids
3296 function includeContactIDs() {
3297 if (!$this->_includeContactIds ||
empty($this->_params
)) {
3301 $contactIds = array();
3302 foreach ($this->_params
as $id => $values) {
3303 if (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
3304 $contactIds[] = substr($values[0], CRM_Core_Form
::CB_PREFIX_LEN
);
3307 if (!empty($contactIds)) {
3308 $this->_where
[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3313 * where / qill clause for postal code
3318 function postalCode(&$values) {
3319 // skip if the fields dont have anything to do with postal_code
3320 if (!CRM_Utils_Array
::value('postal_code', $this->_fields
)) {
3324 list($name, $op, $value, $grouping, $wildcard) = $values;
3326 // Handle numeric postal code range searches properly by casting the column as numeric
3327 if (is_numeric($value)) {
3328 $field = 'ROUND(civicrm_address.postal_code)';
3329 $val = CRM_Utils_Type
::escape($value, 'Integer');
3332 $field = 'civicrm_address.postal_code';
3333 $val = CRM_Utils_Type
::escape($value, 'String');
3336 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3338 if ($name == 'postal_code') {
3339 $this->_where
[$grouping][] = self
::buildClause($field, $op, $val, 'String');
3340 $this->_qill
[$grouping][] = ts('Postal code') . " {$op} {$value}";
3342 elseif ($name == 'postal_code_low') {
3343 $this->_where
[$grouping][] = " ( $field >= '$val' ) ";
3344 $this->_qill
[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3346 elseif ($name == 'postal_code_high') {
3347 $this->_where
[$grouping][] = " ( $field <= '$val' ) ";
3348 $this->_qill
[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3353 * where / qill clause for location type
3358 function locationType(&$values, $status = NULL) {
3359 list($name, $op, $value, $grouping, $wildcard) = $values;
3361 if (is_array($value)) {
3362 $this->_where
[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', array_keys($value)) . ')';
3363 $this->_tables
['civicrm_address'] = 1;
3364 $this->_whereTables
['civicrm_address'] = 1;
3366 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
3368 foreach (array_keys($value) as $id) {
3369 $names[] = $locationType[$id];
3372 $this->_primaryLocation
= FALSE;
3375 $this->_qill
[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3378 return implode(' ' . ts('or') . ' ', $names);
3383 function country(&$values, $fromStateProvince = TRUE) {
3384 list($name, $op, $value, $grouping, $wildcard) = $values;
3386 if (!$fromStateProvince) {
3387 $stateValues = $this->getWhereValues('state_province', $grouping);
3388 if (!empty($stateValues)) {
3389 // return back to caller if there are state province values
3390 // since that handles this case
3395 $countryClause = $countryQill = NULL;
3401 $this->_tables
['civicrm_address'] = 1;
3402 $this->_whereTables
['civicrm_address'] = 1;
3404 $countries = CRM_Core_PseudoConstant
::country();
3405 if (is_numeric($value)) {
3406 $countryClause = self
::buildClause(
3407 'civicrm_address.country_id',
3412 $countryName = $countries[(int ) $value];
3416 $intValues = self
::parseSearchBuilderString($value);
3417 if ($intValues && ($op == 'IN' ||
$op == 'NOT IN')) {
3418 $countryClause = self
::buildClause(
3419 'civicrm_address.country_id',
3424 $countryNames = array();
3425 foreach ($intValues as $v) {
3426 $countryNames[] = $countries[$v];
3428 $countryName = implode(',', $countryNames);
3431 $countries = CRM_Core_PseudoConstant
::country();
3432 $intVal = CRM_Utils_Array
::key($value, $countries);
3433 $countryClause = self
::buildClause(
3434 'civicrm_address.country_id',
3439 $countryName = $value;
3442 $countryQill = ts('Country') . " {$op} '$countryName'";
3444 if (!$fromStateProvince) {
3445 $this->_where
[$grouping][] = $countryClause;
3446 $this->_qill
[$grouping][] = $countryQill;
3450 if ($fromStateProvince) {
3451 if (!empty($countryClause)) {
3454 " ...AND... " . $countryQill,
3458 return array(NULL, NULL);
3464 * where / qill clause for county (if present)
3469 function county(&$values, $status = null) {
3470 list($name, $op, $value, $grouping, $wildcard) = $values;
3472 if (! is_array($value)) {
3473 // force the county to be an array
3474 $value = array($value);
3477 // check if the values are ids OR names of the counties
3478 $inputFormat = 'id';
3479 foreach ($value as $v) {
3480 if (!is_numeric($v)) {
3481 $inputFormat = 'name';
3489 else if ($op == '!=') {
3493 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3494 $op = str_replace('EMPTY', 'NULL', $op);
3497 if (in_array( $op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3498 $clause = "civicrm_address.county_id $op";
3500 elseif ($inputFormat == 'id') {
3501 $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3503 $county = CRM_Core_PseudoConstant
::county();
3504 foreach ($value as $id) {
3505 $names[] = CRM_Utils_Array
::value($id, $county);
3509 $inputClause = array();
3510 $county = CRM_Core_PseudoConstant
::county();
3511 foreach ($value as $name) {
3512 $name = trim($name);
3513 $inputClause[] = CRM_Utils_Array
::key($name, $county);
3515 $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3518 $this->_tables
['civicrm_address'] = 1;
3519 $this->_whereTables
['civicrm_address'] = 1;
3521 $this->_where
[$grouping][] = $clause;
3523 $this->_qill
[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3525 return implode(' ' . ts('or') . ' ', $names);
3530 * where / qill clause for state/province AND country (if present)
3535 function stateProvince(&$values, $status = NULL) {
3536 list($name, $op, $value, $grouping, $wildcard) = $values;
3538 // quick escape for IS NULL
3539 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3542 else if (!is_array($value)) {
3543 // force the state to be an array
3544 // check if its in the mapper format!
3545 $values = self
::parseSearchBuilderString($value);
3546 if (is_array($values)) {
3550 $value = array($value);
3554 // check if the values are ids OR names of the states
3555 $inputFormat = 'id';
3557 foreach ($value as $v) {
3558 if (!is_numeric($v)) {
3559 $inputFormat = 'name';
3569 else if ($op == '!=') {
3573 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3574 $op = str_replace('EMPTY', 'NULL', $op);
3576 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3577 $stateClause = "civicrm_address.state_province_id $op";
3579 else if ($inputFormat == 'id') {
3580 if ($op != 'NOT IN') {
3583 $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $value) . ')';
3585 $stateProvince = CRM_Core_PseudoConstant
::stateProvince();
3586 foreach ($value as $id) {
3587 $names[] = CRM_Utils_Array
::value($id, $stateProvince);
3591 $inputClause = array();
3592 $stateProvince = CRM_Core_PseudoConstant
::stateProvince();
3593 foreach ($value as $name) {
3594 $name = trim($name);
3595 $inputClause[] = CRM_Utils_Array
::key($name, $stateProvince);
3597 $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $inputClause) . ')';
3600 $this->_tables
['civicrm_address'] = 1;
3601 $this->_whereTables
['civicrm_address'] = 1;
3603 $countryValues = $this->getWhereValues('country', $grouping);
3604 list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3606 if ($countryClause) {
3607 $clause = "( $stateClause AND $countryClause )";
3610 $clause = $stateClause;
3613 $this->_where
[$grouping][] = $clause;
3615 $this->_qill
[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill;
3618 return implode(' ' . ts('or') . ' ', $names) . $countryQill;
3623 * where / qill clause for change log
3628 function changeLog(&$values) {
3629 list($name, $op, $value, $grouping, $wildcard) = $values;
3631 $targetName = $this->getWhereValues('changed_by', $grouping);
3636 $name = trim($targetName[2]);
3637 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3638 $name = $targetName[4] ?
"%$name%" : $name;
3639 $this->_where
[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3640 $this->_tables
['civicrm_log'] = $this->_whereTables
['civicrm_log'] = 1;
3641 $this->_qill
[$grouping][] = ts('Changed by') . ": $name";
3644 function modifiedDates($values) {
3645 $this->_useDistinct
= TRUE;
3647 // CRM-11281, default to added date if not set
3648 $fieldTitle = ts('Added Date');
3650 foreach (array_keys($this->_params
) as $id) {
3651 if ($this->_params
[$id][0] == 'log_date') {
3652 if ($this->_params
[$id][2] == 2) {
3653 $fieldTitle = ts('Modified Date');
3658 $this->dateQueryBuilder($values,
3659 'civicrm_log', 'log_date', 'modified_date', $fieldTitle
3663 function demographics(&$values) {
3664 list($name, $op, $value, $grouping, $wildcard) = $values;
3666 if (($name == 'birth_date_low') ||
($name == 'birth_date_high')) {
3668 $this->dateQueryBuilder($values,
3669 'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3672 elseif (($name == 'deceased_date_low') ||
($name == 'deceased_date_high')) {
3674 $this->dateQueryBuilder($values,
3675 'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3679 self
::$_openedPanes[ts('Demographics')] = TRUE;
3682 function privacy(&$values) {
3683 list($name, $op, $value, $grouping, $wildcard) = $values;
3684 //fixed for profile search listing CRM-4633
3685 if (strpbrk($value, "[")) {
3686 $value = "'{$value}'";
3688 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3691 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3693 $field = CRM_Utils_Array
::value($name, $this->_fields
);
3694 $title = $field ?
$field['title'] : $name;
3695 $this->_qill
[$grouping][] = "$title $op $value";
3698 function privacyOptions($values) {
3699 list($name, $op, $value, $grouping, $wildcard) = $values;
3701 if (empty($value) ||
!is_array($value)) {
3705 // get the operator and toggle values
3706 $opValues = $this->getWhereValues('privacy_operator', $grouping);
3709 strtolower($opValues[2] == 'AND')
3714 $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3716 if ($toggleValues &&
3717 $toggleValues[2] == 2
3724 foreach ($value as $dontCare => $pOption) {
3725 $clauses[] = " ( contact_a.{$pOption} $compareOP 1 ) ";
3726 $field = CRM_Utils_Array
::value($pOption, $this->_fields
);
3727 $title = $field ?
$field['title'] : $pOption;
3728 $qill[] = " $title $compareOP 1 ";
3731 $this->_where
[$grouping][] = '( ' . implode($operator, $clauses) . ' )';
3732 $this->_qill
[$grouping][] = implode($operator, $qill);
3735 function preferredCommunication(&$values) {
3736 list($name, $op, $value, $grouping, $wildcard) = $values;
3739 if (!is_array($value)) {
3741 $value = trim($value, ' ()');
3742 if (strpos($value, CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
3743 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
3746 $v = explode(",", $value);
3749 foreach ($v as $item) {
3756 foreach ($value as $key => $checked) {
3763 $commPref = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
3765 $sqlValue = array();
3766 $sql = "contact_a.preferred_communication_method";
3767 foreach ($pref as $val) {
3768 $sqlValue[] = "( $sql like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. $val . CRM_Core_DAO
::VALUE_SEPARATOR
. "%' ) ";
3769 $showValue[] = $commPref[$val];
3771 $this->_where
[$grouping][] = "( " . implode(' OR ', $sqlValue) . " )";
3772 $this->_qill
[$grouping][] = ts('Preferred Communication Method') . " $op " . implode(' ' . ts('or') . ' ', $showValue);
3776 * where / qill clause for relationship
3781 function relationship(&$values) {
3782 list($name, $op, $value, $grouping, $wildcard) = $values;
3783 if($this->_relationshipValuesAdded
){
3786 // also get values array for relation_target_name
3787 // for relatinship search we always do wildcard
3788 $targetName = $this->getWhereValues('relation_target_name', $grouping);
3789 $relStatus = $this->getWhereValues('relation_status', $grouping);
3790 $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
3792 $nameClause = $name = NULL;
3794 $name = trim($targetName[2]);
3795 if (substr($name, 0, 1) == '"' &&
3796 substr($name, -1, 1) == '"'
3798 $name = substr($name, 1, -1);
3799 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3800 $nameClause = "= '$name'";
3803 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3804 $nameClause = "LIKE '%{$name}%'";
3808 $rel = explode('_', $value);
3810 self
::$_relType = $rel[1];
3811 $params = array('id' => $rel[0]);
3812 $rTypeValues = array();
3813 $rType = CRM_Contact_BAO_RelationshipType
::retrieve($params, $rTypeValues);
3814 if ($rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) {
3815 // if we don't know which end of the relationship we are dealing with we'll create a temp table
3816 //@todo unless we are dealing with a target group
3817 self
::$_relType = 'reciprocal';
3819 // if we are creating a temp table we build our own where for the relationship table
3820 if(self
::$_relType == 'reciprocal' && empty($targetGroup)) {
3822 self
::$_relationshipTempTable = $relationshipTempTable = 'civicrm_temp_rel' . rand(0,99999);
3824 $where[$grouping][] = " sort_name $nameClause ";
3828 $where = &$this->_where
;
3830 $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
3835 $relTypeInd = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Individual');
3836 $relTypeOrg = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Organization');
3837 $relTypeHou = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Household');
3838 $allRelationshipType = array();
3839 $allRelationshipType = array_merge($relTypeInd, $relTypeOrg);
3840 $allRelationshipType = array_merge($allRelationshipType, $relTypeHou);
3842 if ($nameClause ||
!$targetGroup) {
3843 $this->_qill
[$grouping][] = "$allRelationshipType[$value] $name";
3847 //check to see if the target contact is in specified group
3849 //add contacts from static groups
3850 $this->_tables
['civicrm_relationship_group_contact'] =
3851 $this->_whereTables
['civicrm_relationship_group_contact'] =
3852 " LEFT JOIN civicrm_group_contact civicrm_relationship_group_contact ON civicrm_relationship_group_contact.contact_id = contact_b.id";
3853 $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN (" . implode(",", $targetGroup[2]) . ") )";
3855 //add contacts from saved searches
3856 $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b");
3858 //set the group where clause
3860 $groupWhere[] = "( " . $ssWhere . " )";
3862 $this->_where
[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
3864 //Get the names of the target groups for the qill
3865 $groupNames = &CRM_Core_PseudoConstant
::group();
3866 $qillNames = array();
3867 foreach ($targetGroup[2] as $groupId) {
3868 if (array_key_exists($groupId, $groupNames)) {
3869 $qillNames[] = $groupNames[$groupId];
3872 $this->_qill
[$grouping][] = "$allRelationshipType[$value] ( " . implode(", ", $qillNames) . " )";
3875 // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
3876 $today = date('Ymd');
3877 //check for active, inactive and all relation status
3878 if ($relStatus[2] == 0) {
3879 $where[$grouping][] = "(
3880 civicrm_relationship.is_active = 1 AND
3881 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
3882 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
3884 $this->_qill
[$grouping][] = ts('Relationship - Active and Current');
3886 elseif ($relStatus[2] == 1) {
3887 $where[$grouping][] = "(
3888 civicrm_relationship.is_active = 0 OR
3889 civicrm_relationship.end_date < {$today} OR
3890 civicrm_relationship.start_date > {$today}
3892 $this->_qill
[$grouping][] = ts('Relationship - Inactive or not Current');
3895 $this->addRelationshipDateClauses($grouping, $where);
3896 if(!empty($rType) && isset($rType->id
)){
3897 $where[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rType->id
;
3899 $this->_tables
['civicrm_relationship'] = $this->_whereTables
['civicrm_relationship'] = 1;
3900 $this->_useDistinct
= TRUE;
3901 $this->_relationshipValuesAdded
= TRUE;
3902 // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
3904 // @todo creating a temp table could be expanded to group filter
3905 // as even creating a temp table of all relationships is much much more efficient than
3906 // an OR in the join
3907 if($relationshipTempTable) {
3908 $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
3910 CREATE TEMPORARY TABLE {$relationshipTempTable}
3911 (SELECT contact_id_b as contact_id, civicrm_relationship.id
3912 FROM civicrm_relationship
3913 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
3916 (SELECT contact_id_a as contact_id, civicrm_relationship.id
3917 FROM civicrm_relationship
3918 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
3921 CRM_Core_DAO
::executeQuery($sql);
3926 * Add start & end date criteria in
3927 * @param string $grouping
3928 * @param array $where = array to add where clauses to, in case you are generating a temp table
3929 * not the main query.
3931 function addRelationshipDateClauses($grouping, &$where){
3932 $dateValues = array();
3938 foreach ($dateTypes as $dateField){
3939 $dateValueLow = $this->getWhereValues('relation_'. $dateField .'_low', $grouping);
3940 $dateValueHigh= $this->getWhereValues('relation_'. $dateField .'_high', $grouping);
3941 if(!empty($dateValueLow)){
3942 $date = date('Ymd', strtotime($dateValueLow[2]));
3943 $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
3944 $this->_qill
[$grouping][] = ($dateField == 'end_date' ?
ts('Relationship Ended on or After') : ts('Relationship Recorded Start Date On or Before')) . " " . CRM_Utils_Date
::customFormat($date);
3946 if(!empty($dateValueHigh)){
3947 $date = date('Ymd', strtotime($dateValueHigh[2]));
3948 $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
3949 $this->_qill
[$grouping][] = ( $dateField == 'end_date' ?
ts('Relationship Ended on or Before') : ts('Relationship Recorded Start Date On or After')) . " " . CRM_Utils_Date
::customFormat($date);
3954 * default set of return properties
3959 static function &defaultReturnProperties($mode = 1) {
3960 if (!isset(self
::$_defaultReturnProperties)) {
3961 self
::$_defaultReturnProperties = array();
3964 if (!isset(self
::$_defaultReturnProperties[$mode])) {
3965 // add activity return properties
3966 if ($mode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
3967 self
::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query
::defaultReturnProperties($mode, FALSE);
3970 self
::$_defaultReturnProperties[$mode] = CRM_Core_Component
::defaultReturnProperties($mode, FALSE);
3973 if (empty(self
::$_defaultReturnProperties[$mode])) {
3974 self
::$_defaultReturnProperties[$mode] = array(
3977 'legal_identifier' => 1,
3978 'external_identifier' => 1,
3979 'contact_type' => 1,
3980 'contact_sub_type' => 1,
3982 'display_name' => 1,
3983 'preferred_mail_format' => 1,
3992 'street_address' => 1,
3993 'supplemental_address_1' => 1,
3994 'supplemental_address_2' => 1,
3997 'postal_code_suffix' => 1,
3998 'state_province' => 1,
4000 'world_region' => 1,
4007 'household_name' => 1,
4008 'organization_name' => 1,
4009 'deceased_date' => 1,
4014 'current_employer' => 1,
4015 // FIXME: should we use defaultHierReturnProperties() for the below?
4016 'do_not_email' => 1,
4019 'do_not_phone' => 1,
4020 'do_not_trade' => 1,
4022 'contact_is_deleted' => 1,
4023 'preferred_communication_method' => 1,
4024 'preferred_language' => 1,
4028 return self
::$_defaultReturnProperties[$mode];
4032 * get primary condition for a sql clause
4039 static function getPrimaryCondition($value) {
4040 if (is_numeric($value)) {
4041 $value = (int ) $value;
4042 return ($value == 1) ?
'is_primary = 1' : 'is_primary = 0';
4048 * wrapper for a simple search query
4050 * @param array $params
4051 * @param array $returnProperties
4052 * @param \bolean|bool $count
4057 static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4058 $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4059 list($select, $from, $where, $having) = $query->query();
4061 return "$select $from $where $having";
4065 * These are stub comments as this function needs more explanation - particularly in terms of how it
4066 * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4068 * This function was originally written as a wrapper for the api query but is called from multiple places
4069 * in the core code directly so the name is misleading. This function does not use the searchQuery function
4070 * but it is unclear as to whehter that is historical or there is a reason
4071 * CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4073 * @param array $params
4074 * @param array $returnProperties
4075 * @param null $fields
4076 * @param string $sort
4077 * @param int $offset
4078 * @param int $row_count
4079 * @param bool $smartGroupCache
4080 * @param bool $count return count obnly
4081 * @param bool $skipPermissions Should permissions be ignored or should the logged in user's permissions be applied
4083 * @params bool $smartGroupCache ?? update smart group cache?
4088 static function apiQuery(
4090 $returnProperties = NULL,
4095 $smartGroupCache = TRUE,
4097 $skipPermissions = TRUE
4100 $query = new CRM_Contact_BAO_Query(
4101 $params, $returnProperties,
4102 NULL, TRUE, FALSE, 1,
4104 TRUE, $smartGroupCache
4107 //this should add a check for view deleted if permissions are enabled
4108 if ($skipPermissions){
4109 $query->_skipDeleteClause
= TRUE;
4111 $query->generatePermissionClause(FALSE, $count);
4113 // note : this modifies _fromClause and _simpleFromClause
4114 $query->includePseudoFieldsJoin($sort);
4116 list($select, $from, $where, $having) = $query->query($count);
4118 $options = $query->_options
;
4119 if(!empty($query->_permissionWhereClause
)){
4120 if (empty($where)) {
4121 $where = "WHERE $query->_permissionWhereClause";
4124 $where = "$where AND $query->_permissionWhereClause";
4128 $sql = "$select $from $where $having";
4131 if ($query->_useGroupBy
) {
4132 $sql .= ' GROUP BY contact_a.id';
4134 if (!empty($sort)) {
4135 $sort = CRM_Utils_Type
::escape($sort, 'String');
4136 $sql .= " ORDER BY $sort ";
4138 if ($row_count > 0 && $offset >= 0) {
4139 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4140 $rowCount = CRM_Utils_Type
::escape($row_count, 'Int');
4141 $sql .= " LIMIT $offset, $row_count ";
4144 $dao = CRM_Core_DAO
::executeQuery($sql);
4147 while ($dao->fetch()) {
4149 $noRows = $dao->rowCount
;
4151 return array($noRows,NULL);
4153 $val = $query->store($dao);
4154 $convertedVals = $query->convertToPseudoNames($dao, TRUE);
4156 if (!empty($convertedVals)) {
4157 $val = array_merge_recursive($val, $convertedVals);
4159 $values[$dao->contact_id
] = $val;
4162 return array($values, $options);
4166 * create and query the db for an contact search
4168 * @param int $offset the offset for the query
4169 * @param int $rowCount the number of rows to return
4170 * @param string $sort the order by string
4171 * @param boolean $count is this a count only query ?
4172 * @param boolean $includeContactIds should we include contact ids?
4173 * @param boolean $sortByChar if true returns the distinct array of first characters for search results
4174 * @param boolean $groupContacts if true, return only the contact ids
4175 * @param boolean $returnQuery should we return the query as a string
4176 * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components)
4177 * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load.
4179 * @return CRM_Contact_DAO_Contact
4182 function searchQuery(
4183 $offset = 0, $rowCount = 0, $sort = NULL,
4184 $count = FALSE, $includeContactIds = FALSE,
4185 $sortByChar = FALSE, $groupContacts = FALSE,
4186 $returnQuery = FALSE,
4187 $additionalWhereClause = NULL, $sortOrder = NULL,
4188 $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4191 if ($includeContactIds) {
4192 $this->_includeContactIds
= TRUE;
4193 $this->_whereClause
= $this->whereClause();
4196 $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
);
4198 // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4199 // and that contact happens to be deleted, set $onlyDeleted to true
4200 foreach ($this->_params
as $values) {
4201 $name = CRM_Utils_Array
::value(0, $values);
4202 $op = CRM_Utils_Array
::value(1, $values);
4203 $value = CRM_Utils_Array
::value(2, $values);
4204 if ($name == 'contact_id' and $op == '=') {
4205 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4206 $onlyDeleted = TRUE;
4211 $this->generatePermissionClause($onlyDeleted, $count);
4213 // building the query string
4216 if (isset($this->_groupByComponentClause
)) {
4217 $groupBy = $this->_groupByComponentClause
;
4219 elseif ($this->_useGroupBy
) {
4220 $groupBy = ' GROUP BY contact_a.id';
4223 if ($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
&& (!$count)) {
4224 $groupBy = 'GROUP BY civicrm_activity.id ';
4227 $order = $orderBy = $limit = '';
4229 $config = CRM_Core_Config
::singleton();
4230 if ($config->includeOrderByClause ||
4231 isset($this->_distinctComponentClause
)
4234 if (is_string($sort)) {
4238 $orderBy = trim($sort->orderBy());
4240 if (!empty($orderBy)) {
4241 // this is special case while searching for
4242 // changelog CRM-1718
4243 if (preg_match('/sort_name/i', $orderBy)) {
4244 $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
4247 $orderBy = CRM_Utils_Type
::escape($orderBy, 'String');
4248 $order = " ORDER BY $orderBy";
4251 $sortOrder = CRM_Utils_Type
::escape($sortOrder, 'String');
4252 $order .= " $sortOrder";
4255 // always add contact_a.id to the ORDER clause
4256 // so the order is deterministic
4257 if (strpos('contact_a.id', $order) === FALSE) {
4258 $order .= ", contact_a.id";
4262 elseif ($sortByChar) {
4263 $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc";
4266 $order = " ORDER BY contact_a.sort_name asc, contact_a.id";
4270 // hack for order clause
4272 $fieldStr = trim(str_replace('ORDER BY', '', $order));
4273 $fieldOrder = explode(' ', $fieldStr);
4274 $field = $fieldOrder[0];
4280 $this->_whereTables
["civicrm_address"] = 1;
4281 $order = str_replace($field, "civicrm_address.{$field}", $order);
4285 case 'state_province':
4286 $this->_whereTables
["civicrm_{$field}"] = 1;
4287 $order = str_replace($field, "civicrm_{$field}.name", $order);
4291 $this->_whereTables
["civicrm_email"] = 1;
4292 $order = str_replace($field, "civicrm_email.{$field}", $order);
4295 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4296 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4300 if ($rowCount > 0 && $offset >= 0) {
4301 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4302 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
4303 $limit = " LIMIT $offset, $rowCount ";
4307 // note : this modifies _fromClause and _simpleFromClause
4308 $this->includePseudoFieldsJoin($sort);
4310 list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts);
4312 if(!empty($this->_permissionWhereClause
)){
4313 if (empty($where)) {
4314 $where = "WHERE $this->_permissionWhereClause";
4317 $where = "$where AND $this->_permissionWhereClause";
4321 if ($additionalWhereClause) {
4322 $where = $where . ' AND ' . $additionalWhereClause;
4325 //additional from clause should be w/ proper joins.
4326 if ($additionalFromClause) {
4327 $from .= "\n" . $additionalFromClause;
4330 // if we are doing a transform, do it here
4331 // use the $from, $where and $having to get the contact ID
4332 if ($this->_displayRelationshipType
) {
4333 $this->filterRelatedContacts($from, $where, $having);
4336 if ($skipOrderAndLimit) {
4337 $query = "$select $from $where $having $groupBy";
4340 $query = "$select $from $where $having $groupBy $order $limit";
4348 return CRM_Core_DAO
::singleValueQuery($query);
4351 $dao = CRM_Core_DAO
::executeQuery($query);
4352 if ($groupContacts) {
4354 while ($dao->fetch()) {
4357 return implode(',', $ids);
4364 * Fetch a list of contacts from the prev/next cache for displaying a search results page
4366 * @param string $cacheKey
4367 * @param int $offset
4368 * @param int $rowCount
4369 * @param bool $includeContactIds
4370 * @return CRM_Core_DAO
4372 function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
4373 $this->_includeContactIds
= $includeContactIds;
4374 list($select, $from, $where) = $this->query();
4375 $from = " FROM civicrm_prevnext_cache pnc INNER JOIN civicrm_contact contact_a ON contact_a.id = pnc.entity_id1 AND pnc.cacheKey = '$cacheKey' " . substr($from, 31);
4376 $order = " ORDER BY pnc.id";
4377 $groupBy = " GROUP BY contact_a.id";
4378 $limit = " LIMIT $offset, $rowCount";
4379 $query = "$select $from $where $groupBy $order $limit";
4381 return CRM_Core_DAO
::executeQuery($query);
4385 * Populate $this->_permissionWhereClause with permission related clause and update other
4386 * query related properties.
4388 * Function calls ACL permission class and hooks to filter the query appropriately
4390 * Note that these 2 params were in the code when extracted from another function
4391 * and a second round extraction would be to make them properties of the class
4393 * @param bool $onlyDeleted Only get deleted contacts
4394 * @param bool $count Return Count only
4398 function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
4399 if (!$this->_skipPermission
) {
4400 $this->_permissionWhereClause
= CRM_ACL_API
::whereClause(
4401 CRM_Core_Permission
::VIEW
,
4403 $this->_whereTables
,
4406 $this->_skipDeleteClause
4409 // regenerate fromClause since permission might have added tables
4410 if ($this->_permissionWhereClause
) {
4411 //fix for row count in qill (in contribute/membership find)
4413 $this->_useDistinct
= TRUE;
4415 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4416 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4420 // add delete clause if needed even if we are skipping permission
4422 if (!$this->_skipDeleteClause
) {
4423 if (CRM_Core_Permission
::check('access deleted contacts') and $onlyDeleted) {
4424 $this->_permissionWhereClause
= '(contact_a.is_deleted)';
4428 $this->_permissionWhereClause
= '(contact_a.is_deleted = 0)';
4434 function setSkipPermission($val) {
4435 $this->_skipPermission
= $val;
4438 function &summaryContribution($context = NULL) {
4439 list($select, $from, $where, $having) = $this->query(TRUE);
4443 SELECT COUNT( civicrm_contribution.total_amount ) as total_count,
4444 SUM( civicrm_contribution.total_amount ) as total_amount,
4445 AVG( civicrm_contribution.total_amount ) as total_avg,
4446 civicrm_contribution.currency as currency";
4448 // make sure contribution is completed - CRM-4989
4449 $where .= " AND civicrm_contribution.contribution_status_id = 1 ";
4450 if ($context == 'search') {
4451 $where .= " AND contact_a.is_deleted = 0 ";
4455 $summary['total'] = array();
4456 $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
4458 $query = "$select $from $where GROUP BY currency";
4461 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4463 $summary['total']['count'] = 0;
4464 $summary['total']['amount'] = $summary['total']['avg'] = array();
4465 while ($dao->fetch()) {
4466 $summary['total']['count'] +
= $dao->total_count
;
4467 $summary['total']['amount'][] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
4468 $summary['total']['avg'][] = CRM_Utils_Money
::format($dao->total_avg
, $dao->currency
);
4470 if (!empty($summary['total']['amount'])) {
4471 $summary['total']['amount'] = implode(', ', $summary['total']['amount']);
4472 $summary['total']['avg'] = implode(', ', $summary['total']['avg']);
4475 $summary['total']['amount'] = $summary['total']['avg'] = 0;
4480 SELECT COUNT( civicrm_contribution.total_amount ) as cancel_count,
4481 SUM( civicrm_contribution.total_amount ) as cancel_amount,
4482 AVG( civicrm_contribution.total_amount ) as cancel_avg,
4483 civicrm_contribution.currency as currency";
4485 $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
4486 if ($context == 'search') {
4487 $where .= " AND contact_a.is_deleted = 0 ";
4490 $query = "$select $from $where GROUP BY currency";
4491 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4494 if ($dao->fetch()) {
4495 $summary['cancel']['count'] = $dao->cancel_count
;
4496 $summary['cancel']['amount'] = $dao->cancel_amount
;
4497 $summary['cancel']['avg'] = $dao->cancel_avg
;
4501 $summary['cancel']['count'] = 0;
4502 $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
4503 while ($dao->fetch()) {
4504 $summary['cancel']['count'] +
= $dao->cancel_count
;
4505 $summary['cancel']['amount'][] = CRM_Utils_Money
::format($dao->cancel_amount
, $dao->currency
);
4506 $summary['cancel']['avg'][] = CRM_Utils_Money
::format($dao->cancel_avg
, $dao->currency
);
4508 $summary['cancel']['amount'] = implode(', ', $summary['cancel']['amount']);
4509 $summary['cancel']['avg'] = implode(', ', $summary['cancel']['avg']);
4516 * getter for the qill object
4522 return $this->_qill
;
4526 * default set of return default hier return properties
4531 static function &defaultHierReturnProperties() {
4532 if (!isset(self
::$_defaultHierReturnProperties)) {
4533 self
::$_defaultHierReturnProperties = array(
4536 'legal_identifier' => 1,
4537 'external_identifier' => 1,
4538 'contact_type' => 1,
4539 'contact_sub_type' => 1,
4541 'display_name' => 1,
4548 'email_greeting' => 1,
4549 'postal_greeting' => 1,
4553 'preferred_communication_method' => 1,
4554 'do_not_phone' => 1,
4555 'do_not_email' => 1,
4558 'do_not_trade' => 1,
4561 '1' => array('location_type' => 1,
4562 'street_address' => 1,
4564 'state_province' => 1,
4566 'postal_code_suffix' => 1,
4569 'phone-Mobile' => 1,
4582 'location_type' => 1,
4583 'street_address' => 1,
4585 'state_province' => 1,
4587 'postal_code_suffix' => 1,
4590 'phone-Mobile' => 1,
4604 return self
::$_defaultHierReturnProperties;
4607 function dateQueryBuilder(
4608 &$values, $tableName, $fieldName,
4609 $dbFieldName, $fieldTitle,
4610 $appendTimeStamp = TRUE
4612 list($name, $op, $value, $grouping, $wildcard) = $values;
4618 if ($name == "{$fieldName}_low" ||
4619 $name == "{$fieldName}_high"
4621 if (isset($this->_rangeCache
[$fieldName])) {
4624 $this->_rangeCache
[$fieldName] = 1;
4626 $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
4628 if ($name == $fieldName . '_low') {
4630 $firstPhrase = ts('greater than or equal to');
4631 $firstDate = CRM_Utils_Date
::processDate($value);
4633 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4634 if (!empty($secondValues) && $secondValues[2]) {
4636 $secondPhrase = ts('less than or equal to');
4637 $secondValue = $secondValues[2];
4639 if ($appendTimeStamp && strlen($secondValue) == 10) {
4640 $secondValue .= ' 23:59:59';
4642 $secondDate = CRM_Utils_Date
::processDate($secondValue);
4645 elseif ($name == $fieldName . '_high') {
4647 $firstPhrase = ts('less than or equal to');
4649 if ($appendTimeStamp && strlen($value) == 10) {
4650 $value .= ' 23:59:59';
4652 $firstDate = CRM_Utils_Date
::processDate($value);
4654 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4655 if (!empty($secondValues) && $secondValues[2]) {
4657 $secondPhrase = ts('greater than or equal to');
4658 $secondValue = $secondValues[2];
4659 $secondDate = CRM_Utils_Date
::processDate($secondValue);
4663 if (!$appendTimeStamp) {
4664 $firstDate = substr($firstDate, 0, 8);
4666 $firstDateFormat = CRM_Utils_Date
::customFormat($firstDate);
4669 if (!$appendTimeStamp) {
4670 $secondDate = substr($secondDate, 0, 8);
4672 $secondDateFormat = CRM_Utils_Date
::customFormat($secondDate);
4675 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4677 $this->_where
[$grouping][] = "
4678 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
4679 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
4681 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
4684 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
4685 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
4689 if ($name == $fieldName) {
4693 $date = CRM_Utils_Date
::processDate($value);
4695 if (!$appendTimeStamp) {
4696 $date = substr($date, 0, 8);
4699 $format = CRM_Utils_Date
::customFormat($date);
4702 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op '$date'";
4705 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op";
4707 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4708 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$format\"";
4712 $tableName == 'civicrm_log' &&
4713 $fieldTitle == ts('Added Date')
4715 //CRM-6903 --hack to check modified date of first record.
4716 //as added date means first modified date of object.
4717 $addedDateQuery = 'select id from civicrm_log group by entity_id order by id';
4718 $this->_where
[$grouping][] = "civicrm_log.id IN ( {$addedDateQuery} )";
4722 function numberRangeBuilder(&$values,
4723 $tableName, $fieldName,
4724 $dbFieldName, $fieldTitle,
4727 list($name, $op, $value, $grouping, $wildcard) = $values;
4729 if ($name == "{$fieldName}_low" ||
4730 $name == "{$fieldName}_high"
4732 if (isset($this->_rangeCache
[$fieldName])) {
4735 $this->_rangeCache
[$fieldName] = 1;
4737 $secondOP = $secondPhrase = $secondValue = NULL;
4739 if ($name == "{$fieldName}_low") {
4741 $firstPhrase = ts('greater than');
4743 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4744 if (!empty($secondValues)) {
4746 $secondPhrase = ts('less than');
4747 $secondValue = $secondValues[2];
4752 $firstPhrase = ts('less than');
4754 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4755 if (!empty($secondValues)) {
4757 $secondPhrase = ts('greater than');
4758 $secondValue = $secondValues[2];
4763 $this->_where
[$grouping][] = "
4764 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
4765 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
4767 $displayValue = $options ?
$options[$value] : $value;
4768 $secondDisplayValue = $options ?
$options[$secondValue] : $secondValue;
4770 $this->_qill
[$grouping][] =
4771 "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
4774 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
4775 $displayValue = $options ?
$options[$value] : $value;
4776 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
4778 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4783 if ($name == $fieldName) {
4787 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
4789 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4790 $displayValue = $options ?
$options[$value] : $value;
4791 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
4798 * Given the field name, operator, value & its data type
4799 * builds the where Clause for the query
4800 * used for handling 'IS NULL'/'IS NOT NULL' operators
4802 * @param string $field fieldname
4803 * @param string $op operator
4804 * @param string $value value
4805 * @param string $dataType data type of the field
4807 * @return where clause for the query
4810 static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
4812 $clause = "$field $op";
4820 $clause = " ( $field IS NULL OR $field = '' ) ";
4823 case 'IS NOT EMPTY':
4824 $clause = " ( $field IS NOT NULL AND $field <> '' ) ";
4829 if (isset($dataType)) {
4830 if (is_array($value)) {
4834 $value = CRM_Utils_Type
::escape($value, "String");
4835 $values = explode(',', CRM_Utils_Array
::value(0, explode(')', CRM_Utils_Array
::value(1, explode('(', $value)))));
4837 // supporting multiple values in IN clause
4839 foreach ($values as $v) {
4841 $val[] = "'" . CRM_Utils_Type
::escape($v, $dataType) . "'";
4843 $value = "(" . implode($val, ",") . ")";
4845 return "$clause $value";
4848 if (empty($dataType)) {
4849 $dataType = 'String';
4852 $value = CRM_Utils_Type
::escape($value, $dataType);
4854 // if we dont have a dataType we should assume
4855 if ($dataType == 'String' ||
$dataType == 'Text') {
4856 $value = "'" . strtolower($value) . "'";
4858 return "$clause $value";
4862 function openedSearchPanes($reset = FALSE) {
4863 if (!$reset ||
empty($this->_whereTables
)) {
4864 return self
::$_openedPanes;
4867 // pane name to table mapper
4868 $panesMapper = array(
4869 ts('Contributions') => 'civicrm_contribution',
4870 ts('Memberships') => 'civicrm_membership',
4871 ts('Events') => 'civicrm_participant',
4872 ts('Relationships') => 'civicrm_relationship',
4873 ts('Activities') => 'civicrm_activity',
4874 ts('Pledges') => 'civicrm_pledge',
4875 ts('Cases') => 'civicrm_case',
4876 ts('Grants') => 'civicrm_grant',
4877 ts('Address Fields') => 'civicrm_address',
4878 ts('Notes') => 'civicrm_note',
4879 ts('Change Log') => 'civicrm_log',
4880 ts('Mailings') => 'civicrm_mailing_event_queue',
4882 CRM_Contact_BAO_Query_Hook
::singleton()->getPanesMapper($panesMapper);
4884 foreach (array_keys($this->_whereTables
) as $table) {
4885 if ($panName = array_search($table, $panesMapper)) {
4886 self
::$_openedPanes[$panName] = TRUE;
4890 return self
::$_openedPanes;
4893 function setOperator($operator) {
4894 $validOperators = array('AND', 'OR');
4895 if (!in_array($operator, $validOperators)) {
4898 $this->_operator
= $operator;
4901 function getOperator() {
4902 return $this->_operator
;
4905 function filterRelatedContacts(&$from, &$where, &$having) {
4906 static $_rTypeProcessed = NULL;
4907 static $_rTypeFrom = NULL;
4908 static $_rTypeWhere = NULL;
4910 if (!$_rTypeProcessed) {
4911 $_rTypeProcessed = TRUE;
4913 // create temp table with contact ids
4914 $tableName = CRM_Core_DAO
::createTempTableName('civicrm_transform', TRUE);
4915 $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
4916 CRM_Core_DAO
::executeQuery($sql);
4919 REPLACE INTO $tableName ( contact_id )
4925 CRM_Core_DAO
::executeQuery($sql);
4927 $qillMessage = ts('Contacts with a Relationship Type of: ');
4928 $rTypes = CRM_Core_PseudoConstant
::relationshipType();
4930 if (is_numeric($this->_displayRelationshipType
)) {
4931 $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType
]['label_a_b'];
4933 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
4934 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
4937 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
4938 AND displayRelType.is_active = 1
4942 list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType
);
4943 if ($dirOne == 'a') {
4944 $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
4946 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
4947 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
4951 $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
4953 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
4954 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
4958 WHERE displayRelType.relationship_type_id = $relType
4959 AND displayRelType.is_active = 1
4962 $this->_qill
[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'";
4965 if (strpos($from, $_rTypeFrom) === FALSE) {
4966 // lets replace all the INNER JOIN's in the $from so we dont exclude other data
4967 // this happens when we have an event_type in the quert (CRM-7969)
4968 $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
4969 $from .= $_rTypeFrom;
4970 $where = $_rTypeWhere;
4976 static function caseImportant( $op ) {
4978 in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ?
FALSE : TRUE;
4981 static function componentPresent( &$returnProperties, $prefix ) {
4982 foreach ($returnProperties as $name => $dontCare ) {
4983 if (substr($name, 0, strlen($prefix)) == $prefix) {
4991 * Builds the necessary structures for all fields that are similar to option value lookups
4993 * @param $name string the name of the field
4994 * @param $op string the sql operator, this function should handle ALL SQL operators
4995 * @param $value any string / integer / array depends on the operator and whos calling the query builder
4996 * @param $grouping int the index where to place the where clause
4997 * @param $selectValues
4998 * @param $field array an array that contains various properties of the field identified by $name
4999 * @param $label string The label for this field element
5000 * @param $dataType string The data type for this element
5002 * @param bool $useIDsOnly
5004 * @internal param array $selectValue the key value pairs for this element. This allows us to use this function for things besides option-value pairs
5005 * @return void adds the where clause and qill to the query object
5007 function optionValueQuery(
5015 $dataType = 'String',
5019 if (!empty($selectValues)) {
5020 $qill = $selectValues[$value];
5026 $pseudoFields = array('email_greeting', 'postal_greeting', 'addressee', 'gender_id', 'prefix_id', 'suffix_id');
5028 if (is_numeric($value)) {
5029 $qill = $selectValues[(int ) $value];
5031 elseif ($op == 'IN' ||
$op == 'NOT IN') {
5032 $values = self
::parseSearchBuilderString($value);
5033 if (is_array($values)) {
5035 $newValues = array();
5036 foreach ($values as $v) {
5037 $intVals[] = (int) $v;
5038 $newValues[] = $selectValues[(int ) $v];
5041 $value = (in_array($name, $pseudoFields)) ?
$intVals : $newValues;
5042 $qill = implode(', ', $newValues);
5045 elseif (!array_key_exists($value, $selectValues)) {
5046 // its a string, lets get the int value
5047 $value = array_search($value, $selectValues);
5050 list($tableName, $fieldName) = explode('.', $field['where'], 2);
5051 if ($tableName == 'civicrm_contact') {
5052 $wc = "contact_a.$fieldName";
5056 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
5059 if (in_array($name, $pseudoFields)) {
5060 if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id'))) {
5061 $wc = "contact_a.{$name}_id";
5063 $dataType = 'Positive';
5064 $value = (!$value) ?
0 : $value;
5067 $this->_qill
[$grouping][] = $label . " $op '$qill'";
5068 $op = (in_array($name, $pseudoFields) && ($op == 'LIKE' ||
$op == 'RLIKE')) ?
'=' : $op;
5069 $this->_where
[$grouping][] = self
::buildClause($wc, $op, $value, $dataType);
5073 * function to check and explode a user defined numeric string into an array
5074 * this was the protocol used by search builder in the old old days before we had
5075 * super nice js widgets to do the hard work
5077 * @param the $string
5078 * @param string $dataType the dataType we should check for the values, default integer
5080 * @return FALSE if string does not match the patter
5081 * array of numeric values if string does match the pattern
5084 static function parseSearchBuilderString($string, $dataType = 'Integer') {
5085 $string = trim($string);
5086 if (substr($string, 0, 1) != '(' ||
substr($string, -1, 1) != ')') {
5090 $string = substr($string, 1, -1);
5091 $values = explode(',', $string);
5092 if (empty($values)) {
5096 $returnValues = array();
5097 foreach ($values as $v) {
5098 if ($dataType == 'Integer' && ! is_numeric($v)) {
5101 else if ($dataType == 'String' && ! is_string($v)) {
5104 $returnValues[] = trim($v);
5107 if (empty($returnValues)) {
5111 return $returnValues;
5115 * convert the pseudo constants id's to their names
5117 * @param reference parameter $dao
5118 * @param bool $return
5122 function convertToPseudoNames(&$dao, $return = FALSE) {
5123 if (empty($this->_pseudoConstantsSelect
)) {
5127 foreach ($this->_pseudoConstantsSelect
as $key => $value) {
5128 if (CRM_Utils_Array
::value('sorting', $this->_pseudoConstantsSelect
[$key])) {
5132 if (property_exists($dao, $value['idCol'])) {
5133 $val = $dao->$value['idCol'];
5135 if (CRM_Utils_System
::isNull($val)) {
5138 elseif ($baoName = CRM_Utils_Array
::value('bao', $value, NULL)) {
5140 $idColumn = "{$key}_id";
5141 $dao->$idColumn = $val;
5142 $dao->$key = CRM_Core_PseudoConstant
::getLabel($baoName, $value['pseudoField'], $val);
5144 elseif ($value['pseudoField'] == 'state_province_abbreviation') {
5145 $dao->$key = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($val);
5148 $labels = CRM_Core_OptionGroup
::values($value['pseudoField']);
5149 $dao->$key = $labels[$val];
5152 // return converted values in array format
5154 if (strpos($key, '-') !== FALSE) {
5155 $keyVal = explode('-', $key);
5156 $current = &$values;
5157 $lastElement = array_pop($keyVal);
5158 foreach ($keyVal as $v) {
5159 if (!array_key_exists($v, $current)) {
5160 $current[$v] = array();
5162 $current = &$current[$v];
5164 $current[$lastElement] = $dao->$key;
5167 $values[$key] = $dao->$key;
5176 * include pseudo fields LEFT JOIN
5177 * @param $sort can be a object or string
5181 function includePseudoFieldsJoin($sort) {
5182 if (!$sort ||
empty($this->_pseudoConstantsSelect
)) {
5185 $sort = is_string($sort) ?
$sort : $sort->orderBy();
5188 foreach ($this->_pseudoConstantsSelect
as $name => $value) {
5189 if (CRM_Utils_Array
::value('table', $value)) {
5190 $regex = "/({$value['table']}\.|{$name})/";
5191 if (preg_match($regex, $sort)) {
5192 $this->_elemnt
[$value['element']] = 1;
5193 $this->_select
[$value['element']] = $value['select'];
5194 $this->_pseudoConstantsSelect
[$name]['sorting'] = 1;
5195 $present[$value['table']] = $value['join'];
5199 $presentSimpleFrom = $present;
5201 if (array_key_exists('civicrm_worldregion', $this->_whereTables
) &&
5202 array_key_exists('civicrm_country', $presentSimpleFrom)) {
5203 unset($presentSimpleFrom['civicrm_country']);
5205 if (array_key_exists('civicrm_worldregion', $this->_tables
) &&
5206 array_key_exists('civicrm_country', $present)) {
5207 unset($present['civicrm_country']);
5210 $presentClause = $presentSimpleFromClause = NULL;
5211 if (!empty($present)) {
5212 $presentClause = implode(' ', $present);
5214 if (!empty($presentSimpleFrom)) {
5215 $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
5218 $this->_fromClause
= $this->_fromClause
. $presentClause;
5219 $this->_simpleFromClause
= $this->_simpleFromClause
. $presentSimpleFromClause;
5221 return array($presentClause, $presentSimpleFromClause);