3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
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;
326 public $_rowCountClause;
329 * use groupBy component clause for component searches
333 public $_groupByComponentClause;
336 * Track open panes, useful in advance search
341 public static $_openedPanes = array();
344 * For search builder - which custom fields are location-dependent
347 public $_locationSpecificCustomFields = array();
350 * The tables which have a dependency on location and/or address
355 static $_dependencies = array(
356 'civicrm_state_province' => 1,
357 'civicrm_country' => 1,
358 'civicrm_county' => 1,
359 'civicrm_address' => 1,
360 'civicrm_location_type' => 1,
364 * List of location specific fields
366 static $_locationSpecificFields = array(
371 'supplemental_address_1',
372 'supplemental_address_2',
375 'postal_code_suffix',
388 * Rememeber if we handle either end of a number or date range
389 * so we can skip the other
391 protected $_rangeCache = array();
393 * Set to true when $this->relationship is run to avoid adding twice
396 protected $_relationshipValuesAdded = FALSE;
399 * Set to the name of the temp table if one has been created
402 static $_relationshipTempTable = NULL;
404 public $_pseudoConstantsSelect = array();
407 * class constructor which also does all the work
409 * @param array $params
410 * @param array $returnProperties
411 * @param array $fields
412 * @param boolean $includeContactIds
413 * @param boolean $strict
414 * @param boolean $mode - mode the search is operating on
419 function __construct(
420 $params = NULL, $returnProperties = NULL, $fields = NULL,
421 $includeContactIds = FALSE, $strict = FALSE, $mode = 1,
422 $skipPermission = FALSE, $searchDescendentGroups = TRUE,
423 $smartGroupCache = TRUE, $displayRelationshipType = NULL,
426 $this->_params
= &$params;
427 if ($this->_params
== NULL) {
428 $this->_params
= array();
431 if (empty($returnProperties)) {
432 $this->_returnProperties
= self
::defaultReturnProperties($mode);
435 $this->_returnProperties
= &$returnProperties;
438 $this->_includeContactIds
= $includeContactIds;
439 $this->_strict
= $strict;
440 $this->_mode
= $mode;
441 $this->_skipPermission
= $skipPermission;
442 $this->_smartGroupCache
= $smartGroupCache;
443 $this->_displayRelationshipType
= $displayRelationshipType;
444 $this->setOperator($operator);
447 $this->_fields
= &$fields;
448 $this->_search
= FALSE;
449 $this->_skipPermission
= TRUE;
452 $this->_fields
= CRM_Contact_BAO_Contact
::exportableFields('All', FALSE, TRUE, TRUE);
454 $fields = CRM_Core_Component
::getQueryFields();
455 unset($fields['note']);
456 $this->_fields
= array_merge($this->_fields
, $fields);
458 // add activity fields
459 $fields = CRM_Activity_BAO_Activity
::exportableFields();
460 $this->_fields
= array_merge($this->_fields
, $fields);
462 // add any fields provided by hook implementers
463 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
464 $this->_fields
= array_merge($this->_fields
, $extFields);
467 // basically do all the work once, and then reuse it
472 * function which actually does all the work for the constructor
477 function initialize() {
478 $this->_select
= array();
479 $this->_element
= array();
480 $this->_tables
= array();
481 $this->_whereTables
= array();
482 $this->_where
= array();
483 $this->_qill
= array();
484 $this->_options
= array();
485 $this->_cfIDs
= array();
486 $this->_paramLookup
= array();
487 $this->_having
= array();
489 $this->_customQuery
= NULL;
491 // reset cached static variables - CRM-5803
492 self
::$_activityRole = NULL;
493 self
::$_considerCompActivities = NULL;
494 self
::$_withContactActivitiesOnly = NULL;
496 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
497 $this->_element
['contact_id'] = 1;
498 $this->_tables
['civicrm_contact'] = 1;
500 if (!empty($this->_params
)) {
501 $this->buildParamsLookup();
504 $this->_whereTables
= $this->_tables
;
506 $this->selectClause();
507 $this->_whereClause
= $this->whereClause();
509 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
510 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
512 $this->openedSearchPanes(TRUE);
515 function buildParamsLookup() {
516 // first fix and handle contact deletion nicely
517 // this code is primarily for search builder use case
518 // where different clauses can specify if they want deleted
521 $trashParamExists = FALSE;
522 $paramByGroup = array();
523 foreach ( $this->_params
as $k => $param ) {
524 if (!empty($param[0]) && $param[0] == 'contact_is_deleted' ) {
525 $trashParamExists = TRUE;
527 if (!empty($param[3])) {
528 $paramByGroup[$param[3]][$k] = $param;
532 if ( $trashParamExists ) {
533 $this->_skipDeleteClause
= TRUE;
535 //cycle through group sets and explicitly add trash param if not set
536 foreach ( $paramByGroup as $setID => $set ) {
538 !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params
) &&
539 !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params
) ) {
540 $this->_params
[] = array(
541 'contact_is_deleted',
551 foreach ($this->_params
as $value) {
552 if (empty($value[0])) {
555 $cfID = CRM_Core_BAO_CustomField
::getKeyID($value[0]);
557 if (!array_key_exists($cfID, $this->_cfIDs
)) {
558 $this->_cfIDs
[$cfID] = array();
560 $this->_cfIDs
[$cfID][] = $value;
563 if (!array_key_exists($value[0], $this->_paramLookup
)) {
564 $this->_paramLookup
[$value[0]] = array();
566 $this->_paramLookup
[$value[0]][] = $value;
571 * Some composite fields do not appear in the fields array
572 * hack to make them part of the query
577 function addSpecialFields() {
578 static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name');
579 foreach ($special as $name) {
580 if (!empty($this->_returnProperties
[$name])) {
581 $this->_select
[$name] = "contact_a.{$name} as $name";
582 $this->_element
[$name] = 1;
588 * Given a list of conditions in params and a list of desired
589 * return Properties generate the required select and from
590 * clauses. Note that since the where clause introduces new
591 * tables, the initial attempt also retrieves all variables used
597 function selectClause() {
599 $this->addSpecialFields();
601 foreach ($this->_fields
as $name => $field) {
602 // skip component fields
603 // there are done by the alter query below
604 // and need not be done on every field
606 (substr($name, 0, 12) == 'participant_') ||
607 (substr($name, 0, 7) == 'pledge_') ||
608 (substr($name, 0, 5) == 'case_')
613 // redirect to activity select clause
614 if (substr($name, 0, 9) == 'activity_') {
615 CRM_Activity_BAO_Query
::select($this);
619 // if this is a hierarchical name, we ignore it
620 $names = explode('-', $name);
621 if (count($names) > 1 && isset($names[1]) && is_numeric($names[1])) {
625 // make an exception for special cases, to add the field in select clause
626 $makeException = FALSE;
628 //special handling for groups/tags
629 if (in_array($name, array('groups', 'tags', 'notes'))
630 && isset($this->_returnProperties
[substr($name, 0, -1)])
632 $makeException = TRUE;
635 // since note has 3 different options we need special handling
636 // note / note_subject / note_body
637 if ($name == 'notes') {
638 foreach (array('note', 'note_subject', 'note_body') as $noteField) {
639 if (isset($this->_returnProperties
[$noteField])) {
640 $makeException = TRUE;
646 if (in_array($name, array('prefix_id', 'suffix_id', 'gender_id'))) {
647 if (CRM_Utils_Array
::value($field['pseudoconstant']['optionGroupName'], $this->_returnProperties
)) {
648 $makeException = TRUE;
652 $cfID = CRM_Core_BAO_CustomField
::getKeyID($name);
653 if (!empty($this->_paramLookup
[$name]) ||
!empty($this->_returnProperties
[$name]) ||
657 // add to cfIDs array if not present
658 if (!array_key_exists($cfID, $this->_cfIDs
)) {
659 $this->_cfIDs
[$cfID] = array();
662 elseif (isset($field['where'])) {
663 list($tableName, $fieldName) = explode('.', $field['where'], 2);
664 if (isset($tableName)) {
665 if (CRM_Utils_Array
::value($tableName, self
::$_dependencies)) {
666 $this->_tables
['civicrm_address'] = 1;
667 $this->_select
['address_id'] = 'civicrm_address.id as address_id';
668 $this->_element
['address_id'] = 1;
671 if ($tableName == 'im_provider' ||
$tableName == 'email_greeting' ||
672 $tableName == 'postal_greeting' ||
$tableName == 'addressee'
674 if ($tableName == 'im_provider') {
675 CRM_Core_OptionValue
::select($this);
678 if (in_array($tableName,
679 array('email_greeting', 'postal_greeting', 'addressee'))) {
680 $this->_element
["{$name}_id"] = 1;
681 $this->_select
["{$name}_id"] = "contact_a.{$name}_id as {$name}_id";
682 $this->_pseudoConstantsSelect
[$name] = array('pseudoField' => $tableName, 'idCol' => "{$name}_id");
683 $this->_pseudoConstantsSelect
[$name]['select'] = "{$name}.{$fieldName} as $name";
684 $this->_pseudoConstantsSelect
[$name]['element'] = $name;
686 if ($tableName == 'email_greeting') {
687 $this->_pseudoConstantsSelect
[$name]['join'] =
688 " LEFT JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')";
689 $this->_pseudoConstantsSelect
[$name]['join'] .=
690 " LEFT JOIN civicrm_option_value email_greeting ON (contact_a.email_greeting_id = email_greeting.value AND option_group_email_greeting.id = email_greeting.option_group_id ) ";
692 elseif ($tableName == 'postal_greeting') {
693 $this->_pseudoConstantsSelect
[$name]['join'] =
694 " LEFT JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')";
695 $this->_pseudoConstantsSelect
[$name]['join'] .=
696 " LEFT JOIN civicrm_option_value postal_greeting ON (contact_a.postal_greeting_id = postal_greeting.value AND option_group_postal_greeting.id = postal_greeting.option_group_id ) ";
698 elseif ($tableName == 'addressee') {
699 $this->_pseudoConstantsSelect
[$name]['join'] =
700 " LEFT JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')";
701 $this->_pseudoConstantsSelect
[$name]['join'] .=
702 " LEFT JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) ";
704 $this->_pseudoConstantsSelect
[$name]['table'] = $tableName;
707 $greetField = "{$name}_display";
708 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
709 $this->_element
[$greetField] = 1;
711 $greetField = "{$name}_custom";
712 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
713 $this->_element
[$greetField] = 1;
717 if (!in_array($tableName, array('civicrm_state_province', 'civicrm_country', 'civicrm_county'))) {
718 $this->_tables
[$tableName] = 1;
721 // also get the id of the tableName
722 $tName = substr($tableName, 8);
723 if (in_array($tName, array('country', 'state_province', 'county'))) {
724 if ($tName == 'state_province') {
725 $this->_pseudoConstantsSelect
['state_province_name'] =
726 array('pseudoField' => "{$tName}", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address',
727 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ");
729 $this->_pseudoConstantsSelect
[$tName] =
730 array('pseudoField' => 'state_province_abbreviation', 'idCol' => "{$tName}_id",
731 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ");
734 $this->_pseudoConstantsSelect
[$name] =
735 array('pseudoField' => "{$tName}_id", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address',
736 'table' => "civicrm_{$tName}", 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ");
739 $this->_select
["{$tName}_id"] = "civicrm_address.{$tName}_id as {$tName}_id";
740 $this->_element
["{$tName}_id"] = 1;
742 elseif ($tName != 'contact') {
743 $this->_select
["{$tName}_id"] = "{$tableName}.id as {$tName}_id";
744 $this->_element
["{$tName}_id"] = 1;
747 //special case for phone
748 if ($name == 'phone') {
749 $this->_select
['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id";
750 $this->_element
['phone_type_id'] = 1;
753 // if IM then select provider_id also
754 // to get "IM Service Provider" in a file to be exported, CRM-3140
756 $this->_select
['provider_id'] = "civicrm_im.provider_id as provider_id";
757 $this->_element
['provider_id'] = 1;
760 if ($tName == 'contact') {
761 // special case, when current employer is set for Individual contact
762 if ($fieldName == 'organization_name') {
763 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name";
765 elseif ($fieldName != 'id') {
766 if ($fieldName == 'prefix_id') {
767 $this->_pseudoConstantsSelect
['individual_prefix'] = array('pseudoField' => 'prefix_id', 'idCol' => "prefix_id", 'bao' => 'CRM_Contact_BAO_Contact');
769 if ($fieldName == 'suffix_id') {
770 $this->_pseudoConstantsSelect
['individual_suffix'] = array('pseudoField' => 'suffix_id', 'idCol' => "suffix_id", 'bao' => 'CRM_Contact_BAO_Contact');
772 if ($fieldName == 'gender_id') {
773 $this->_pseudoConstantsSelect
['gender'] = array('pseudoField' => 'gender_id', 'idCol' => "gender_id", 'bao' => 'CRM_Contact_BAO_Contact');
775 if ($name == 'communication_style_id') {
776 $this->_pseudoConstantsSelect
['communication_style'] = array('pseudoField' => 'communication_style_id', 'idCol' => "communication_style_id", 'bao' => 'CRM_Contact_BAO_Contact');
778 $this->_select
[$name] = "contact_a.{$fieldName} as `$name`";
781 elseif (in_array($tName, array('country', 'county'))) {
782 $this->_pseudoConstantsSelect
[$name]['select'] = "{$field['where']} as `$name`";
783 $this->_pseudoConstantsSelect
[$name]['element'] = $name;
785 elseif ($tName == 'state_province') {
786 $this->_pseudoConstantsSelect
[$tName]['select'] = "{$field['where']} as `$name`";
787 $this->_pseudoConstantsSelect
[$tName]['element'] = $name;
790 $this->_select
[$name] = "{$field['where']} as `$name`";
792 if (!in_array($tName, array('state_province', 'country', 'county'))) {
793 $this->_element
[$name] = 1;
798 elseif ($name === 'tags') {
799 $this->_useGroupBy
= TRUE;
800 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags";
801 $this->_element
[$name] = 1;
802 $this->_tables
['civicrm_tag'] = 1;
803 $this->_tables
['civicrm_entity_tag'] = 1;
805 elseif ($name === 'groups') {
806 $this->_useGroupBy
= TRUE;
807 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_group.title)) as groups";
808 $this->_element
[$name] = 1;
809 $this->_tables
['civicrm_group'] = 1;
811 elseif ($name === 'notes') {
812 // if note field is subject then return subject else body of the note
813 $noteColumn = 'note';
814 if (isset($noteField) && $noteField == 'note_subject') {
815 $noteColumn = 'subject';
818 $this->_useGroupBy
= TRUE;
819 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.$noteColumn)) as notes";
820 $this->_element
[$name] = 1;
821 $this->_tables
['civicrm_note'] = 1;
823 elseif ($name === 'current_employer') {
824 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer";
825 $this->_element
[$name] = 1;
829 if ($cfID && !empty($field['is_search_range'])) {
830 // this is a custom field with range search enabled, so we better check for two/from values
831 if (!empty($this->_paramLookup
[$name . '_from'])) {
832 if (!array_key_exists($cfID, $this->_cfIDs
)) {
833 $this->_cfIDs
[$cfID] = array();
835 foreach ($this->_paramLookup
[$name . '_from'] as $pID => $p) {
836 // search in the cdID array for the same grouping
838 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
839 if ($c[3] == $p[3]) {
840 $this->_cfIDs
[$cfID][$cID][2]['from'] = $p[2];
845 $p[2] = array('from' => $p[2]);
846 $this->_cfIDs
[$cfID][] = $p;
850 if (!empty($this->_paramLookup
[$name . '_to'])) {
851 if (!array_key_exists($cfID, $this->_cfIDs
)) {
852 $this->_cfIDs
[$cfID] = array();
854 foreach ($this->_paramLookup
[$name . '_to'] as $pID => $p) {
855 // search in the cdID array for the same grouping
857 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
858 if ($c[4] == $p[4]) {
859 $this->_cfIDs
[$cfID][$cID][2]['to'] = $p[2];
864 $p[2] = array('to' => $p[2]);
865 $this->_cfIDs
[$cfID][] = $p;
872 // add location as hierarchical elements
873 $this->addHierarchicalElements();
875 // add multiple field like website
876 $this->addMultipleElements();
879 CRM_Core_Component
::alterQuery($this, 'select');
881 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'select');
883 if (!empty($this->_cfIDs
)) {
884 $this->_customQuery
= new CRM_Core_BAO_CustomQuery($this->_cfIDs
, TRUE, $this->_locationSpecificCustomFields
);
885 $this->_customQuery
->query();
886 $this->_select
= array_merge($this->_select
, $this->_customQuery
->_select
);
887 $this->_element
= array_merge($this->_element
, $this->_customQuery
->_element
);
888 $this->_tables
= array_merge($this->_tables
, $this->_customQuery
->_tables
);
889 $this->_whereTables
= array_merge($this->_whereTables
, $this->_customQuery
->_whereTables
);
890 $this->_options
= $this->_customQuery
->_options
;
895 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
901 function addHierarchicalElements() {
902 if (empty($this->_returnProperties
['location'])) {
905 if (!is_array($this->_returnProperties
['location'])) {
909 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
910 $processed = array();
913 $addressCustomFields = CRM_Core_BAO_CustomField
::getFieldsForImport('Address');
914 $addressCustomFieldIds = array();
916 foreach ($this->_returnProperties
['location'] as $name => $elements) {
917 $lCond = self
::getPrimaryCondition($name);
920 $locationTypeId = array_search($name, $locationTypes);
921 if ($locationTypeId === FALSE) {
924 $lCond = "location_type_id = $locationTypeId";
925 $this->_useDistinct
= TRUE;
927 //commented for CRM-3256
928 $this->_useGroupBy
= TRUE;
931 $name = str_replace(' ', '_', $name);
933 $tName = "$name-location_type";
934 $ltName = "`$name-location_type`";
935 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
936 $this->_select
["{$tName}"] = "`$tName`.name as `{$tName}`";
937 $this->_element
["{$tName}_id"] = 1;
938 $this->_element
["{$tName}"] = 1;
940 $locationTypeName = $tName;
941 $locationTypeJoin = array();
945 foreach ($elements as $elementFullName => $dontCare) {
947 $elementName = $elementCmpName = $elementFullName;
949 if (substr($elementCmpName, 0, 5) == 'phone') {
950 $elementCmpName = 'phone';
953 if (in_array($elementCmpName, array_keys($addressCustomFields))) {
954 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($elementCmpName)) {
955 $addressCustomFieldIds[$cfID][$name] = 1;
958 //add address table only once
959 if ((in_array($elementCmpName, self
::$_locationSpecificFields) ||
!empty($addressCustomFieldIds))
961 && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid'))
963 $tName = "$name-address";
964 $aName = "`$name-address`";
965 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
966 $this->_element
["{$tName}_id"] = 1;
967 $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)";
968 $this->_tables
[$tName] = $addressJoin;
969 $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) ";
970 $processed[$aName] = 1;
974 $cond = $elementType = '';
975 if (strpos($elementName, '-') !== FALSE) {
976 // this is either phone, email or IM
977 list($elementName, $elementType) = explode('-', $elementName);
980 if (($elementName != 'phone') && ($elementName != 'im')) {
981 $cond = self
::getPrimaryCondition($elementType);
983 // CRM-13011 : If location type is primary, do not restrict search to the phone
984 // type id - we want the primary phone, regardless of what type it is.
985 // Otherwise, restrict to the specified phone type for the given field.
986 if ((!$cond) && ($elementName == 'phone') && $elements['location_type'] != 'Primary') {
987 $cond = "phone_type_id = '$elementType'";
989 elseif ((!$cond) && ($elementName == 'im')) {
990 // IM service provider id, CRM-3140
991 $cond = "provider_id = '$elementType'";
993 $elementType = '-' . $elementType;
996 $field = CRM_Utils_Array
::value($elementName, $this->_fields
);
998 // hack for profile, add location id
1001 // fix for CRM-882( to handle phone types )
1002 !is_numeric($elementType)
1004 if (is_numeric($name)) {
1005 $field = CRM_Utils_Array
::value($elementName . "-Primary$elementType", $this->_fields
);
1008 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
1011 elseif (is_numeric($name)) {
1012 //this for phone type to work
1013 if (in_array($elementName, array('phone', 'phone_ext'))) {
1014 $field = CRM_Utils_Array
::value($elementName . "-Primary" . $elementType, $this->_fields
);
1017 $field = CRM_Utils_Array
::value($elementName . "-Primary", $this->_fields
);
1021 //this is for phone type to work for profile edit
1022 if (in_array($elementName, array('phone', 'phone_ext'))) {
1023 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
1026 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId", $this->_fields
);
1031 // Check if there is a value, if so also add to where Clause
1033 if ($this->_params
) {
1035 if (isset($locationTypeId)) {
1036 $nm .= "-$locationTypeId";
1038 if (!is_numeric($elementType)) {
1039 $nm .= "$elementType";
1042 foreach ($this->_params
as $id => $values) {
1043 if ((is_array($values) && $values[0] == $nm) ||
1044 (in_array($elementName, array('phone', 'im'))
1045 && (strpos($values[0], $nm) !== FALSE)
1055 if ($field && isset($field['where'])) {
1056 list($tableName, $fieldName) = explode('.', $field['where'], 2);
1057 $pf = substr($tableName, 8);
1058 $tName = $name . '-' . $pf . $elementType;
1059 if (isset($tableName)) {
1060 if ($tableName == 'civicrm_state_province' ||
$tableName == 'civicrm_country' ||
$tableName == 'civicrm_county') {
1061 $this->_select
["{$tName}_id"] = "{$aName}.{$pf}_id as `{$tName}_id`";
1064 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1067 $this->_element
["{$tName}_id"] = 1;
1068 if (substr($tName, -15) == '-state_province') {
1069 // FIXME: hack to fix CRM-1900
1070 $a = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1074 if (substr_count($a, 'state_province_name') > 0) {
1075 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] =
1076 array('pseudoField' => "{$pf}_id", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address');
1077 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.name as `{$name}-{$elementFullName}`";
1080 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] =
1081 array('pseudoField' => 'state_province_abbreviation', 'idCol' => "{$tName}_id");
1082 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`";
1086 if (substr($elementFullName, 0, 2) == 'im') {
1087 $provider = "{$name}-{$elementFullName}-provider_id";
1088 $this->_select
[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`";
1089 $this->_element
[$provider] = 1;
1091 if ($pf == 'country' ||
$pf == 'county') {
1092 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] = array('pseudoField' => "{$pf}_id", 'idCol' => "{$tName}_id", 'bao' => 'CRM_Core_BAO_Address');
1093 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1096 $this->_select
["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1100 if (in_array($pf, array('state_province', 'country', 'county'))) {
1101 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['element'] = "{$name}-{$elementFullName}";
1104 $this->_element
["{$name}-{$elementFullName}"] = 1;
1107 if (empty($processed["`$tName`"])) {
1108 $processed["`$tName`"] = 1;
1109 $newName = $tableName . '_' . $index;
1110 switch ($tableName) {
1111 case 'civicrm_phone':
1112 case 'civicrm_email':
1114 case 'civicrm_openid':
1116 $this->_tables
[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id AND `$tName`.$lCond";
1117 // this special case to add phone type
1119 $phoneTypeCondition = " AND `$tName`.$cond ";
1120 //gross hack to pickup corrupted data also, CRM-7603
1121 if (strpos($cond, 'phone_type_id') !== FALSE) {
1122 $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) ";
1124 $this->_tables
[$tName] .= $phoneTypeCondition;
1127 //build locationType join
1128 $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )";
1131 $this->_whereTables
[$tName] = $this->_tables
[$tName];
1135 case 'civicrm_state_province':
1136 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $tName;
1137 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join'] =
1138 "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id";
1140 $this->_whereTables
["{$name}-address"] = $addressJoin;
1144 case 'civicrm_country':
1145 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1146 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join'] =
1147 "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id";
1149 $this->_whereTables
["{$name}-address"] = $addressJoin;
1153 case 'civicrm_county':
1154 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1155 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join'] =
1156 "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id";
1158 $this->_whereTables
["{$name}-address"] = $addressJoin;
1164 $this->_whereTables
["{$name}-address"] = $addressJoin;
1173 // add location type join
1174 $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )";
1175 $this->_tables
[$locationTypeName] = $ltypeJoin;
1177 // table should be present in $this->_whereTables,
1178 // to add its condition in location type join, CRM-3939.
1179 if ($addWhereCount) {
1180 $locClause = array();
1181 foreach ($this->_whereTables
as $tableName => $clause) {
1182 if (!empty($locationTypeJoin[$tableName])) {
1183 $locClause[] = $locationTypeJoin[$tableName];
1187 if (!empty($locClause)) {
1188 $this->_whereTables
[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )";
1193 if (!empty($addressCustomFieldIds)) {
1194 $customQuery = new CRM_Core_BAO_CustomQuery($addressCustomFieldIds);
1195 foreach ($addressCustomFieldIds as $cfID => $locTypeName) {
1196 foreach ($locTypeName as $name => $dnc) {
1197 $this->_locationSpecificCustomFields
[$cfID] = array($name, array_search($name, $locationTypes));
1198 $fieldName = "$name-custom_{$cfID}";
1199 $tName = "$name-address-custom-{$cfID}";
1200 $aName = "`$name-address-custom-{$cfID}`";
1201 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1202 $this->_element
["{$tName}_id"] = 1;
1203 $this->_select
[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`";
1204 $this->_element
[$fieldName] = 1;
1205 $this->_tables
[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)";
1212 * If the return Properties are set in a hierarchy, traverse the hierarchy to get
1218 function addMultipleElements() {
1219 if (empty($this->_returnProperties
['website'])) {
1222 if (!is_array($this->_returnProperties
['website'])) {
1226 foreach ($this->_returnProperties
['website'] as $key => $elements) {
1227 foreach ($elements as $elementFullName => $dontCare) {
1228 $tName = "website-{$key}-{$elementFullName}";
1229 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1230 $this->_select
["{$tName}"] = "`$tName`.url as `{$tName}`";
1231 $this->_element
["{$tName}_id"] = 1;
1232 $this->_element
["{$tName}"] = 1;
1234 $type = "website-{$key}-website_type_id";
1235 $this->_select
[$type] = "`$tName`.website_type_id as `{$type}`";
1236 $this->_element
[$type] = 1;
1237 $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id AND `$tName`.website_type_id = $key )";
1243 * generate the query based on what type of query we need
1245 * @param boolean $count
1246 * @param boolean $sortByChar
1247 * @param boolean $groupContacts
1249 * @return the sql string for that query (this will most likely
1253 function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE) {
1255 if (isset($this->_rowCountClause
)) {
1256 $select = "SELECT {$this->_rowCountClause}";
1257 } else if (isset($this->_distinctComponentClause
)) {
1258 // we add distinct to get the right count for components
1259 // for the more complex result set, we use GROUP BY the same id
1261 $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} )";
1264 $select = 'SELECT count(DISTINCT contact_a.id) as rowCount';
1266 $from = $this->_simpleFromClause
;
1267 if ($this->_useDistinct
) {
1268 $this->_useGroupBy
= TRUE;
1271 elseif ($sortByChar) {
1272 $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name';
1273 $from = $this->_simpleFromClause
;
1275 elseif ($groupContacts) {
1276 $select = 'SELECT contact_a.id as id';
1277 if ($this->_useDistinct
) {
1278 $this->_useGroupBy
= TRUE;
1280 $from = $this->_simpleFromClause
;
1283 if (!empty($this->_paramLookup
['group'])) {
1284 // make sure there is only one element
1285 // this is used when we are running under smog and need to know
1286 // how the contact was added (CRM-1203)
1287 if ((count($this->_paramLookup
['group']) == 1) &&
1288 (count($this->_paramLookup
['group'][0][2]) == 1)
1290 $groups = array_keys($this->_paramLookup
['group'][0][2]);
1291 $groupId = $groups[0];
1293 //check if group is saved search
1294 $group = new CRM_Contact_BAO_Group();
1295 $group->id
= $groupId;
1298 if (!isset($group->saved_search_id
)) {
1299 $tbName = "`civicrm_group_contact-{$groupId}`";
1300 $this->_select
['group_contact_id'] = "$tbName.id as group_contact_id";
1301 $this->_element
['group_contact_id'] = 1;
1302 $this->_select
['status'] = "$tbName.status as status";
1303 $this->_element
['status'] = 1;
1306 $this->_useGroupBy
= TRUE;
1308 if ($this->_useDistinct
&& !isset($this->_distinctComponentClause
)) {
1309 if (!($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
)) {
1311 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
1312 $this->_useDistinct
= FALSE;
1313 $this->_useGroupBy
= TRUE;
1317 $select = "SELECT ";
1318 if (isset($this->_distinctComponentClause
)) {
1319 $select .= "{$this->_distinctComponentClause}, ";
1321 $select .= implode(', ', $this->_select
);
1322 $from = $this->_fromClause
;
1326 if (!empty($this->_whereClause
)) {
1327 $where = "WHERE {$this->_whereClause}";
1331 if (!empty($this->_having
)) {
1332 foreach ($this->_having
as $havingsets) {
1333 foreach ($havingsets as $havingset) {
1334 $havingvalue[] = $havingset;
1337 $having = ' HAVING ' . implode(' AND ', $havingvalue);
1340 // if we are doing a transform, do it here
1341 // use the $from, $where and $having to get the contact ID
1342 if ($this->_displayRelationshipType
) {
1343 $this->filterRelatedContacts($from, $where, $having);
1346 return array($select, $from, $where, $having);
1349 function &getWhereValues($name, $grouping) {
1351 foreach ($this->_params
as $values) {
1352 if ($values[0] == $name && $values[3] == $grouping) {
1360 static function fixDateValues($relative, &$from, &$to) {
1362 list($from, $to) = CRM_Utils_Date
::getFromTo($relative, $from, $to);
1366 static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE) {
1368 if (empty($formValues)) {
1372 foreach ($formValues as $id => $values) {
1373 if ($id == 'privacy') {
1374 if (is_array($formValues['privacy'])) {
1375 $op = !empty($formValues['privacy']['do_not_toggle']) ?
'=' : '!=';
1376 foreach ($formValues['privacy'] as $key => $value) {
1378 $params[] = array($key, $op, $value, 0, 0);
1383 elseif ($id == 'email_on_hold') {
1384 if ($formValues['email_on_hold']['on_hold']) {
1385 $params[] = array('on_hold', '=', $formValues['email_on_hold']['on_hold'], 0, 0);
1388 elseif (preg_match('/_date_relative$/', $id) ||
1389 $id == 'event_relative' ||
1390 $id == 'case_from_relative' ||
1391 $id == 'case_to_relative'
1393 if ($id == 'event_relative') {
1394 $fromRange = 'event_start_date_low';
1395 $toRange = 'event_end_date_high';
1397 else if ($id == 'case_from_relative') {
1398 $fromRange = 'case_from_start_date_low';
1399 $toRange = 'case_from_start_date_high';
1401 else if ($id == 'case_to_relative') {
1402 $fromRange = 'case_to_end_date_low';
1403 $toRange = 'case_to_end_date_high';
1406 $dateComponent = explode('_date_relative', $id);
1407 $fromRange = "{$dateComponent[0]}_date_low";
1408 $toRange = "{$dateComponent[0]}_date_high";
1411 if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) {
1412 CRM_Contact_BAO_Query
::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]);
1417 $values = CRM_Contact_BAO_Query
::fixWhereValues($id, $values, $wildcard, $useEquals);
1422 $params[] = $values;
1428 static function &fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE) {
1429 // skip a few search variables
1430 static $skipWhere = NULL;
1431 static $arrayValues = NULL;
1432 static $likeNames = NULL;
1435 if (CRM_Utils_System
::isNull($values)) {
1441 'task', 'radio_ts', 'uf_group_id',
1442 'component_mode', 'qfKey', 'operator',
1443 'display_relationship_type',
1447 if (in_array($id, $skipWhere) ||
1448 substr($id, 0, 4) == '_qf_' ||
1449 substr($id, 0, 7) == 'hidden_'
1455 $likeNames = array('sort_name', 'email', 'note', 'display_name');
1458 // email comes in via advanced search
1459 // so use wildcard always
1460 if ($id == 'email') {
1464 if (!$useEquals && in_array($id, $likeNames)) {
1465 $result = array($id, 'LIKE', $values, 0, 1);
1467 elseif (is_string($values) && strpos($values, '%') !== FALSE) {
1468 $result = array($id, 'LIKE', $values, 0, 0);
1470 elseif ($id == 'group') {
1471 if (is_array($values)) {
1472 foreach ($values as $groupIds => $val) {
1474 if (preg_match('/-(\d+)$/', $groupIds, $matches)) {
1475 if (strlen($matches[1]) > 0) {
1476 $values[$matches[1]] = 1;
1477 unset($values[$groupIds]);
1483 $groupIds = explode(',', $values);
1485 foreach ($groupIds as $groupId) {
1486 $values[$groupId] = 1;
1490 $result = array($id, 'IN', $values, 0, 0);
1492 elseif ($id == 'contact_tags' ||
$id == 'tag') {
1493 if (!is_array($values)) {
1494 $tagIds = explode(',', $values);
1496 foreach ($tagIds as $tagId) {
1497 $values[$tagId] = 1;
1500 $result = array($id, 'IN', $values, 0, 0);
1503 $result = array($id, '=', $values, 0, $wildcard);
1509 function whereClauseSingle(&$values) {
1510 // do not process custom fields or prefixed contact ids or component params
1511 if (CRM_Core_BAO_CustomField
::getKeyID($values[0]) ||
1512 (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) ||
1513 (substr($values[0], 0, 13) == 'contribution_') ||
1514 (substr($values[0], 0, 6) == 'event_') ||
1515 (substr($values[0], 0, 12) == 'participant_') ||
1516 (substr($values[0], 0, 7) == 'member_') ||
1517 (substr($values[0], 0, 6) == 'grant_') ||
1518 (substr($values[0], 0, 7) == 'pledge_') ||
1519 (substr($values[0], 0, 5) == 'case_') ||
1520 (substr($values[0], 0, 10) == 'financial_') ||
1521 (substr($values[0], 0, 11) == 'membership_')
1526 // skip for hook injected fields / params
1527 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
1528 if (array_key_exists($values[0], $extFields)) {
1532 switch ($values[0]) {
1533 case 'deleted_contacts':
1534 $this->deletedContacts($values);
1537 case 'contact_type':
1538 $this->contactType($values);
1541 case 'contact_sub_type':
1542 $this->contactSubType($values);
1546 $this->group($values);
1550 // so we resolve this into a list of groups & proceed as if they had been
1552 list($name, $op, $value, $grouping, $wildcard) = $values;
1553 $values[0] = 'group';
1555 $this->_paramLookup
['group'][0][0] ='group';
1556 $this->_paramLookup
['group'][0][1] = 'IN';
1557 $this->_paramLookup
['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value);
1558 $this->group($values);
1561 // case tag comes from find contacts
1563 $this->tagSearch($values);
1567 case 'contact_tags':
1568 $this->tag($values);
1573 case 'note_subject':
1574 $this->notes($values);
1578 $this->ufUser($values);
1582 case 'display_name':
1583 $this->sortName($values);
1587 $this->email($values);
1590 case 'phone_numeric':
1591 $this->phone_numeric($values);
1594 case 'phone_phone_type_id':
1595 case 'phone_location_type_id':
1596 $this->phone_option_group($values);
1599 case 'street_address':
1600 $this->street_address($values);
1603 case 'street_number':
1604 $this->street_number($values);
1607 case 'sortByCharacter':
1608 $this->sortByCharacter($values);
1611 case 'location_type':
1612 $this->locationType($values);
1616 $this->county($values);
1619 case 'state_province':
1620 $this->stateProvince($values);
1624 $this->country($values, FALSE);
1628 case 'postal_code_low':
1629 case 'postal_code_high':
1630 $this->postalCode($values);
1633 case 'activity_date':
1634 case 'activity_date_low':
1635 case 'activity_date_high':
1636 case 'activity_role':
1637 case 'activity_status':
1638 case 'activity_subject':
1639 case 'test_activities':
1640 case 'activity_type_id':
1641 case 'activity_type':
1642 case 'activity_survey_id':
1643 case 'activity_tags':
1644 case 'activity_taglist':
1645 case 'activity_test':
1646 case 'activity_campaign_id':
1647 case 'activity_engagement_level':
1649 case 'activity_result':
1650 case 'source_contact':
1651 CRM_Activity_BAO_Query
::whereClauseSingle($values, $this);
1654 case 'birth_date_low':
1655 case 'birth_date_high':
1656 case 'deceased_date_low':
1657 case 'deceased_date_high':
1658 $this->demographics($values);
1661 case 'log_date_low':
1662 case 'log_date_high':
1663 $this->modifiedDates($values);
1667 $this->changeLog($values);
1670 case 'do_not_phone':
1671 case 'do_not_email':
1674 case 'do_not_trade':
1676 $this->privacy($values);
1679 case 'privacy_options':
1680 $this->privacyOptions($values);
1683 case 'privacy_operator':
1684 case 'privacy_toggle':
1685 // these are handled by privacy options
1688 case 'preferred_communication_method':
1689 $this->preferredCommunication($values);
1692 case 'relation_type_id':
1693 case 'relation_start_date_high':
1694 case 'relation_start_date_low':
1695 case 'relation_end_date_high':
1696 case 'relation_end_date_low':
1697 case 'relation_target_name':
1698 case 'relation_status':
1699 case 'relation_date_low':
1700 case 'relation_date_high':
1701 $this->relationship($values);
1702 $this->_relationshipValuesAdded
= TRUE;
1705 case 'task_status_id':
1706 $this->task($values);
1710 // since this case is handled with the above
1713 case 'prox_distance':
1714 CRM_Contact_BAO_ProximityQuery
::process($this, $values);
1717 case 'prox_street_address':
1719 case 'prox_postal_code':
1720 case 'prox_state_province_id':
1721 case 'prox_country_id':
1722 // handled by the proximity_distance clause
1726 $this->restWhere($values);
1732 * Given a list of conditions in params generate the required
1738 function whereClause() {
1739 $this->_where
[0] = array();
1740 $this->_qill
[0] = array();
1742 $this->includeContactIds();
1743 if (!empty($this->_params
)) {
1744 foreach (array_keys($this->_params
) as $id) {
1745 if (empty($this->_params
[$id][0])) {
1748 // check for both id and contact_id
1749 if ($this->_params
[$id][0] == 'id' ||
$this->_params
[$id][0] == 'contact_id') {
1751 $this->_params
[$id][1] == 'IS NULL' ||
1752 $this->_params
[$id][1] == 'IS NOT NULL'
1754 $this->_where
[0][] = "contact_a.id {$this->_params[$id][1]}";
1756 elseif (is_array($this->_params
[$id][2])) {
1757 $idList = implode("','", $this->_params
[$id][2]);
1758 //why on earth do they put ' in the middle & not on the outside? We have to assume it's
1759 //to support 'something' so lets add them conditionally to support the api (which is a tested flow
1760 // so if you are looking to alter this check api test results
1761 if(strpos(trim($idList), "'") > 0) {
1762 $idList = "'" . $idList . "'";
1765 $this->_where
[0][] = "contact_a.id IN ({$idList})";
1768 $this->_where
[0][] = "contact_a.id {$this->_params[$id][1]} {$this->_params[$id][2]}";
1772 $this->whereClauseSingle($this->_params
[$id]);
1776 CRM_Core_Component
::alterQuery($this, 'where');
1778 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'where');
1781 if ($this->_customQuery
) {
1782 // Added following if condition to avoid the wrong value diplay for 'myaccount' / any UF info.
1783 // Hope it wont affect the other part of civicrm.. if it does please remove it.
1784 if (!empty($this->_customQuery
->_where
)) {
1785 $this->_where
= CRM_Utils_Array
::crmArrayMerge($this->_where
, $this->_customQuery
->_where
);
1788 $this->_qill
= CRM_Utils_Array
::crmArrayMerge($this->_qill
, $this->_customQuery
->_qill
);
1792 $andClauses = array();
1795 if (!empty($this->_where
)) {
1796 foreach ($this->_where
as $grouping => $values) {
1797 if ($grouping > 0 && !empty($values)) {
1798 $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
1803 if (!empty($this->_where
[0])) {
1804 $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where
[0]) . ' ) ';
1806 if (!empty($clauses)) {
1807 $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
1810 if ($validClauses > 1) {
1811 $this->_useDistinct
= TRUE;
1815 return implode(' AND ', $andClauses);
1818 function restWhere(&$values) {
1819 $name = CRM_Utils_Array
::value(0, $values);
1820 $op = CRM_Utils_Array
::value(1, $values);
1821 $value = CRM_Utils_Array
::value(2, $values);
1822 $grouping = CRM_Utils_Array
::value(3, $values);
1823 $wildcard = CRM_Utils_Array
::value(4, $values);
1825 if (isset($grouping) && empty($this->_where
[$grouping])) {
1826 $this->_where
[$grouping] = array();
1829 $multipleFields = array('url');
1831 //check if the location type exits for fields
1833 $locType = explode('-', $name);
1835 if (!in_array($locType[0], $multipleFields)) {
1836 //add phone type if exists
1837 if (isset($locType[2]) && $locType[2]) {
1838 $locType[2] = CRM_Core_DAO
::escapeString($locType[2]);
1842 $field = CRM_Utils_Array
::value($name, $this->_fields
);
1845 $field = CRM_Utils_Array
::value($locType[0], $this->_fields
);
1854 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
1855 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
1857 if (substr($name, 0, 14) === 'state_province') {
1858 if (isset($locType[1]) && is_numeric($locType[1])) {
1860 $aName = "{$locationType[$locType[1]]}-address";
1861 $where = "`$aName`.state_province_id";
1864 $where = "civicrm_address.state_province_id";
1867 $states = CRM_Core_PseudoConstant
::stateProvince();
1868 if (is_numeric($value)) {
1869 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1870 $value = $states[(int ) $value];
1873 $intVal = CRM_Utils_Array
::key($value, $states);
1874 $this->_where
[$grouping][] = self
::buildClause($where, $op, $intVal, 'Positive');
1877 $this->_qill
[$grouping][] = ts('State') . " $op '$value'";
1880 $this->_qill
[$grouping][] = ts('State') . " ($lType) $op '$value'";
1883 elseif (!empty($field['pseudoconstant'])) {
1884 $this->optionValueQuery(
1885 $name, $op, $value, $grouping,
1886 CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', $field['name']),
1892 if ($name == 'gender_id') {
1893 self
::$_openedPanes[ts('Demographics')] = TRUE;
1896 elseif (substr($name, 0, 7) === 'country') {
1897 if (isset($locType[1]) && is_numeric($locType[1])) {
1899 $aName = "{$locationType[$locType[1]]}-address";
1900 $where = "`$aName`.country_id";
1903 $where = "civicrm_address.country_id";
1906 $countries = CRM_Core_PseudoConstant
::country();
1907 if (is_numeric($value)) {
1908 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1909 $value = $countries[(int ) $value];
1912 $intVal = CRM_Utils_Array
::key($value, $countries);
1913 $this->_where
[$grouping][] = self
::buildClause($where, $op, $intVal, 'Positive');
1917 $this->_qill
[$grouping][] = ts('Country') . " $op '$value'";
1920 $this->_qill
[$grouping][] = ts('Country') . " ($lType) $op '$value'";
1923 elseif (substr($name, 0, 6) === 'county') {
1924 if (isset($locType[1]) && is_numeric($locType[1])) {
1926 $aName = "{$locationType[$locType[1]]}-address";
1927 $where = "`$aName`.county_id";
1930 $where = "civicrm_address.county_id";
1933 $counties = CRM_Core_PseudoConstant
::county();
1934 if (is_numeric($value)) {
1935 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
1936 $value = $counties[(int ) $value];
1939 $intVal = CRM_Utils_Array
::key($value, $counties);
1940 $this->_where
[$grouping][] = self
::buildClause($where, $op, $intVal, 'Positive');
1944 $this->_qill
[$grouping][] = ts('County') . " $op '$value'";
1947 $this->_qill
[$grouping][] = ts('County') . " ($lType) $op '$value'";
1950 elseif ($name === 'world_region') {
1951 $field['where'] = 'civicrm_worldregion.id';
1952 $this->optionValueQuery(
1953 $name, $op, $value, $grouping,
1954 CRM_Core_PseudoConstant
::worldRegion(),
1959 elseif ($name === 'birth_date') {
1960 $date = CRM_Utils_Date
::processDate($value);
1961 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $date);
1964 $date = CRM_Utils_Date
::customFormat($date);
1965 $this->_qill
[$grouping][] = "$field[title] $op \"$date\"";
1968 $this->_qill
[$grouping][] = "$field[title] $op";
1970 self
::$_openedPanes[ts('Demographics')] = TRUE;
1972 elseif ($name === 'deceased_date') {
1973 $date = CRM_Utils_Date
::processDate($value);
1974 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $date);
1976 $date = CRM_Utils_Date
::customFormat($date);
1977 $this->_qill
[$grouping][] = "$field[title] $op \"$date\"";
1980 $this->_qill
[$grouping][] = "$field[title] $op";
1982 self
::$_openedPanes[ts('Demographics')] = TRUE;
1984 elseif ($name === 'is_deceased') {
1985 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $value);
1986 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
1987 self
::$_openedPanes[ts('Demographics')] = TRUE;
1989 elseif ($name === 'contact_id') {
1990 if (is_int($value)) {
1991 $this->_where
[$grouping][] = self
::buildClause($field['where'], $op, $value);
1992 $this->_qill
[$grouping][] = "$field[title] $op $value";
1995 elseif ($name === 'name') {
1996 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
1998 $value = "%$value%";
2001 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
2002 $this->_where
[$grouping][] = self
::buildClause($wc, $op, "'$value'");
2003 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2005 elseif ($name === 'current_employer') {
2006 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
2008 $value = "%$value%";
2011 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.organization_name)" : "contact_a.organization_name";
2012 $ceWhereClause = self
::buildClause($wc, $op,
2015 $ceWhereClause .= " AND contact_a.contact_type = 'Individual'";
2016 $this->_where
[$grouping][] = $ceWhereClause;
2017 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2019 elseif ($name === 'email_greeting') {
2020 $filterCondition = array('greeting_type' => 'email_greeting');
2021 $this->optionValueQuery(
2022 $name, $op, $value, $grouping,
2023 CRM_Core_PseudoConstant
::greeting($filterCondition),
2025 ts('Email Greeting')
2028 elseif ($name === 'postal_greeting') {
2029 $filterCondition = array('greeting_type' => 'postal_greeting');
2030 $this->optionValueQuery(
2031 $name, $op, $value, $grouping,
2032 CRM_Core_PseudoConstant
::greeting($filterCondition),
2034 ts('Postal Greeting')
2037 elseif ($name === 'addressee') {
2038 $filterCondition = array('greeting_type' => 'addressee');
2039 $this->optionValueQuery(
2040 $name, $op, $value, $grouping,
2041 CRM_Core_PseudoConstant
::greeting($filterCondition),
2046 elseif (substr($name, 0, 4) === 'url-') {
2047 $tName = 'civicrm_website';
2048 $this->_whereTables
[$tName] = $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2049 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
2051 $value = "%$value%";
2055 $wc = 'civicrm_website.url';
2056 $this->_where
[$grouping][] = $d = self
::buildClause($wc, $op, $value);
2057 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2059 elseif ($name === 'contact_is_deleted') {
2060 $this->_where
[$grouping][] = self
::buildClause("contact_a.is_deleted", $op, $value);
2061 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2064 // sometime the value is an array, need to investigate and fix
2065 if (is_array($value)) {
2066 CRM_Core_Error
::fatal();
2069 if (!empty($field['where'])) {
2071 $value = $strtolower($value);
2074 $value = "%$value%";
2078 if (isset($locType[1]) &&
2079 is_numeric($locType[1])
2083 //get the location name
2084 list($tName, $fldName) = self
::getLocationTableName($field['where'], $locType);
2086 $where = "`$tName`.$fldName";
2088 $this->_where
[$grouping][] = self
::buildClause("LOWER($where)", $op, $value);
2089 $this->_whereTables
[$tName] = $this->_tables
[$tName];
2090 $this->_qill
[$grouping][] = "$field[title] $op '$value'";
2093 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2094 if ($tableName == 'civicrm_contact') {
2095 $fieldName = "LOWER(contact_a.{$fieldName})";
2098 if ($op != 'IN' && !is_numeric($value)) {
2099 $fieldName = "LOWER({$field['where']})";
2102 $fieldName = "{$field['where']}";
2107 if (!empty($field['type'])) {
2108 $type = CRM_Utils_Type
::typeToString($field['type']);
2111 $this->_where
[$grouping][] = self
::buildClause($fieldName, $op, $value, $type);
2112 $this->_qill
[$grouping][] = "$field[title] $op $value";
2117 if ($setTables && isset($field['where'])) {
2118 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2119 if (isset($tableName)) {
2120 $this->_tables
[$tableName] = 1;
2121 $this->_whereTables
[$tableName] = 1;
2127 static function getLocationTableName(&$where, &$locType) {
2128 if (isset($locType[1]) && is_numeric($locType[1])) {
2129 list($tbName, $fldName) = explode(".", $where);
2131 //get the location name
2132 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
2133 $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2134 if (in_array($locType[0], $specialFields)) {
2135 //hack to fix / special handing for phone_ext
2136 if ($locType[0] == 'phone_ext') {
2137 $locType[0] = 'phone';
2139 if (isset($locType[2]) && $locType[2]) {
2140 $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2143 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2146 elseif (in_array($locType[0],
2148 'address_name', 'street_address', 'supplemental_address_1', 'supplemental_address_2',
2149 'city', 'postal_code', 'postal_code_suffix', 'geo_code_1', 'geo_code_2',
2152 //fix for search by profile with address fields.
2153 $tName = "{$locationType[$locType[1]]}-address";
2155 elseif ($locType[0] == 'on_hold') {
2156 $tName = "{$locationType[$locType[1]]}-email";
2159 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2161 $tName = str_replace(' ', '_', $tName);
2162 return array($tName, $fldName);
2164 CRM_Core_Error
::fatal();
2168 * Given a result dao, extract the values and return that array
2170 * @param Object $dao
2172 * @return array values for this query
2174 function store($dao) {
2177 foreach ($this->_element
as $key => $dontCare) {
2178 if (property_exists($dao, $key)) {
2179 if (strpos($key, '-') !== FALSE) {
2180 $values = explode('-', $key);
2181 $lastElement = array_pop($values);
2183 $cnt = count($values);
2185 foreach ($values as $v) {
2186 if (!array_key_exists($v, $current)) {
2187 $current[$v] = array();
2189 //bad hack for im_provider
2190 if ($lastElement == 'provider_id') {
2191 if ($count < $cnt) {
2192 $current = &$current[$v];
2195 $lastElement = "{$v}_{$lastElement}";
2199 $current = &$current[$v];
2204 $current[$lastElement] = $dao->$key;
2207 $value[$key] = $dao->$key;
2215 * getter for tables array
2221 return $this->_tables
;
2224 function whereTables() {
2225 return $this->_whereTables
;
2229 * generate the where clause (used in match contacts and permissions)
2231 * @param array $params
2232 * @param array $fields
2233 * @param array $tables
2234 * @param boolean $strict
2240 static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2241 $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2245 $tables = array_merge($query->tables(), $tables);
2246 $whereTables = array_merge($query->whereTables(), $whereTables);
2248 return $query->_whereClause
;
2252 * create the from clause
2254 * @param array $tables tables that need to be included in this from clause
2255 * if null, return mimimal from clause (i.e. civicrm_contact)
2256 * @param array $inner tables that should be inner-joined
2257 * @param array $right tables that should be right-joined
2259 * @return string the from clause
2263 static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
2265 $from = ' FROM civicrm_contact contact_a';
2266 if (empty($tables)) {
2270 if (!empty($tables['civicrm_worldregion'])) {
2271 $tables = array_merge(array('civicrm_country' => 1), $tables);
2274 if ((!empty($tables['civicrm_state_province']) ||
!empty($tables['civicrm_country']) ||
2275 CRM_Utils_Array
::value('civicrm_county', $tables)
2276 ) && empty($tables['civicrm_address'])) {
2277 $tables = array_merge(array('civicrm_address' => 1),
2282 // add group_contact table if group table is present
2283 if (!empty($tables['civicrm_group']) && empty($tables['civicrm_group_contact'])) {
2284 $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added'";
2287 // add group_contact and group table is subscription history is present
2288 if (!empty($tables['civicrm_subscription_history']) && empty($tables['civicrm_group'])) {
2289 $tables = array_merge(array(
2290 'civicrm_group' => 1,
2291 'civicrm_group_contact' => 1,
2297 // to handle table dependencies of components
2298 CRM_Core_Component
::tableNames($tables);
2299 // to handle table dependencies of hook injected tables
2300 CRM_Contact_BAO_Query_Hook
::singleton()->setTableDependency($tables);
2302 //format the table list according to the weight
2303 $info = CRM_Core_TableHierarchy
::info();
2305 foreach ($tables as $key => $value) {
2307 if (strpos($key, '-') !== FALSE) {
2308 $keyArray = explode('-', $key);
2309 $k = CRM_Utils_Array
::value('civicrm_' . $keyArray[1], $info, 99);
2311 elseif (strpos($key, '_') !== FALSE) {
2312 $keyArray = explode('_', $key);
2313 if (is_numeric(array_pop($keyArray))) {
2314 $k = CRM_Utils_Array
::value(implode('_', $keyArray), $info, 99);
2317 $k = CRM_Utils_Array
::value($key, $info, 99);
2321 $k = CRM_Utils_Array
::value($key, $info, 99);
2323 $tempTable[$k . ".$key"] = $key;
2326 $newTables = array();
2327 foreach ($tempTable as $key) {
2328 $newTables[$key] = $tables[$key];
2331 $tables = $newTables;
2333 foreach ($tables as $name => $value) {
2338 if (!empty($inner[$name])) {
2341 elseif (!empty($right[$name])) {
2349 // if there is already a join statement in value, use value itself
2350 if (strpos($value, 'JOIN')) {
2351 $from .= " $value ";
2354 $from .= " $side JOIN $name ON ( $value ) ";
2359 case 'civicrm_address':
2360 if ($primaryLocation) {
2361 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )";
2364 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) ";
2368 case 'civicrm_phone':
2369 $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) ";
2372 case 'civicrm_email':
2373 $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) ";
2377 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) ";
2381 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2382 $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2383 $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)";
2386 case 'civicrm_openid':
2387 $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )";
2390 case 'civicrm_worldregion':
2391 $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2392 $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2395 case 'civicrm_location_type':
2396 $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2399 case 'civicrm_group':
2400 $from .= " $side JOIN civicrm_group ON civicrm_group.id = civicrm_group_contact.group_id ";
2403 case 'civicrm_group_contact':
2404 $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2407 case 'civicrm_activity':
2408 case 'civicrm_activity_tag':
2409 case 'activity_type':
2410 case 'activity_status':
2411 case 'civicrm_activity_contact':
2412 case 'source_contact':
2413 $from .= CRM_Activity_BAO_Query
::from($name, $mode, $side);
2416 case 'civicrm_entity_tag':
2417 $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2418 civicrm_entity_tag.entity_id = contact_a.id ) ";
2421 case 'civicrm_note':
2422 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2423 contact_a.id = civicrm_note.entity_id ) ";
2426 case 'civicrm_subscription_history':
2427 $from .= " $side JOIN civicrm_subscription_history
2428 ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2429 AND civicrm_group_contact.group_id = civicrm_subscription_history.group_id";
2432 case 'civicrm_relationship':
2433 if (self
::$_relType == 'reciprocal') {
2434 if(self
::$_relationshipTempTable) {
2435 // we have a temptable to join on
2436 $tbl = self
::$_relationshipTempTable;
2437 $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2440 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2441 $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)";
2444 elseif (self
::$_relType == 'b') {
2445 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2446 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2449 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2450 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2455 $from .= " INNER JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2456 $from .= " INNER JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2460 $from .= " $side JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2463 case 'civicrm_grant':
2464 $from .= CRM_Grant_BAO_Query
::from($name, $mode, $side);
2467 case 'civicrm_website':
2468 $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2472 $from .= CRM_Core_Component
::from($name, $mode, $side);
2473 $from .= CRM_Contact_BAO_Query_Hook
::singleton()->buildSearchfrom($name, $mode, $side);
2483 * WHERE / QILL clause for deleted_contacts
2487 function deletedContacts($values) {
2488 list($_, $_, $value, $grouping, $_) = $values;
2490 // *prepend* to the relevant grouping as this is quite an important factor
2491 array_unshift($this->_qill
[$grouping], ts('Search in Trash'));
2496 * where / qill clause for contact_type
2501 function contactType(&$values) {
2502 list($name, $op, $value, $grouping, $wildcard) = $values;
2504 $subTypes = array();
2507 // account for search builder mapping multiple values
2508 if (!is_array($value)) {
2509 $values = self
::parseSearchBuilderString($value, 'String');
2510 if (is_array($values)) {
2511 $value = array_flip($values);
2515 if (is_array($value)) {
2516 foreach ($value as $k => $v) {
2521 if (strpos($k, CRM_Core_DAO
::VALUE_SEPARATOR
)) {
2522 list($contactType, $subType) = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $k, 2);
2525 if (!empty($subType)) {
2526 $subTypes[$subType] = 1;
2528 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2533 $contactTypeANDSubType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value, 2);
2534 $contactType = $contactTypeANDSubType[0];
2535 $subType = CRM_Utils_Array
::value(1, $contactTypeANDSubType);
2536 if (!empty($subType)) {
2537 $subTypes[$subType] = 1;
2539 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2543 if (!empty($clause)) {
2544 if ($op == 'IN' ||
$op == 'NOT IN') {
2545 $this->_where
[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2549 $type = array_pop($clause);
2550 $this->_where
[$grouping][] = "contact_a.contact_type $op $type";
2553 $this->_qill
[$grouping][] = ts('Contact Type') . ' - ' . implode(' ' . ts('or') . ' ', $quill);
2555 if (!empty($subTypes)) {
2556 $this->includeContactSubTypes($subTypes, $grouping);
2562 * where / qill clause for contact_sub_type
2567 function contactSubType(&$values) {
2568 list($name, $op, $value, $grouping, $wildcard) = $values;
2569 $this->includeContactSubTypes($value, $grouping);
2572 function includeContactSubTypes($value, $grouping) {
2575 $alias = "contact_a.contact_sub_type";
2577 if (is_array($value)) {
2578 foreach ($value as $k => $v) {
2580 $clause[$k] = "($alias like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($k, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2585 $clause[$value] = "($alias like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($value, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2588 if (!empty($clause)) {
2589 $this->_where
[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2590 $this->_qill
[$grouping][] = ts('Contact Subtype') . ' - ' . implode(' ' . ts('or') . ' ', array_keys($clause));
2595 * where / qill clause for groups
2600 function group(&$values) {
2601 list($name, $op, $value, $grouping, $wildcard) = $values;
2603 if (count($value) > 1) {
2604 $this->_useDistinct
= TRUE;
2607 $groupNames = CRM_Core_PseudoConstant
::group();
2608 $groupIds = implode(',', array_keys($value));
2611 foreach ($value as $id => $dontCare) {
2612 if (array_key_exists($id, $groupNames) && $dontCare) {
2613 $names[] = $groupNames[$id];
2619 $gcsValues = &$this->getWhereValues('group_contact_status', $grouping);
2621 is_array($gcsValues[2])
2623 foreach ($gcsValues[2] as $k => $v) {
2625 if ($k == 'Added') {
2628 $statii[] = "'" . CRM_Utils_Type
::escape($k, 'String') . "'";
2633 $statii[] = '"Added"';
2638 if (count($value) == 1 &&
2639 count($statii) == 1 &&
2640 $statii[0] == '"Added"'
2642 // check if smart group, if so we can get rid of that one additional
2644 $groupIDs = array_keys($value);
2646 if (!empty($groupIDs[0]) &&
2647 CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group',
2657 $gcTable = "`civicrm_group_contact-{$groupIds}`";
2658 $this->_tables
[$gcTable] = $this->_whereTables
[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON ( contact_a.id = {$gcTable}.contact_id AND {$gcTable}.group_id $op ( $groupIds ) )";
2661 $qill = ts('Contacts %1', array(1 => $op));
2662 $qill .= ' ' . implode(' ' . ts('or') . ' ', $names);
2664 $groupClause = NULL;
2667 $groupClause = "{$gcTable}.group_id $op ( $groupIds )";
2668 if (!empty($statii)) {
2669 $groupClause .= " AND {$gcTable}.status IN (" . implode(', ', $statii) . ")";
2670 $qill .= " " . ts('AND') . " " . ts('Group Status') . ' - ' . implode(' ' . ts('or') . ' ', $statii);
2675 $ssClause = $this->savedSearch($values);
2678 $groupClause = "( ( $groupClause ) OR ( $ssClause ) )";
2681 $groupClause = $ssClause;
2686 $this->_where
[$grouping][] = $groupClause;
2687 $this->_qill
[$grouping][] = $qill;
2690 * Function translates selection of group type into a list of groups
2692 function getGroupsFromTypeCriteria($value){
2693 $groupIds = array();
2694 foreach ($value as $groupTypeValue) {
2695 $groupList = CRM_Core_PseudoConstant
::group($groupTypeValue);
2696 $groupIds = ($groupIds +
$groupList);
2702 * where / qill clause for smart groups
2707 function savedSearch(&$values) {
2708 list($name, $op, $value, $grouping, $wildcard) = $values;
2709 return $this->addGroupContactCache(array_keys($value));
2713 * @param array $groups
2714 * @param string $tableAlias
2715 * @param string $joinTable
2717 * @return null|string
2719 function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a") {
2720 $config = CRM_Core_Config
::singleton();
2722 // Find all the groups that are part of a saved search.
2723 $groupIDs = implode(',', $groups);
2724 if (empty($groupIDs)) {
2729 SELECT id, cache_date, saved_search_id, children
2731 WHERE id IN ( $groupIDs )
2732 AND ( saved_search_id != 0
2733 OR saved_search_id IS NOT NULL
2734 OR children IS NOT NULL )
2737 $group = CRM_Core_DAO
::executeQuery($sql);
2738 $groupsFiltered = array();
2740 while ($group->fetch()) {
2741 $groupsFiltered[] = $group->id
;
2743 $this->_useDistinct
= TRUE;
2745 if (!$this->_smartGroupCache ||
$group->cache_date
== NULL) {
2746 CRM_Contact_BAO_GroupContactCache
::load($group);
2750 if (count($groupsFiltered)) {
2751 $groupIDsFiltered = implode(',', $groupsFiltered);
2753 if ($tableAlias == NULL) {
2754 $tableAlias = "civicrm_group_contact_cache_{$groupIDsFiltered}";
2757 $this->_tables
[$tableAlias] = $this->_whereTables
[$tableAlias] = " LEFT JOIN civicrm_group_contact_cache `{$tableAlias}` ON {$joinTable}.id = `{$tableAlias}`.contact_id ";
2759 return "`{$tableAlias}`.group_id IN (" . $groupIDsFiltered . ")";
2766 * where / qill clause for cms users
2771 function ufUser(&$values) {
2772 list($name, $op, $value, $grouping, $wildcard) = $values;
2775 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2777 $this->_qill
[$grouping][] = ts('CMS User');
2779 elseif ($value == 0) {
2780 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2782 $this->_where
[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
2783 $this->_qill
[$grouping][] = ts('Not a CMS User');
2788 * all tag search specific
2793 function tagSearch(&$values) {
2794 list($name, $op, $value, $grouping, $wildcard) = $values;
2797 $value = "%{$value}%";
2800 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2801 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2803 $etTable = "`civicrm_entity_tag-" . $value . "`";
2804 $tTable = "`civicrm_tag-" . $value . "`";
2806 if ($useAllTagTypes[2]) {
2807 $this->_tables
[$etTable] =
2808 $this->_whereTables
[$etTable] =
2809 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
2810 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id )";
2812 // search tag in cases
2813 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2814 $tCaseTable = "`civicrm_case_tag-" . $value . "`";
2815 $this->_tables
[$etCaseTable] =
2816 $this->_whereTables
[$etCaseTable] =
2817 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2818 LEFT JOIN civicrm_case
2819 ON (civicrm_case_contact.case_id = civicrm_case.id
2820 AND civicrm_case.is_deleted = 0 )
2821 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
2822 LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id )";
2823 // search tag in activities
2824 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2825 $tActTable = "`civicrm_act_tag-" . $value . "`";
2826 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2827 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2829 $this->_tables
[$etActTable] =
2830 $this->_whereTables
[$etActTable] =
2831 " LEFT JOIN civicrm_activity_contact
2832 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
2833 LEFT JOIN civicrm_activity
2834 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
2835 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2836 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
2837 LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id )";
2839 $this->_where
[$grouping][] = "({$tTable}.name $op '". $value . "' OR {$tCaseTable}.name $op '". $value . "' OR {$tActTable}.name $op '". $value . "')";
2840 $this->_qill
[$grouping][] = ts('Tag %1 %2 ', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
2842 $etTable = "`civicrm_entity_tag-" . $value . "`";
2843 $tTable = "`civicrm_tag-" . $value . "`";
2844 $this->_tables
[$etTable] = $this->_whereTables
[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND
2845 {$etTable}.entity_table = 'civicrm_contact' )
2846 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id ) ";
2848 $this->_where
[$grouping][] = self
::buildClause("{$tTable}.name", $op, $value, 'String');
2849 $this->_qill
[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
2854 * where / qill clause for tag
2859 function tag(&$values) {
2860 list($name, $op, $value, $grouping, $wildcard) = $values;
2862 $tagNames = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_EntityTag', 'tag_id', array('onlyActive' => FALSE));
2863 if (is_array($value)) {
2864 if (count($value) > 1) {
2865 $this->_useDistinct
= TRUE;
2867 foreach ($value as $id => $dontCare) {
2868 $names[] = CRM_Utils_Array
::value($id, $tagNames);
2870 $names = implode(' ' . ts('or') . ' ', $names);
2871 $value = implode(',', array_keys($value));
2874 $names = CRM_Utils_Array
::value($value, $tagNames);
2878 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
2879 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
2881 $etTable = "`civicrm_entity_tag-" . $value . "`";
2883 if ($useAllTagTypes[2]) {
2884 $this->_tables
[$etTable] =
2885 $this->_whereTables
[$etTable] =
2886 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2888 // search tag in cases
2889 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
2890 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2891 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
2893 $this->_tables
[$etCaseTable] =
2894 $this->_whereTables
[$etCaseTable] =
2895 " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
2896 LEFT JOIN civicrm_case
2897 ON (civicrm_case_contact.case_id = civicrm_case.id
2898 AND civicrm_case.is_deleted = 0 )
2899 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
2900 // search tag in activities
2901 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
2902 $this->_tables
[$etActTable] =
2903 $this->_whereTables
[$etActTable] =
2904 " LEFT JOIN civicrm_activity_contact
2905 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
2906 LEFT JOIN civicrm_activity
2907 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
2908 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
2909 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
2912 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2913 $this->_where
[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
2916 $this->_where
[$grouping][] = "({$etTable}.tag_id $op (". $value . ") OR {$etCaseTable}.tag_id $op (". $value . ") OR {$etActTable}.tag_id $op (". $value . "))";
2918 $this->_qill
[$grouping][] = ts('Tag %1 %2', array(1 => $op, 2 => $tagTypesText[2])) . ' ' . $names;
2920 $this->_tables
[$etTable] =
2921 $this->_whereTables
[$etTable] =
2922 " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
2925 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
2926 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
2927 $op = str_replace('EMPTY', 'NULL', $op);
2928 $this->_where
[$grouping][] = "{$etTable}.tag_id $op";
2931 $this->_where
[$grouping][] = "{$etTable}.tag_id $op (" . $value . ')';
2933 $this->_qill
[$grouping][] = ts('Tagged %1', array( 1 => $op)) . ' ' . $names;
2939 * where/qill clause for notes
2944 function notes(&$values) {
2945 list($name, $op, $value, $grouping, $wildcard) = $values;
2947 $noteOptionValues = $this->getWhereValues('note_option', $grouping);
2948 $noteOption = CRM_Utils_Array
::value('2', $noteOptionValues, '6');
2949 $noteOption = ($name == 'note_body') ?
2 : (($name == 'note_subject') ?
3 : $noteOption);
2951 $this->_useDistinct
= TRUE;
2953 $this->_tables
['civicrm_note'] =
2954 $this->_whereTables
['civicrm_note'] =
2955 " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
2957 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2959 $value = $strtolower(CRM_Core_DAO
::escapeString($n));
2960 if ($wildcard ||
$op == 'LIKE') {
2961 if (strpos($value, '%') === FALSE) {
2962 $value = "%$value%";
2966 elseif ($op == 'IS NULL' ||
$op == 'IS NOT NULL') {
2972 if ( $noteOption %
2 == 0 ) {
2973 $clauses[] = self
::buildClause('civicrm_note.note', $op, $value, 'String');
2974 $label = ts('Note: Body Only');
2976 if ( $noteOption %
3 == 0 ) {
2977 $clauses[] = self
::buildClause('civicrm_note.subject', $op, $value, 'String');
2978 $label = $label ?
ts('Note: Body and Subject') : ts('Note: Subject Only');
2980 $this->_where
[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
2981 $this->_qill
[$grouping][] = $label . " $op - '$n'";
2984 function nameNullOrEmptyOp($name, $op, $grouping) {
2988 $this->_where
[$grouping][] = "contact_a.$name $op";
2989 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2993 $this->_where
[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
2994 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
2997 case 'IS NOT EMPTY':
2998 $this->_where
[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
2999 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
3008 * where / qill clause for sort_name
3013 function sortName(&$values) {
3014 list($name, $op, $value, $grouping, $wildcard) = $values;
3016 // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
3017 if ( $this->nameNullOrEmptyOp( $name, $op, $grouping ) ) {
3022 $name = trim($value);
3028 $config = CRM_Core_Config
::singleton();
3032 //By default, $sub elements should be joined together with OR statements (don't change this variable).
3035 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
3036 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
3038 if (substr($name, 0, 1) == '"' &&
3039 substr($name, -1, 1) == '"'
3041 //If name is encased in double quotes, the value should be taken to be the string in entirety and the
3042 $value = substr($name, 1, -1);
3043 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
3044 $wc = ($newName == 'sort_name') ?
'LOWER(contact_a.sort_name)' : 'LOWER(contact_a.display_name)';
3045 $sub[] = " ( $wc = '$value' ) ";
3046 if ($config->includeEmailInName
) {
3047 $sub[] = " ( civicrm_email.email = '$value' ) ";
3050 elseif (strpos($name, ',') !== FALSE) {
3051 // if we have a comma in the string, search for the entire string
3052 $value = $strtolower(CRM_Core_DAO
::escapeString($name));
3054 if ($config->includeWildCardInName
) {
3055 $value = "'%$value%'";
3058 $value = "'$value%'";
3063 $value = "'$value'";
3065 if ($newName == 'sort_name') {
3066 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3069 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.display_name)" : "contact_a.display_name";
3071 $sub[] = " ( $wc $op $value )";
3072 if ($config->includeNickNameInName
) {
3073 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3074 $sub[] = " ( $wc $op $value )";
3076 if ($config->includeEmailInName
) {
3077 $sub[] = " ( civicrm_email.email $op $value ) ";
3081 // the string should be treated as a series of keywords to be matched with match ANY OR
3082 // match ALL depending on Civi config settings (see CiviAdmin)
3084 // The Civi configuration setting can be overridden if the string *starts* with the case
3085 // insenstive strings 'AND:' or 'OR:'TO THINK ABOUT: what happens when someone searches
3086 // for the following "AND: 'a string in quotes'"? - probably nothing - it would make the
3087 // AND OR variable reduntant because there is only one search string?
3089 // Check to see if the $subGlue is overridden in the search text
3090 if (strtolower(substr($name, 0, 4)) == 'and:') {
3091 $name = substr($name, 4);
3094 if (strtolower(substr($name, 0, 3)) == 'or:') {
3095 $name = substr($name, 3);
3099 $firstChar = substr($name, 0, 1);
3100 $lastChar = substr($name, -1, 1);
3101 $quotes = array("'", '"');
3102 if ((strlen($name) > 2) && in_array($firstChar, $quotes) &&
3103 in_array($lastChar, $quotes)
3105 $name = substr($name, 1);
3106 $name = substr($name, 0, -1);
3107 $pieces = array($name);
3110 $pieces = explode(' ', $name);
3112 foreach ($pieces as $piece) {
3113 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($piece)));
3114 if (strlen($value)) {
3115 // Added If as a sanitization - without it, when you do an OR search, any string with
3116 // double spaces (i.e. " ") or that has a space after the keyword (e.g. "OR: ") will
3117 // return all contacts because it will include a condition similar to "OR contact
3118 // name LIKE '%'". It might be better to replace this with array_filter.
3119 $fieldsub = array();
3121 if ($config->includeWildCardInName
) {
3122 $value = "'%$value%'";
3125 $value = "'$value%'";
3130 $value = "'$value'";
3132 if ($newName == 'sort_name') {
3133 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3136 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.display_name)" : "contact_a.display_name";
3138 $fieldsub[] = " ( $wc $op $value )";
3139 if ($config->includeNickNameInName
) {
3140 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3141 $fieldsub[] = " ( $wc $op $value )";
3143 if ($config->includeEmailInName
) {
3144 $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3146 $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3147 // I seperated the glueing in two. The first stage should always be OR because we are searching for matches in *ANY* of these fields
3152 $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3154 $this->_where
[$grouping][] = $sub;
3155 if ($config->includeEmailInName
) {
3156 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3157 $this->_qill
[$grouping][] = ts('Name or Email ') . "$op - '$name'";
3160 $this->_qill
[$grouping][] = ts('Name like') . " - '$name'";
3165 * where / qill clause for email
3170 function email(&$values) {
3171 list($name, $op, $value, $grouping, $wildcard) = $values;
3175 $config = CRM_Core_Config
::singleton();
3177 if (substr($n, 0, 1) == '"' &&
3178 substr($n, -1, 1) == '"'
3180 $n = substr($n, 1, -1);
3181 $value = strtolower(CRM_Core_DAO
::escapeString($n));
3182 $value = "'$value'";
3186 $value = strtolower($n);
3188 if (strpos($value, '%') === FALSE) {
3189 $value = "%{$value}%";
3194 $this->_qill
[$grouping][] = ts('Email') . " $op '$n'";
3195 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, $value, 'String');
3198 $this->_qill
[$grouping][] = ts('Email') . " $op ";
3199 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, NULL, 'String');
3202 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3206 * where / qill clause for phone number
3211 function phone_numeric(&$values) {
3212 list($name, $op, $value, $grouping, $wildcard) = $values;
3213 // Strip non-numeric characters; allow wildcards
3214 $number = preg_replace('/[^\d%]/', '', $value);
3216 if ( strpos($number, '%') === FALSE ) {
3217 $number = "%$number%";
3220 $this->_qill
[$grouping][] = ts('Phone number contains') . " $number";
3221 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String');
3222 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3227 * where / qill clause for phone type/location
3232 function phone_option_group($values) {
3233 list($name, $op, $value, $grouping, $wildcard) = $values;
3234 $option = ($name == 'phone_phone_type_id' ?
'phone_type_id' : 'location_type_id');
3235 $options = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', $option);
3236 $optionName = $options[$value];
3237 $this->_qill
[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ?
ts('type') : ('location')) . " $op $optionName";
3238 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3239 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3243 * where / qill clause for street_address
3248 function street_address(&$values) {
3249 list($name, $op, $value, $grouping, $wildcard) = $values;
3258 $value = strtolower($n);
3259 if (strpos($value, '%') === FALSE) {
3260 // only add wild card if not there
3261 $value = "%{$value}%";
3264 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String');
3265 $this->_qill
[$grouping][] = ts('Street') . " $op '$n'";
3268 $this->_where
[$grouping][] = self
::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3269 $this->_qill
[$grouping][] = ts('Street') . " $op ";
3272 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3276 * where / qill clause for street_unit
3281 function street_number(&$values) {
3282 list($name, $op, $value, $grouping, $wildcard) = $values;
3290 if (strtolower($n) == 'odd') {
3291 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3292 $this->_qill
[$grouping][] = ts('Street Number is odd');
3294 elseif (strtolower($n) == 'even') {
3295 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3296 $this->_qill
[$grouping][] = ts('Street Number is even');
3299 $value = strtolower($n);
3301 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3302 $this->_qill
[$grouping][] = ts('Street Number') . " $op '$n'";
3305 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3309 * where / qill clause for sorting by character
3314 function sortByCharacter(&$values) {
3315 list($name, $op, $value, $grouping, $wildcard) = $values;
3317 $name = trim($value);
3318 $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($name)) . "%'";
3319 $this->_where
[$grouping][] = $cond;
3320 $this->_qill
[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3324 * where / qill clause for including contact ids
3329 function includeContactIDs() {
3330 if (!$this->_includeContactIds ||
empty($this->_params
)) {
3334 $contactIds = array();
3335 foreach ($this->_params
as $id => $values) {
3336 if (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
3337 $contactIds[] = substr($values[0], CRM_Core_Form
::CB_PREFIX_LEN
);
3340 if (!empty($contactIds)) {
3341 $this->_where
[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3346 * where / qill clause for postal code
3351 function postalCode(&$values) {
3352 // skip if the fields dont have anything to do with postal_code
3353 if (empty($this->_fields
['postal_code'])) {
3357 list($name, $op, $value, $grouping, $wildcard) = $values;
3359 // Handle numeric postal code range searches properly by casting the column as numeric
3360 if (is_numeric($value)) {
3361 $field = 'ROUND(civicrm_address.postal_code)';
3362 $val = CRM_Utils_Type
::escape($value, 'Integer');
3365 $field = 'civicrm_address.postal_code';
3366 $val = CRM_Utils_Type
::escape($value, 'String');
3369 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3371 if ($name == 'postal_code') {
3372 $this->_where
[$grouping][] = self
::buildClause($field, $op, $val, 'String');
3373 $this->_qill
[$grouping][] = ts('Postal code') . " {$op} {$value}";
3375 elseif ($name == 'postal_code_low') {
3376 $this->_where
[$grouping][] = " ( $field >= '$val' ) ";
3377 $this->_qill
[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3379 elseif ($name == 'postal_code_high') {
3380 $this->_where
[$grouping][] = " ( $field <= '$val' ) ";
3381 $this->_qill
[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3386 * where / qill clause for location type
3391 function locationType(&$values, $status = NULL) {
3392 list($name, $op, $value, $grouping, $wildcard) = $values;
3394 if (is_array($value)) {
3395 $this->_where
[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', array_keys($value)) . ')';
3396 $this->_tables
['civicrm_address'] = 1;
3397 $this->_whereTables
['civicrm_address'] = 1;
3399 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
3401 foreach (array_keys($value) as $id) {
3402 $names[] = $locationType[$id];
3405 $this->_primaryLocation
= FALSE;
3408 $this->_qill
[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3411 return implode(' ' . ts('or') . ' ', $names);
3416 function country(&$values, $fromStateProvince = TRUE) {
3417 list($name, $op, $value, $grouping, $wildcard) = $values;
3419 if (!$fromStateProvince) {
3420 $stateValues = $this->getWhereValues('state_province', $grouping);
3421 if (!empty($stateValues)) {
3422 // return back to caller if there are state province values
3423 // since that handles this case
3428 $countryClause = $countryQill = NULL;
3434 $this->_tables
['civicrm_address'] = 1;
3435 $this->_whereTables
['civicrm_address'] = 1;
3437 $countries = CRM_Core_PseudoConstant
::country();
3438 if (is_numeric($value)) {
3439 $countryClause = self
::buildClause(
3440 'civicrm_address.country_id',
3445 $countryName = $countries[(int ) $value];
3449 $intValues = self
::parseSearchBuilderString($value);
3450 if ($intValues && ($op == 'IN' ||
$op == 'NOT IN')) {
3451 $countryClause = self
::buildClause(
3452 'civicrm_address.country_id',
3457 $countryNames = array();
3458 foreach ($intValues as $v) {
3459 $countryNames[] = $countries[$v];
3461 $countryName = implode(',', $countryNames);
3464 $countries = CRM_Core_PseudoConstant
::country();
3465 $intVal = CRM_Utils_Array
::key($value, $countries);
3466 $countryClause = self
::buildClause(
3467 'civicrm_address.country_id',
3472 $countryName = $value;
3475 $countryQill = ts('Country') . " {$op} '$countryName'";
3477 if (!$fromStateProvince) {
3478 $this->_where
[$grouping][] = $countryClause;
3479 $this->_qill
[$grouping][] = $countryQill;
3483 if ($fromStateProvince) {
3484 if (!empty($countryClause)) {
3487 " ...AND... " . $countryQill,
3491 return array(NULL, NULL);
3497 * where / qill clause for county (if present)
3502 function county(&$values, $status = null) {
3503 list($name, $op, $value, $grouping, $wildcard) = $values;
3505 if (! is_array($value)) {
3506 // force the county to be an array
3507 $value = array($value);
3510 // check if the values are ids OR names of the counties
3511 $inputFormat = 'id';
3512 foreach ($value as $v) {
3513 if (!is_numeric($v)) {
3514 $inputFormat = 'name';
3522 else if ($op == '!=') {
3526 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3527 $op = str_replace('EMPTY', 'NULL', $op);
3530 if (in_array( $op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3531 $clause = "civicrm_address.county_id $op";
3533 elseif ($inputFormat == 'id') {
3534 $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3536 $county = CRM_Core_PseudoConstant
::county();
3537 foreach ($value as $id) {
3538 $names[] = CRM_Utils_Array
::value($id, $county);
3542 $inputClause = array();
3543 $county = CRM_Core_PseudoConstant
::county();
3544 foreach ($value as $name) {
3545 $name = trim($name);
3546 $inputClause[] = CRM_Utils_Array
::key($name, $county);
3548 $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3551 $this->_tables
['civicrm_address'] = 1;
3552 $this->_whereTables
['civicrm_address'] = 1;
3554 $this->_where
[$grouping][] = $clause;
3556 $this->_qill
[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3558 return implode(' ' . ts('or') . ' ', $names);
3563 * where / qill clause for state/province AND country (if present)
3568 function stateProvince(&$values, $status = NULL) {
3569 list($name, $op, $value, $grouping, $wildcard) = $values;
3571 // quick escape for IS NULL
3572 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3575 else if (!is_array($value)) {
3576 // force the state to be an array
3577 // check if its in the mapper format!
3578 $values = self
::parseSearchBuilderString($value);
3579 if (is_array($values)) {
3583 $value = array($value);
3587 // check if the values are ids OR names of the states
3588 $inputFormat = 'id';
3590 foreach ($value as $v) {
3591 if (!is_numeric($v)) {
3592 $inputFormat = 'name';
3602 else if ($op == '!=') {
3606 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3607 $op = str_replace('EMPTY', 'NULL', $op);
3609 if ( in_array( $op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY' ) ) ) {
3610 $stateClause = "civicrm_address.state_province_id $op";
3612 else if ($inputFormat == 'id') {
3613 if ($op != 'NOT IN') {
3616 $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $value) . ')';
3618 $stateProvince = CRM_Core_PseudoConstant
::stateProvince();
3619 foreach ($value as $id) {
3620 $names[] = CRM_Utils_Array
::value($id, $stateProvince);
3624 $inputClause = array();
3625 $stateProvince = CRM_Core_PseudoConstant
::stateProvince();
3626 foreach ($value as $name) {
3627 $name = trim($name);
3628 $inputClause[] = CRM_Utils_Array
::key($name, $stateProvince);
3630 $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $inputClause) . ')';
3633 $this->_tables
['civicrm_address'] = 1;
3634 $this->_whereTables
['civicrm_address'] = 1;
3636 $countryValues = $this->getWhereValues('country', $grouping);
3637 list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3639 if ($countryClause) {
3640 $clause = "( $stateClause AND $countryClause )";
3643 $clause = $stateClause;
3646 $this->_where
[$grouping][] = $clause;
3648 $this->_qill
[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill;
3651 return implode(' ' . ts('or') . ' ', $names) . $countryQill;
3656 * where / qill clause for change log
3661 function changeLog(&$values) {
3662 list($name, $op, $value, $grouping, $wildcard) = $values;
3664 $targetName = $this->getWhereValues('changed_by', $grouping);
3669 $name = trim($targetName[2]);
3670 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3671 $name = $targetName[4] ?
"%$name%" : $name;
3672 $this->_where
[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3673 $this->_tables
['civicrm_log'] = $this->_whereTables
['civicrm_log'] = 1;
3674 $this->_qill
[$grouping][] = ts('Modified by') . ": $name";
3677 function modifiedDates($values) {
3678 $this->_useDistinct
= TRUE;
3680 // CRM-11281, default to added date if not set
3681 $fieldTitle = ts('Added Date');
3682 $fieldName = 'created_date';
3683 foreach (array_keys($this->_params
) as $id) {
3684 if ($this->_params
[$id][0] == 'log_date') {
3685 if ($this->_params
[$id][2] == 2) {
3686 $fieldTitle = ts('Modified Date');
3687 $fieldName = 'modified_date';
3693 $this->dateQueryBuilder($values, 'contact_a', 'log_date', $fieldName, $fieldTitle);
3695 self
::$_openedPanes[ts('Change Log')] = TRUE;
3698 function demographics(&$values) {
3699 list($name, $op, $value, $grouping, $wildcard) = $values;
3701 if (($name == 'birth_date_low') ||
($name == 'birth_date_high')) {
3703 $this->dateQueryBuilder($values,
3704 'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3707 elseif (($name == 'deceased_date_low') ||
($name == 'deceased_date_high')) {
3709 $this->dateQueryBuilder($values,
3710 'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3714 self
::$_openedPanes[ts('Demographics')] = TRUE;
3717 function privacy(&$values) {
3718 list($name, $op, $value, $grouping, $wildcard) = $values;
3719 //fixed for profile search listing CRM-4633
3720 if (strpbrk($value, "[")) {
3721 $value = "'{$value}'";
3723 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3726 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3728 $field = CRM_Utils_Array
::value($name, $this->_fields
);
3729 $title = $field ?
$field['title'] : $name;
3730 $this->_qill
[$grouping][] = "$title $op $value";
3733 function privacyOptions($values) {
3734 list($name, $op, $value, $grouping, $wildcard) = $values;
3736 if (empty($value) ||
!is_array($value)) {
3740 // get the operator and toggle values
3741 $opValues = $this->getWhereValues('privacy_operator', $grouping);
3744 strtolower($opValues[2] == 'AND')
3749 $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3751 if ($toggleValues &&
3752 $toggleValues[2] == 2
3759 foreach ($value as $dontCare => $pOption) {
3760 $clauses[] = " ( contact_a.{$pOption} $compareOP 1 ) ";
3761 $field = CRM_Utils_Array
::value($pOption, $this->_fields
);
3762 $title = $field ?
$field['title'] : $pOption;
3763 $qill[] = " $title $compareOP 1 ";
3766 $this->_where
[$grouping][] = '( ' . implode($operator, $clauses) . ' )';
3767 $this->_qill
[$grouping][] = implode($operator, $qill);
3770 function preferredCommunication(&$values) {
3771 list($name, $op, $value, $grouping, $wildcard) = $values;
3774 if (in_array($op, array( 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3777 elseif (!is_array($value)) {
3779 $value = trim($value, ' ()');
3780 if (strpos($value, CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
3781 $v = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value);
3784 $v = explode(",", $value);
3787 foreach ($v as $item) {
3794 foreach ($value as $key => $checked) {
3801 $commPref = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method');
3803 $sqlValue = array();
3804 $showValue = array();
3805 $sql = "contact_a.preferred_communication_method";
3806 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3807 $sqlValue[] = "{$sql} {$op}";
3810 foreach ($pref as $val) {
3811 $sqlValue[] = "( $sql like '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. $val . CRM_Core_DAO
::VALUE_SEPARATOR
. "%' ) ";
3812 $showValue[] = $commPref[$val];
3815 $this->_where
[$grouping][] = "( " . implode(' OR ', $sqlValue) . " )";
3816 $this->_qill
[$grouping][] = ts('Preferred Communication Method') . " $op " . implode(' ' . ts('or') . ' ', $showValue);
3820 * where / qill clause for relationship
3825 function relationship(&$values) {
3826 list($name, $op, $value, $grouping, $wildcard) = $values;
3827 if($this->_relationshipValuesAdded
){
3830 // also get values array for relation_target_name
3831 // for relatinship search we always do wildcard
3832 $targetName = $this->getWhereValues('relation_target_name', $grouping);
3833 $relStatus = $this->getWhereValues('relation_status', $grouping);
3834 $relPermission = $this->getWhereValues('relation_permission', $grouping);
3835 $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
3837 $nameClause = $name = NULL;
3839 $name = trim($targetName[2]);
3840 if (substr($name, 0, 1) == '"' &&
3841 substr($name, -1, 1) == '"'
3843 $name = substr($name, 1, -1);
3844 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3845 $nameClause = "= '$name'";
3848 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3849 $nameClause = "LIKE '%{$name}%'";
3853 $rel = explode('_', $value);
3855 self
::$_relType = $rel[1];
3856 $params = array('id' => $rel[0]);
3857 $rTypeValues = array();
3858 $rType = CRM_Contact_BAO_RelationshipType
::retrieve($params, $rTypeValues);
3859 if ($rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) {
3860 // if we don't know which end of the relationship we are dealing with we'll create a temp table
3861 //@todo unless we are dealing with a target group
3862 self
::$_relType = 'reciprocal';
3864 // if we are creating a temp table we build our own where for the relationship table
3865 $relationshipTempTable = NULL;
3866 if(self
::$_relType == 'reciprocal' && empty($targetGroup)) {
3868 self
::$_relationshipTempTable =
3869 $relationshipTempTable =
3870 CRM_Core_DAO
::createTempTableName( 'civicrm_rel');
3872 $where[$grouping][] = " sort_name $nameClause ";
3876 $where = &$this->_where
;
3878 $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
3883 $relTypeInd = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Individual');
3884 $relTypeOrg = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Organization');
3885 $relTypeHou = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, 'Household');
3886 $allRelationshipType = array();
3887 $allRelationshipType = array_merge($relTypeInd, $relTypeOrg);
3888 $allRelationshipType = array_merge($allRelationshipType, $relTypeHou);
3890 if ($nameClause ||
!$targetGroup) {
3891 $this->_qill
[$grouping][] = "$allRelationshipType[$value] $name";
3895 //check to see if the target contact is in specified group
3897 //add contacts from static groups
3898 $this->_tables
['civicrm_relationship_group_contact'] =
3899 $this->_whereTables
['civicrm_relationship_group_contact'] =
3900 " LEFT JOIN civicrm_group_contact civicrm_relationship_group_contact ON civicrm_relationship_group_contact.contact_id = contact_b.id AND civicrm_relationship_group_contact.status = 'Added'";
3902 "( civicrm_relationship_group_contact.group_id IN (" .
3903 implode(",", $targetGroup[2]) . ") ) ";
3905 //add contacts from saved searches
3906 $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b");
3908 //set the group where clause
3910 $groupWhere[] = "( " . $ssWhere . " )";
3912 $this->_where
[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
3914 //Get the names of the target groups for the qill
3915 $groupNames = CRM_Core_PseudoConstant
::group();
3916 $qillNames = array();
3917 foreach ($targetGroup[2] as $groupId) {
3918 if (array_key_exists($groupId, $groupNames)) {
3919 $qillNames[] = $groupNames[$groupId];
3922 $this->_qill
[$grouping][] = "$allRelationshipType[$value] ( " . implode(", ", $qillNames) . " )";
3925 // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
3926 $today = date('Ymd');
3927 //check for active, inactive and all relation status
3928 if ($relStatus[2] == 0) {
3929 $where[$grouping][] = "(
3930 civicrm_relationship.is_active = 1 AND
3931 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
3932 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
3934 $this->_qill
[$grouping][] = ts('Relationship - Active and Current');
3936 elseif ($relStatus[2] == 1) {
3937 $where[$grouping][] = "(
3938 civicrm_relationship.is_active = 0 OR
3939 civicrm_relationship.end_date < {$today} OR
3940 civicrm_relationship.start_date > {$today}
3942 $this->_qill
[$grouping][] = ts('Relationship - Inactive or not Current');
3945 //check for permissioned, non-permissioned and all permissioned relations
3946 if ($relPermission[2] == 1) {
3947 $this->_where
[$grouping][] = "(
3948 civicrm_relationship.is_permission_a_b = 1
3950 $this->_qill
[$grouping][] = ts('Relationship - Permissioned');
3951 } elseif ($relPermission[2] == 2) {
3952 //non-allowed permission relationship.
3953 $this->_where
[$grouping][] = "(
3954 civicrm_relationship.is_permission_a_b = 0
3956 $this->_qill
[$grouping][] = ts('Relationship - Non-permissioned');
3959 $this->addRelationshipDateClauses($grouping, $where);
3960 if(!empty($rType) && isset($rType->id
)){
3961 $where[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rType->id
;
3963 $this->_tables
['civicrm_relationship'] = $this->_whereTables
['civicrm_relationship'] = 1;
3964 $this->_useDistinct
= TRUE;
3965 $this->_relationshipValuesAdded
= TRUE;
3966 // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
3968 // @todo creating a temp table could be expanded to group filter
3969 // as even creating a temp table of all relationships is much much more efficient than
3970 // an OR in the join
3971 if($relationshipTempTable) {
3972 $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
3974 CREATE TEMPORARY TABLE {$relationshipTempTable}
3975 (SELECT contact_id_b as contact_id, civicrm_relationship.id
3976 FROM civicrm_relationship
3977 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
3980 (SELECT contact_id_a as contact_id, civicrm_relationship.id
3981 FROM civicrm_relationship
3982 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
3985 CRM_Core_DAO
::executeQuery($sql);
3990 * Add start & end date criteria in
3991 * @param string $grouping
3992 * @param array $where = array to add where clauses to, in case you are generating a temp table
3993 * not the main query.
3995 function addRelationshipDateClauses($grouping, &$where){
3996 $dateValues = array();
4002 foreach ($dateTypes as $dateField){
4003 $dateValueLow = $this->getWhereValues('relation_'. $dateField .'_low', $grouping);
4004 $dateValueHigh= $this->getWhereValues('relation_'. $dateField .'_high', $grouping);
4005 if(!empty($dateValueLow)){
4006 $date = date('Ymd', strtotime($dateValueLow[2]));
4007 $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
4008 $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);
4010 if(!empty($dateValueHigh)){
4011 $date = date('Ymd', strtotime($dateValueHigh[2]));
4012 $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
4013 $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);
4018 * default set of return properties
4023 static function &defaultReturnProperties($mode = 1) {
4024 if (!isset(self
::$_defaultReturnProperties)) {
4025 self
::$_defaultReturnProperties = array();
4028 if (!isset(self
::$_defaultReturnProperties[$mode])) {
4029 // add activity return properties
4030 if ($mode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
4031 self
::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query
::defaultReturnProperties($mode, FALSE);
4034 self
::$_defaultReturnProperties[$mode] = CRM_Core_Component
::defaultReturnProperties($mode, FALSE);
4037 if (empty(self
::$_defaultReturnProperties[$mode])) {
4038 self
::$_defaultReturnProperties[$mode] = array(
4041 'legal_identifier' => 1,
4042 'external_identifier' => 1,
4043 'contact_type' => 1,
4044 'contact_sub_type' => 1,
4046 'display_name' => 1,
4047 'preferred_mail_format' => 1,
4054 'formal_title' => 1,
4055 'communication_style_id' => 1,
4058 'street_address' => 1,
4059 'supplemental_address_1' => 1,
4060 'supplemental_address_2' => 1,
4063 'postal_code_suffix' => 1,
4064 'state_province' => 1,
4066 'world_region' => 1,
4073 'household_name' => 1,
4074 'organization_name' => 1,
4075 'deceased_date' => 1,
4080 'current_employer' => 1,
4081 // FIXME: should we use defaultHierReturnProperties() for the below?
4082 'do_not_email' => 1,
4085 'do_not_phone' => 1,
4086 'do_not_trade' => 1,
4088 'contact_is_deleted' => 1,
4089 'preferred_communication_method' => 1,
4090 'preferred_language' => 1,
4094 return self
::$_defaultReturnProperties[$mode];
4098 * get primary condition for a sql clause
4105 static function getPrimaryCondition($value) {
4106 if (is_numeric($value)) {
4107 $value = (int ) $value;
4108 return ($value == 1) ?
'is_primary = 1' : 'is_primary = 0';
4114 * wrapper for a simple search query
4116 * @param array $params
4117 * @param array $returnProperties
4118 * @param \bolean|bool $count
4123 static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4124 $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4125 list($select, $from, $where, $having) = $query->query();
4127 return "$select $from $where $having";
4131 * These are stub comments as this function needs more explanation - particularly in terms of how it
4132 * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4134 * This function was originally written as a wrapper for the api query but is called from multiple places
4135 * in the core code directly so the name is misleading. This function does not use the searchQuery function
4136 * but it is unclear as to whehter that is historical or there is a reason
4137 * CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4139 * @param array $params
4140 * @param array $returnProperties
4141 * @param null $fields
4142 * @param string $sort
4143 * @param int $offset
4144 * @param int $row_count
4145 * @param bool $smartGroupCache
4146 * @param bool $count return count obnly
4147 * @param bool $skipPermissions Should permissions be ignored or should the logged in user's permissions be applied
4149 * @params bool $smartGroupCache ?? update smart group cache?
4154 static function apiQuery(
4156 $returnProperties = NULL,
4161 $smartGroupCache = TRUE,
4163 $skipPermissions = TRUE
4166 $query = new CRM_Contact_BAO_Query(
4167 $params, $returnProperties,
4168 NULL, TRUE, FALSE, 1,
4170 TRUE, $smartGroupCache
4173 //this should add a check for view deleted if permissions are enabled
4174 if ($skipPermissions){
4175 $query->_skipDeleteClause
= TRUE;
4177 $query->generatePermissionClause(FALSE, $count);
4179 // note : this modifies _fromClause and _simpleFromClause
4180 $query->includePseudoFieldsJoin($sort);
4182 list($select, $from, $where, $having) = $query->query($count);
4184 $options = $query->_options
;
4185 if(!empty($query->_permissionWhereClause
)){
4186 if (empty($where)) {
4187 $where = "WHERE $query->_permissionWhereClause";
4190 $where = "$where AND $query->_permissionWhereClause";
4194 $sql = "$select $from $where $having";
4197 if ($query->_useGroupBy
) {
4198 $sql .= ' GROUP BY contact_a.id';
4200 if (!empty($sort)) {
4201 $sort = CRM_Utils_Type
::escape($sort, 'String');
4202 $sql .= " ORDER BY $sort ";
4204 if ($row_count > 0 && $offset >= 0) {
4205 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4206 $rowCount = CRM_Utils_Type
::escape($row_count, 'Int');
4207 $sql .= " LIMIT $offset, $row_count ";
4210 $dao = CRM_Core_DAO
::executeQuery($sql);
4213 while ($dao->fetch()) {
4215 $noRows = $dao->rowCount
;
4217 return array($noRows,NULL);
4219 $val = $query->store($dao);
4220 $convertedVals = $query->convertToPseudoNames($dao, TRUE);
4222 if (!empty($convertedVals)) {
4223 $val = array_replace_recursive($val, $convertedVals);
4225 $values[$dao->contact_id
] = $val;
4228 return array($values, $options);
4232 * create and query the db for an contact search
4234 * @param int $offset the offset for the query
4235 * @param int $rowCount the number of rows to return
4236 * @param string $sort the order by string
4237 * @param boolean $count is this a count only query ?
4238 * @param boolean $includeContactIds should we include contact ids?
4239 * @param boolean $sortByChar if true returns the distinct array of first characters for search results
4240 * @param boolean $groupContacts if true, return only the contact ids
4241 * @param boolean $returnQuery should we return the query as a string
4242 * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components)
4243 * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load.
4245 * @return CRM_Contact_DAO_Contact
4248 function searchQuery(
4249 $offset = 0, $rowCount = 0, $sort = NULL,
4250 $count = FALSE, $includeContactIds = FALSE,
4251 $sortByChar = FALSE, $groupContacts = FALSE,
4252 $returnQuery = FALSE,
4253 $additionalWhereClause = NULL, $sortOrder = NULL,
4254 $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4257 if ($includeContactIds) {
4258 $this->_includeContactIds
= TRUE;
4259 $this->_whereClause
= $this->whereClause();
4262 $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
);
4264 // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4265 // and that contact happens to be deleted, set $onlyDeleted to true
4266 foreach ($this->_params
as $values) {
4267 $name = CRM_Utils_Array
::value(0, $values);
4268 $op = CRM_Utils_Array
::value(1, $values);
4269 $value = CRM_Utils_Array
::value(2, $values);
4270 if ($name == 'contact_id' and $op == '=') {
4271 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4272 $onlyDeleted = TRUE;
4277 $this->generatePermissionClause($onlyDeleted, $count);
4279 // building the query string
4282 if (isset($this->_groupByComponentClause
)) {
4283 $groupBy = $this->_groupByComponentClause
;
4285 elseif ($this->_useGroupBy
) {
4286 $groupBy = ' GROUP BY contact_a.id';
4289 if ($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
&& (!$count)) {
4290 $groupBy = 'GROUP BY civicrm_activity.id ';
4293 $order = $orderBy = $limit = '';
4295 $config = CRM_Core_Config
::singleton();
4296 if ($config->includeOrderByClause ||
4297 isset($this->_distinctComponentClause
)
4300 if (is_string($sort)) {
4304 $orderBy = trim($sort->orderBy());
4306 if (!empty($orderBy)) {
4307 // this is special case while searching for
4308 // changelog CRM-1718
4309 if (preg_match('/sort_name/i', $orderBy)) {
4310 $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
4313 $orderBy = CRM_Utils_Type
::escape($orderBy, 'String');
4314 $order = " ORDER BY $orderBy";
4317 $sortOrder = CRM_Utils_Type
::escape($sortOrder, 'String');
4318 $order .= " $sortOrder";
4321 // always add contact_a.id to the ORDER clause
4322 // so the order is deterministic
4323 if (strpos('contact_a.id', $order) === FALSE) {
4324 $order .= ", contact_a.id";
4328 elseif ($sortByChar) {
4329 $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc";
4332 $order = " ORDER BY contact_a.sort_name asc, contact_a.id";
4336 // hack for order clause
4338 $fieldStr = trim(str_replace('ORDER BY', '', $order));
4339 $fieldOrder = explode(' ', $fieldStr);
4340 $field = $fieldOrder[0];
4346 $this->_whereTables
["civicrm_address"] = 1;
4347 $order = str_replace($field, "civicrm_address.{$field}", $order);
4351 case 'state_province':
4352 $this->_whereTables
["civicrm_{$field}"] = 1;
4353 $order = str_replace($field, "civicrm_{$field}.name", $order);
4357 $this->_whereTables
["civicrm_email"] = 1;
4358 $order = str_replace($field, "civicrm_email.{$field}", $order);
4362 //CRM-12565 add "`" around $field if it is a pseudo constant
4363 foreach ($this->_pseudoConstantsSelect
as $key => $value) {
4364 if (!empty($value['element']) && $value['element'] == $field) {
4365 $order = str_replace($field, "`{$field}`", $order);
4369 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4370 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4374 if ($rowCount > 0 && $offset >= 0) {
4375 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4376 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
4377 $limit = " LIMIT $offset, $rowCount ";
4381 // note : this modifies _fromClause and _simpleFromClause
4382 $this->includePseudoFieldsJoin($sort);
4384 list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts);
4386 if(!empty($this->_permissionWhereClause
)){
4387 if (empty($where)) {
4388 $where = "WHERE $this->_permissionWhereClause";
4391 $where = "$where AND $this->_permissionWhereClause";
4395 if ($additionalWhereClause) {
4396 $where = $where . ' AND ' . $additionalWhereClause;
4399 //additional from clause should be w/ proper joins.
4400 if ($additionalFromClause) {
4401 $from .= "\n" . $additionalFromClause;
4404 // if we are doing a transform, do it here
4405 // use the $from, $where and $having to get the contact ID
4406 if ($this->_displayRelationshipType
) {
4407 $this->filterRelatedContacts($from, $where, $having);
4410 if ($skipOrderAndLimit) {
4411 $query = "$select $from $where $having $groupBy";
4414 $query = "$select $from $where $having $groupBy $order $limit";
4421 return CRM_Core_DAO
::singleValueQuery($query);
4424 $dao = CRM_Core_DAO
::executeQuery($query);
4425 if ($groupContacts) {
4427 while ($dao->fetch()) {
4430 return implode(',', $ids);
4437 * Fetch a list of contacts from the prev/next cache for displaying a search results page
4439 * @param string $cacheKey
4440 * @param int $offset
4441 * @param int $rowCount
4442 * @param bool $includeContactIds
4443 * @return CRM_Core_DAO
4445 function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
4446 $this->_includeContactIds
= $includeContactIds;
4447 list($select, $from, $where) = $this->query();
4448 $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);
4449 $order = " ORDER BY pnc.id";
4450 $groupBy = " GROUP BY contact_a.id";
4451 $limit = " LIMIT $offset, $rowCount";
4452 $query = "$select $from $where $groupBy $order $limit";
4454 return CRM_Core_DAO
::executeQuery($query);
4458 * Populate $this->_permissionWhereClause with permission related clause and update other
4459 * query related properties.
4461 * Function calls ACL permission class and hooks to filter the query appropriately
4463 * Note that these 2 params were in the code when extracted from another function
4464 * and a second round extraction would be to make them properties of the class
4466 * @param bool $onlyDeleted Only get deleted contacts
4467 * @param bool $count Return Count only
4471 function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
4472 if (!$this->_skipPermission
) {
4473 $this->_permissionWhereClause
= CRM_ACL_API
::whereClause(
4474 CRM_Core_Permission
::VIEW
,
4476 $this->_whereTables
,
4479 $this->_skipDeleteClause
4482 // regenerate fromClause since permission might have added tables
4483 if ($this->_permissionWhereClause
) {
4484 //fix for row count in qill (in contribute/membership find)
4486 $this->_useDistinct
= TRUE;
4488 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4489 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4493 // add delete clause if needed even if we are skipping permission
4495 if (!$this->_skipDeleteClause
) {
4496 if (CRM_Core_Permission
::check('access deleted contacts') and $onlyDeleted) {
4497 $this->_permissionWhereClause
= '(contact_a.is_deleted)';
4501 $this->_permissionWhereClause
= '(contact_a.is_deleted = 0)';
4507 function setSkipPermission($val) {
4508 $this->_skipPermission
= $val;
4511 function &summaryContribution($context = NULL) {
4512 list($innerselect, $from, $where, $having) = $this->query(TRUE);
4516 SELECT COUNT( conts.total_amount ) as total_count,
4517 SUM( conts.total_amount ) as total_amount,
4518 AVG( conts.total_amount ) as total_avg,
4519 conts.currency as currency";
4520 if($this->_permissionWhereClause
) {
4521 $where .= " AND " . $this->_permissionWhereClause
;
4523 if ($context == 'search') {
4524 $where .= " AND contact_a.is_deleted = 0 ";
4527 // make sure contribution is completed - CRM-4989
4528 $completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 ";
4532 $summary['total'] = array();
4533 $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
4535 $query = "$select FROM (
4536 SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $completedWhere
4537 GROUP BY civicrm_contribution.id
4541 $dao = CRM_Core_DAO
::executeQuery($query);
4543 $summary['total']['count'] = 0;
4544 $summary['total']['amount'] = $summary['total']['avg'] = array();
4545 while ($dao->fetch()) {
4546 $summary['total']['count'] +
= $dao->total_count
;
4547 $summary['total']['amount'][] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
4548 $summary['total']['avg'][] = CRM_Utils_Money
::format($dao->total_avg
, $dao->currency
);
4550 if (!empty($summary['total']['amount'])) {
4551 $summary['total']['amount'] = implode(', ', $summary['total']['amount']);
4552 $summary['total']['avg'] = implode(', ', $summary['total']['avg']);
4555 $summary['total']['amount'] = $summary['total']['avg'] = 0;
4558 // soft credit summary
4559 if (CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled()) {
4560 $softCreditWhere = "{$completedWhere} AND civicrm_contribution_soft.id IS NOT NULL";
4563 SELECT civicrm_contribution_soft.amount as total_amount, civicrm_contribution_soft.currency $from $softCreditWhere
4564 GROUP BY civicrm_contribution_soft.id
4567 $dao = CRM_Core_DAO
::executeQuery($query);
4568 $summary['soft_credit']['count'] = 0;
4569 $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = array();
4570 while ($dao->fetch()) {
4571 $summary['soft_credit']['count'] +
= $dao->total_count
;
4572 $summary['soft_credit']['amount'][] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
4573 $summary['soft_credit']['avg'][] = CRM_Utils_Money
::format($dao->total_avg
, $dao->currency
);
4575 if (!empty($summary['soft_credit']['amount'])) {
4576 $summary['soft_credit']['amount'] = implode(', ', $summary['soft_credit']['amount']);
4577 $summary['soft_credit']['avg'] = implode(', ', $summary['soft_credit']['avg']);
4580 $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = 0;
4585 //@todo - this could be one query using the IF in mysql - eg
4586 // SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM (
4587 // SELECT civicrm_contribution.total_amount, civicrm_contribution.currency ,
4588 // IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed,
4589 // IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed,
4590 // IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled,
4591 // IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled
4592 // FROM civicrm_contact contact_a
4593 // LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id
4594 // WHERE ( ... where clause....
4595 // AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1)
4599 SELECT COUNT( conts.total_amount ) as cancel_count,
4600 SUM( conts.total_amount ) as cancel_amount,
4601 AVG( conts.total_amount ) as cancel_avg,
4602 conts.currency as currency";
4604 $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
4605 if ($context == 'search') {
4606 $where .= " AND contact_a.is_deleted = 0 ";
4609 $query = "$select FROM (
4610 SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $where
4611 GROUP BY civicrm_contribution.id
4615 $dao = CRM_Core_DAO
::executeQuery($query);
4618 if ($dao->fetch()) {
4619 $summary['cancel']['count'] = $dao->cancel_count
;
4620 $summary['cancel']['amount'] = $dao->cancel_amount
;
4621 $summary['cancel']['avg'] = $dao->cancel_avg
;
4625 $summary['cancel']['count'] = 0;
4626 $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
4627 while ($dao->fetch()) {
4628 $summary['cancel']['count'] +
= $dao->cancel_count
;
4629 $summary['cancel']['amount'][] = CRM_Utils_Money
::format($dao->cancel_amount
, $dao->currency
);
4630 $summary['cancel']['avg'][] = CRM_Utils_Money
::format($dao->cancel_avg
, $dao->currency
);
4632 $summary['cancel']['amount'] = implode(', ', $summary['cancel']['amount']);
4633 $summary['cancel']['avg'] = implode(', ', $summary['cancel']['avg']);
4640 * getter for the qill object
4646 return $this->_qill
;
4650 * default set of return default hier return properties
4655 static function &defaultHierReturnProperties() {
4656 if (!isset(self
::$_defaultHierReturnProperties)) {
4657 self
::$_defaultHierReturnProperties = array(
4660 'legal_identifier' => 1,
4661 'external_identifier' => 1,
4662 'contact_type' => 1,
4663 'contact_sub_type' => 1,
4665 'display_name' => 1,
4672 'formal_title' => 1,
4673 'communication_style_id' => 1,
4674 'email_greeting' => 1,
4675 'postal_greeting' => 1,
4679 'preferred_communication_method' => 1,
4680 'do_not_phone' => 1,
4681 'do_not_email' => 1,
4684 'do_not_trade' => 1,
4687 '1' => array('location_type' => 1,
4688 'street_address' => 1,
4690 'state_province' => 1,
4692 'postal_code_suffix' => 1,
4695 'phone-Mobile' => 1,
4708 'location_type' => 1,
4709 'street_address' => 1,
4711 'state_province' => 1,
4713 'postal_code_suffix' => 1,
4716 'phone-Mobile' => 1,
4730 return self
::$_defaultHierReturnProperties;
4733 function dateQueryBuilder(
4734 &$values, $tableName, $fieldName,
4735 $dbFieldName, $fieldTitle,
4736 $appendTimeStamp = TRUE
4738 list($name, $op, $value, $grouping, $wildcard) = $values;
4744 if ($name == "{$fieldName}_low" ||
4745 $name == "{$fieldName}_high"
4747 if (isset($this->_rangeCache
[$fieldName])) {
4750 $this->_rangeCache
[$fieldName] = 1;
4752 $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
4754 if ($name == $fieldName . '_low') {
4756 $firstPhrase = ts('greater than or equal to');
4757 $firstDate = CRM_Utils_Date
::processDate($value);
4759 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4760 if (!empty($secondValues) && $secondValues[2]) {
4762 $secondPhrase = ts('less than or equal to');
4763 $secondValue = $secondValues[2];
4765 if ($appendTimeStamp && strlen($secondValue) == 10) {
4766 $secondValue .= ' 23:59:59';
4768 $secondDate = CRM_Utils_Date
::processDate($secondValue);
4771 elseif ($name == $fieldName . '_high') {
4773 $firstPhrase = ts('less than or equal to');
4775 if ($appendTimeStamp && strlen($value) == 10) {
4776 $value .= ' 23:59:59';
4778 $firstDate = CRM_Utils_Date
::processDate($value);
4780 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4781 if (!empty($secondValues) && $secondValues[2]) {
4783 $secondPhrase = ts('greater than or equal to');
4784 $secondValue = $secondValues[2];
4785 $secondDate = CRM_Utils_Date
::processDate($secondValue);
4789 if (!$appendTimeStamp) {
4790 $firstDate = substr($firstDate, 0, 8);
4792 $firstDateFormat = CRM_Utils_Date
::customFormat($firstDate);
4795 if (!$appendTimeStamp) {
4796 $secondDate = substr($secondDate, 0, 8);
4798 $secondDateFormat = CRM_Utils_Date
::customFormat($secondDate);
4801 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4803 $this->_where
[$grouping][] = "
4804 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
4805 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
4807 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
4810 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
4811 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
4815 if ($name == $fieldName) {
4819 $date = CRM_Utils_Date
::processDate($value);
4821 if (!$appendTimeStamp) {
4822 $date = substr($date, 0, 8);
4825 $format = CRM_Utils_Date
::customFormat($date);
4828 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op '$date'";
4831 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op";
4833 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4834 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$format\"";
4838 function numberRangeBuilder(&$values,
4839 $tableName, $fieldName,
4840 $dbFieldName, $fieldTitle,
4843 list($name, $op, $value, $grouping, $wildcard) = $values;
4845 if ($name == "{$fieldName}_low" ||
4846 $name == "{$fieldName}_high"
4848 if (isset($this->_rangeCache
[$fieldName])) {
4851 $this->_rangeCache
[$fieldName] = 1;
4853 $secondOP = $secondPhrase = $secondValue = NULL;
4855 if ($name == "{$fieldName}_low") {
4857 $firstPhrase = ts('greater than');
4859 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
4860 if (!empty($secondValues)) {
4862 $secondPhrase = ts('less than');
4863 $secondValue = $secondValues[2];
4868 $firstPhrase = ts('less than');
4870 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
4871 if (!empty($secondValues)) {
4873 $secondPhrase = ts('greater than');
4874 $secondValue = $secondValues[2];
4879 $this->_where
[$grouping][] = "
4880 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
4881 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
4883 $displayValue = $options ?
$options[$value] : $value;
4884 $secondDisplayValue = $options ?
$options[$secondValue] : $secondValue;
4886 $this->_qill
[$grouping][] =
4887 "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
4890 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
4891 $displayValue = $options ?
$options[$value] : $value;
4892 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
4894 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4899 if ($name == $fieldName) {
4903 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
4905 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
4906 $displayValue = $options ?
$options[$value] : $value;
4907 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
4914 * Given the field name, operator, value & its data type
4915 * builds the where Clause for the query
4916 * used for handling 'IS NULL'/'IS NOT NULL' operators
4918 * @param string $field fieldname
4919 * @param string $op operator
4920 * @param string $value value
4921 * @param string $dataType data type of the field
4923 * @return where clause for the query
4926 static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
4928 $clause = "$field $op";
4936 $clause = " ( $field IS NULL OR $field = '' ) ";
4939 case 'IS NOT EMPTY':
4940 $clause = " ( $field IS NOT NULL AND $field <> '' ) ";
4945 if (isset($dataType)) {
4946 if (is_array($value)) {
4950 $value = CRM_Utils_Type
::escape($value, "String");
4951 $values = explode(',', CRM_Utils_Array
::value(0, explode(')', CRM_Utils_Array
::value(1, explode('(', $value)))));
4953 // supporting multiple values in IN clause
4955 foreach ($values as $v) {
4957 $val[] = "'" . CRM_Utils_Type
::escape($v, $dataType) . "'";
4959 $value = "(" . implode($val, ",") . ")";
4961 return "$clause $value";
4964 if (empty($dataType)) {
4965 $dataType = 'String';
4968 $value = CRM_Utils_Type
::escape($value, $dataType);
4969 // if we dont have a dataType we should assume
4970 if ($dataType == 'String' ||
$dataType == 'Text') {
4971 $value = "'" . strtolower($value) . "'";
4973 return "$clause $value";
4977 function openedSearchPanes($reset = FALSE) {
4978 if (!$reset ||
empty($this->_whereTables
)) {
4979 return self
::$_openedPanes;
4982 // pane name to table mapper
4983 $panesMapper = array(
4984 ts('Contributions') => 'civicrm_contribution',
4985 ts('Memberships') => 'civicrm_membership',
4986 ts('Events') => 'civicrm_participant',
4987 ts('Relationships') => 'civicrm_relationship',
4988 ts('Activities') => 'civicrm_activity',
4989 ts('Pledges') => 'civicrm_pledge',
4990 ts('Cases') => 'civicrm_case',
4991 ts('Grants') => 'civicrm_grant',
4992 ts('Address Fields') => 'civicrm_address',
4993 ts('Notes') => 'civicrm_note',
4994 ts('Change Log') => 'civicrm_log',
4995 ts('Mailings') => 'civicrm_mailing_event_queue',
4997 CRM_Contact_BAO_Query_Hook
::singleton()->getPanesMapper($panesMapper);
4999 foreach (array_keys($this->_whereTables
) as $table) {
5000 if ($panName = array_search($table, $panesMapper)) {
5001 self
::$_openedPanes[$panName] = TRUE;
5005 return self
::$_openedPanes;
5008 function setOperator($operator) {
5009 $validOperators = array('AND', 'OR');
5010 if (!in_array($operator, $validOperators)) {
5013 $this->_operator
= $operator;
5016 function getOperator() {
5017 return $this->_operator
;
5020 function filterRelatedContacts(&$from, &$where, &$having) {
5021 static $_rTypeProcessed = NULL;
5022 static $_rTypeFrom = NULL;
5023 static $_rTypeWhere = NULL;
5025 if (!$_rTypeProcessed) {
5026 $_rTypeProcessed = TRUE;
5028 // create temp table with contact ids
5029 $tableName = CRM_Core_DAO
::createTempTableName('civicrm_transform', TRUE);
5030 $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
5031 CRM_Core_DAO
::executeQuery($sql);
5034 REPLACE INTO $tableName ( contact_id )
5040 CRM_Core_DAO
::executeQuery($sql);
5042 $qillMessage = ts('Contacts with a Relationship Type of: ');
5043 $rTypes = CRM_Core_PseudoConstant
::relationshipType();
5045 if (is_numeric($this->_displayRelationshipType
)) {
5046 $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType
]['label_a_b'];
5048 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
5049 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
5052 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
5053 AND displayRelType.is_active = 1
5057 list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType
);
5058 if ($dirOne == 'a') {
5059 $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
5061 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
5062 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
5066 $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
5068 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
5069 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
5073 WHERE displayRelType.relationship_type_id = $relType
5074 AND displayRelType.is_active = 1
5077 $this->_qill
[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'";
5080 if (strpos($from, $_rTypeFrom) === FALSE) {
5081 // lets replace all the INNER JOIN's in the $from so we dont exclude other data
5082 // this happens when we have an event_type in the quert (CRM-7969)
5083 $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
5084 $from .= $_rTypeFrom;
5085 $where = $_rTypeWhere;
5091 static function caseImportant( $op ) {
5093 in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ?
FALSE : TRUE;
5096 static function componentPresent( &$returnProperties, $prefix ) {
5097 foreach ($returnProperties as $name => $dontCare ) {
5098 if (substr($name, 0, strlen($prefix)) == $prefix) {
5106 * Builds the necessary structures for all fields that are similar to option value lookups
5108 * @param $name string the name of the field
5109 * @param $op string the sql operator, this function should handle ALL SQL operators
5110 * @param $value any string / integer / array depends on the operator and whos calling the query builder
5111 * @param $grouping int the index where to place the where clause
5112 * @param $selectValues
5113 * @param $field array an array that contains various properties of the field identified by $name
5114 * @param $label string The label for this field element
5115 * @param $dataType string The data type for this element
5117 * @param bool $useIDsOnly
5119 * @internal param array $selectValue the key value pairs for this element. This allows us to use this function for things besides option-value pairs
5120 * @return void adds the where clause and qill to the query object
5122 function optionValueQuery(
5130 $dataType = 'String',
5134 if (!empty($selectValues)) {
5135 $qill = $selectValues[$value];
5141 $pseudoFields = array('email_greeting', 'postal_greeting', 'addressee', 'gender_id', 'prefix_id', 'suffix_id', 'communication_style_id');
5143 if (is_numeric($value)) {
5144 $qill = $selectValues[(int ) $value];
5146 elseif ($op == 'IN' ||
$op == 'NOT IN') {
5147 $values = self
::parseSearchBuilderString($value);
5148 if (is_array($values)) {
5150 $newValues = array();
5151 foreach ($values as $v) {
5152 $intVals[] = (int) $v;
5153 $newValues[] = $selectValues[(int ) $v];
5156 $value = (in_array($name, $pseudoFields)) ?
$intVals : $newValues;
5157 $qill = implode(', ', $newValues);
5160 elseif (!array_key_exists($value, $selectValues)) {
5161 // its a string, lets get the int value
5162 $value = array_search($value, $selectValues);
5165 list($tableName, $fieldName) = explode('.', $field['where'], 2);
5166 if ($tableName == 'civicrm_contact') {
5167 $wc = "contact_a.$fieldName";
5171 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
5174 if (in_array($name, $pseudoFields)) {
5175 if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id', 'communication_style_id'))) {
5176 $wc = "contact_a.{$name}_id";
5178 $dataType = 'Positive';
5179 $value = (!$value) ?
0 : $value;
5182 $this->_qill
[$grouping][] = $label . " $op '$qill'";
5183 $op = (in_array($name, $pseudoFields) && ($op == 'LIKE' ||
$op == 'RLIKE')) ?
'=' : $op;
5184 $this->_where
[$grouping][] = self
::buildClause($wc, $op, $value, $dataType);
5188 * function to check and explode a user defined numeric string into an array
5189 * this was the protocol used by search builder in the old old days before we had
5190 * super nice js widgets to do the hard work
5192 * @param the $string
5193 * @param string $dataType the dataType we should check for the values, default integer
5195 * @return FALSE if string does not match the patter
5196 * array of numeric values if string does match the pattern
5199 static function parseSearchBuilderString($string, $dataType = 'Integer') {
5200 $string = trim($string);
5201 if (substr($string, 0, 1) != '(' ||
substr($string, -1, 1) != ')') {
5205 $string = substr($string, 1, -1);
5206 $values = explode(',', $string);
5207 if (empty($values)) {
5211 $returnValues = array();
5212 foreach ($values as $v) {
5213 if ($dataType == 'Integer' && ! is_numeric($v)) {
5216 else if ($dataType == 'String' && ! is_string($v)) {
5219 $returnValues[] = trim($v);
5222 if (empty($returnValues)) {
5226 return $returnValues;
5230 * convert the pseudo constants id's to their names
5232 * @param reference parameter $dao
5233 * @param bool $return
5237 function convertToPseudoNames(&$dao, $return = FALSE) {
5238 if (empty($this->_pseudoConstantsSelect
)) {
5242 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
5243 foreach ($this->_pseudoConstantsSelect
as $key => $value) {
5244 if (!empty($this->_pseudoConstantsSelect
[$key]['sorting'])) {
5248 if (property_exists($dao, $value['idCol'])) {
5249 $val = $dao->$value['idCol'];
5251 if (CRM_Utils_System
::isNull($val)) {
5254 elseif ($baoName = CRM_Utils_Array
::value('bao', $value, NULL)) {
5256 $idColumn = "{$key}_id";
5257 $dao->$idColumn = $val;
5258 $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant
::getLabel($baoName, $value['pseudoField'], $val);
5260 elseif ($value['pseudoField'] == 'state_province_abbreviation') {
5261 $dao->$key = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($val);
5263 elseif ($value['pseudoField'] == 'participant_role') {
5264 $viewRoles = array();
5265 foreach (explode($sep, $val) as $k => $v) {
5266 $viewRoles[] = CRM_Event_PseudoConstant
::participantRole($v);
5268 $dao->$key = implode(', ', $viewRoles);
5271 $labels = CRM_Core_OptionGroup
::values($value['pseudoField']);
5272 $dao->$key = $labels[$val];
5275 // return converted values in array format
5277 if (strpos($key, '-') !== FALSE) {
5278 $keyVal = explode('-', $key);
5279 $current = &$values;
5280 $lastElement = array_pop($keyVal);
5281 foreach ($keyVal as $v) {
5282 if (!array_key_exists($v, $current)) {
5283 $current[$v] = array();
5285 $current = &$current[$v];
5287 $current[$lastElement] = $dao->$key;
5290 $values[$key] = $dao->$key;
5299 * include pseudo fields LEFT JOIN
5300 * @param $sort can be a object or string
5304 function includePseudoFieldsJoin($sort) {
5305 if (!$sort ||
empty($this->_pseudoConstantsSelect
)) {
5308 $sort = is_string($sort) ?
$sort : $sort->orderBy();
5311 foreach ($this->_pseudoConstantsSelect
as $name => $value) {
5312 if (!empty($value['table'])) {
5313 $regex = "/({$value['table']}\.|{$name})/";
5314 if (preg_match($regex, $sort)) {
5315 $this->_elemnt
[$value['element']] = 1;
5316 $this->_select
[$value['element']] = $value['select'];
5317 $this->_pseudoConstantsSelect
[$name]['sorting'] = 1;
5318 $present[$value['table']] = $value['join'];
5322 $presentSimpleFrom = $present;
5324 if (array_key_exists('civicrm_worldregion', $this->_whereTables
) &&
5325 array_key_exists('civicrm_country', $presentSimpleFrom)) {
5326 unset($presentSimpleFrom['civicrm_country']);
5328 if (array_key_exists('civicrm_worldregion', $this->_tables
) &&
5329 array_key_exists('civicrm_country', $present)) {
5330 unset($present['civicrm_country']);
5333 $presentClause = $presentSimpleFromClause = NULL;
5334 if (!empty($present)) {
5335 $presentClause = implode(' ', $present);
5337 if (!empty($presentSimpleFrom)) {
5338 $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
5341 $this->_fromClause
= $this->_fromClause
. $presentClause;
5342 $this->_simpleFromClause
= $this->_simpleFromClause
. $presentSimpleFromClause;
5344 return array($presentClause, $presentSimpleFromClause);