3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * This is the heart of the search query building mechanism.
37 class CRM_Contact_BAO_Query
{
40 * The various search modes.
42 * As of February 2017, entries not present for 4, 32, 64, 1024.
44 * MODE_ALL seems to be out of sync with the available constants;
45 * if this is intentionally excluding MODE_MAILING then that may
48 * Likewise if there's reason for the missing modes (4, 32, 64 etc).
53 NO_RETURN_PROPERTIES
= 'CRM_Contact_BAO_Query::NO_RETURN_PROPERTIES',
59 MODE_CONTACTSRELATED
= 32,
62 MODE_PLEDGEBANK
= 256,
72 * Constants for search operators
75 SEARCH_OPERATOR_AND
= 'AND',
76 SEARCH_OPERATOR_OR
= 'OR';
79 * The default set of return properties.
83 static $_defaultReturnProperties = NULL;
86 * The default set of hier return properties.
90 static $_defaultHierReturnProperties;
93 * The set of input params.
101 public $_paramLookup;
106 * The set of output params
110 public $_returnProperties;
120 * The name of the elements that are in the select clause
121 * used to extract the values.
128 * The tables involved in the query.
135 * The table involved in the where clause.
139 public $_whereTables;
142 * Array of WHERE clause components.
149 * The WHERE clause as a string.
153 public $_whereClause;
156 * Additional WHERE clause for permissions.
160 public $_permissionWhereClause;
170 * Additional permission from clause
174 public $_permissionFromClause;
177 * The from clause for the simple select and alphabetical
182 public $_simpleFromClause;
192 * The english language version of the query
199 * All the fields that could potentially be involved in
207 * The cache to translate the option values into labels.
214 * Are we in search mode.
218 public $_search = TRUE;
221 * Should we skip permission checking.
225 public $_skipPermission = FALSE;
228 * Should we skip adding of delete clause.
232 public $_skipDeleteClause = FALSE;
235 * Are we in strict mode (use equality over LIKE)
239 public $_strict = FALSE;
242 * What operator to use to group the clauses.
246 public $_operator = 'AND';
251 * Should we only search on primary location.
255 public $_primaryLocation = TRUE;
258 * Are contact ids part of the query.
262 public $_includeContactIds = FALSE;
265 * Should we use the smart group cache.
269 public $_smartGroupCache = TRUE;
272 * Should we display contacts with a specific relationship type.
276 public $_displayRelationshipType = NULL;
279 * Reference to the query object for custom values.
283 public $_customQuery;
286 * Should we enable the distinct clause, used if we are including
287 * more than one group
291 public $_useDistinct = FALSE;
294 * Should we just display one contact record
296 public $_useGroupBy = FALSE;
299 * The relationship type direction
310 static $_activityRole;
313 * Consider the component activity type
314 * during activity search.
318 static $_considerCompActivities;
321 * Consider with contact activities only,
322 * during activity search.
326 static $_withContactActivitiesOnly;
329 * Use distinct component clause for component searches
333 public $_distinctComponentClause;
335 public $_rowCountClause;
338 * Use groupBy component clause for component searches
342 public $_groupByComponentClause;
345 * Track open panes, useful in advance search
349 public static $_openedPanes = array();
352 * For search builder - which custom fields are location-dependent
355 public $_locationSpecificCustomFields = array();
358 * The tables which have a dependency on location and/or address
362 static $_dependencies = array(
363 'civicrm_state_province' => 1,
364 'civicrm_country' => 1,
365 'civicrm_county' => 1,
366 'civicrm_address' => 1,
367 'civicrm_location_type' => 1,
371 * List of location specific fields.
373 static $_locationSpecificFields = array(
378 'supplemental_address_1',
379 'supplemental_address_2',
380 'supplemental_address_3',
383 'postal_code_suffix',
397 * Remember if we handle either end of a number or date range
398 * so we can skip the other
400 protected $_rangeCache = array();
402 * Set to true when $this->relationship is run to avoid adding twice
405 protected $_relationshipValuesAdded = FALSE;
408 * Set to the name of the temp table if one has been created
411 static $_relationshipTempTable = NULL;
413 public $_pseudoConstantsSelect = array();
415 public $_groupUniqueKey = NULL;
418 * Class constructor which also does all the work.
420 * @param array $params
421 * @param array $returnProperties
422 * @param array $fields
423 * @param bool $includeContactIds
424 * @param bool $strict
425 * @param bool|int $mode - mode the search is operating on
427 * @param bool $skipPermission
428 * @param bool $searchDescendentGroups
429 * @param bool $smartGroupCache
430 * @param null $displayRelationshipType
431 * @param string $operator
432 * @param string $apiEntity
433 * @param bool|NULL $primaryLocationOnly
435 public function __construct(
436 $params = NULL, $returnProperties = NULL, $fields = NULL,
437 $includeContactIds = FALSE, $strict = FALSE, $mode = 1,
438 $skipPermission = FALSE, $searchDescendentGroups = TRUE,
439 $smartGroupCache = TRUE, $displayRelationshipType = NULL,
442 $primaryLocationOnly = NULL
444 if ($primaryLocationOnly === NULL) {
445 $primaryLocationOnly = Civi
::settings()->get('searchPrimaryDetailsOnly');
447 $this->_primaryLocation
= $primaryLocationOnly;
448 $this->_params
= &$params;
449 if ($this->_params
== NULL) {
450 $this->_params
= array();
453 if ($returnProperties === self
::NO_RETURN_PROPERTIES
) {
454 $this->_returnProperties
= array();
456 elseif (empty($returnProperties)) {
457 $this->_returnProperties
= self
::defaultReturnProperties($mode);
460 $this->_returnProperties
= &$returnProperties;
463 $this->_includeContactIds
= $includeContactIds;
464 $this->_strict
= $strict;
465 $this->_mode
= $mode;
466 $this->_skipPermission
= $skipPermission;
467 $this->_smartGroupCache
= $smartGroupCache;
468 $this->_displayRelationshipType
= $displayRelationshipType;
469 $this->setOperator($operator);
472 $this->_fields
= &$fields;
473 $this->_search
= FALSE;
474 $this->_skipPermission
= TRUE;
477 $this->_fields
= CRM_Contact_BAO_Contact
::exportableFields('All', FALSE, TRUE, TRUE, FALSE, !$skipPermission);
479 $fields = CRM_Core_Component
::getQueryFields(!$this->_skipPermission
);
480 unset($fields['note']);
481 $this->_fields
= array_merge($this->_fields
, $fields);
483 // add activity fields
484 $fields = CRM_Activity_BAO_Activity
::exportableFields();
485 $this->_fields
= array_merge($this->_fields
, $fields);
487 // add any fields provided by hook implementers
488 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
489 $this->_fields
= array_merge($this->_fields
, $extFields);
492 // basically do all the work once, and then reuse it
493 $this->initialize($apiEntity);
497 * Function which actually does all the work for the constructor.
499 * @param string $apiEntity
500 * The api entity being called.
501 * This sort-of duplicates $mode in a confusing way. Probably not by design.
503 public function initialize($apiEntity = NULL) {
504 $this->_select
= array();
505 $this->_element
= array();
506 $this->_tables
= array();
507 $this->_whereTables
= array();
508 $this->_where
= array();
509 $this->_qill
= array();
510 $this->_options
= array();
511 $this->_cfIDs
= array();
512 $this->_paramLookup
= array();
513 $this->_having
= array();
515 $this->_customQuery
= NULL;
517 // reset cached static variables - CRM-5803
518 self
::$_activityRole = NULL;
519 self
::$_considerCompActivities = NULL;
520 self
::$_withContactActivitiesOnly = NULL;
522 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
523 $this->_element
['contact_id'] = 1;
524 $this->_tables
['civicrm_contact'] = 1;
526 if (!empty($this->_params
)) {
527 $this->buildParamsLookup();
530 $this->_whereTables
= $this->_tables
;
532 $this->selectClause($apiEntity);
533 $this->_whereClause
= $this->whereClause($apiEntity);
534 if (array_key_exists('civicrm_contribution', $this->_whereTables
)) {
535 $component = 'contribution';
537 if (array_key_exists('civicrm_membership', $this->_whereTables
)) {
538 $component = 'membership';
540 if (isset($component)) {
541 CRM_Financial_BAO_FinancialType
::buildPermissionedClause($this->_whereClause
, $component);
544 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
, $apiEntity);
545 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
547 $this->openedSearchPanes(TRUE);
551 * Function for same purpose as convertFormValues.
553 * Like convert form values this function exists to pre-Process parameters from the form.
555 * It is unclear why they are different functions & likely relates to advances search
556 * versus search builder.
558 * The direction we are going is having the form convert values to a standardised format &
559 * moving away from weird & wonderful where clause switches.
561 * Fix and handle contact deletion nicely.
563 * this code is primarily for search builder use case where different clauses can specify if they want deleted.
567 public function buildParamsLookup() {
568 $trashParamExists = FALSE;
569 $paramByGroup = array();
570 foreach ($this->_params
as $k => $param) {
571 if (!empty($param[0]) && $param[0] == 'contact_is_deleted') {
572 $trashParamExists = TRUE;
574 if (!empty($param[3])) {
575 $paramByGroup[$param[3]][$k] = $param;
579 if ($trashParamExists) {
580 $this->_skipDeleteClause
= TRUE;
582 //cycle through group sets and explicitly add trash param if not set
583 foreach ($paramByGroup as $setID => $set) {
585 !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params
) &&
586 !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params
)
588 $this->_params
[] = array(
589 'contact_is_deleted',
599 foreach ($this->_params
as $value) {
600 if (empty($value[0])) {
603 $cfID = CRM_Core_BAO_CustomField
::getKeyID($value[0]);
605 if (!array_key_exists($cfID, $this->_cfIDs
)) {
606 $this->_cfIDs
[$cfID] = array();
608 // Set wildcard value based on "and/or" selection
609 foreach ($this->_params
as $key => $param) {
610 if ($param[0] == $value[0] . '_operator') {
611 $value[4] = $param[2] == 'or';
615 $this->_cfIDs
[$cfID][] = $value;
618 if (!array_key_exists($value[0], $this->_paramLookup
)) {
619 $this->_paramLookup
[$value[0]] = array();
621 if ($value[0] !== 'group') {
622 // Just trying to unravel how group interacts here! This whole function is weird.
623 $this->_paramLookup
[$value[0]][] = $value;
629 * Some composite fields do not appear in the fields array hack to make them part of the query.
632 * The api entity being called.
633 * This sort-of duplicates $mode in a confusing way. Probably not by design.
635 public function addSpecialFields($apiEntity) {
636 static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name');
637 // if get called via Contact.get API having address_id as return parameter
638 if ($apiEntity == 'Contact') {
639 $special[] = 'address_id';
641 foreach ($special as $name) {
642 if (!empty($this->_returnProperties
[$name])) {
643 if ($name == 'address_id') {
644 $this->_tables
['civicrm_address'] = 1;
645 $this->_select
['address_id'] = 'civicrm_address.id as address_id';
646 $this->_element
['address_id'] = 1;
649 $this->_select
[$name] = "contact_a.{$name} as $name";
650 $this->_element
[$name] = 1;
657 * Given a list of conditions in params and a list of desired
658 * return Properties generate the required select and from
659 * clauses. Note that since the where clause introduces new
660 * tables, the initial attempt also retrieves all variables used
663 * @param string $apiEntity
664 * The api entity being called.
665 * This sort-of duplicates $mode in a confusing way. Probably not by design.
667 public function selectClause($apiEntity = NULL) {
669 // @todo Tidy up this. This arises because 1) we are ignoring the $mode & adding a new
670 // param ($apiEntity) instead - presumably an oversight & 2 because
671 // contact is not implemented as a component.
672 $this->addSpecialFields($apiEntity);
674 foreach ($this->_fields
as $name => $field) {
675 // skip component fields
676 // there are done by the alter query below
677 // and need not be done on every field
678 // @todo remove these & handle using metadata - only obscure fields
679 // that are hack-added should need to be excluded from the main loop.
681 (substr($name, 0, 12) == 'participant_') ||
682 (substr($name, 0, 7) == 'pledge_') ||
683 (substr($name, 0, 5) == 'case_')
688 // redirect to activity select clause
690 (substr($name, 0, 9) == 'activity_') ||
691 ($name == 'parent_id')
693 CRM_Activity_BAO_Query
::select($this);
696 // if this is a hierarchical name, we ignore it
697 $names = explode('-', $name);
698 if (count($names) > 1 && isset($names[1]) && is_numeric($names[1])) {
702 // make an exception for special cases, to add the field in select clause
703 $makeException = FALSE;
705 //special handling for groups/tags
706 if (in_array($name, array('groups', 'tags', 'notes'))
707 && isset($this->_returnProperties
[substr($name, 0, -1)])
709 // @todo instead of setting make exception to get us into
710 // an if clause that has handling for these fields buried with in it
711 // move the handling to here.
712 $makeException = TRUE;
715 // since note has 3 different options we need special handling
716 // note / note_subject / note_body
717 if ($name == 'notes') {
718 foreach (array('note', 'note_subject', 'note_body') as $noteField) {
719 if (isset($this->_returnProperties
[$noteField])) {
720 $makeException = TRUE;
726 $cfID = CRM_Core_BAO_CustomField
::getKeyID($name);
728 !empty($this->_paramLookup
[$name])
729 ||
!empty($this->_returnProperties
[$name])
730 ||
$this->pseudoConstantNameIsInReturnProperties($field)
734 // add to cfIDs array if not present
735 if (!array_key_exists($cfID, $this->_cfIDs
)) {
736 $this->_cfIDs
[$cfID] = array();
739 elseif (isset($field['where'])) {
740 list($tableName, $fieldName) = explode('.', $field['where'], 2);
741 if (isset($tableName)) {
742 if (CRM_Utils_Array
::value($tableName, self
::$_dependencies)) {
743 $this->_tables
['civicrm_address'] = 1;
744 $this->_select
['address_id'] = 'civicrm_address.id as address_id';
745 $this->_element
['address_id'] = 1;
748 if ($tableName == 'im_provider' ||
$tableName == 'email_greeting' ||
749 $tableName == 'postal_greeting' ||
$tableName == 'addressee'
751 if ($tableName == 'im_provider') {
752 CRM_Core_OptionValue
::select($this);
755 if (in_array($tableName,
756 array('email_greeting', 'postal_greeting', 'addressee'))) {
757 $this->_element
["{$name}_id"] = 1;
758 $this->_select
["{$name}_id"] = "contact_a.{$name}_id as {$name}_id";
759 $this->_pseudoConstantsSelect
[$name] = array('pseudoField' => $tableName, 'idCol' => "{$name}_id");
760 $this->_pseudoConstantsSelect
[$name]['select'] = "{$name}.{$fieldName} as $name";
761 $this->_pseudoConstantsSelect
[$name]['element'] = $name;
763 if ($tableName == 'email_greeting') {
765 $this->_pseudoConstantsSelect
[$name]['join']
766 = " LEFT JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')";
767 $this->_pseudoConstantsSelect
[$name]['join'] .=
768 " 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 ) ";
770 elseif ($tableName == 'postal_greeting') {
772 $this->_pseudoConstantsSelect
[$name]['join']
773 = " LEFT JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')";
774 $this->_pseudoConstantsSelect
[$name]['join'] .=
775 " 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 ) ";
777 elseif ($tableName == 'addressee') {
779 $this->_pseudoConstantsSelect
[$name]['join']
780 = " LEFT JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')";
781 $this->_pseudoConstantsSelect
[$name]['join'] .=
782 " LEFT JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) ";
784 $this->_pseudoConstantsSelect
[$name]['table'] = $tableName;
787 $greetField = "{$name}_display";
788 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
789 $this->_element
[$greetField] = 1;
791 $greetField = "{$name}_custom";
792 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
793 $this->_element
[$greetField] = 1;
797 if (!in_array($tableName, array('civicrm_state_province', 'civicrm_country', 'civicrm_county'))) {
798 $this->_tables
[$tableName] = 1;
801 // also get the id of the tableName
802 $tName = substr($tableName, 8);
803 if (in_array($tName, array('country', 'state_province', 'county'))) {
804 if ($tName == 'state_province') {
805 $this->_pseudoConstantsSelect
['state_province_name'] = array(
806 'pseudoField' => "{$tName}",
807 'idCol' => "{$tName}_id",
808 'bao' => 'CRM_Core_BAO_Address',
809 'table' => "civicrm_{$tName}",
810 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
813 $this->_pseudoConstantsSelect
[$tName] = array(
814 'pseudoField' => 'state_province_abbreviation',
815 'idCol' => "{$tName}_id",
816 'table' => "civicrm_{$tName}",
817 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
821 $this->_pseudoConstantsSelect
[$name] = array(
822 'pseudoField' => "{$tName}_id",
823 'idCol' => "{$tName}_id",
824 'bao' => 'CRM_Core_BAO_Address',
825 'table' => "civicrm_{$tName}",
826 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
830 $this->_select
["{$tName}_id"] = "civicrm_address.{$tName}_id as {$tName}_id";
831 $this->_element
["{$tName}_id"] = 1;
833 elseif ($tName != 'contact') {
834 $this->_select
["{$tName}_id"] = "{$tableName}.id as {$tName}_id";
835 $this->_element
["{$tName}_id"] = 1;
838 //special case for phone
839 if ($name == 'phone') {
840 $this->_select
['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id";
841 $this->_element
['phone_type_id'] = 1;
844 // if IM then select provider_id also
845 // to get "IM Service Provider" in a file to be exported, CRM-3140
847 $this->_select
['provider_id'] = "civicrm_im.provider_id as provider_id";
848 $this->_element
['provider_id'] = 1;
851 if ($tName == 'contact' && $fieldName == 'organization_name') {
852 // special case, when current employer is set for Individual contact
853 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name";
855 elseif ($tName == 'contact' && $fieldName === 'id') {
856 // Handled elsewhere, explicitly ignore. Possibly for all tables...
858 elseif (in_array($tName, array('country', 'county'))) {
859 $this->_pseudoConstantsSelect
[$name]['select'] = "{$field['where']} as `$name`";
860 $this->_pseudoConstantsSelect
[$name]['element'] = $name;
862 elseif ($tName == 'state_province') {
863 $this->_pseudoConstantsSelect
[$tName]['select'] = "{$field['where']} as `$name`";
864 $this->_pseudoConstantsSelect
[$tName]['element'] = $name;
866 elseif (strpos($name, 'contribution_soft_credit') !== FALSE) {
867 if (CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled($this->_params
)) {
868 $this->_select
[$name] = "{$field['where']} as `$name`";
872 // If we have an option group defined then rather than joining the option value table in
873 // (which is an unindexed join) we render the option value on output.
874 // @todo - extend this to other pseudoconstants.
875 if ($this->pseudoConstantNameIsInReturnProperties($field, $name)) {
876 $pseudoFieldName = $field['pseudoconstant']['optionGroupName'];
877 $this->_pseudoConstantsSelect
[$pseudoFieldName] = array(
878 'pseudoField' => $field['name'],
880 'field_name' => $field['name'],
881 'bao' => $field['bao'],
882 'pseudoconstant' => $field['pseudoconstant'],
884 $this->_tables
[$tableName] = 1;
885 $this->_element
[$pseudoFieldName] = 1;
887 $this->_select
[$name] = str_replace('civicrm_contact.', 'contact_a.', "{$field['where']} as `$name`");
889 if (!in_array($tName, array('state_province', 'country', 'county'))) {
890 $this->_element
[$name] = 1;
895 elseif ($name === 'tags') {
896 //@todo move this handling outside the big IF & ditch $makeException
897 $this->_useGroupBy
= TRUE;
898 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags";
899 $this->_element
[$name] = 1;
900 $this->_tables
['civicrm_tag'] = 1;
901 $this->_tables
['civicrm_entity_tag'] = 1;
903 elseif ($name === 'groups') {
904 //@todo move this handling outside the big IF & ditch $makeException
905 $this->_useGroupBy
= TRUE;
906 // Duplicates will be created here but better to sort them out in php land.
907 $this->_select
[$name] = "
909 GROUP_CONCAT(DISTINCT IF(civicrm_group_contact.status = 'Added', civicrm_group_contact.group_id, '')),
910 GROUP_CONCAT(DISTINCT civicrm_group_contact_cache.group_id)
913 $this->_element
[$name] = 1;
914 $this->_tables
['civicrm_group_contact'] = 1;
915 $this->_tables
['civicrm_group_contact_cache'] = 1;
916 $this->_pseudoConstantsSelect
["{$name}"] = array(
917 'pseudoField' => "groups",
921 elseif ($name === 'notes') {
922 //@todo move this handling outside the big IF & ditch $makeException
923 // if note field is subject then return subject else body of the note
924 $noteColumn = 'note';
925 if (isset($noteField) && $noteField == 'note_subject') {
926 $noteColumn = 'subject';
929 $this->_useGroupBy
= TRUE;
930 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.$noteColumn)) as notes";
931 $this->_element
[$name] = 1;
932 $this->_tables
['civicrm_note'] = 1;
934 elseif ($name === 'current_employer') {
935 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer";
936 $this->_element
[$name] = 1;
940 if ($cfID && !empty($field['is_search_range'])) {
941 // this is a custom field with range search enabled, so we better check for two/from values
942 if (!empty($this->_paramLookup
[$name . '_from'])) {
943 if (!array_key_exists($cfID, $this->_cfIDs
)) {
944 $this->_cfIDs
[$cfID] = array();
946 foreach ($this->_paramLookup
[$name . '_from'] as $pID => $p) {
947 // search in the cdID array for the same grouping
949 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
950 if ($c[3] == $p[3]) {
951 $this->_cfIDs
[$cfID][$cID][2]['from'] = $p[2];
956 $p[2] = array('from' => $p[2]);
957 $this->_cfIDs
[$cfID][] = $p;
961 if (!empty($this->_paramLookup
[$name . '_to'])) {
962 if (!array_key_exists($cfID, $this->_cfIDs
)) {
963 $this->_cfIDs
[$cfID] = array();
965 foreach ($this->_paramLookup
[$name . '_to'] as $pID => $p) {
966 // search in the cdID array for the same grouping
968 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
969 if ($c[4] == $p[4]) {
970 $this->_cfIDs
[$cfID][$cID][2]['to'] = $p[2];
975 $p[2] = array('to' => $p[2]);
976 $this->_cfIDs
[$cfID][] = $p;
983 // add location as hierarchical elements
984 $this->addHierarchicalElements();
986 // add multiple field like website
987 $this->addMultipleElements();
990 CRM_Core_Component
::alterQuery($this, 'select');
992 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'select');
994 if (!empty($this->_cfIDs
)) {
995 // @todo This function is the select function but instead of running 'select' it
996 // is running the whole query.
997 $this->_customQuery
= new CRM_Core_BAO_CustomQuery($this->_cfIDs
, TRUE, $this->_locationSpecificCustomFields
);
998 $this->_customQuery
->query();
999 $this->_select
= array_merge($this->_select
, $this->_customQuery
->_select
);
1000 $this->_element
= array_merge($this->_element
, $this->_customQuery
->_element
);
1001 $this->_tables
= array_merge($this->_tables
, $this->_customQuery
->_tables
);
1002 $this->_whereTables
= array_merge($this->_whereTables
, $this->_customQuery
->_whereTables
);
1003 $this->_options
= $this->_customQuery
->_options
;
1008 * If the return Properties are set in a hierarchy, traverse the hierarchy to get the return values.
1010 public function addHierarchicalElements() {
1011 if (empty($this->_returnProperties
['location'])) {
1014 if (!is_array($this->_returnProperties
['location'])) {
1018 $locationTypes = CRM_Core_DAO_Address
::buildOptions('location_type_id', 'validate');
1019 $processed = array();
1022 $addressCustomFields = CRM_Core_BAO_CustomField
::getFieldsForImport('Address');
1023 $addressCustomFieldIds = array();
1025 foreach ($this->_returnProperties
['location'] as $name => $elements) {
1026 $lCond = self
::getPrimaryCondition($name);
1029 $locationTypeId = array_search($name, $locationTypes);
1030 if ($locationTypeId === FALSE) {
1033 $lCond = "location_type_id = $locationTypeId";
1034 $this->_useDistinct
= TRUE;
1036 //commented for CRM-3256
1037 $this->_useGroupBy
= TRUE;
1040 $name = str_replace(' ', '_', $name);
1042 $tName = "$name-location_type";
1043 $ltName = "`$name-location_type`";
1044 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1045 $this->_select
["{$tName}"] = "`$tName`.name as `{$tName}`";
1046 $this->_element
["{$tName}_id"] = 1;
1047 $this->_element
["{$tName}"] = 1;
1049 $locationTypeName = $tName;
1050 $locationTypeJoin = array();
1052 $addAddress = FALSE;
1054 foreach ($elements as $elementFullName => $dontCare) {
1056 $elementName = $elementCmpName = $elementFullName;
1058 if (substr($elementCmpName, 0, 5) == 'phone') {
1059 $elementCmpName = 'phone';
1062 if (in_array($elementCmpName, array_keys($addressCustomFields))) {
1063 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($elementCmpName)) {
1064 $addressCustomFieldIds[$cfID][$name] = 1;
1067 //add address table only once
1068 if ((in_array($elementCmpName, self
::$_locationSpecificFields) ||
!empty($addressCustomFieldIds))
1070 && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid'))
1072 $tName = "$name-address";
1073 $aName = "`$name-address`";
1074 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1075 $this->_element
["{$tName}_id"] = 1;
1076 $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)";
1077 $this->_tables
[$tName] = $addressJoin;
1078 $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) ";
1079 $processed[$aName] = 1;
1083 $cond = $elementType = '';
1084 if (strpos($elementName, '-') !== FALSE) {
1085 // this is either phone, email or IM
1086 list($elementName, $elementType) = explode('-', $elementName);
1088 if (($elementName != 'phone') && ($elementName != 'im')) {
1089 $cond = self
::getPrimaryCondition($elementType);
1091 // CRM-13011 : If location type is primary, do not restrict search to the phone
1092 // type id - we want the primary phone, regardless of what type it is.
1093 // Otherwise, restrict to the specified phone type for the given field.
1094 if ((!$cond) && ($elementName == 'phone')) {
1095 $cond = "phone_type_id = '$elementType'";
1097 elseif ((!$cond) && ($elementName == 'im')) {
1098 // IM service provider id, CRM-3140
1099 $cond = "provider_id = '$elementType'";
1101 $elementType = '-' . $elementType;
1104 $field = CRM_Utils_Array
::value($elementName, $this->_fields
);
1106 // hack for profile, add location id
1109 // fix for CRM-882( to handle phone types )
1110 !is_numeric($elementType)
1112 if (is_numeric($name)) {
1113 $field = CRM_Utils_Array
::value($elementName . "-Primary$elementType", $this->_fields
);
1116 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
1119 elseif (is_numeric($name)) {
1120 //this for phone type to work
1121 if (in_array($elementName, array('phone', 'phone_ext'))) {
1122 $field = CRM_Utils_Array
::value($elementName . "-Primary" . $elementType, $this->_fields
);
1125 $field = CRM_Utils_Array
::value($elementName . "-Primary", $this->_fields
);
1129 //this is for phone type to work for profile edit
1130 if (in_array($elementName, array('phone', 'phone_ext'))) {
1131 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
1134 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId", $this->_fields
);
1139 // Check if there is a value, if so also add to where Clause
1141 if ($this->_params
) {
1143 if (isset($locationTypeId)) {
1144 $nm .= "-$locationTypeId";
1146 if (!is_numeric($elementType)) {
1147 $nm .= "$elementType";
1150 foreach ($this->_params
as $id => $values) {
1151 if ((is_array($values) && $values[0] == $nm) ||
1152 (in_array($elementName, array('phone', 'im'))
1153 && (strpos($values[0], $nm) !== FALSE)
1163 if ($field && isset($field['where'])) {
1164 list($tableName, $fieldName) = explode('.', $field['where'], 2);
1165 $pf = substr($tableName, 8);
1166 $tName = $name . '-' . $pf . $elementType;
1167 if (isset($tableName)) {
1168 if ($tableName == 'civicrm_state_province' ||
$tableName == 'civicrm_country' ||
$tableName == 'civicrm_county') {
1169 $this->_select
["{$tName}_id"] = "{$aName}.{$pf}_id as `{$tName}_id`";
1172 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1175 $this->_element
["{$tName}_id"] = 1;
1176 if (substr($tName, -15) == '-state_province') {
1177 // FIXME: hack to fix CRM-1900
1178 $a = Civi
::settings()->get('address_format');
1180 if (substr_count($a, 'state_province_name') > 0) {
1181 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] = array(
1182 'pseudoField' => "{$pf}_id",
1183 'idCol' => "{$tName}_id",
1184 'bao' => 'CRM_Core_BAO_Address',
1186 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.name as `{$name}-{$elementFullName}`";
1189 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] = array(
1190 'pseudoField' => 'state_province_abbreviation',
1191 'idCol' => "{$tName}_id",
1193 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`";
1197 if (substr($elementFullName, 0, 2) == 'im') {
1198 $provider = "{$name}-{$elementFullName}-provider_id";
1199 $this->_select
[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`";
1200 $this->_element
[$provider] = 1;
1202 if ($pf == 'country' ||
$pf == 'county') {
1203 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] = array(
1204 'pseudoField' => "{$pf}_id",
1205 'idCol' => "{$tName}_id",
1206 'bao' => 'CRM_Core_BAO_Address',
1208 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1211 $this->_select
["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1215 if (in_array($pf, array('state_province', 'country', 'county'))) {
1216 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['element'] = "{$name}-{$elementFullName}";
1219 $this->_element
["{$name}-{$elementFullName}"] = 1;
1222 if (empty($processed["`$tName`"])) {
1223 $processed["`$tName`"] = 1;
1224 $newName = $tableName . '_' . $index;
1225 switch ($tableName) {
1226 case 'civicrm_phone':
1227 case 'civicrm_email':
1229 case 'civicrm_openid':
1231 $this->_tables
[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id";
1232 if ($tableName != 'civicrm_phone') {
1233 $this->_tables
[$tName] .= " AND `$tName`.$lCond";
1235 elseif (is_numeric($name)) {
1236 $this->_select
[$tName] = "IF (`$tName`.is_primary = $name, `$tName`.phone, NULL) as `$tName`";
1239 // this special case to add phone type
1241 $phoneTypeCondition = " AND `$tName`.$cond ";
1242 //gross hack to pickup corrupted data also, CRM-7603
1243 if (strpos($cond, 'phone_type_id') !== FALSE) {
1244 $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) ";
1245 if (!empty($lCond)) {
1246 $phoneTypeCondition .= " AND ( `$tName`.$lCond ) ";
1249 $this->_tables
[$tName] .= $phoneTypeCondition;
1252 //build locationType join
1253 $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )";
1256 $this->_whereTables
[$tName] = $this->_tables
[$tName];
1260 case 'civicrm_state_province':
1261 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $tName;
1262 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join']
1263 = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id";
1265 $this->_whereTables
["{$name}-address"] = $addressJoin;
1269 case 'civicrm_country':
1270 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1271 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join']
1272 = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id";
1274 $this->_whereTables
["{$name}-address"] = $addressJoin;
1278 case 'civicrm_county':
1279 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1280 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join']
1281 = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id";
1283 $this->_whereTables
["{$name}-address"] = $addressJoin;
1289 $this->_whereTables
["{$name}-address"] = $addressJoin;
1298 // add location type join
1299 $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )";
1300 $this->_tables
[$locationTypeName] = $ltypeJoin;
1302 // table should be present in $this->_whereTables,
1303 // to add its condition in location type join, CRM-3939.
1304 if ($addWhereCount) {
1305 $locClause = array();
1306 foreach ($this->_whereTables
as $tableName => $clause) {
1307 if (!empty($locationTypeJoin[$tableName])) {
1308 $locClause[] = $locationTypeJoin[$tableName];
1312 if (!empty($locClause)) {
1313 $this->_whereTables
[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )";
1318 if (!empty($addressCustomFieldIds)) {
1319 $customQuery = new CRM_Core_BAO_CustomQuery($addressCustomFieldIds);
1320 foreach ($addressCustomFieldIds as $cfID => $locTypeName) {
1321 foreach ($locTypeName as $name => $dnc) {
1322 $this->_locationSpecificCustomFields
[$cfID] = array($name, array_search($name, $locationTypes));
1323 $fieldName = "$name-custom_{$cfID}";
1324 $tName = "$name-address-custom-{$cfID}";
1325 $aName = "`$name-address-custom-{$cfID}`";
1326 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1327 $this->_element
["{$tName}_id"] = 1;
1328 $this->_select
[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`";
1329 $this->_element
[$fieldName] = 1;
1330 $this->_tables
[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)";
1337 * If the return Properties are set in a hierarchy, traverse the hierarchy to get the return values.
1339 public function addMultipleElements() {
1340 if (empty($this->_returnProperties
['website'])) {
1343 if (!is_array($this->_returnProperties
['website'])) {
1347 foreach ($this->_returnProperties
['website'] as $key => $elements) {
1348 foreach ($elements as $elementFullName => $dontCare) {
1349 $tName = "website-{$key}-{$elementFullName}";
1350 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1351 $this->_select
["{$tName}"] = "`$tName`.url as `{$tName}`";
1352 $this->_element
["{$tName}_id"] = 1;
1353 $this->_element
["{$tName}"] = 1;
1355 $type = "website-{$key}-website_type_id";
1356 $this->_select
[$type] = "`$tName`.website_type_id as `{$type}`";
1357 $this->_element
[$type] = 1;
1358 $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id AND `$tName`.website_type_id = $key )";
1364 * Generate the query based on what type of query we need.
1366 * @param bool $count
1367 * @param bool $sortByChar
1368 * @param bool $groupContacts
1369 * @param bool $onlyDeleted
1372 * sql query parts as an array
1374 public function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE, $onlyDeleted = FALSE) {
1375 // build permission clause
1376 $this->generatePermissionClause($onlyDeleted, $count);
1379 if (isset($this->_rowCountClause
)) {
1380 $select = "SELECT {$this->_rowCountClause}";
1382 elseif (isset($this->_distinctComponentClause
)) {
1383 // we add distinct to get the right count for components
1384 // for the more complex result set, we use GROUP BY the same id
1386 $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} ) as rowCount";
1389 $select = 'SELECT count(DISTINCT contact_a.id) as rowCount';
1391 $from = $this->_simpleFromClause
;
1392 if ($this->_useDistinct
) {
1393 $this->_useGroupBy
= TRUE;
1396 elseif ($sortByChar) {
1397 $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name';
1398 $from = $this->_simpleFromClause
;
1400 elseif ($groupContacts) {
1401 $select = 'SELECT contact_a.id as id';
1402 if ($this->_useDistinct
) {
1403 $this->_useGroupBy
= TRUE;
1405 $from = $this->_simpleFromClause
;
1408 if (!empty($this->_paramLookup
['group'])) {
1410 list($name, $op, $value, $grouping, $wildcard) = $this->_paramLookup
['group'][0];
1412 if (is_array($value) && in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
1413 $this->_paramLookup
['group'][0][1] = key($value);
1416 // Presumably the lines below come into manage groups screen.
1417 // make sure there is only one element
1418 // this is used when we are running under smog and need to know
1419 // how the contact was added (CRM-1203)
1420 $groups = (array) CRM_Utils_Array
::value($this->_paramLookup
['group'][0][1], $this->_paramLookup
['group'][0][2], $this->_paramLookup
['group'][0][2]);
1421 if ((count($this->_paramLookup
['group']) == 1) &&
1422 (count($groups) == 1)
1424 $groupId = $groups[0];
1426 //check if group is saved search
1427 $group = new CRM_Contact_BAO_Group();
1428 $group->id
= $groupId;
1431 if (!isset($group->saved_search_id
)) {
1432 $tbName = "civicrm_group_contact";
1433 // CRM-17254 don't retrieve extra fields if contact_id is specifically requested
1434 // as this will add load to an intentionally light query.
1435 // ideally this code would be removed as it appears to be to support CRM-1203
1436 // and passing in the required returnProperties from the url would
1437 // make more sense that globally applying the requirements of one form.
1438 if (($this->_returnProperties
!= array('contact_id'))) {
1439 $this->_select
['group_contact_id'] = "$tbName.id as group_contact_id";
1440 $this->_element
['group_contact_id'] = 1;
1441 $this->_select
['status'] = "$tbName.status as status";
1442 $this->_element
['status'] = 1;
1446 $this->_useGroupBy
= TRUE;
1448 if ($this->_useDistinct
&& !isset($this->_distinctComponentClause
)) {
1449 if (!($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
)) {
1451 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
1452 $this->_useDistinct
= FALSE;
1453 $this->_useGroupBy
= TRUE;
1457 $select = $this->getSelect();
1458 $from = $this->_fromClause
;
1462 if (!empty($this->_whereClause
)) {
1463 $where = "WHERE {$this->_whereClause}";
1466 if (!empty($this->_permissionWhereClause
) && empty($this->_displayRelationshipType
)) {
1467 if (empty($where)) {
1468 $where = "WHERE $this->_permissionWhereClause";
1471 $where = "$where AND $this->_permissionWhereClause";
1476 if (!empty($this->_having
)) {
1477 foreach ($this->_having
as $havingSets) {
1478 foreach ($havingSets as $havingSet) {
1479 $havingValue[] = $havingSet;
1482 $having = ' HAVING ' . implode(' AND ', $havingValue);
1485 // if we are doing a transform, do it here
1486 // use the $from, $where and $having to get the contact ID
1487 if ($this->_displayRelationshipType
) {
1488 $this->filterRelatedContacts($from, $where, $having);
1491 return array($select, $from, $where, $having);
1495 * Get where values from the parameters.
1497 * @param string $name
1498 * @param mixed $grouping
1502 public function getWhereValues($name, $grouping) {
1504 foreach ($this->_params
as $values) {
1505 if ($values[0] == $name && $values[3] == $grouping) {
1516 * @param bool $relative
1517 * @param string $from
1520 public static function fixDateValues($relative, &$from, &$to) {
1522 list($from, $to) = CRM_Utils_Date
::getFromTo($relative, $from, $to);
1527 * Convert values from form-appropriate to query-object appropriate.
1529 * The query object is increasingly supporting the sql-filter syntax which is the most flexible syntax.
1530 * So, ideally we would convert all fields to look like
1533 * // Set the operator for legacy reasons, but it is ignored
1535 * // array in sql filter syntax
1536 * 2 => array('BETWEEN' => array(1,60),
1541 * There are some examples of the syntax in
1542 * https://github.com/civicrm/civicrm-core/tree/master/api/v3/examples/Relationship
1544 * More notes at CRM_Core_DAO::createSQLFilter
1546 * and a list of supported operators in CRM_Core_DAO
1548 * @param array $formValues
1549 * @param int $wildcard
1550 * @param bool $useEquals
1552 * @param string $apiEntity
1554 * @param array $entityReferenceFields
1555 * Field names of any entity reference fields (which will need reformatting to IN syntax).
1559 public static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL,
1560 $entityReferenceFields = array()) {
1562 if (empty($formValues)) {
1566 self
::filterCountryFromValuesIfStateExists($formValues);
1568 // Handle relative dates first
1569 foreach (array_keys($formValues) as $id) {
1570 if (preg_match('/_date_relative$/', $id) ||
1571 $id == 'event_relative' ||
1572 $id == 'case_from_relative' ||
1573 $id == 'case_to_relative' ||
1574 $id == 'participant_relative'
1576 if ($id == 'event_relative') {
1577 $fromRange = 'event_start_date_low';
1578 $toRange = 'event_end_date_high';
1580 elseif ($id == 'participant_relative') {
1581 $fromRange = 'participant_register_date_low';
1582 $toRange = 'participant_register_date_high';
1584 elseif ($id == 'case_from_relative') {
1585 $fromRange = 'case_from_start_date_low';
1586 $toRange = 'case_from_start_date_high';
1588 elseif ($id == 'case_to_relative') {
1589 $fromRange = 'case_to_end_date_low';
1590 $toRange = 'case_to_end_date_high';
1593 $dateComponent = explode('_date_relative', $id);
1594 $fromRange = "{$dateComponent[0]}_date_low";
1595 $toRange = "{$dateComponent[0]}_date_high";
1598 if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) {
1599 CRM_Contact_BAO_Query
::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]);
1604 foreach ($formValues as $id => $values) {
1605 if (self
::isAlreadyProcessedForQueryFormat($values)) {
1606 $params[] = $values;
1610 self
::legacyConvertFormValues($id, $values);
1612 // The form uses 1 field to represent two db fields
1613 if ($id == 'contact_type' && $values && (!is_array($values) ||
!array_intersect(array_keys($values), CRM_Core_DAO
::acceptedSQLOperators()))) {
1614 $contactType = array();
1616 foreach ((array) $values as $key => $type) {
1617 $types = explode('__', is_numeric($type) ?
$key : $type, 2);
1618 $contactType[$types[0]] = $types[0];
1619 // Add sub-type if specified
1620 if (!empty($types[1])) {
1621 $subType[$types[1]] = $types[1];
1624 $params[] = array('contact_type', 'IN', $contactType, 0, 0);
1626 $params[] = array('contact_sub_type', 'IN', $subType, 0, 0);
1629 elseif ($id == 'privacy') {
1630 if (is_array($formValues['privacy'])) {
1631 $op = !empty($formValues['privacy']['do_not_toggle']) ?
'=' : '!=';
1632 foreach ($formValues['privacy'] as $key => $value) {
1634 $params[] = array($key, $op, $value, 0, 0);
1639 elseif ($id == 'email_on_hold') {
1640 if ($onHoldValue = CRM_Utils_Array
::value('email_on_hold', $formValues)) {
1641 $onHoldValue = (array) $onHoldValue;
1642 $params[] = array('on_hold', 'IN', $onHoldValue, 0, 0);
1645 elseif (substr($id, 0, 7) == 'custom_'
1647 substr($id, -9, 9) == '_relative'
1648 ||
substr($id, -5, 5) == '_from'
1649 ||
substr($id, -3, 3) == '_to'
1652 self
::convertCustomRelativeFields($formValues, $params, $values, $id);
1654 elseif (preg_match('/_date_relative$/', $id) ||
1655 $id == 'event_relative' ||
1656 $id == 'case_from_relative' ||
1657 $id == 'case_to_relative' ||
1658 $id == 'participant_relative'
1660 // Already handled in previous loop
1663 elseif (in_array($id, $entityReferenceFields) && !empty($values) && is_string($values) && (strpos($values, ',') !=
1665 $params[] = array($id, 'IN', explode(',', $values), 0, 0);
1668 $values = CRM_Contact_BAO_Query
::fixWhereValues($id, $values, $wildcard, $useEquals, $apiEntity);
1673 $params[] = $values;
1680 * Function to support legacy format for groups and tags.
1683 * @param array|int $values
1686 public static function legacyConvertFormValues($id, &$values) {
1687 $legacyElements = array(
1692 'membership_type_id',
1693 'membership_status_id',
1695 if (in_array($id, $legacyElements) && is_array($values)) {
1696 // prior to 4.7, formValues for some attributes (e.g. group, tag) are stored in array(id1 => 1, id2 => 1),
1697 // as per the recent Search fixes $values need to be in standard array(id1, id2) format
1698 $values = CRM_Utils_Array
::convertCheckboxFormatToArray($values);
1703 * Fix values from query from/to something no-one cared enough to document.
1706 * @param array $values
1707 * @param int $wildcard
1708 * @param bool $useEquals
1710 * @param string $apiEntity
1712 * @return array|null
1714 public static function fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL) {
1715 // skip a few search variables
1716 static $skipWhere = NULL;
1717 static $likeNames = NULL;
1720 // Change camelCase EntityName to lowercase with underscores
1721 $apiEntity = _civicrm_api_get_entity_name_from_camel($apiEntity);
1723 // check if $value is in OK (Operator as Key) format as used by Get API
1724 if (CRM_Utils_System
::isNull($values)) {
1736 'display_relationship_type',
1740 if (in_array($id, $skipWhere) ||
1741 substr($id, 0, 4) == '_qf_' ||
1742 substr($id, 0, 7) == 'hidden_'
1748 (substr($id, 0, strlen($apiEntity)) != $apiEntity) &&
1749 (substr($id, 0, 10) != 'financial_' && substr($id, 0, 8) != 'payment_') &&
1750 (substr($id, 0, 7) != 'custom_')
1752 $id = $apiEntity . '_' . $id;
1756 $likeNames = array('sort_name', 'email', 'note', 'display_name');
1759 // email comes in via advanced search
1760 // so use wildcard always
1761 if ($id == 'email') {
1765 if (!$useEquals && in_array($id, $likeNames)) {
1766 $result = array($id, 'LIKE', $values, 0, 1);
1768 elseif (is_string($values) && strpos($values, '%') !== FALSE) {
1769 $result = array($id, 'LIKE', $values, 0, 0);
1771 elseif ($id == 'contact_type' ||
1772 (!empty($values) && is_array($values) && !in_array(key($values), CRM_Core_DAO
::acceptedSQLOperators(), TRUE))
1774 $result = array($id, 'IN', $values, 0, $wildcard);
1777 $result = array($id, '=', $values, 0, $wildcard);
1784 * Get the where clause for a single field.
1786 * @param array $values
1787 * @param string $apiEntity
1789 public function whereClauseSingle(&$values, $apiEntity = NULL) {
1790 // do not process custom fields or prefixed contact ids or component params
1791 if (CRM_Core_BAO_CustomField
::getKeyID($values[0]) ||
1792 (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) ||
1793 (substr($values[0], 0, 13) == 'contribution_') ||
1794 (substr($values[0], 0, 6) == 'event_') ||
1795 (substr($values[0], 0, 12) == 'participant_') ||
1796 (substr($values[0], 0, 7) == 'member_') ||
1797 (substr($values[0], 0, 6) == 'grant_') ||
1798 (substr($values[0], 0, 7) == 'pledge_') ||
1799 (substr($values[0], 0, 5) == 'case_') ||
1800 (substr($values[0], 0, 10) == 'financial_') ||
1801 (substr($values[0], 0, 8) == 'payment_') ||
1802 (substr($values[0], 0, 11) == 'membership_')
1807 // skip for hook injected fields / params
1808 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
1809 if (array_key_exists($values[0], $extFields)) {
1813 switch ($values[0]) {
1814 case 'deleted_contacts':
1815 $this->deletedContacts($values);
1818 case 'contact_sub_type':
1819 $this->contactSubType($values);
1824 $this->group($values);
1827 // case tag comes from find contacts
1829 $this->tagSearch($values);
1833 case 'contact_tags':
1834 $this->tag($values);
1839 case 'note_subject':
1840 $this->notes($values);
1844 $this->ufUser($values);
1848 case 'display_name':
1849 $this->sortName($values);
1853 case 'postal_greeting':
1854 case 'email_greeting':
1855 $this->greetings($values);
1860 $this->email($values, $apiEntity);
1863 case 'phone_numeric':
1864 $this->phone_numeric($values);
1867 case 'phone_phone_type_id':
1868 case 'phone_location_type_id':
1869 $this->phone_option_group($values);
1872 case 'street_address':
1873 $this->street_address($values);
1876 case 'street_number':
1877 $this->street_number($values);
1880 case 'sortByCharacter':
1881 $this->sortByCharacter($values);
1884 case 'location_type':
1885 $this->locationType($values);
1889 $this->county($values);
1892 case 'state_province':
1893 case 'state_province_id':
1894 case 'state_province_name':
1895 $this->stateProvince($values);
1900 $this->country($values, FALSE);
1904 case 'postal_code_low':
1905 case 'postal_code_high':
1906 $this->postalCode($values);
1909 case 'activity_date':
1910 case 'activity_date_low':
1911 case 'activity_date_high':
1912 case 'activity_role':
1913 case 'activity_status_id':
1914 case 'activity_status':
1915 case 'activity_priority':
1916 case 'activity_priority_id':
1917 case 'followup_parent_id':
1919 case 'source_contact_id':
1920 case 'activity_text':
1921 case 'activity_option':
1922 case 'test_activities':
1923 case 'activity_type_id':
1924 case 'activity_type':
1925 case 'activity_survey_id':
1926 case 'activity_tags':
1927 case 'activity_taglist':
1928 case 'activity_test':
1929 case 'activity_campaign_id':
1930 case 'activity_engagement_level':
1932 case 'activity_result':
1933 case 'source_contact':
1934 CRM_Activity_BAO_Query
::whereClauseSingle($values, $this);
1939 case 'birth_date_low':
1940 case 'birth_date_high':
1941 case 'deceased_date_low':
1942 case 'deceased_date_high':
1943 $this->demographics($values);
1946 case 'age_asof_date':
1947 // handled by demographics
1950 case 'log_date_low':
1951 case 'log_date_high':
1952 $this->modifiedDates($values);
1956 $this->changeLog($values);
1959 case 'do_not_phone':
1960 case 'do_not_email':
1963 case 'do_not_trade':
1965 $this->privacy($values);
1968 case 'privacy_options':
1969 $this->privacyOptions($values);
1972 case 'privacy_operator':
1973 case 'privacy_toggle':
1974 // these are handled by privacy options
1977 case 'preferred_communication_method':
1978 $this->preferredCommunication($values);
1981 case 'relation_type_id':
1982 case 'relation_start_date_high':
1983 case 'relation_start_date_low':
1984 case 'relation_end_date_high':
1985 case 'relation_end_date_low':
1986 case 'relation_active_period_date_high':
1987 case 'relation_active_period_date_low':
1988 case 'relation_target_name':
1989 case 'relation_status':
1990 case 'relation_date_low':
1991 case 'relation_date_high':
1992 $this->relationship($values);
1993 $this->_relationshipValuesAdded
= TRUE;
1996 case 'task_status_id':
1997 $this->task($values);
2001 // since this case is handled with the above
2004 case 'prox_distance':
2005 CRM_Contact_BAO_ProximityQuery
::process($this, $values);
2008 case 'prox_street_address':
2010 case 'prox_postal_code':
2011 case 'prox_state_province_id':
2012 case 'prox_country_id':
2013 case 'prox_geo_code_1':
2014 case 'prox_geo_code_2':
2015 // handled by the proximity_distance clause
2019 $this->restWhere($values);
2025 * Given a list of conditions in params generate the required where clause.
2027 * @param string $apiEntity
2031 public function whereClause($apiEntity = NULL) {
2032 $this->_where
[0] = array();
2033 $this->_qill
[0] = array();
2035 $this->includeContactIds();
2036 if (!empty($this->_params
)) {
2037 foreach (array_keys($this->_params
) as $id) {
2038 if (empty($this->_params
[$id][0])) {
2041 // check for both id and contact_id
2042 if ($this->_params
[$id][0] == 'id' ||
$this->_params
[$id][0] == 'contact_id') {
2043 $this->_where
[0][] = self
::buildClause("contact_a.id", $this->_params
[$id][1], $this->_params
[$id][2]);
2046 $this->whereClauseSingle($this->_params
[$id], $apiEntity);
2050 CRM_Core_Component
::alterQuery($this, 'where');
2052 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'where');
2055 if ($this->_customQuery
) {
2056 // Added following if condition to avoid the wrong value display for 'my account' / any UF info.
2057 // Hope it wont affect the other part of civicrm.. if it does please remove it.
2058 if (!empty($this->_customQuery
->_where
)) {
2059 $this->_where
= CRM_Utils_Array
::crmArrayMerge($this->_where
, $this->_customQuery
->_where
);
2062 $this->_qill
= CRM_Utils_Array
::crmArrayMerge($this->_qill
, $this->_customQuery
->_qill
);
2066 $andClauses = array();
2069 if (!empty($this->_where
)) {
2070 foreach ($this->_where
as $grouping => $values) {
2071 if ($grouping > 0 && !empty($values)) {
2072 $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
2077 if (!empty($this->_where
[0])) {
2078 $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where
[0]) . ' ) ';
2080 if (!empty($clauses)) {
2081 $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
2084 if ($validClauses > 1) {
2085 $this->_useDistinct
= TRUE;
2089 return implode(' AND ', $andClauses);
2093 * Generate where clause for any parameters not already handled.
2095 * @param array $values
2099 public function restWhere(&$values) {
2100 $name = CRM_Utils_Array
::value(0, $values);
2101 $op = CRM_Utils_Array
::value(1, $values);
2102 $value = CRM_Utils_Array
::value(2, $values);
2103 $grouping = CRM_Utils_Array
::value(3, $values);
2104 $wildcard = CRM_Utils_Array
::value(4, $values);
2106 if (isset($grouping) && empty($this->_where
[$grouping])) {
2107 $this->_where
[$grouping] = array();
2110 $multipleFields = array('url');
2112 //check if the location type exists for fields
2114 $locType = explode('-', $name);
2116 if (!in_array($locType[0], $multipleFields)) {
2117 //add phone type if exists
2118 if (isset($locType[2]) && $locType[2]) {
2119 $locType[2] = CRM_Core_DAO
::escapeString($locType[2]);
2123 $field = CRM_Utils_Array
::value($name, $this->_fields
);
2126 $field = CRM_Utils_Array
::value($locType[0], $this->_fields
);
2135 $locationType = CRM_Core_DAO_Address
::buildOptions('location_type_id', 'validate');
2136 if (isset($locType[1]) && is_numeric($locType[1])) {
2137 $lType = $locationType[$locType[1]];
2140 $field['title'] .= " ($lType)";
2143 if (substr($name, 0, 14) === 'state_province') {
2144 if (isset($locType[1]) && is_numeric($locType[1])) {
2146 $aName = "{$lType}-address";
2147 $where = "`$aName`.state_province_id";
2150 $where = "civicrm_address.state_province_id";
2153 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value);
2154 $this->_tables
[$aName] = $this->_whereTables
[$aName] = 1;
2155 list($qillop, $qillVal) = self
::buildQillForFieldValue('CRM_Core_DAO_Address', "state_province_id", $value, $op);
2156 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(1 => $field['title'], 2 => $qillop, 3 => $qillVal));
2158 elseif (!empty($field['pseudoconstant'])) {
2159 $this->optionValueQuery(
2160 $name, $op, $value, $grouping,
2161 'CRM_Contact_DAO_Contact',
2167 if ($name == 'gender_id') {
2168 self
::$_openedPanes[ts('Demographics')] = TRUE;
2171 elseif (substr($name, 0, 7) === 'country' ||
substr($name, 0, 6) === 'county') {
2172 $name = (substr($name, 0, 7) === 'country') ?
"country_id" : "county_id";
2173 if (isset($locType[1]) && is_numeric($locType[1])) {
2175 $aName = "{$lType}-address";
2176 $where = "`$aName`.$name";
2179 $where = "civicrm_address.$name";
2182 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
2183 $this->_tables
[$aName] = $this->_whereTables
[$aName] = 1;
2185 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue(NULL, $name, $value, $op);
2186 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(1 => $field['title'], 2 => $qillop, 3 => $qillVal));
2188 elseif ($name === 'world_region') {
2189 $this->optionValueQuery(
2190 $name, $op, $value, $grouping,
2198 elseif ($name === 'is_deceased') {
2199 $this->setQillAndWhere($name, $op, $value, $grouping, $field);
2200 self
::$_openedPanes[ts('Demographics')] = TRUE;
2202 elseif ($name === 'created_date' ||
$name === 'modified_date' ||
$name === 'deceased_date' ||
$name === 'birth_date') {
2203 $appendDateTime = TRUE;
2204 if ($name === 'deceased_date' ||
$name === 'birth_date') {
2205 $appendDateTime = FALSE;
2206 self
::$_openedPanes[ts('Demographics')] = TRUE;
2208 $this->dateQueryBuilder($values, 'contact_a', $name, $name, $field['title'], $appendDateTime);
2210 elseif ($name === 'contact_id') {
2211 if (is_int($value)) {
2212 $this->_where
[$grouping][] = self
::buildClause($field['where'], $op, $value);
2213 $this->_qill
[$grouping][] = "$field[title] $op $value";
2216 elseif ($name === 'name') {
2217 $value = CRM_Core_DAO
::escapeString($value);
2220 $value = self
::getWildCardedValue($wildcard, $op, $value);
2222 CRM_Core_Error
::deprecatedFunctionWarning('Untested code path');
2223 // @todo it's likely this code path is obsolete / never called. It is definitely not
2224 // passed through in our test suite.
2225 $this->_where
[$grouping][] = self
::buildClause($field['where'], $op, "'$value'");
2226 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2228 elseif ($name === 'current_employer') {
2231 $value = self
::getWildCardedValue($wildcard, $op, $value);
2233 $ceWhereClause = self
::buildClause("contact_a.organization_name", $op,
2236 $ceWhereClause .= " AND contact_a.contact_type = 'Individual'";
2237 $this->_where
[$grouping][] = $ceWhereClause;
2238 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2240 elseif ($name === 'email_greeting') {
2241 CRM_Core_Error
::deprecatedFunctionWarning('pass in email_greeting_id or email_greeting_display');
2242 $filterCondition = array('greeting_type' => 'email_greeting');
2243 $this->optionValueQuery(
2244 $name, $op, $value, $grouping,
2245 CRM_Core_PseudoConstant
::greeting($filterCondition),
2247 ts('Email Greeting')
2250 elseif ($name === 'postal_greeting') {
2251 CRM_Core_Error
::deprecatedFunctionWarning('pass in postal_greeting_id or postal_greeting_display');
2252 $filterCondition = array('greeting_type' => 'postal_greeting');
2253 $this->optionValueQuery(
2254 $name, $op, $value, $grouping,
2255 CRM_Core_PseudoConstant
::greeting($filterCondition),
2257 ts('Postal Greeting')
2260 elseif ($name === 'addressee') {
2261 CRM_Core_Error
::deprecatedFunctionWarning('pass in addressee_id or addressee_display');
2262 $filterCondition = array('greeting_type' => 'addressee');
2263 $this->optionValueQuery(
2264 $name, $op, $value, $grouping,
2265 CRM_Core_PseudoConstant
::greeting($filterCondition),
2270 elseif (substr($name, 0, 4) === 'url-') {
2271 $tName = 'civicrm_website';
2272 $this->_whereTables
[$tName] = $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2273 $value = CRM_Core_DAO
::escapeString($value);
2276 $value = self
::getWildCardedValue($wildcard, $op, $value);
2279 $this->_where
[$grouping][] = $d = self
::buildClause('civicrm_website.url', $op, $value);
2280 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2282 elseif ($name === 'contact_is_deleted') {
2283 $this->setQillAndWhere('is_deleted', $op, $value, $grouping, $field);
2285 elseif (!empty($field['where'])) {
2287 if (!empty($field['type'])) {
2288 $type = CRM_Utils_Type
::typeToString($field['type']);
2291 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2293 if (isset($locType[1]) &&
2294 is_numeric($locType[1])
2298 //get the location name
2299 list($tName, $fldName) = self
::getLocationTableName($field['where'], $locType);
2300 $fieldName = "`$tName`.$fldName";
2302 // we set both _tables & whereTables because whereTables doesn't seem to do what the name implies it should
2303 $this->_tables
[$tName] = $this->_whereTables
[$tName] = 1;
2307 if ($tableName == 'civicrm_contact') {
2308 $fieldName = "contact_a.{$fieldName}";
2311 $fieldName = $field['where'];
2315 list($qillop, $qillVal) = self
::buildQillForFieldValue(NULL, $field['title'], $value, $op);
2316 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(
2317 1 => $field['title'],
2319 3 => (strpos($op, 'NULL') !== FALSE ||
strpos($op, 'EMPTY') !== FALSE) ?
$qillVal : "'$qillVal'"));
2321 if (is_array($value)) {
2322 // traditionally an array being passed has been a fatal error. We can take advantage of this to add support
2323 // for api style operators for functions that hit this point without worrying about regression
2324 // (the previous comments indicated the condition for hitting this point were unknown
2325 // per CRM-14743 we are adding modified_date & created_date operator support
2326 $operations = array_keys($value);
2327 foreach ($operations as $operator) {
2328 if (!in_array($operator, CRM_Core_DAO
::acceptedSQLOperators())) {
2329 //Via Contact get api value is not in array(operator => array(values)) format ONLY for IN/NOT IN operators
2330 //so this condition will satisfy the search for now
2331 if (strpos($op, 'IN') !== FALSE) {
2332 $value = array($op => $value);
2334 // we don't know when this might happen
2336 CRM_Core_Error
::fatal(ts("%1 is not a valid operator", array(1 => $operator)));
2340 $this->_where
[$grouping][] = CRM_Core_DAO
::createSQLFilter($fieldName, $value, $type);
2345 $value = self
::getWildCardedValue($wildcard, $op, $value);
2348 $this->_where
[$grouping][] = self
::buildClause($fieldName, $op, $value, $type);
2352 if ($setTables && isset($field['where'])) {
2353 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2354 if (isset($tableName)) {
2355 $this->_tables
[$tableName] = 1;
2356 $this->_whereTables
[$tableName] = 1;
2368 public static function getLocationTableName(&$where, &$locType) {
2369 if (isset($locType[1]) && is_numeric($locType[1])) {
2370 list($tbName, $fldName) = explode(".", $where);
2372 //get the location name
2373 $locationType = CRM_Core_DAO_Address
::buildOptions('location_type_id', 'validate');
2374 $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2375 if (in_array($locType[0], $specialFields)) {
2376 //hack to fix / special handing for phone_ext
2377 if ($locType[0] == 'phone_ext') {
2378 $locType[0] = 'phone';
2380 if (isset($locType[2]) && $locType[2]) {
2381 $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2384 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2387 elseif (in_array($locType[0],
2392 'street_number_suffix',
2394 'supplemental_address_1',
2395 'supplemental_address_2',
2396 'supplemental_address_3',
2399 'postal_code_suffix',
2405 //fix for search by profile with address fields.
2406 $tName = "{$locationType[$locType[1]]}-address";
2408 elseif (in_array($locType[0],
2416 $tName = "{$locationType[$locType[1]]}-email";
2418 elseif ($locType[0] == 'provider_id') {
2419 $tName = "{$locationType[$locType[1]]}-im";
2421 elseif ($locType[0] == 'openid') {
2422 $tName = "{$locationType[$locType[1]]}-openid";
2425 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2427 $tName = str_replace(' ', '_', $tName);
2428 return array($tName, $fldName);
2430 CRM_Core_Error
::fatal();
2434 * Given a result dao, extract the values and return that array
2436 * @param CRM_Core_DAO $dao
2439 * values for this query
2441 public function store($dao) {
2444 foreach ($this->_element
as $key => $dontCare) {
2445 if (property_exists($dao, $key)) {
2446 if (strpos($key, '-') !== FALSE) {
2447 $values = explode('-', $key);
2448 $lastElement = array_pop($values);
2450 $cnt = count($values);
2452 foreach ($values as $v) {
2453 if (!array_key_exists($v, $current)) {
2454 $current[$v] = array();
2456 //bad hack for im_provider
2457 if ($lastElement == 'provider_id') {
2458 if ($count < $cnt) {
2459 $current = &$current[$v];
2462 $lastElement = "{$v}_{$lastElement}";
2466 $current = &$current[$v];
2471 $current[$lastElement] = $dao->$key;
2474 $value[$key] = $dao->$key;
2482 * Getter for tables array.
2486 public function tables() {
2487 return $this->_tables
;
2491 * Sometimes used to create the from clause, but, not reliably, set
2492 * this AND set tables.
2494 * It's unclear the intent - there is a 'simpleFrom' clause which
2495 * takes whereTables into account & a fromClause which doesn't.
2497 * logic may have eroded?
2501 public function whereTables() {
2502 return $this->_whereTables
;
2506 * Generate the where clause (used in match contacts and permissions)
2508 * @param array $params
2509 * @param array $fields
2510 * @param array $tables
2511 * @param $whereTables
2512 * @param bool $strict
2516 public static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2517 $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2521 $tables = array_merge($query->tables(), $tables);
2522 $whereTables = array_merge($query->whereTables(), $whereTables);
2524 return $query->_whereClause
;
2528 * Create the from clause.
2530 * @param array $tables
2531 * Tables that need to be included in this from clause. If null,
2532 * return mimimal from clause (i.e. civicrm_contact).
2533 * @param array $inner
2534 * Tables that should be inner-joined.
2535 * @param array $right
2536 * Tables that should be right-joined.
2537 * @param bool $primaryLocation
2538 * Search on primary location. See note below.
2540 * Determines search mode based on bitwise MODE_* constants.
2541 * @param string|NULL $apiEntity
2542 * Determines search mode based on entity by string.
2544 * The $primaryLocation flag only seems to be used when
2545 * locationType() has been called. This may be a search option
2546 * exposed, or perhaps it's a "search all details" approach which
2547 * predates decoupling of location types and primary fields?
2549 * @see https://issues.civicrm.org/jira/browse/CRM-19967
2554 public static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1, $apiEntity = NULL) {
2556 $from = ' FROM civicrm_contact contact_a';
2557 if (empty($tables)) {
2561 if (!empty($tables['civicrm_worldregion'])) {
2562 $tables = array_merge(array('civicrm_country' => 1), $tables);
2565 if ((!empty($tables['civicrm_state_province']) ||
!empty($tables['civicrm_country']) ||
2566 CRM_Utils_Array
::value('civicrm_county', $tables)
2567 ) && empty($tables['civicrm_address'])
2569 $tables = array_merge(array('civicrm_address' => 1),
2574 // add group_contact and group table is subscription history is present
2575 if (!empty($tables['civicrm_subscription_history']) && empty($tables['civicrm_group'])) {
2576 $tables = array_merge(array(
2577 'civicrm_group' => 1,
2578 'civicrm_group_contact' => 1,
2584 // to handle table dependencies of components
2585 CRM_Core_Component
::tableNames($tables);
2586 // to handle table dependencies of hook injected tables
2587 CRM_Contact_BAO_Query_Hook
::singleton()->setTableDependency($tables);
2589 //format the table list according to the weight
2590 $info = CRM_Core_TableHierarchy
::info();
2592 foreach ($tables as $key => $value) {
2594 if (strpos($key, '-') !== FALSE) {
2595 $keyArray = explode('-', $key);
2596 $k = CRM_Utils_Array
::value('civicrm_' . $keyArray[1], $info, 99);
2598 elseif (strpos($key, '_') !== FALSE) {
2599 $keyArray = explode('_', $key);
2600 if (is_numeric(array_pop($keyArray))) {
2601 $k = CRM_Utils_Array
::value(implode('_', $keyArray), $info, 99);
2604 $k = CRM_Utils_Array
::value($key, $info, 99);
2608 $k = CRM_Utils_Array
::value($key, $info, 99);
2610 $tempTable[$k . ".$key"] = $key;
2613 $newTables = array();
2614 foreach ($tempTable as $key) {
2615 $newTables[$key] = $tables[$key];
2618 $tables = $newTables;
2620 foreach ($tables as $name => $value) {
2625 if (!empty($inner[$name])) {
2628 elseif (!empty($right[$name])) {
2636 // if there is already a join statement in value, use value itself
2637 if (strpos($value, 'JOIN')) {
2638 $from .= " $value ";
2641 $from .= " $side JOIN $name ON ( $value ) ";
2646 $from .= self
::getEntitySpecificJoins($name, $mode, $side, $primaryLocation);
2652 * Get join statements for the from clause depending on entity type
2654 * @param string $name
2656 * @param string $side
2657 * @param string $primaryLocation
2660 protected static function getEntitySpecificJoins($name, $mode, $side, $primaryLocation) {
2661 $limitToPrimaryClause = $primaryLocation ?
"AND {$name}.is_primary = 1" : '';
2663 case 'civicrm_address':
2664 //CRM-14263 further handling of address joins further down...
2665 return " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id {$limitToPrimaryClause} )";
2667 case 'civicrm_phone':
2668 return " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id {$limitToPrimaryClause}) ";
2670 case 'civicrm_email':
2671 return " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id {$limitToPrimaryClause})";
2674 return " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id {$limitToPrimaryClause}) ";
2677 $from = " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2678 $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2679 $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)";
2682 case 'civicrm_openid':
2683 return " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id {$limitToPrimaryClause} )";
2685 case 'civicrm_worldregion':
2686 $from = " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2687 return "$from $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2689 case 'civicrm_location_type':
2690 return " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2692 case 'civicrm_group':
2693 return " $side JOIN civicrm_group ON civicrm_group.id = civicrm_group_contact.group_id ";
2695 case 'civicrm_group_contact':
2696 return " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2698 case 'civicrm_group_contact_cache':
2699 return " $side JOIN civicrm_group_contact_cache ON contact_a.id = civicrm_group_contact_cache.contact_id ";
2701 case 'civicrm_activity':
2702 case 'civicrm_activity_tag':
2703 case 'activity_type':
2704 case 'activity_status':
2706 case 'civicrm_activity_contact':
2707 case 'source_contact':
2708 case 'activity_priority':
2709 return CRM_Activity_BAO_Query
::from($name, $mode, $side);
2711 case 'civicrm_entity_tag':
2712 $from = " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact'";
2713 return "$from AND civicrm_entity_tag.entity_id = contact_a.id ) ";
2715 case 'civicrm_note':
2716 $from = " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact'";
2717 return "$from AND contact_a.id = civicrm_note.entity_id ) ";
2719 case 'civicrm_subscription_history':
2720 $from = " $side JOIN civicrm_subscription_history";
2721 $from .= " ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id";
2722 return "$from AND civicrm_group_contact.group_id = civicrm_subscription_history.group_id";
2724 case 'civicrm_relationship':
2725 if (self
::$_relType == 'reciprocal') {
2726 if (self
::$_relationshipTempTable) {
2727 // we have a temptable to join on
2728 $tbl = self
::$_relationshipTempTable;
2729 return " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2732 $from = " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2733 $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)";
2737 elseif (self
::$_relType == 'b') {
2738 $from = " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2739 return "$from $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2742 $from = " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2743 return "$from $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2747 $from = " INNER JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2748 return "$from INNER JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2751 return " $side JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2753 case 'civicrm_grant':
2754 return CRM_Grant_BAO_Query
::from($name, $mode, $side);
2756 case 'civicrm_website':
2757 return " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2759 case 'civicrm_campaign':
2760 //Move to default case if not in either mode.
2761 if ($mode & CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) {
2762 return CRM_Contribute_BAO_Query
::from($name, $mode, $side);
2764 elseif ($mode & CRM_Contact_BAO_Query
::MODE_MAILING
) {
2765 return CRM_Mailing_BAO_Query
::from($name, $mode, $side);
2767 elseif ($mode & CRM_Contact_BAO_Query
::MODE_CAMPAIGN
) {
2768 return CRM_Campaign_BAO_Query
::from($name, $mode, $side);
2772 $locationTypeName = '';
2773 if (strpos($name, '-address') != 0) {
2774 $locationTypeName = 'address';
2776 elseif (strpos($name, '-phone') != 0) {
2777 $locationTypeName = 'phone';
2779 elseif (strpos($name, '-email') != 0) {
2780 $locationTypeName = 'email';
2782 elseif (strpos($name, '-im') != 0) {
2783 $locationTypeName = 'im';
2785 elseif (strpos($name, '-openid') != 0) {
2786 $locationTypeName = 'openid';
2789 if ($locationTypeName) {
2790 //we have a join on an location table - possibly in conjunction with search builder - CRM-14263
2791 $parts = explode('-', $name);
2792 $locationTypes = CRM_Core_DAO_Address
::buildOptions('location_type_id', 'validate');
2793 foreach ($locationTypes as $locationTypeID => $locationType) {
2794 if ($parts[0] == str_replace(' ', '_', $locationType)) {
2795 $locationID = $locationTypeID;
2798 $from = " $side JOIN civicrm_{$locationTypeName} `{$name}` ON ( contact_a.id = `{$name}`.contact_id ) and `{$name}`.location_type_id = $locationID ";
2801 $from = CRM_Core_Component
::from($name, $mode, $side);
2803 $from .= CRM_Contact_BAO_Query_Hook
::singleton()->buildSearchfrom($name, $mode, $side);
2810 * WHERE / QILL clause for deleted_contacts
2812 * @param array $values
2814 public function deletedContacts($values) {
2815 list($_, $_, $value, $grouping, $_) = $values;
2817 // *prepend* to the relevant grouping as this is quite an important factor
2818 array_unshift($this->_qill
[$grouping], ts('Search in Trash'));
2823 * Where / qill clause for contact_type
2827 public function contactType(&$values) {
2828 list($name, $op, $value, $grouping, $wildcard) = $values;
2830 $subTypes = array();
2833 // account for search builder mapping multiple values
2834 if (!is_array($value)) {
2835 $values = self
::parseSearchBuilderString($value, 'String');
2836 if (is_array($values)) {
2837 $value = array_flip($values);
2841 if (is_array($value)) {
2842 foreach ($value as $k => $v) {
2847 if (strpos($k, CRM_Core_DAO
::VALUE_SEPARATOR
)) {
2848 list($contactType, $subType) = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $k, 2);
2851 if (!empty($subType)) {
2852 $subTypes[$subType] = 1;
2854 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2859 $contactTypeANDSubType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value, 2);
2860 $contactType = $contactTypeANDSubType[0];
2861 $subType = CRM_Utils_Array
::value(1, $contactTypeANDSubType);
2862 if (!empty($subType)) {
2863 $subTypes[$subType] = 1;
2865 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2869 if (!empty($clause)) {
2871 if ($op == 'IN' ||
$op == 'NOT IN') {
2872 $this->_where
[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2875 $type = array_pop($clause);
2876 $this->_where
[$grouping][] = self
::buildClause("contact_a.contact_type", $op, $contactType);
2879 $this->_qill
[$grouping][] = ts('Contact Type') . " $op " . implode(' ' . ts('or') . ' ', $quill);
2881 if (!empty($subTypes)) {
2882 $this->includeContactSubTypes($subTypes, $grouping);
2888 * Where / qill clause for contact_sub_type.
2890 * @param array $values
2892 public function contactSubType(&$values) {
2893 list($name, $op, $value, $grouping, $wildcard) = $values;
2894 $this->includeContactSubTypes($value, $grouping, $op);
2902 public function includeContactSubTypes($value, $grouping, $op = 'LIKE') {
2904 if (is_array($value) && in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
2906 $value = $value[$op];
2910 $alias = "contact_a.contact_sub_type";
2911 $qillOperators = CRM_Core_SelectValues
::getSearchBuilderOperators();
2913 $op = str_replace('IN', 'LIKE', $op);
2914 $op = str_replace('=', 'LIKE', $op);
2915 $op = str_replace('!', 'NOT ', $op);
2917 if (strpos($op, 'NULL') !== FALSE ||
strpos($op, 'EMPTY') !== FALSE) {
2918 $this->_where
[$grouping][] = self
::buildClause($alias, $op, $value, 'String');
2920 elseif (is_array($value)) {
2921 foreach ($value as $k => $v) {
2922 $clause[$k] = "($alias $op '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($v, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2926 $clause[$value] = "($alias $op '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($value, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2929 if (!empty($clause)) {
2930 $this->_where
[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2932 $this->_qill
[$grouping][] = ts('Contact Subtype %1 ', array(1 => $qillOperators[$op])) . implode(' ' . ts('or') . ' ', array_keys($clause));
2936 * Where / qill clause for groups.
2940 public function group($values) {
2941 list($name, $op, $value, $grouping, $wildcard) = $values;
2943 // If the $value is in OK (operator as key) array format we need to extract the key as operator and value first
2944 if (is_array($value) && in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
2946 $value = $value[$op];
2949 // Replace pseudo operators from search builder
2950 $op = str_replace('EMPTY', 'NULL', $op);
2952 if (strpos($op, 'NULL')) {
2956 if (is_array($value) && count($value) > 1) {
2957 if (strpos($op, 'IN') === FALSE && strpos($op, 'NULL') === FALSE) {
2958 CRM_Core_Error
::fatal(ts("%1 is not a valid operator", array(1 => $op)));
2960 $this->_useDistinct
= TRUE;
2963 if (isset($value)) {
2964 $value = CRM_Utils_Array
::value($op, $value, $value);
2967 if ($name == 'group_type') {
2968 $value = array_keys($this->getGroupsFromTypeCriteria($value));
2971 $regularGroupIDs = $smartGroupIDs = array();
2972 foreach ((array) $value as $id) {
2973 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $id, 'saved_search_id')) {
2974 $smartGroupIDs[] = $id;
2977 $regularGroupIDs[] = trim($id);
2981 $isNotOp = ($op == 'NOT IN' ||
$op == '!=');
2984 $gcsValues = $this->getWhereValues('group_contact_status', $grouping);
2986 is_array($gcsValues[2])
2988 foreach ($gcsValues[2] as $k => $v) {
2990 $statii[] = "'" . CRM_Utils_Type
::escape($k, 'String') . "'";
2995 $statii[] = "'Added'";
2997 $groupClause = array();
2998 if (count($regularGroupIDs) ||
empty($value)) {
2999 // include child groups IDs if any
3000 $childGroupIds = (array) CRM_Contact_BAO_Group
::getChildGroupIds($regularGroupIDs);
3001 foreach ($childGroupIds as $key => $id) {
3002 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $id, 'saved_search_id')) {
3003 $smartGroupIDs[] = $id;
3004 unset($childGroupIds[$key]);
3007 if (count($childGroupIds)) {
3008 $regularGroupIDs = array_merge($regularGroupIDs, $childGroupIds);
3011 // if $regularGroupIDs is populated with regular child group IDs
3012 // then change the mysql operator to desired
3013 if (count($regularGroupIDs) > 1) {
3014 $op = strpos($op, 'IN') ?
$op : ($op == '!=') ?
'NOT IN' : 'IN';
3017 if (!empty($regularGroupIDs)) {
3018 $groupIds = CRM_Utils_Type
::validate(
3019 implode(',', (array) $regularGroupIDs),
3020 'CommaSeparatedIntegers'
3023 $gcTable = "`civicrm_group_contact-" . uniqid() . "`";
3024 $joinClause = array("contact_a.id = {$gcTable}.contact_id");
3026 if (strpos($op, 'IN') !== FALSE) {
3027 $clause = "{$gcTable}.group_id $op ( $groupIds ) ";
3029 elseif ($op == '!=') {
3030 $clause = "{$gcTable}.contact_id NOT IN (SELECT contact_id FROM civicrm_group_contact cgc WHERE cgc.group_id = $groupIds )";
3033 $clause = "{$gcTable}.group_id $op $groupIds ";
3035 $groupClause[] = "( {$clause} )";
3038 $joinClause[] = "{$gcTable}.status IN (" . implode(', ', $statii) . ")";
3040 $this->_tables
[$gcTable] = $this->_whereTables
[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON (" . implode(' AND ', $joinClause) . ")";
3043 //CRM-19589: contact(s) removed from a Smart Group, resides in civicrm_group_contact table
3044 $groupContactCacheClause = '';
3045 if (count($smartGroupIDs) ||
empty($value)) {
3046 $this->_groupUniqueKey
= uniqid();
3047 $gccTableAlias = "civicrm_group_contact_cache_{$this->_groupUniqueKey}";
3048 $groupContactCacheClause = $this->addGroupContactCache($smartGroupIDs, $gccTableAlias, "contact_a", $op);
3049 if (!empty($groupContactCacheClause)) {
3051 $groupIds = implode(',', (array) $smartGroupIDs);
3052 $gcTable = "civicrm_group_contact_{$this->_groupUniqueKey}";
3053 $joinClause = array("contact_a.id = {$gcTable}.contact_id");
3054 $this->_tables
[$gcTable] = $this->_whereTables
[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON (" . implode(' AND ', $joinClause) . ")";
3055 if (strpos($op, 'IN') !== FALSE) {
3056 $groupClause[] = "{$gcTable}.group_id $op ( $groupIds ) AND {$gccTableAlias}.group_id IS NULL";
3059 $groupClause[] = "{$gcTable}.group_id $op $groupIds AND {$gccTableAlias}.group_id IS NULL";
3062 $groupClause[] = " ( {$groupContactCacheClause} ) ";
3066 $and = ($op == 'IS NULL') ?
' AND ' : ' OR ';
3067 if (!empty($groupClause)) {
3068 $this->_where
[$grouping][] = ' ( ' . implode($and, $groupClause) . ' ) ';
3071 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contact_DAO_Group', 'id', $value, $op);
3072 $this->_qill
[$grouping][] = ts("Group(s) %1 %2", array(1 => $qillop, 2 => $qillVal));
3073 if (strpos($op, 'NULL') === FALSE) {
3074 $this->_qill
[$grouping][] = ts("Group Status %1", array(1 => implode(' ' . ts('or') . ' ', $statii)));
3078 public function getGroupCacheTableKey() {
3079 return $this->_groupUniqueKey
;
3083 * Function translates selection of group type into a list of groups.
3088 public function getGroupsFromTypeCriteria($value) {
3089 $groupIds = array();
3090 foreach ((array) $value as $groupTypeValue) {
3091 $groupList = CRM_Core_PseudoConstant
::group($groupTypeValue);
3092 $groupIds = ($groupIds +
$groupList);
3098 * Prime smart group cache for smart groups in the search, and join
3099 * civicrm_group_contact_cache table into the query.
3101 * @param array $groups IDs of groups specified in search criteria.
3102 * @param string $tableAlias Alias to use for civicrm_group_contact_cache table.
3103 * @param string $joinTable Table on which to join civicrm_group_contact_cache
3104 * @param string $op SQL comparison operator (NULL, IN, !=, IS NULL, etc.)
3105 * @param string $joinColumn Column in $joinTable on which to join civicrm_group_contact_cache.contact_id
3107 * @return string WHERE clause component for smart group criteria.
3109 public function addGroupContactCache($groups, $tableAlias, $joinTable = "contact_a", $op, $joinColumn = 'id') {
3110 $isNullOp = (strpos($op, 'NULL') !== FALSE);
3111 $groupsIds = $groups;
3113 $operator = ['=' => 'IN', '!=' => 'NOT IN'];
3114 if (!empty($operator[$op]) && is_array($groups)) {
3115 $op = $operator[$op];
3117 if (!$isNullOp && !$groups) {
3120 elseif (strpos($op, 'IN') !== FALSE) {
3121 $groups = array($op => $groups);
3123 elseif (is_array($groups) && count($groups)) {
3124 $groups = array('IN' => $groups);
3127 // Find all the groups that are part of a saved search.
3128 $smartGroupClause = self
::buildClause("id", $op, $groups, 'Int');
3130 SELECT id, cache_date, saved_search_id, children
3132 WHERE $smartGroupClause
3133 AND ( saved_search_id != 0
3134 OR saved_search_id IS NOT NULL
3135 OR children IS NOT NULL )
3138 $group = CRM_Core_DAO
::executeQuery($sql);
3140 while ($group->fetch()) {
3141 $this->_useDistinct
= TRUE;
3142 if (!$this->_smartGroupCache ||
$group->cache_date
== NULL) {
3143 CRM_Contact_BAO_GroupContactCache
::load($group);
3146 if ($group->N
== 0 && $op != 'NOT IN') {
3150 $this->_tables
[$tableAlias] = $this->_whereTables
[$tableAlias] = " LEFT JOIN civicrm_group_contact_cache {$tableAlias} ON {$joinTable}.{$joinColumn} = {$tableAlias}.contact_id ";
3152 if ($op == 'NOT IN') {
3153 return "{$tableAlias}.contact_id NOT IN (SELECT contact_id FROM civicrm_group_contact_cache cgcc WHERE cgcc.group_id IN ( " . implode(',', (array) $groupsIds) . " ) )";
3155 return self
::buildClause("{$tableAlias}.group_id", $op, $groups, 'Int');
3159 * Where / qill clause for cms users
3163 public function ufUser(&$values) {
3164 list($name, $op, $value, $grouping, $wildcard) = $values;
3167 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
3169 $this->_qill
[$grouping][] = ts('CMS User');
3171 elseif ($value == 0) {
3172 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
3174 $this->_where
[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
3175 $this->_qill
[$grouping][] = ts('Not a CMS User');
3180 * All tag search specific.
3182 * @param array $values
3184 public function tagSearch(&$values) {
3185 list($name, $op, $value, $grouping, $wildcard) = $values;
3188 $value = "%{$value}%";
3189 $escapedValue = CRM_Utils_Type
::escape("%{$value}%", 'String');
3191 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3192 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3194 $etTable = "`civicrm_entity_tag-" . uniqid() . "`";
3195 $tTable = "`civicrm_tag-" . uniqid() . "`";
3197 if ($useAllTagTypes[2]) {
3198 $this->_tables
[$etTable] = $this->_whereTables
[$etTable]
3199 = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
3200 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id )";
3202 // search tag in cases
3203 $etCaseTable = "`civicrm_entity_case_tag-" . uniqid() . "`";
3204 $tCaseTable = "`civicrm_case_tag-" . uniqid() . "`";
3205 $this->_tables
[$etCaseTable] = $this->_whereTables
[$etCaseTable]
3206 = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3207 LEFT JOIN civicrm_case
3208 ON (civicrm_case_contact.case_id = civicrm_case.id
3209 AND civicrm_case.is_deleted = 0 )
3210 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
3211 LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id )";
3212 // search tag in activities
3213 $etActTable = "`civicrm_entity_act_tag-" . uniqid() . "`";
3214 $tActTable = "`civicrm_act_tag-" . uniqid() . "`";
3215 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
3216 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
3218 $this->_tables
[$etActTable] = $this->_whereTables
[$etActTable]
3219 = " LEFT JOIN civicrm_activity_contact
3220 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3221 LEFT JOIN civicrm_activity
3222 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3223 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3224 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
3225 LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id )";
3227 $this->_where
[$grouping][] = "({$tTable}.name $op '" . $escapedValue . "' OR {$tCaseTable}.name $op '" . $escapedValue . "' OR {$tActTable}.name $op '" . $escapedValue . "')";
3228 $this->_qill
[$grouping][] = ts('Tag %1 %2', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
3231 $etTable = "`civicrm_entity_tag-" . uniqid() . "`";
3232 $tTable = "`civicrm_tag-" . uniqid() . "`";
3233 $this->_tables
[$etTable] = $this->_whereTables
[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND
3234 {$etTable}.entity_table = 'civicrm_contact' )
3235 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id ) ";
3237 $this->_where
[$grouping][] = self
::buildClause("{$tTable}.name", $op, $value, 'String');
3238 $this->_qill
[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
3243 * Where / qill clause for tag.
3245 * @param array $values
3247 public function tag(&$values) {
3248 list($name, $op, $value, $grouping, $wildcard) = $values;
3250 list($qillop, $qillVal) = self
::buildQillForFieldValue('CRM_Core_DAO_EntityTag', "tag_id", $value, $op, array('onlyActive' => FALSE));
3251 // API/Search Builder format array(operator => array(values))
3252 if (is_array($value)) {
3253 if (in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
3255 $value = $value[$op];
3257 if (count($value) > 1) {
3258 $this->_useDistinct
= TRUE;
3262 // implode array, then remove all spaces and validate CommaSeparatedIntegers
3263 $value = CRM_Utils_Type
::validate(
3264 str_replace(' ', '', implode(',', (array) $value)),
3265 'CommaSeparatedIntegers'
3268 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3269 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3271 $etTable = "`civicrm_entity_tag-" . uniqid() . "`";
3273 if ($useAllTagTypes[2]) {
3274 $this->_tables
[$etTable] = $this->_whereTables
[$etTable]
3275 = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
3277 // search tag in cases
3278 $etCaseTable = "`civicrm_entity_case_tag-" . uniqid() . "`";
3279 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
3280 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
3282 $this->_tables
[$etCaseTable] = $this->_whereTables
[$etCaseTable]
3283 = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3284 LEFT JOIN civicrm_case
3285 ON (civicrm_case_contact.case_id = civicrm_case.id
3286 AND civicrm_case.is_deleted = 0 )
3287 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
3288 // search tag in activities
3289 $etActTable = "`civicrm_entity_act_tag-" . uniqid() . "`";
3290 $this->_tables
[$etActTable] = $this->_whereTables
[$etActTable]
3291 = " LEFT JOIN civicrm_activity_contact
3292 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3293 LEFT JOIN civicrm_activity
3294 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3295 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3296 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
3299 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3300 $this->_where
[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
3303 $this->_where
[$grouping][] = "({$etTable}.tag_id $op (" . $value . ") OR {$etCaseTable}.tag_id $op (" . $value . ") OR {$etActTable}.tag_id $op (" . $value . "))";
3307 $this->_tables
[$etTable] = $this->_whereTables
[$etTable]
3308 = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
3311 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3312 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3313 $op = str_replace('EMPTY', 'NULL', $op);
3314 $this->_where
[$grouping][] = "{$etTable}.tag_id $op";
3316 // CRM-16941: for tag tried with != operator we don't show contact who don't have given $value AND also in other tag
3317 elseif ($op == '!=') {
3318 $this->_where
[$grouping][] = "{$etTable}.entity_id NOT IN (SELECT entity_id FROM civicrm_entity_tag cet WHERE cet.entity_table = 'civicrm_contact' AND " . self
::buildClause("cet.tag_id", '=', $value, 'Int') . ")";
3320 elseif ($op == '=' ||
strstr($op, 'IN')) {
3321 $op = ($op == '=') ?
'IN' : $op;
3322 $this->_where
[$grouping][] = "{$etTable}.tag_id $op ( $value )";
3325 $this->_qill
[$grouping][] = ts('Tagged %1 %2', array(1 => $qillop, 2 => $qillVal));
3329 * Where/qill clause for notes
3331 * @param array $values
3333 public function notes(&$values) {
3334 list($name, $op, $value, $grouping, $wildcard) = $values;
3336 $noteOptionValues = $this->getWhereValues('note_option', $grouping);
3337 $noteOption = CRM_Utils_Array
::value('2', $noteOptionValues, '6');
3338 $noteOption = ($name == 'note_body') ?
2 : (($name == 'note_subject') ?
3 : $noteOption);
3340 $this->_useDistinct
= TRUE;
3342 $this->_tables
['civicrm_note'] = $this->_whereTables
['civicrm_note']
3343 = " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
3346 $value = CRM_Core_DAO
::escapeString($n);
3348 if (strpos($value, '%') === FALSE) {
3349 $value = "%$value%";
3353 elseif ($op == 'IS NULL' ||
$op == 'IS NOT NULL') {
3359 if ($noteOption %
2 == 0) {
3360 $clauses[] = self
::buildClause('civicrm_note.note', $op, $value, 'String');
3361 $label = ts('Note: Body Only');
3363 if ($noteOption %
3 == 0) {
3364 $clauses[] = self
::buildClause('civicrm_note.subject', $op, $value, 'String');
3365 $label = $label ?
ts('Note: Body and Subject') : ts('Note: Subject Only');
3367 $this->_where
[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
3368 list($qillOp, $qillVal) = self
::buildQillForFieldValue(NULL, $name, $n, $op);
3369 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(1 => $label, 2 => $qillOp, 3 => $qillVal));
3373 * @param string $name
3379 public function nameNullOrEmptyOp($name, $op, $grouping) {
3383 $this->_where
[$grouping][] = "contact_a.$name $op";
3384 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
3388 $this->_where
[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
3389 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
3392 case 'IS NOT EMPTY':
3393 $this->_where
[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
3394 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
3403 * Where / qill clause for sort_name
3405 * @param array $values
3407 public function sortName(&$values) {
3408 list($fieldName, $op, $value, $grouping, $wildcard) = $values;
3410 // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
3411 if ($this->nameNullOrEmptyOp($fieldName, $op, $grouping)) {
3415 $input = $value = trim($value);
3417 if (!strlen($value)) {
3421 $config = CRM_Core_Config
::singleton();
3425 //By default, $sub elements should be joined together with OR statements (don't change this variable).
3428 $firstChar = substr($value, 0, 1);
3429 $lastChar = substr($value, -1, 1);
3430 $quotes = array("'", '"');
3431 // If string is quoted, strip quotes and otherwise don't alter it
3432 if ((strlen($value) > 2) && in_array($firstChar, $quotes) && in_array($lastChar, $quotes)) {
3433 $value = trim($value, implode('', $quotes));
3435 // Replace spaces with wildcards for a LIKE operation
3436 // UNLESS string contains a comma (this exception is a tiny bit questionable)
3437 elseif ($op == 'LIKE' && strpos($value, ',') === FALSE) {
3438 $value = str_replace(' ', '%', $value);
3440 $value = CRM_Core_DAO
::escapeString(trim($value));
3441 if (strlen($value)) {
3442 $fieldsub = array();
3443 $value = "'" . self
::getWildCardedValue($wildcard, $op, $value) . "'";
3444 if ($fieldName == 'sort_name') {
3445 $wc = "contact_a.sort_name";
3448 $wc = "contact_a.display_name";
3450 $fieldsub[] = " ( $wc $op $value )";
3451 if ($config->includeNickNameInName
) {
3452 $wc = "contact_a.nick_name";
3453 $fieldsub[] = " ( $wc $op $value )";
3455 if ($config->includeEmailInName
) {
3456 $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3458 $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3461 $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3463 $this->_where
[$grouping][] = $sub;
3464 if ($config->includeEmailInName
) {
3465 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3466 $this->_qill
[$grouping][] = ts('Name or Email') . " $op - '$input'";
3469 $this->_qill
[$grouping][] = ts('Name') . " $op - '$input'";
3474 * Where/qill clause for greeting fields.
3476 * @param array $values
3478 public function greetings(&$values) {
3479 list($name, $op, $value, $grouping, $wildcard) = $values;
3480 $name .= '_display';
3482 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue(NULL, $name, $value, $op);
3483 $this->_qill
[$grouping][] = ts('Greeting %1 %2', array(1 => $qillop, 2 => $qillVal));
3484 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $value, 'String');
3488 * Where / qill clause for email
3490 * @param array $values
3491 * @param string $apiEntity
3493 protected function email(&$values, $apiEntity) {
3494 list($name, $op, $value, $grouping, $wildcard) = $values;
3495 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3497 // CRM-18147: for Contact's GET API, email fieldname got appended with its entity as in {$apiEntiy}_{$name}
3498 // so following code is use build whereClause for contact's primart email id
3499 if (!empty($apiEntity)) {
3500 $dataType = 'String';
3501 if ($name == 'email_id') {
3502 $dataType = 'Integer';
3506 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.is_primary', '=', 1, 'Integer');
3507 $this->_where
[$grouping][] = self
::buildClause("civicrm_email.$name", $op, $value, $dataType);
3513 if (substr($n, 0, 1) == '"' &&
3514 substr($n, -1, 1) == '"'
3516 $n = substr($n, 1, -1);
3517 $value = CRM_Core_DAO
::escapeString($n);
3521 $value = self
::getWildCardedValue($wildcard, $op, $n);
3523 $this->_qill
[$grouping][] = ts('Email') . " $op '$n'";
3524 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, $value, 'String');
3527 $this->_qill
[$grouping][] = ts('Email') . " $op ";
3528 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, NULL, 'String');
3533 * Where / qill clause for phone number
3535 * @param array $values
3537 public function phone_numeric(&$values) {
3538 list($name, $op, $value, $grouping, $wildcard) = $values;
3539 // Strip non-numeric characters; allow wildcards
3540 $number = preg_replace('/[^\d%]/', '', $value);
3542 if (strpos($number, '%') === FALSE) {
3543 $number = "%$number%";
3546 $this->_qill
[$grouping][] = ts('Phone number contains') . " $number";
3547 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String');
3548 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3553 * Where / qill clause for phone type/location
3555 * @param array $values
3557 public function phone_option_group($values) {
3558 list($name, $op, $value, $grouping, $wildcard) = $values;
3559 $option = ($name == 'phone_phone_type_id' ?
'phone_type_id' : 'location_type_id');
3560 $options = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', $option);
3561 $optionName = $options[$value];
3562 $this->_qill
[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ?
ts('type') : ('location')) . " $op $optionName";
3563 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3564 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3568 * Where / qill clause for street_address.
3570 * @param array $values
3572 public function street_address(&$values) {
3573 list($name, $op, $value, $grouping) = $values;
3582 if (strpos($value, '%') === FALSE) {
3583 // only add wild card if not there
3584 $value = "%{$value}%";
3587 $this->_where
[$grouping][] = self
::buildClause('civicrm_address.street_address', $op, $value, 'String');
3588 $this->_qill
[$grouping][] = ts('Street') . " $op '$n'";
3591 $this->_where
[$grouping][] = self
::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3592 $this->_qill
[$grouping][] = ts('Street') . " $op ";
3595 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3599 * Where / qill clause for street_unit.
3601 * @param array $values
3603 public function street_number(&$values) {
3604 list($name, $op, $value, $grouping, $wildcard) = $values;
3612 if (strtolower($n) == 'odd') {
3613 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3614 $this->_qill
[$grouping][] = ts('Street Number is odd');
3616 elseif (strtolower($n) == 'even') {
3617 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3618 $this->_qill
[$grouping][] = ts('Street Number is even');
3622 $this->_where
[$grouping][] = self
::buildClause('civicrm_address.street_number', $op, $value, 'String');
3623 $this->_qill
[$grouping][] = ts('Street Number') . " $op '$n'";
3626 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3630 * Where / qill clause for sorting by character.
3632 * @param array $values
3634 public function sortByCharacter(&$values) {
3635 list($name, $op, $value, $grouping, $wildcard) = $values;
3637 $name = trim($value);
3638 $cond = " contact_a.sort_name LIKE '" . CRM_Core_DAO
::escapeWildCardString($name) . "%'";
3639 $this->_where
[$grouping][] = $cond;
3640 $this->_qill
[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3644 * Where / qill clause for including contact ids.
3646 public function includeContactIDs() {
3647 if (!$this->_includeContactIds ||
empty($this->_params
)) {
3651 $contactIds = array();
3652 foreach ($this->_params
as $id => $values) {
3653 if (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
3654 $contactIds[] = substr($values[0], CRM_Core_Form
::CB_PREFIX_LEN
);
3657 CRM_Utils_Type
::validateAll($contactIds, 'Positive');
3658 if (!empty($contactIds)) {
3659 $this->_where
[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3664 * Where / qill clause for postal code.
3666 * @param array $values
3668 public function postalCode(&$values) {
3669 // skip if the fields dont have anything to do with postal_code
3670 if (empty($this->_fields
['postal_code'])) {
3674 list($name, $op, $value, $grouping, $wildcard) = $values;
3676 // Handle numeric postal code range searches properly by casting the column as numeric
3677 if (is_numeric($value)) {
3678 $field = "IF (civicrm_address.postal_code REGEXP '^[0-9]{1,10}$', CAST(civicrm_address.postal_code AS UNSIGNED), 0)";
3679 $val = CRM_Utils_Type
::escape($value, 'Integer');
3682 $field = 'civicrm_address.postal_code';
3683 // Per CRM-17060 we might be looking at an 'IN' syntax so don't case arrays to string.
3684 if (!is_array($value)) {
3685 $val = CRM_Utils_Type
::escape($value, 'String');
3688 // Do we need to escape values here? I would expect buildClause does.
3693 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3695 if ($name == 'postal_code') {
3696 $this->_where
[$grouping][] = self
::buildClause($field, $op, $val, 'String');
3697 $this->_qill
[$grouping][] = ts('Postal code') . " {$op} {$value}";
3699 elseif ($name == 'postal_code_low') {
3700 $this->_where
[$grouping][] = " ( $field >= '$val' ) ";
3701 $this->_qill
[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3703 elseif ($name == 'postal_code_high') {
3704 $this->_where
[$grouping][] = " ( $field <= '$val' ) ";
3705 $this->_qill
[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3710 * Where / qill clause for location type.
3712 * @param array $values
3713 * @param null $status
3717 public function locationType(&$values, $status = NULL) {
3718 list($name, $op, $value, $grouping, $wildcard) = $values;
3720 if (is_array($value)) {
3721 $this->_where
[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', $value) . ')';
3722 $this->_tables
['civicrm_address'] = 1;
3723 $this->_whereTables
['civicrm_address'] = 1;
3725 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
3727 foreach ($value as $id) {
3728 $names[] = $locationType[$id];
3731 $this->_primaryLocation
= FALSE;
3734 $this->_qill
[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3737 return implode(' ' . ts('or') . ' ', $names);
3744 * @param bool $fromStateProvince
3746 * @return array|NULL
3748 public function country(&$values, $fromStateProvince = TRUE) {
3749 list($name, $op, $value, $grouping, $wildcard) = $values;
3751 if (!$fromStateProvince) {
3752 $stateValues = $this->getWhereValues('state_province', $grouping);
3753 if (!empty($stateValues)) {
3754 // return back to caller if there are state province values
3755 // since that handles this case
3760 $countryClause = $countryQill = NULL;
3761 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ||
($values && !empty($value))) {
3762 $this->_tables
['civicrm_address'] = 1;
3763 $this->_whereTables
['civicrm_address'] = 1;
3765 $countryClause = self
::buildClause('civicrm_address.country_id', $op, $value, 'Positive');
3766 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue(NULL, 'country_id', $value, $op);
3767 $countryQill = ts("%1 %2 %3", array(1 => 'Country', 2 => $qillop, 3 => $qillVal));
3769 if (!$fromStateProvince) {
3770 $this->_where
[$grouping][] = $countryClause;
3771 $this->_qill
[$grouping][] = $countryQill;
3775 if ($fromStateProvince) {
3776 if (!empty($countryClause)) {
3779 " ...AND... " . $countryQill,
3783 return array(NULL, NULL);
3789 * Where / qill clause for county (if present).
3791 * @param array $values
3792 * @param null $status
3796 public function county(&$values, $status = NULL) {
3797 list($name, $op, $value, $grouping, $wildcard) = $values;
3799 if (!is_array($value)) {
3800 // force the county to be an array
3801 $value = array($value);
3804 // check if the values are ids OR names of the counties
3805 $inputFormat = 'id';
3806 foreach ($value as $v) {
3807 if (!is_numeric($v)) {
3808 $inputFormat = 'name';
3816 elseif ($op == '!=') {
3820 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3821 $op = str_replace('EMPTY', 'NULL', $op);
3824 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3825 $clause = "civicrm_address.county_id $op";
3827 elseif ($inputFormat == 'id') {
3828 $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3830 $county = CRM_Core_PseudoConstant
::county();
3831 foreach ($value as $id) {
3832 $names[] = CRM_Utils_Array
::value($id, $county);
3836 $inputClause = array();
3837 $county = CRM_Core_PseudoConstant
::county();
3838 foreach ($value as $name) {
3839 $name = trim($name);
3840 $inputClause[] = CRM_Utils_Array
::key($name, $county);
3842 $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3845 $this->_tables
['civicrm_address'] = 1;
3846 $this->_whereTables
['civicrm_address'] = 1;
3848 $this->_where
[$grouping][] = $clause;
3850 $this->_qill
[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3853 return implode(' ' . ts('or') . ' ', $names);
3858 * Where / qill clause for state/province AND country (if present).
3860 * @param array $values
3861 * @param null $status
3865 public function stateProvince(&$values, $status = NULL) {
3866 list($name, $op, $value, $grouping, $wildcard) = $values;
3868 $stateClause = self
::buildClause('civicrm_address.state_province_id', $op, $value, 'Positive');
3869 $this->_tables
['civicrm_address'] = 1;
3870 $this->_whereTables
['civicrm_address'] = 1;
3872 $countryValues = $this->getWhereValues('country', $grouping);
3873 list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3874 if ($countryClause) {
3875 $clause = "( $stateClause AND $countryClause )";
3878 $clause = $stateClause;
3881 $this->_where
[$grouping][] = $clause;
3882 list($qillop, $qillVal) = self
::buildQillForFieldValue('CRM_Core_DAO_Address', "state_province_id", $value, $op);
3884 $this->_qill
[$grouping][] = ts("State/Province %1 %2 %3", array(1 => $qillop, 2 => $qillVal, 3 => $countryQill));
3887 return implode(' ' . ts('or') . ' ', $qillVal) . $countryQill;
3892 * Where / qill clause for change log.
3894 * @param array $values
3896 public function changeLog(&$values) {
3897 list($name, $op, $value, $grouping, $wildcard) = $values;
3899 $targetName = $this->getWhereValues('changed_by', $grouping);
3904 $name = trim($targetName[2]);
3905 $name = CRM_Core_DAO
::escapeString($name);
3906 $name = $targetName[4] ?
"%$name%" : $name;
3907 $this->_where
[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3908 $this->_tables
['civicrm_log'] = $this->_whereTables
['civicrm_log'] = 1;
3909 $this->_qill
[$grouping][] = ts('Modified By') . " $name";
3915 public function modifiedDates($values) {
3916 $this->_useDistinct
= TRUE;
3918 // CRM-11281, default to added date if not set
3919 $fieldTitle = ts('Added Date');
3920 $fieldName = 'created_date';
3921 foreach (array_keys($this->_params
) as $id) {
3922 if ($this->_params
[$id][0] == 'log_date') {
3923 if ($this->_params
[$id][2] == 2) {
3924 $fieldTitle = ts('Modified Date');
3925 $fieldName = 'modified_date';
3930 $this->dateQueryBuilder($values, 'contact_a', 'log_date', $fieldName, $fieldTitle);
3932 self
::$_openedPanes[ts('Change Log')] = TRUE;
3938 public function demographics(&$values) {
3939 list($name, $op, $value, $grouping, $wildcard) = $values;
3941 if (($name == 'age_low') ||
($name == 'age_high')) {
3942 $this->ageRangeQueryBuilder($values,
3943 'contact_a', 'age', 'birth_date', ts('Age')
3946 elseif (($name == 'birth_date_low') ||
($name == 'birth_date_high')) {
3948 $this->dateQueryBuilder($values,
3949 'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3952 elseif (($name == 'deceased_date_low') ||
($name == 'deceased_date_high')) {
3954 $this->dateQueryBuilder($values,
3955 'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3959 self
::$_openedPanes[ts('Demographics')] = TRUE;
3965 public function privacy(&$values) {
3966 list($name, $op, $value, $grouping) = $values;
3967 //fixed for profile search listing CRM-4633
3968 if (strpbrk($value, "[")) {
3969 $value = "'{$value}'";
3971 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3974 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3976 $field = CRM_Utils_Array
::value($name, $this->_fields
);
3977 $op = CRM_Utils_Array
::value($op, CRM_Core_SelectValues
::getSearchBuilderOperators(), $op);
3978 $title = $field ?
$field['title'] : $name;
3979 $this->_qill
[$grouping][] = "$title $op $value";
3985 public function privacyOptions($values) {
3986 list($name, $op, $value, $grouping, $wildcard) = $values;
3988 if (empty($value) ||
!is_array($value)) {
3992 // get the operator and toggle values
3993 $opValues = $this->getWhereValues('privacy_operator', $grouping);
3996 strtolower($opValues[2] == 'AND')
3998 // @todo this line is logially unreachable
4002 $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
4004 if ($toggleValues &&
4005 $toggleValues[2] == 2
4012 foreach ($value as $dontCare => $pOption) {
4013 $clauses[] = " ( contact_a.{$pOption} = 1 ) ";
4014 $field = CRM_Utils_Array
::value($pOption, $this->_fields
);
4015 $title = $field ?
$field['title'] : $pOption;
4016 $qill[] = " $title = 1 ";
4019 $this->_where
[$grouping][] = $compareOP . '( ' . implode($operator, $clauses) . ' )';
4020 $this->_qill
[$grouping][] = $compareOP . '( ' . implode($operator, $qill) . ' )';
4026 public function preferredCommunication(&$values) {
4027 list($name, $op, $value, $grouping, $wildcard) = $values;
4029 if (!is_array($value)) {
4030 $value = str_replace(array('(', ')'), '', explode(",", $value));
4032 elseif (in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
4034 $value = $value[$op];
4036 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contact_DAO_Contact', $name, $value, $op);
4038 if (self
::caseImportant($op)) {
4039 $value = implode("[[:cntrl:]]|[[:cntrl:]]", (array) $value);
4040 $op = (strstr($op, '!') ||
strstr($op, 'NOT')) ?
'NOT RLIKE' : 'RLIKE';
4041 $value = "[[:cntrl:]]" . $value . "[[:cntrl:]]";
4044 $this->_where
[$grouping][] = self
::buildClause("contact_a.preferred_communication_method", $op, $value);
4045 $this->_qill
[$grouping][] = ts('Preferred Communication Method %1 %2', array(1 => $qillop, 2 => $qillVal));
4049 * Where / qill clause for relationship.
4051 * @param array $values
4053 public function relationship(&$values) {
4054 list($name, $op, $value, $grouping, $wildcard) = $values;
4055 if ($this->_relationshipValuesAdded
) {
4058 // also get values array for relation_target_name
4059 // for relationship search we always do wildcard
4060 $relationType = $this->getWhereValues('relation_type_id', $grouping);
4061 $targetName = $this->getWhereValues('relation_target_name', $grouping);
4062 $relStatus = $this->getWhereValues('relation_status', $grouping);
4063 $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
4065 $nameClause = $name = NULL;
4067 $name = trim($targetName[2]);
4068 if (substr($name, 0, 1) == '"' &&
4069 substr($name, -1, 1) == '"'
4071 $name = substr($name, 1, -1);
4072 $name = CRM_Core_DAO
::escapeString($name);
4073 $nameClause = "= '$name'";
4076 $name = CRM_Core_DAO
::escapeString($name);
4077 $nameClause = "LIKE '%{$name}%'";
4081 $relTypes = $relTypesIds = array();
4082 if (!empty($relationType)) {
4083 $relationType[2] = (array) $relationType[2];
4084 foreach ($relationType[2] as $relType) {
4085 $rel = explode('_', $relType);
4086 self
::$_relType = $rel[1];
4087 $params = array('id' => $rel[0]);
4088 $typeValues = array();
4089 $rTypeValue = CRM_Contact_BAO_RelationshipType
::retrieve($params, $typeValues);
4090 if (!empty($rTypeValue)) {
4091 if ($rTypeValue->name_a_b
== $rTypeValue->name_b_a
) {
4092 // if we don't know which end of the relationship we are dealing with we'll create a temp table
4093 self
::$_relType = 'reciprocal';
4095 $relTypesIds[] = $rel[0];
4096 $relTypes[] = $relType;
4101 // if we are creating a temp table we build our own where for the relationship table
4102 $relationshipTempTable = NULL;
4103 if (self
::$_relType == 'reciprocal') {
4105 self
::$_relationshipTempTable = $relationshipTempTable = CRM_Core_DAO
::createTempTableName('civicrm_rel');
4107 $where[$grouping][] = " sort_name $nameClause ";
4109 $groupJoinTable = "civicrm_relationship";
4110 $groupJoinColumn = "contact_id_alt";
4113 $where = &$this->_where
;
4115 $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
4117 $groupJoinTable = "contact_b";
4118 $groupJoinColumn = "id";
4120 $allRelationshipType = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, NULL, TRUE);
4121 if ($nameClause ||
!$targetGroup) {
4122 if (!empty($relationType)) {
4124 foreach ($relTypes as $rel) {
4125 if (!empty($relQill)) {
4128 $relQill .= $allRelationshipType[$rel];
4130 $this->_qill
[$grouping][] = 'Relationship Type(s) ' . $relQill . " $name";
4133 $this->_qill
[$grouping][] = $name;
4137 //check to see if the target contact is in specified group
4139 //add contacts from static groups
4140 $this->_tables
['civicrm_relationship_group_contact'] = $this->_whereTables
['civicrm_relationship_group_contact']
4141 = " LEFT JOIN civicrm_group_contact civicrm_relationship_group_contact ON civicrm_relationship_group_contact.contact_id = {$groupJoinTable}.{$groupJoinColumn} AND civicrm_relationship_group_contact.status = 'Added'";
4142 $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN (" .
4143 implode(",", $targetGroup[2]) . ") ) ";
4145 //add contacts from saved searches
4146 $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", $groupJoinTable, $op, $groupJoinColumn);
4148 //set the group where clause
4150 $groupWhere[] = "( " . $ssWhere . " )";
4152 $this->_where
[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
4154 //Get the names of the target groups for the qill
4155 $groupNames = CRM_Core_PseudoConstant
::group();
4156 $qillNames = array();
4157 foreach ($targetGroup[2] as $groupId) {
4158 if (array_key_exists($groupId, $groupNames)) {
4159 $qillNames[] = $groupNames[$groupId];
4162 if (!empty($relationType)) {
4164 foreach ($relTypes as $rel) {
4165 if (!empty($relQill)) {
4168 $relQill .= CRM_Utils_Array
::value($rel, $allRelationshipType);
4170 $this->_qill
[$grouping][] = 'Relationship Type(s) ' . $relQill . " ( " . implode(", ", $qillNames) . " )";
4173 $this->_qill
[$grouping][] = implode(", ", $qillNames);
4177 // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
4178 $today = date('Ymd');
4179 //check for active, inactive and all relation status
4180 if ($relStatus[2] == 0) {
4181 $where[$grouping][] = "(
4182 civicrm_relationship.is_active = 1 AND
4183 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
4184 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
4186 $this->_qill
[$grouping][] = ts('Relationship - Active and Current');
4188 elseif ($relStatus[2] == 1) {
4189 $where[$grouping][] = "(
4190 civicrm_relationship.is_active = 0 OR
4191 civicrm_relationship.end_date < {$today} OR
4192 civicrm_relationship.start_date > {$today}
4194 $this->_qill
[$grouping][] = ts('Relationship - Inactive or not Current');
4198 if (in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
)) {
4201 $where[$grouping][] = "(contact_b.is_deleted = {$onlyDeleted})";
4203 $this->addRelationshipPermissionClauses($grouping, $where);
4204 $this->addRelationshipDateClauses($grouping, $where);
4205 $this->addRelationshipActivePeriodClauses($grouping, $where);
4206 if (!empty($relTypes)) {
4207 $where[$grouping][] = 'civicrm_relationship.relationship_type_id IN (' . implode(',', $relTypesIds) . ')';
4209 $this->_tables
['civicrm_relationship'] = $this->_whereTables
['civicrm_relationship'] = 1;
4210 $this->_useDistinct
= TRUE;
4211 $this->_relationshipValuesAdded
= TRUE;
4212 // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
4214 if ($relationshipTempTable) {
4216 if (!empty($where[$grouping])) {
4217 $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
4218 $whereClause = str_replace('contact_b', 'c', $whereClause);
4221 CREATE TEMPORARY TABLE {$relationshipTempTable}
4223 `contact_id` int(10) unsigned NOT NULL DEFAULT '0',
4224 `contact_id_alt` int(10) unsigned NOT NULL DEFAULT '0',
4225 KEY `contact_id` (`contact_id`),
4226 KEY `contact_id_alt` (`contact_id_alt`)
4228 (SELECT contact_id_b as contact_id, contact_id_a as contact_id_alt, civicrm_relationship.id
4229 FROM civicrm_relationship
4230 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
4233 (SELECT contact_id_a as contact_id, contact_id_b as contact_id_alt, civicrm_relationship.id
4234 FROM civicrm_relationship
4235 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
4238 CRM_Core_DAO
::executeQuery($sql);
4243 * Add relationship permission criteria to where clause.
4245 * @param string $grouping
4246 * @param array $where Array to add "where" criteria to, in case you are generating a temp table.
4247 * Not the main query.
4249 public function addRelationshipPermissionClauses($grouping, &$where) {
4250 $relPermission = $this->getWhereValues('relation_permission', $grouping);
4251 if ($relPermission) {
4252 if (!is_array($relPermission[2])) {
4253 // this form value was scalar in previous versions of Civi
4254 $relPermission[2] = array($relPermission[2]);
4256 $where[$grouping][] = "(civicrm_relationship.is_permission_a_b IN (" . implode(",", $relPermission[2]) . "))";
4258 $allRelationshipPermissions = CRM_Contact_BAO_Relationship
::buildOptions('is_permission_a_b');
4260 $relPermNames = array_intersect_key($allRelationshipPermissions, array_flip($relPermission[2]));
4261 $this->_qill
[$grouping][] = ts('Permissioned Relationships') . ' - ' . implode(' OR ', $relPermNames);
4266 * Add start & end date criteria in
4267 * @param string $grouping
4268 * @param array $where
4269 * = array to add where clauses to, in case you are generating a temp table.
4270 * not the main query.
4272 public function addRelationshipDateClauses($grouping, &$where) {
4273 $dateValues = array();
4279 foreach ($dateTypes as $dateField) {
4280 $dateValueLow = $this->getWhereValues('relation_' . $dateField . '_low', $grouping);
4281 $dateValueHigh = $this->getWhereValues('relation_' . $dateField . '_high', $grouping);
4282 if (!empty($dateValueLow)) {
4283 $date = date('Ymd', strtotime($dateValueLow[2]));
4284 $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
4285 $this->_qill
[$grouping][] = ($dateField == 'end_date' ?
ts('Relationship Ended on or After') : ts('Relationship Recorded Start Date On or After')) . " " . CRM_Utils_Date
::customFormat($date);
4287 if (!empty($dateValueHigh)) {
4288 $date = date('Ymd', strtotime($dateValueHigh[2]));
4289 $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
4290 $this->_qill
[$grouping][] = ($dateField == 'end_date' ?
ts('Relationship Ended on or Before') : ts('Relationship Recorded Start Date On or Before')) . " " . CRM_Utils_Date
::customFormat($date);
4296 * Add start & end active period criteria in
4297 * @param string $grouping
4298 * @param array $where
4299 * = array to add where clauses to, in case you are generating a temp table.
4300 * not the main query.
4302 public function addRelationshipActivePeriodClauses($grouping, &$where) {
4303 $dateValues = array();
4304 $dateField = 'active_period_date';
4306 $dateValueLow = $this->getWhereValues('relation_active_period_date_low', $grouping);
4307 $dateValueHigh = $this->getWhereValues('relation_active_period_date_high', $grouping);
4308 $dateValueLowFormated = $dateValueHighFormated = NULL;
4309 if (!empty($dateValueLow) && !empty($dateValueHigh)) {
4310 $dateValueLowFormated = date('Ymd', strtotime($dateValueLow[2]));
4311 $dateValueHighFormated = date('Ymd', strtotime($dateValueHigh[2]));
4312 $this->_qill
[$grouping][] = (ts('Relationship was active between')) . " " . CRM_Utils_Date
::customFormat($dateValueLowFormated) . " and " . CRM_Utils_Date
::customFormat($dateValueHighFormated);
4314 elseif (!empty($dateValueLow)) {
4315 $dateValueLowFormated = date('Ymd', strtotime($dateValueLow[2]));
4316 $this->_qill
[$grouping][] = (ts('Relationship was active after')) . " " . CRM_Utils_Date
::customFormat($dateValueLowFormated);
4318 elseif (!empty($dateValueHigh)) {
4319 $dateValueHighFormated = date('Ymd', strtotime($dateValueHigh[2]));
4320 $this->_qill
[$grouping][] = (ts('Relationship was active before')) . " " . CRM_Utils_Date
::customFormat($dateValueHighFormated);
4323 if ($activePeriodClauses = self
::getRelationshipActivePeriodClauses($dateValueLowFormated, $dateValueHighFormated, TRUE)) {
4324 $where[$grouping][] = $activePeriodClauses;
4329 * Get start & end active period criteria
4331 public static function getRelationshipActivePeriodClauses($from, $to, $forceTableName) {
4332 $tableName = $forceTableName ?
'civicrm_relationship.' : '';
4333 if (!is_null($from) && !is_null($to)) {
4334 return '(((' . $tableName . 'start_date >= ' . $from . ' AND ' . $tableName . 'start_date <= ' . $to . ') OR
4335 (' . $tableName . 'end_date >= ' . $from . ' AND ' . $tableName . 'end_date <= ' . $to . ') OR
4336 (' . $tableName . 'start_date <= ' . $from . ' AND ' . $tableName . 'end_date >= ' . $to . ' )) OR
4337 (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date IS NULL) OR
4338 (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date >= ' . $from . ') OR
4339 (' . $tableName . 'end_date IS NULL AND ' . $tableName . 'start_date <= ' . $to . '))';
4341 elseif (!is_null($from)) {
4342 return '((' . $tableName . 'start_date >= ' . $from . ') OR
4343 (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date IS NULL) OR
4344 (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date >= ' . $from . '))';
4346 elseif (!is_null($to)) {
4347 return '((' . $tableName . 'start_date <= ' . $to . ') OR
4348 (' . $tableName . 'start_date IS NULL AND ' . $tableName . 'end_date IS NULL) OR
4349 (' . $tableName . 'end_date IS NULL AND ' . $tableName . 'start_date <= ' . $to . '))';
4354 * Default set of return properties.
4359 * derault return properties
4361 public static function &defaultReturnProperties($mode = 1) {
4362 if (!isset(self
::$_defaultReturnProperties)) {
4363 self
::$_defaultReturnProperties = array();
4366 if (!isset(self
::$_defaultReturnProperties[$mode])) {
4367 // add activity return properties
4368 if ($mode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
4369 self
::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query
::defaultReturnProperties($mode, FALSE);
4372 self
::$_defaultReturnProperties[$mode] = CRM_Core_Component
::defaultReturnProperties($mode, FALSE);
4375 if (empty(self
::$_defaultReturnProperties[$mode])) {
4376 self
::$_defaultReturnProperties[$mode] = array(
4379 'legal_identifier' => 1,
4380 'external_identifier' => 1,
4381 'contact_type' => 1,
4382 'contact_sub_type' => 1,
4384 'display_name' => 1,
4385 'preferred_mail_format' => 1,
4392 'formal_title' => 1,
4393 'communication_style_id' => 1,
4396 'street_address' => 1,
4397 'supplemental_address_1' => 1,
4398 'supplemental_address_2' => 1,
4399 'supplemental_address_3' => 1,
4402 'postal_code_suffix' => 1,
4403 'state_province' => 1,
4405 'world_region' => 1,
4412 'household_name' => 1,
4413 'organization_name' => 1,
4414 'deceased_date' => 1,
4419 'current_employer' => 1,
4420 // FIXME: should we use defaultHierReturnProperties() for the below?
4421 'do_not_email' => 1,
4424 'do_not_phone' => 1,
4425 'do_not_trade' => 1,
4427 'contact_is_deleted' => 1,
4428 'preferred_communication_method' => 1,
4429 'preferred_language' => 1,
4433 return self
::$_defaultReturnProperties[$mode];
4437 * Get primary condition for a sql clause.
4441 * @return string|NULL
4443 public static function getPrimaryCondition($value) {
4444 if (is_numeric($value)) {
4445 $value = (int ) $value;
4446 return ($value == 1) ?
'is_primary = 1' : 'is_primary = 0';
4452 * Wrapper for a simple search query.
4454 * @param array $params
4455 * @param array $returnProperties
4456 * @param bool $count
4460 public static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4461 $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4462 list($select, $from, $where, $having) = $query->query();
4463 $groupBy = ($query->_useGroupBy
) ?
'GROUP BY contact_a.id' : '';
4465 $query = "$select $from $where $groupBy $having";
4470 * These are stub comments as this function needs more explanation - particularly in terms of how it
4471 * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4473 * This function was originally written as a wrapper for the api query but is called from multiple places
4474 * in the core code directly so the name is misleading. This function does not use the searchQuery function
4475 * but it is unclear as to whehter that is historical or there is a reason
4476 * CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4478 * @param array $params
4479 * @param array $returnProperties
4480 * @param null $fields
4481 * @param string $sort
4482 * @param int $offset
4483 * @param int $row_count
4484 * @param bool $smartGroupCache
4485 * ?? update smart group cache?.
4486 * @param bool $count
4487 * Return count obnly.
4488 * @param bool $skipPermissions
4489 * Should permissions be ignored or should the logged in user's permissions be applied.
4491 * This basically correlates to the component.
4492 * @param string $apiEntity
4493 * The api entity being called.
4494 * This sort-of duplicates $mode in a confusing way. Probably not by design.
4496 * @param bool|null $primaryLocationOnly
4499 public static function apiQuery(
4501 $returnProperties = NULL,
4506 $smartGroupCache = TRUE,
4508 $skipPermissions = TRUE,
4509 $mode = CRM_Contact_BAO_Query
::MODE_CONTACTS
,
4511 $primaryLocationOnly = NULL
4514 $query = new CRM_Contact_BAO_Query(
4515 $params, $returnProperties,
4516 NULL, TRUE, FALSE, $mode,
4518 TRUE, $smartGroupCache,
4520 $apiEntity, $primaryLocationOnly
4523 //this should add a check for view deleted if permissions are enabled
4524 if ($skipPermissions) {
4525 $query->_skipDeleteClause
= TRUE;
4527 $query->generatePermissionClause(FALSE, $count);
4529 // note : this modifies _fromClause and _simpleFromClause
4530 $query->includePseudoFieldsJoin($sort);
4532 list($select, $from, $where, $having) = $query->query($count);
4534 $options = $query->_options
;
4535 if (!empty($query->_permissionWhereClause
)) {
4536 if (empty($where)) {
4537 $where = "WHERE $query->_permissionWhereClause";
4540 $where = "$where AND $query->_permissionWhereClause";
4544 $sql = "$select $from $where $having";
4546 // add group by only when API action is not getcount
4547 // otherwise query fetches incorrect count
4548 if ($query->_useGroupBy
&& !$count) {
4549 $sql .= self
::getGroupByFromSelectColumns($query->_select
, 'contact_a.id');
4551 if (!empty($sort)) {
4552 $sort = CRM_Utils_Type
::escape($sort, 'String');
4553 $sql .= " ORDER BY $sort ";
4555 if ($row_count > 0 && $offset >= 0) {
4556 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4557 $row_count = CRM_Utils_Type
::escape($row_count, 'Int');
4558 $sql .= " LIMIT $offset, $row_count ";
4561 $dao = CRM_Core_DAO
::executeQuery($sql);
4563 // @todo derive this from the component class rather than hard-code two options.
4564 $entityIDField = ($mode == CRM_Contact_BAO_Query
::MODE_CONTRIBUTE
) ?
'contribution_id' : 'contact_id';
4567 while ($dao->fetch()) {
4569 $noRows = $dao->rowCount
;
4570 return array($noRows, NULL);
4572 $val = $query->store($dao);
4573 $convertedVals = $query->convertToPseudoNames($dao, TRUE, TRUE);
4575 if (!empty($convertedVals)) {
4576 $val = array_replace_recursive($val, $convertedVals);
4578 $values[$dao->$entityIDField] = $val;
4580 return array($values, $options);
4584 * Get the actual custom field name by stripping off the appended string.
4586 * The string could be _relative, _from, or _to
4588 * @todo use metadata rather than convention to do this.
4590 * @param string $parameterName
4591 * The name of the parameter submitted to the form.
4598 public static function getCustomFieldName($parameterName) {
4599 if (substr($parameterName, -5, 5) == '_from') {
4600 return substr($parameterName, 0, strpos($parameterName, '_from'));
4602 if (substr($parameterName, -9, 9) == '_relative') {
4603 return substr($parameterName, 0, strpos($parameterName, '_relative'));
4605 if (substr($parameterName, -3, 3) == '_to') {
4606 return substr($parameterName, 0, strpos($parameterName, '_to'));
4611 * Convert submitted values for relative custom fields to query object format.
4613 * The query will support the sqlOperator format so convert to that format.
4615 * @param array $formValues
4617 * @param array $params
4618 * Converted parameters for the query object.
4619 * @param string $values
4621 * @param string $fieldName
4622 * Submitted field name. (Matches form field not DB field.)
4624 protected static function convertCustomRelativeFields(&$formValues, &$params, $values, $fieldName) {
4625 if (empty($values)) {
4626 // e.g we might have relative set & from & to empty. The form flow is a bit funky &
4627 // this function gets called again after they fields have been converted which can get ugly.
4630 $customFieldName = self
::getCustomFieldName($fieldName);
4632 if (substr($fieldName, -9, 9) == '_relative') {
4633 list($from, $to) = CRM_Utils_Date
::getFromTo($values, NULL, NULL);
4636 if ($fieldName == $customFieldName . '_to' && CRM_Utils_Array
::value($customFieldName . '_from', $formValues)) {
4637 // Both to & from are set. We only need to acton one, choosing from.
4641 $from = CRM_Utils_Array
::value($customFieldName . '_from', $formValues, NULL);
4642 $to = CRM_Utils_Array
::value($customFieldName . '_to', $formValues, NULL);
4644 if (self
::isCustomDateField($customFieldName)) {
4645 list($from, $to) = CRM_Utils_Date
::getFromTo(NULL, $from, $to);
4651 $relativeFunction = array('BETWEEN' => array($from, $to));
4654 $relativeFunction = array('>=' => $from);
4658 $relativeFunction = array('<=' => $to);
4670 * Are we dealing with custom field of type date.
4676 public static function isCustomDateField($fieldName) {
4677 if (($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($fieldName)) == FALSE) {
4680 if ('Date' == civicrm_api3('CustomField', 'getvalue', array('id' => $customFieldID, 'return' => 'data_type'))) {
4687 * Has this field already been reformatting to Query object syntax.
4689 * The form layer passed formValues to this function in preProcess & postProcess. Reason unknown. This seems
4690 * to come with associated double queries & is possibly damaging performance.
4692 * However, here we add a tested function to ensure convertFormValues identifies pre-processed fields & returns
4695 * @param mixed $values
4696 * Value in formValues for the field.
4700 public static function isAlreadyProcessedForQueryFormat($values) {
4701 if (!is_array($values)) {
4704 if (($operator = CRM_Utils_Array
::value(1, $values)) == FALSE) {
4707 return in_array($operator, CRM_Core_DAO
::acceptedSQLOperators());
4711 * If the state and country are passed remove state.
4713 * Country is implicit from the state, but including both results in
4714 * a poor query as there is no combined index on state AND country.
4718 * @param array $formValues
4720 public static function filterCountryFromValuesIfStateExists(&$formValues) {
4721 if (!empty($formValues['country']) && !empty($formValues['state_province'])) {
4722 // The use of array map sanitises the data by ensuring we are dealing with integers.
4723 $states = implode(', ', array_map('intval', $formValues['state_province']));
4724 $countryList = CRM_Core_DAO
::singleValueQuery(
4725 "SELECT GROUP_CONCAT(country_id) FROM civicrm_state_province WHERE id IN ($states)"
4727 if ($countryList == $formValues['country']) {
4728 unset($formValues['country']);
4734 * For some special cases, grouping by subset of select fields becomes mandatory.
4735 * Hence, full_group_by mode is handled by appending any_value
4736 * keyword to select fields not present in groupBy
4738 * @param array $selectClauses
4739 * @param array $groupBy - Columns already included in GROUP By clause.
4740 * @param string $aggregateFunction
4744 public static function appendAnyValueToSelect($selectClauses, $groupBy, $aggregateFunction = 'ANY_VALUE') {
4745 if (!CRM_Utils_SQL
::disableFullGroupByMode()) {
4746 $groupBy = array_map('trim', (array) $groupBy);
4747 $aggregateFunctions = '/(ROUND|AVG|COUNT|GROUP_CONCAT|SUM|MAX|MIN|IF)[[:blank:]]*\(/i';
4748 foreach ($selectClauses as $key => &$val) {
4749 list($selectColumn, $alias) = array_pad(preg_split('/ as /i', $val), 2, NULL);
4750 // append ANY_VALUE() keyword
4751 if (!in_array($selectColumn, $groupBy) && preg_match($aggregateFunctions, trim($selectColumn)) !== 1) {
4752 $val = ($aggregateFunction == 'GROUP_CONCAT') ?
4753 str_replace($selectColumn, "$aggregateFunction(DISTINCT {$selectColumn})", $val) :
4754 str_replace($selectColumn, "$aggregateFunction({$selectColumn})", $val);
4759 return "SELECT " . implode(', ', $selectClauses) . " ";
4763 * For some special cases, where if non-aggregate ORDER BY columns are not present in GROUP BY
4764 * on full_group_by mode, then append the those missing columns to GROUP BY clause
4765 * keyword to select fields not present in groupBy
4767 * @param string $groupBy - GROUP BY clause where missing ORDER BY columns will be appended if not present
4768 * @param array $orderBys - ORDER BY sub-clauses
4771 public static function getGroupByFromOrderBy(&$groupBy, $orderBys) {
4772 if (!CRM_Utils_SQL
::disableFullGroupByMode()) {
4773 foreach ($orderBys as $orderBy) {
4774 $orderBy = str_ireplace(array(' DESC', ' ASC', '`'), '', $orderBy); // remove sort syntax from ORDER BY clauses if present
4775 // if ORDER BY column is not present in GROUP BY then append it to end
4776 if (preg_match('/(MAX|MIN)\(/i', trim($orderBy)) !== 1 && !strstr($groupBy, $orderBy)) {
4777 $groupBy .= ", {$orderBy}";
4784 * Include Select columns in groupBy clause.
4786 * @param array $selectClauses
4787 * @param array $groupBy - Columns already included in GROUP By clause.
4791 public static function getGroupByFromSelectColumns($selectClauses, $groupBy = NULL) {
4792 $groupBy = (array) $groupBy;
4793 $mysqlVersion = CRM_Core_DAO
::singleValueQuery('SELECT VERSION()');
4794 $sqlMode = CRM_Core_DAO
::singleValueQuery('SELECT @@sql_mode');
4796 //return if ONLY_FULL_GROUP_BY is not enabled.
4797 if (CRM_Utils_SQL
::supportsFullGroupBy() && !empty($sqlMode) && in_array('ONLY_FULL_GROUP_BY', explode(',', $sqlMode))) {
4798 $regexToExclude = '/(ROUND|AVG|COUNT|GROUP_CONCAT|SUM|MAX|MIN|IF)[[:blank:]]*\(/i';
4799 foreach ($selectClauses as $key => $val) {
4800 $aliasArray = preg_split('/ as /i', $val);
4801 // if more than 1 alias we need to split by ','.
4802 if (count($aliasArray) > 2) {
4803 $aliasArray = preg_split('/,/', $val);
4804 foreach ($aliasArray as $key => $value) {
4805 $alias = current(preg_split('/ as /i', $value));
4806 if (!in_array($alias, $groupBy) && preg_match($regexToExclude, trim($alias)) !== 1) {
4807 $groupBy[] = $alias;
4812 list($selectColumn, $alias) = array_pad($aliasArray, 2, NULL);
4813 $dateRegex = '/^(DATE_FORMAT|DATE_ADD|CASE)/i';
4814 $tableName = current(explode('.', $selectColumn));
4815 $primaryKey = "{$tableName}.id";
4816 // exclude columns which are already included in groupBy and aggregate functions from select
4817 // CRM-18439 - Also exclude the columns which are functionally dependent on columns in $groupBy (MySQL 5.7+)
4818 if (!in_array($selectColumn, $groupBy) && !in_array($primaryKey, $groupBy) && preg_match($regexToExclude, trim($selectColumn)) !== 1) {
4819 if (!empty($alias) && preg_match($dateRegex, trim($selectColumn))) {
4820 $groupBy[] = $alias;
4823 $groupBy[] = $selectColumn;
4830 if (!empty($groupBy)) {
4831 return " GROUP BY " . implode(', ', $groupBy);
4837 * Create and query the db for an contact search.
4839 * @param int $offset
4840 * The offset for the query.
4841 * @param int $rowCount
4842 * The number of rows to return.
4843 * @param string|CRM_Utils_Sort $sort
4844 * The order by string.
4845 * @param bool $count
4846 * Is this a count only query ?.
4847 * @param bool $includeContactIds
4848 * Should we include contact ids?.
4849 * @param bool $sortByChar
4850 * If true returns the distinct array of first characters for search results.
4851 * @param bool $groupContacts
4852 * If true, return only the contact ids.
4853 * @param bool $returnQuery
4854 * Should we return the query as a string.
4855 * @param string $additionalWhereClause
4856 * If the caller wants to further restrict the search (used for components).
4857 * @param null $sortOrder
4858 * @param string $additionalFromClause
4859 * Should be clause with proper joins, effective to reduce where clause load.
4861 * @param bool $skipOrderAndLimit
4863 * @return CRM_Core_DAO
4865 public function searchQuery(
4866 $offset = 0, $rowCount = 0, $sort = NULL,
4867 $count = FALSE, $includeContactIds = FALSE,
4868 $sortByChar = FALSE, $groupContacts = FALSE,
4869 $returnQuery = FALSE,
4870 $additionalWhereClause = NULL, $sortOrder = NULL,
4871 $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4874 if ($includeContactIds) {
4875 $this->_includeContactIds
= TRUE;
4876 $this->_whereClause
= $this->whereClause();
4879 $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
);
4881 // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4882 // and that contact happens to be deleted, set $onlyDeleted to true
4883 foreach ($this->_params
as $values) {
4884 $name = CRM_Utils_Array
::value(0, $values);
4885 $op = CRM_Utils_Array
::value(1, $values);
4886 $value = CRM_Utils_Array
::value(2, $values);
4887 if ($name == 'contact_id' and $op == '=') {
4888 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4889 $onlyDeleted = TRUE;
4895 // building the query string
4896 $groupBy = $groupByCols = NULL;
4898 if (isset($this->_groupByComponentClause
)) {
4899 $groupBy = $this->_groupByComponentClause
;
4900 $groupByCols = preg_replace('/^GROUP BY /', '', trim($this->_groupByComponentClause
));
4901 $groupByCols = explode(', ', $groupByCols);
4903 elseif ($this->_useGroupBy
) {
4904 $groupByCols = array('contact_a.id');
4907 if ($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
&& (!$count)) {
4908 $groupByCols = array('civicrm_activity.id');
4911 $order = $orderBy = $limit = '';
4913 list($order, $additionalFromClause) = $this->prepareOrderBy($sort, $sortByChar, $sortOrder, $additionalFromClause);
4915 if ($rowCount > 0 && $offset >= 0) {
4916 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4917 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
4918 $limit = " LIMIT $offset, $rowCount ";
4921 // Two cases where we are disabling FGB (FULL_GROUP_BY_MODE):
4922 // 1. Expecting the search query to return all the first single letter characters of contacts ONLY, but when FGB is enabled
4923 // MySQL expect the columns present in GROUP BY, must be present in SELECT clause and that results into error, needless to have other columns.
4924 // 2. When GROUP BY columns are present then disable FGB otherwise it demands to add ORDER BY columns in GROUP BY and eventually in SELECT
4925 // clause. This will impact the search query output.
4926 $disableFullGroupByMode = ($sortByChar ||
!empty($groupByCols) ||
$groupContacts);
4928 if ($disableFullGroupByMode) {
4929 CRM_Core_DAO
::disableFullGroupByMode();
4933 $this->_sort
= $sort;
4936 $this->includePseudoFieldsJoin($sort);
4938 list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts, $onlyDeleted);
4940 if (!empty($groupByCols)) {
4941 $groupBy = " GROUP BY " . implode(', ', $groupByCols);
4944 if ($additionalWhereClause) {
4945 $where = $where . ' AND ' . $additionalWhereClause;
4948 //additional from clause should be w/ proper joins.
4949 if ($additionalFromClause) {
4950 $from .= "\n" . $additionalFromClause;
4953 // if we are doing a transform, do it here
4954 // use the $from, $where and $having to get the contact ID
4955 if ($this->_displayRelationshipType
) {
4956 $this->filterRelatedContacts($from, $where, $having);
4959 if ($skipOrderAndLimit) {
4960 $query = "$select $from $where $having $groupBy";
4963 $query = "$select $from $where $having $groupBy $order $limit";
4970 return CRM_Core_DAO
::singleValueQuery($query);
4973 $dao = CRM_Core_DAO
::executeQuery($query);
4975 if ($disableFullGroupByMode) {
4976 CRM_Core_DAO
::reenableFullGroupByMode();
4979 if ($groupContacts) {
4981 while ($dao->fetch()) {
4984 return implode(',', $ids);
4991 * Fetch a list of contacts for displaying a search results page
4993 * @param array $cids
4994 * List of contact IDs
4995 * @param bool $includeContactIds
4996 * @return CRM_Core_DAO
4998 public function getCachedContacts($cids, $includeContactIds) {
4999 CRM_Utils_Type
::validateAll($cids, 'Positive');
5000 $this->_includeContactIds
= $includeContactIds;
5001 $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
);
5002 list($select, $from, $where) = $this->query(FALSE, FALSE, FALSE, $onlyDeleted);
5003 $select .= sprintf(", (%s) AS _wgt", $this->createSqlCase('contact_a.id', $cids));
5004 $where .= sprintf(' AND contact_a.id IN (%s)', implode(',', $cids));
5005 $order = 'ORDER BY _wgt';
5006 $groupBy = $this->_useGroupBy ?
' GROUP BY contact_a.id' : '';
5008 $query = "$select $from $where $groupBy $order $limit";
5010 return CRM_Core_DAO
::executeQuery($query);
5014 * Construct a SQL CASE expression.
5016 * @param string $idCol
5017 * The name of a column with ID's (eg 'contact_a.id').
5018 * @param array $cids
5019 * Array(int $weight => int $id).
5021 * CASE WHEN id=123 THEN 1 WHEN id=456 THEN 2 END
5023 private function createSqlCase($idCol, $cids) {
5025 foreach ($cids as $weight => $cid) {
5026 $buf .= " WHEN $idCol = $cid THEN $weight \n";
5033 * Populate $this->_permissionWhereClause with permission related clause and update other
5034 * query related properties.
5036 * Function calls ACL permission class and hooks to filter the query appropriately
5038 * Note that these 2 params were in the code when extracted from another function
5039 * and a second round extraction would be to make them properties of the class
5041 * @param bool $onlyDeleted
5042 * Only get deleted contacts.
5043 * @param bool $count
5044 * Return Count only.
5046 public function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
5047 if (!$this->_skipPermission
) {
5048 $this->_permissionWhereClause
= CRM_ACL_API
::whereClause(
5049 CRM_Core_Permission
::VIEW
,
5051 $this->_whereTables
,
5054 $this->_skipDeleteClause
5057 // regenerate fromClause since permission might have added tables
5058 if ($this->_permissionWhereClause
) {
5059 //fix for row count in qill (in contribute/membership find)
5061 $this->_useDistinct
= TRUE;
5064 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
5065 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
5066 // note : this modifies _fromClause and _simpleFromClause
5067 $this->includePseudoFieldsJoin($this->_sort
);
5071 // add delete clause if needed even if we are skipping permission
5073 if (!$this->_skipDeleteClause
) {
5074 if (CRM_Core_Permission
::check('access deleted contacts') and $onlyDeleted) {
5075 $this->_permissionWhereClause
= '(contact_a.is_deleted)';
5079 $this->_permissionWhereClause
= '(contact_a.is_deleted = 0)';
5088 public function setSkipPermission($val) {
5089 $this->_skipPermission
= $val;
5093 * @param null $context
5097 public function &summaryContribution($context = NULL) {
5098 list($innerselect, $from, $where, $having) = $this->query(TRUE);
5102 SELECT COUNT( conts.total_amount ) as total_count,
5103 SUM( conts.total_amount ) as total_amount,
5104 AVG( conts.total_amount ) as total_avg,
5105 conts.currency as currency";
5106 if ($this->_permissionWhereClause
) {
5107 $where .= " AND " . $this->_permissionWhereClause
;
5109 if ($context == 'search') {
5110 $where .= " AND contact_a.is_deleted = 0 ";
5113 $query = $this->appendFinancialTypeWhereAndFromToQueryStrings($where, $from);
5115 // make sure contribution is completed - CRM-4989
5116 $completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 ";
5119 $summary['total'] = array();
5120 $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
5121 $innerQuery = "SELECT civicrm_contribution.total_amount, COUNT(civicrm_contribution.total_amount) as civicrm_contribution_total_amount_count,
5122 civicrm_contribution.currency $from $completedWhere";
5123 $query = "$select FROM (
5124 $innerQuery GROUP BY civicrm_contribution.id
5128 $dao = CRM_Core_DAO
::executeQuery($query);
5130 $summary['total']['count'] = 0;
5131 $summary['total']['amount'] = $summary['total']['avg'] = array();
5132 while ($dao->fetch()) {
5133 $summary['total']['count'] +
= $dao->total_count
;
5134 $summary['total']['amount'][] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
5135 $summary['total']['avg'][] = CRM_Utils_Money
::format($dao->total_avg
, $dao->currency
);
5138 $orderBy = 'ORDER BY civicrm_contribution_total_amount_count DESC';
5139 $groupBy = 'GROUP BY currency, civicrm_contribution.total_amount';
5140 $modeSQL = "$select, SUBSTRING_INDEX(GROUP_CONCAT(conts.total_amount
5141 ORDER BY conts.civicrm_contribution_total_amount_count DESC SEPARATOR ';'), ';', 1) as amount,
5142 MAX(conts.civicrm_contribution_total_amount_count) as civicrm_contribution_total_amount_count
5144 $groupBy $orderBy) as conts
5147 $summary['total']['mode'] = CRM_Contribute_BAO_Contribution
::computeStats('mode', $modeSQL);
5149 $medianSQL = "{$from} {$completedWhere}";
5150 $summary['total']['median'] = CRM_Contribute_BAO_Contribution
::computeStats('median', $medianSQL, 'civicrm_contribution');
5151 $summary['total']['currencyCount'] = count($summary['total']['median']);
5153 if (!empty($summary['total']['amount'])) {
5154 $summary['total']['amount'] = implode(', ', $summary['total']['amount']);
5155 $summary['total']['avg'] = implode(', ', $summary['total']['avg']);
5156 $summary['total']['mode'] = implode(', ', $summary['total']['mode']);
5157 $summary['total']['median'] = implode(', ', $summary['total']['median']);
5160 $summary['total']['amount'] = $summary['total']['avg'] = $summary['total']['median'] = 0;
5163 // soft credit summary
5164 if (CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled()) {
5165 $softCreditWhere = "{$completedWhere} AND civicrm_contribution_soft.id IS NOT NULL";
5168 SELECT civicrm_contribution_soft.amount as total_amount, civicrm_contribution_soft.currency $from $softCreditWhere
5169 GROUP BY civicrm_contribution_soft.id
5172 $dao = CRM_Core_DAO
::executeQuery($query);
5173 $summary['soft_credit']['count'] = 0;
5174 $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = array();
5175 while ($dao->fetch()) {
5176 $summary['soft_credit']['count'] +
= $dao->total_count
;
5177 $summary['soft_credit']['amount'][] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
5178 $summary['soft_credit']['avg'][] = CRM_Utils_Money
::format($dao->total_avg
, $dao->currency
);
5180 if (!empty($summary['soft_credit']['amount'])) {
5181 $summary['soft_credit']['amount'] = implode(', ', $summary['soft_credit']['amount']);
5182 $summary['soft_credit']['avg'] = implode(', ', $summary['soft_credit']['avg']);
5185 $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = 0;
5190 //@todo - this could be one query using the IF in mysql - eg
5191 // SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM (
5192 // SELECT civicrm_contribution.total_amount, civicrm_contribution.currency ,
5193 // IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed,
5194 // IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed,
5195 // IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled,
5196 // IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled
5197 // FROM civicrm_contact contact_a
5198 // LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id
5199 // WHERE ( ... where clause....
5200 // AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1)
5204 SELECT COUNT( conts.total_amount ) as cancel_count,
5205 SUM( conts.total_amount ) as cancel_amount,
5206 AVG( conts.total_amount ) as cancel_avg,
5207 conts.currency as currency";
5209 $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
5210 if ($context == 'search') {
5211 $where .= " AND contact_a.is_deleted = 0 ";
5214 $query = "$select FROM (
5215 SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $where
5216 GROUP BY civicrm_contribution.id
5220 $dao = CRM_Core_DAO
::executeQuery($query);
5223 if ($dao->fetch()) {
5224 $summary['cancel']['count'] = $dao->cancel_count
;
5225 $summary['cancel']['amount'] = CRM_Utils_Money
::format($dao->cancel_amount
, $dao->currency
);
5226 $summary['cancel']['avg'] = CRM_Utils_Money
::format($dao->cancel_avg
, $dao->currency
);
5230 $summary['cancel']['count'] = 0;
5231 $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
5232 while ($dao->fetch()) {
5233 $summary['cancel']['count'] +
= $dao->cancel_count
;
5234 $summary['cancel']['amount'][] = CRM_Utils_Money
::format($dao->cancel_amount
, $dao->currency
);
5235 $summary['cancel']['avg'][] = CRM_Utils_Money
::format($dao->cancel_avg
, $dao->currency
);
5237 $summary['cancel']['amount'] = implode(', ', $summary['cancel']['amount']);
5238 $summary['cancel']['avg'] = implode(', ', $summary['cancel']['avg']);
5245 * Append financial ACL limits to the query from & where clauses, if applicable.
5247 * @param string $where
5248 * @param string $from
5250 public function appendFinancialTypeWhereAndFromToQueryStrings(&$where, &$from) {
5251 if (!CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
5254 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
5255 if (!empty($financialTypes)) {
5256 $where .= " AND civicrm_contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ") AND li.id IS NULL";
5257 $from .= " LEFT JOIN civicrm_line_item li
5258 ON civicrm_contribution.id = li.contribution_id AND
5259 li.entity_table = 'civicrm_contribution' AND li.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ") ";
5262 $where .= " AND civicrm_contribution.financial_type_id IN (0)";
5267 * Getter for the qill object.
5271 public function qill() {
5272 return $this->_qill
;
5276 * Default set of return default hier return properties.
5280 public static function &defaultHierReturnProperties() {
5281 if (!isset(self
::$_defaultHierReturnProperties)) {
5282 self
::$_defaultHierReturnProperties = array(
5285 'legal_identifier' => 1,
5286 'external_identifier' => 1,
5287 'contact_type' => 1,
5288 'contact_sub_type' => 1,
5290 'display_name' => 1,
5297 'formal_title' => 1,
5298 'communication_style_id' => 1,
5299 'email_greeting' => 1,
5300 'postal_greeting' => 1,
5304 'preferred_communication_method' => 1,
5305 'do_not_phone' => 1,
5306 'do_not_email' => 1,
5309 'do_not_trade' => 1,
5310 'location' => array(
5312 'location_type' => 1,
5313 'street_address' => 1,
5315 'state_province' => 1,
5317 'postal_code_suffix' => 1,
5320 'phone-Mobile' => 1,
5333 'location_type' => 1,
5334 'street_address' => 1,
5336 'state_province' => 1,
5338 'postal_code_suffix' => 1,
5341 'phone-Mobile' => 1,
5355 return self
::$_defaultHierReturnProperties;
5359 * Build query for a date field.
5361 * @param array $values
5362 * @param string $tableName
5363 * @param string $fieldName
5364 * @param string $dbFieldName
5365 * @param string $fieldTitle
5366 * @param bool $appendTimeStamp
5367 * @param string $dateFormat
5369 public function dateQueryBuilder(
5370 &$values, $tableName, $fieldName,
5371 $dbFieldName, $fieldTitle,
5372 $appendTimeStamp = TRUE,
5373 $dateFormat = 'YmdHis'
5375 list($name, $op, $value, $grouping, $wildcard) = $values;
5377 if ($name == "{$fieldName}_low" ||
5378 $name == "{$fieldName}_high"
5380 if (isset($this->_rangeCache
[$fieldName]) ||
!$value) {
5383 $this->_rangeCache
[$fieldName] = 1;
5385 $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
5387 if ($name == $fieldName . '_low') {
5389 $firstPhrase = ts('greater than or equal to');
5390 $firstDate = CRM_Utils_Date
::processDate($value, NULL, FALSE, $dateFormat);
5392 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5393 if (!empty($secondValues) && $secondValues[2]) {
5395 $secondPhrase = ts('less than or equal to');
5396 $secondValue = $secondValues[2];
5398 if ($appendTimeStamp && strlen($secondValue) == 10) {
5399 $secondValue .= ' 23:59:59';
5401 $secondDate = CRM_Utils_Date
::processDate($secondValue, NULL, FALSE, $dateFormat);
5404 elseif ($name == $fieldName . '_high') {
5406 $firstPhrase = ts('less than or equal to');
5408 if ($appendTimeStamp && strlen($value) == 10) {
5409 $value .= ' 23:59:59';
5411 $firstDate = CRM_Utils_Date
::processDate($value, NULL, FALSE, $dateFormat);
5413 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5414 if (!empty($secondValues) && $secondValues[2]) {
5416 $secondPhrase = ts('greater than or equal to');
5417 $secondValue = $secondValues[2];
5418 $secondDate = CRM_Utils_Date
::processDate($secondValue, NULL, FALSE, $dateFormat);
5422 if (!$appendTimeStamp) {
5423 $firstDate = substr($firstDate, 0, 8);
5425 $firstDateFormat = CRM_Utils_Date
::customFormat($firstDate);
5428 if (!$appendTimeStamp) {
5429 $secondDate = substr($secondDate, 0, 8);
5431 $secondDateFormat = CRM_Utils_Date
::customFormat($secondDate);
5434 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5436 $this->_where
[$grouping][] = "
5437 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5438 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5440 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
5443 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5444 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
5448 if ($name == $fieldName) {
5449 //In Get API, for operators other then '=' the $value is in array(op => value) format
5450 if (is_array($value) && !empty($value) && in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
5452 $value = $value[$op];
5455 $date = $format = NULL;
5456 if (strstr($op, 'IN')) {
5458 foreach ($value as &$date) {
5459 $date = CRM_Utils_Date
::processDate($date, NULL, FALSE, $dateFormat);
5460 if (!$appendTimeStamp) {
5461 $date = substr($date, 0, 8);
5463 $format[] = CRM_Utils_Date
::customFormat($date);
5465 $date = "('" . implode("','", $value) . "')";
5466 $format = implode(', ', $format);
5468 elseif ($value && (!strstr($op, 'NULL') && !strstr($op, 'EMPTY'))) {
5469 $date = CRM_Utils_Date
::processDate($value, NULL, FALSE, $dateFormat);
5470 if (!$appendTimeStamp) {
5471 $date = substr($date, 0, 8);
5473 $format = CRM_Utils_Date
::customFormat($date);
5478 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op $date";
5481 $this->_where
[$grouping][] = self
::buildClause("{$tableName}.{$dbFieldName}", $op);
5484 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5486 $op = CRM_Utils_Array
::value($op, CRM_Core_SelectValues
::getSearchBuilderOperators(), $op);
5487 $this->_qill
[$grouping][] = "$fieldTitle $op $format";
5493 * @param string $tableName
5494 * @param string $fieldName
5495 * @param string $dbFieldName
5496 * @param $fieldTitle
5497 * @param null $options
5499 public function numberRangeBuilder(
5501 $tableName, $fieldName,
5502 $dbFieldName, $fieldTitle,
5505 list($name, $op, $value, $grouping, $wildcard) = $values;
5507 if ($name == "{$fieldName}_low" ||
5508 $name == "{$fieldName}_high"
5510 if (isset($this->_rangeCache
[$fieldName])) {
5513 $this->_rangeCache
[$fieldName] = 1;
5515 $secondOP = $secondPhrase = $secondValue = NULL;
5517 if ($name == "{$fieldName}_low") {
5519 $firstPhrase = ts('greater than');
5521 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5522 if (!empty($secondValues)) {
5524 $secondPhrase = ts('less than');
5525 $secondValue = $secondValues[2];
5530 $firstPhrase = ts('less than');
5532 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5533 if (!empty($secondValues)) {
5535 $secondPhrase = ts('greater than');
5536 $secondValue = $secondValues[2];
5541 $this->_where
[$grouping][] = "
5542 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
5543 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
5545 $displayValue = $options ?
$options[$value] : $value;
5546 $secondDisplayValue = $options ?
$options[$secondValue] : $secondValue;
5548 $this->_qill
[$grouping][]
5549 = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5552 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
5553 $displayValue = $options ?
$options[$value] : $value;
5554 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5556 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5561 if ($name == $fieldName) {
5565 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
5567 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5568 $displayValue = $options ?
$options[$value] : $value;
5569 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
5576 * @param string $tableName
5577 * @param string $fieldName
5578 * @param string $dbFieldName
5579 * @param $fieldTitle
5580 * @param null $options
5582 public function ageRangeQueryBuilder(
5584 $tableName, $fieldName,
5585 $dbFieldName, $fieldTitle,
5588 list($name, $op, $value, $grouping, $wildcard) = $values;
5590 $asofDateValues = $this->getWhereValues("{$fieldName}_asof_date", $grouping);
5591 $asofDate = NULL; // will be treated as current day
5592 if ($asofDateValues) {
5593 $asofDate = CRM_Utils_Date
::processDate($asofDateValues[2]);
5594 $asofDateFormat = CRM_Utils_Date
::customFormat(substr($asofDate, 0, 8));
5595 $fieldTitle .= ' ' . ts('as of') . ' ' . $asofDateFormat;
5598 if ($name == "{$fieldName}_low" ||
5599 $name == "{$fieldName}_high"
5601 if (isset($this->_rangeCache
[$fieldName])) {
5604 $this->_rangeCache
[$fieldName] = 1;
5606 $secondOP = $secondPhrase = $secondValue = NULL;
5608 if ($name == "{$fieldName}_low") {
5609 $firstPhrase = ts('greater than or equal to');
5610 // NB: age > X means date of birth < Y
5612 $firstDate = self
::calcDateFromAge($asofDate, $value, 'min');
5614 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5615 if (!empty($secondValues)) {
5617 $secondPhrase = ts('less than or equal to');
5618 $secondValue = $secondValues[2];
5619 $secondDate = self
::calcDateFromAge($asofDate, $secondValue, 'max');
5624 $firstPhrase = ts('less than or equal to');
5625 $firstDate = self
::calcDateFromAge($asofDate, $value, 'max');
5627 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5628 if (!empty($secondValues)) {
5630 $secondPhrase = ts('greater than or equal to');
5631 $secondValue = $secondValues[2];
5632 $secondDate = self
::calcDateFromAge($asofDate, $secondValue, 'min');
5637 $this->_where
[$grouping][] = "
5638 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5639 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5641 $displayValue = $options ?
$options[$value] : $value;
5642 $secondDisplayValue = $options ?
$options[$secondValue] : $secondValue;
5644 $this->_qill
[$grouping][]
5645 = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5648 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5649 $displayValue = $options ?
$options[$value] : $value;
5650 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5652 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5658 * Calculate date from age.
5660 * @param string $asofDate
5662 * @param string $type
5666 public static function calcDateFromAge($asofDate, $age, $type) {
5667 $date = new DateTime($asofDate);
5668 if ($type == "min") {
5669 // minimum age is $age: dob <= date - age "235959"
5670 $date->sub(new DateInterval("P" . $age . "Y"));
5671 return $date->format('Ymd') . "235959";
5674 // max age is $age: dob >= date - (age + 1y) + 1d "000000"
5675 $date->sub(new DateInterval("P" . ($age +
1) . "Y"))->add(new DateInterval("P1D"));
5676 return $date->format('Ymd') . "000000";
5681 * Given the field name, operator, value & its data type
5682 * builds the where Clause for the query
5683 * used for handling 'IS NULL'/'IS NOT NULL' operators
5685 * @param string $field
5689 * @param string $value
5691 * @param string $dataType
5692 * Data type of the field.
5695 * Where clause for the query.
5697 public static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
5699 $clause = "$field $op";
5707 $clause = ($dataType == 'Date') ?
" $field IS NULL " : " (NULLIF($field, '') IS NULL) ";
5710 case 'IS NOT EMPTY':
5711 $clause = ($dataType == 'Date') ?
" $field IS NOT NULL " : " (NULLIF($field, '') IS NOT NULL) ";
5715 return " {$clause} BINARY '{$value}' ";
5719 // I feel like this would be escaped properly if passed through $queryString = CRM_Core_DAO::createSqlFilter.
5720 if (!empty($value) && (!is_array($value) ||
!array_key_exists($op, $value))) {
5721 $value = array($op => (array) $value);
5725 if (empty($dataType) ||
$dataType == 'Date') {
5726 $dataType = 'String';
5728 if (is_array($value)) {
5729 //this could have come from the api - as in the restWhere section we potentially use the api operator syntax which is becoming more
5730 // widely used and consistent across the codebase
5731 // adding this here won't accept the search functions which don't submit an array
5732 if (($queryString = CRM_Core_DAO
::createSqlFilter($field, $value, $dataType)) != FALSE) {
5734 return $queryString;
5736 if (!empty($value[0]) && $op === 'BETWEEN') {
5737 CRM_Core_Error
::deprecatedFunctionWarning('Fix search input params');
5738 if (($queryString = CRM_Core_DAO
::createSqlFilter($field, array($op => $value), $dataType)) != FALSE) {
5739 return $queryString;
5742 throw new CRM_Core_Exception(ts('Failed to interpret input for search'));
5745 $value = CRM_Utils_Type
::escape($value, $dataType);
5746 // if we don't have a dataType we should assume
5747 if ($dataType == 'String' ||
$dataType == 'Text') {
5748 $value = "'" . $value . "'";
5750 return "$clause $value";
5755 * @param bool $reset
5759 public function openedSearchPanes($reset = FALSE) {
5760 if (!$reset ||
empty($this->_whereTables
)) {
5761 return self
::$_openedPanes;
5764 // pane name to table mapper
5765 $panesMapper = array(
5766 ts('Contributions') => 'civicrm_contribution',
5767 ts('Memberships') => 'civicrm_membership',
5768 ts('Events') => 'civicrm_participant',
5769 ts('Relationships') => 'civicrm_relationship',
5770 ts('Activities') => 'civicrm_activity',
5771 ts('Pledges') => 'civicrm_pledge',
5772 ts('Cases') => 'civicrm_case',
5773 ts('Grants') => 'civicrm_grant',
5774 ts('Address Fields') => 'civicrm_address',
5775 ts('Notes') => 'civicrm_note',
5776 ts('Change Log') => 'civicrm_log',
5777 ts('Mailings') => 'civicrm_mailing',
5779 CRM_Contact_BAO_Query_Hook
::singleton()->getPanesMapper($panesMapper);
5781 foreach (array_keys($this->_whereTables
) as $table) {
5782 if ($panName = array_search($table, $panesMapper)) {
5783 self
::$_openedPanes[$panName] = TRUE;
5787 return self
::$_openedPanes;
5793 public function setOperator($operator) {
5794 $validOperators = array('AND', 'OR');
5795 if (!in_array($operator, $validOperators)) {
5798 $this->_operator
= $operator;
5804 public function getOperator() {
5805 return $this->_operator
;
5813 public function filterRelatedContacts(&$from, &$where, &$having) {
5814 if (!isset(Civi
::$statics[__CLASS__
]['related_contacts_filter'])) {
5815 Civi
::$statics[__CLASS__
]['related_contacts_filter'] = array();
5817 $_rTempCache =& Civi
::$statics[__CLASS__
]['related_contacts_filter'];
5818 // since there only can be one instance of this filter in every query
5819 // skip if filter has already applied
5820 foreach ($_rTempCache as $acache) {
5821 foreach ($acache['queries'] as $aqcache) {
5822 if (strpos($from, $aqcache['from']) !== FALSE) {
5828 $arg_sig = sha1("$from $where $having");
5829 if (isset($_rTempCache[$arg_sig])) {
5830 $cache = $_rTempCache[$arg_sig];
5833 // create temp table with contact ids
5834 $tableName = CRM_Core_DAO
::createTempTableName('civicrm_transform', TRUE);
5836 $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
5837 CRM_Core_DAO
::executeQuery($sql);
5840 REPLACE INTO $tableName ( contact_id )
5846 CRM_Core_DAO
::executeQuery($sql);
5848 $cache = array('tableName' => $tableName, 'queries' => array());
5849 $_rTempCache[$arg_sig] = $cache;
5851 // upsert the query depending on relationship type
5852 if (isset($cache['queries'][$this->_displayRelationshipType
])) {
5853 $qcache = $cache['queries'][$this->_displayRelationshipType
];
5856 $tableName = $cache['tableName'];
5861 $rTypes = CRM_Core_PseudoConstant
::relationshipType();
5862 if (is_numeric($this->_displayRelationshipType
)) {
5863 $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType
]['label_a_b'];
5865 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
5866 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
5868 $qcache['where'] = "
5869 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
5870 AND displayRelType.is_active = 1
5874 list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType
);
5875 if ($dirOne == 'a') {
5876 $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
5877 $qcache['from'] .= "
5878 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
5879 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
5883 $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
5884 $qcache['from'] .= "
5885 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
5886 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
5889 $qcache['where'] = "
5890 WHERE displayRelType.relationship_type_id = $relType
5891 AND displayRelType.is_active = 1
5894 $qcache['relTypeLabel'] = $relationshipTypeLabel;
5895 $_rTempCache[$arg_sig]['queries'][$this->_displayRelationshipType
] = $qcache;
5897 $qillMessage = ts('Contacts with a Relationship Type of: ');
5898 $iqill = $qillMessage . "'" . $qcache['relTypeLabel'] . "'";
5899 if (!is_array($this->_qill
[0]) ||
!in_array($iqill, $this->_qill
[0])) {
5900 $this->_qill
[0][] = $iqill;
5902 if (strpos($from, $qcache['from']) === FALSE) {
5903 // lets replace all the INNER JOIN's in the $from so we dont exclude other data
5904 // this happens when we have an event_type in the quert (CRM-7969)
5905 $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
5906 $from .= $qcache['from'];
5907 $where = $qcache['where'];
5908 if (!empty($this->_permissionWhereClause
)) {
5909 $where .= "AND $this->_permissionWhereClause";
5917 * See CRM-19811 for why this is database hurty without apparent benefit.
5923 public static function caseImportant($op) {
5925 in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ?
FALSE : TRUE;
5929 * @param $returnProperties
5934 public static function componentPresent(&$returnProperties, $prefix) {
5935 foreach ($returnProperties as $name => $dontCare) {
5936 if (substr($name, 0, strlen($prefix)) == $prefix) {
5944 * Builds the necessary structures for all fields that are similar to option value look-ups.
5946 * @param string $name
5947 * the name of the field.
5949 * the sql operator, this function should handle ALL SQL operators.
5950 * @param string $value
5951 * depends on the operator and who's calling the query builder.
5952 * @param int $grouping
5953 * the index where to place the where clause.
5954 * @param string $daoName
5956 * @param array $field
5957 * an array that contains various properties of the field identified by $name.
5958 * @param string $label
5959 * The label for this field element.
5960 * @param string $dataType
5961 * The data type for this element.
5962 * @param bool $useIDsOnly
5964 public function optionValueQuery(
5972 $dataType = 'String',
5976 $pseudoFields = array(
5983 'communication_style_id',
5987 list($tableName, $fieldName) = explode('.', $field['where'], 2);
5988 if ($tableName == 'civicrm_contact') {
5989 $wc = "contact_a.$fieldName";
5992 // Special handling for on_hold, so that we actually use the 'where'
5993 // property in order to limit the query by the on_hold status of the email,
5994 // instead of using email.id which would be nonsensical.
5995 if ($field['name'] == 'on_hold') {
5996 $wc = "{$field['where']}";
5999 $wc = "$tableName.id";
6004 CRM_Core_Error
::deprecatedFunctionWarning('pass $ids to this method');
6005 $wc = "{$field['where']}";
6007 if (in_array($name, $pseudoFields)) {
6008 if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id', 'communication_style_id'))) {
6009 $wc = "contact_a.{$name}_id";
6011 $dataType = 'Positive';
6012 $value = (!$value) ?
0 : $value;
6014 if ($name == "world_region") {
6015 $field['name'] = $name;
6018 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue($daoName, $field['name'], $value, $op);
6019 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(1 => $label, 2 => $qillop, 3 => $qillVal));
6020 $this->_where
[$grouping][] = self
::buildClause($wc, $op, $value, $dataType);
6024 * Check and explode a user defined numeric string into an array
6025 * this was the protocol used by search builder in the old old days before we had
6026 * super nice js widgets to do the hard work
6028 * @param string $string
6029 * @param string $dataType
6030 * The dataType we should check for the values, default integer.
6032 * @return bool|array
6033 * false if string does not match the pattern
6034 * array of numeric values if string does match the pattern
6036 public static function parseSearchBuilderString($string, $dataType = 'Integer') {
6037 $string = trim($string);
6038 if (substr($string, 0, 1) != '(' ||
substr($string, -1, 1) != ')') {
6042 $string = substr($string, 1, -1);
6043 $values = explode(',', $string);
6044 if (empty($values)) {
6048 $returnValues = array();
6049 foreach ($values as $v) {
6050 if ($dataType == 'Integer' && !is_numeric($v)) {
6053 elseif ($dataType == 'String' && !is_string($v)) {
6056 $returnValues[] = trim($v);
6059 if (empty($returnValues)) {
6063 return $returnValues;
6067 * Convert the pseudo constants id's to their names
6069 * @param CRM_Core_DAO $dao
6070 * @param bool $return
6071 * @param bool $usedForAPI
6073 * @return array|NULL
6075 public function convertToPseudoNames(&$dao, $return = FALSE, $usedForAPI = FALSE) {
6076 if (empty($this->_pseudoConstantsSelect
)) {
6080 foreach ($this->_pseudoConstantsSelect
as $key => $value) {
6081 if (!empty($this->_pseudoConstantsSelect
[$key]['sorting'])) {
6085 if (is_object($dao) && property_exists($dao, $value['idCol'])) {
6086 $val = $dao->{$value['idCol']};
6087 if ($key == 'groups') {
6088 $dao->groups
= $this->convertGroupIDStringToLabelString($dao, $val);
6092 if (CRM_Utils_System
::isNull($val)) {
6095 elseif (!empty($value['pseudoconstant'])) {
6096 // If pseudoconstant is set that is kind of defacto for 'we have a bit more info about this'
6097 // and we can use the metadata to figure it out.
6098 // ideally this bit of IF will absorb & replace all the rest in time as we move to
6099 // more metadata based choices.
6100 if (strpos($val, CRM_Core_DAO
::VALUE_SEPARATOR
) !== FALSE) {
6101 $dbValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, trim($val, CRM_Core_DAO
::VALUE_SEPARATOR
));
6102 foreach ($dbValues as $pseudoValue) {
6103 $convertedValues[] = CRM_Core_PseudoConstant
::getLabel($value['bao'], $value['idCol'], $pseudoValue);
6106 $dao->$key = ($usedForAPI) ?
$convertedValues : implode(', ', $convertedValues);
6107 $realFieldName = CRM_Utils_Array
::value('field_name', $this->_pseudoConstantsSelect
[$key]);
6108 if ($usedForAPI && $realFieldName) {
6109 // normally we would see 2 fields returned for pseudoConstants. An exception is
6110 // preferred_communication_method where there is no id-variant.
6111 // For the api we prioritise getting the real data returned.
6112 // over the resolved version
6113 $dao->$realFieldName = $dbValues;
6118 // This is basically the same as the default but since we have the bao we can use
6119 // a cached function.
6120 $dao->$key = CRM_Core_PseudoConstant
::getLabel($value['bao'], $value['idCol'], $val);
6123 elseif ($baoName = CRM_Utils_Array
::value('bao', $value, NULL)) {
6125 $idColumn = "{$key}_id";
6126 $dao->$idColumn = $val;
6128 if ($key == 'state_province_name') {
6129 $dao->{$value['pseudoField']} = $dao->$key = CRM_Core_PseudoConstant
::stateProvince($val);
6132 $dao->{$value['pseudoField']} = $dao->$key = CRM_Core_PseudoConstant
::getLabel($baoName, $value['pseudoField'], $val);
6135 elseif ($value['pseudoField'] == 'state_province_abbreviation') {
6136 $dao->$key = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($val);
6138 // @todo handle this in the section above for pseudoconstants.
6139 elseif (in_array($value['pseudoField'], array('participant_role_id', 'participant_role'))) {
6140 // @todo define bao on this & merge into the above condition.
6141 $viewValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $val);
6143 if ($value['pseudoField'] == 'participant_role') {
6144 $pseudoOptions = CRM_Core_PseudoConstant
::get('CRM_Event_DAO_Participant', 'role_id');
6145 foreach ($viewValues as $k => $v) {
6146 $viewValues[$k] = $pseudoOptions[$v];
6149 $dao->$key = ($usedForAPI && count($viewValues) > 1) ?
$viewValues : implode(', ', $viewValues);
6152 $labels = CRM_Core_OptionGroup
::values($value['pseudoField']);
6153 $dao->$key = $labels[$val];
6156 // return converted values in array format
6158 if (strpos($key, '-') !== FALSE) {
6159 $keyVal = explode('-', $key);
6160 $current = &$values;
6161 $lastElement = array_pop($keyVal);
6162 foreach ($keyVal as $v) {
6163 if (!array_key_exists($v, $current)) {
6164 $current[$v] = array();
6166 $current = &$current[$v];
6168 $current[$lastElement] = $dao->$key;
6171 $values[$key] = $dao->$key;
6178 'gender_id' => 'gender',
6179 'prefix_id' => 'individual_prefix',
6180 'suffix_id' => 'individual_suffix',
6181 'communication_style_id' => 'communication_style',
6182 ) as $realField => $labelField) {
6183 // This is a temporary routine for handling these fields while
6184 // we figure out how to handled them based on metadata in
6185 /// export and search builder. CRM-19815, CRM-19830.
6186 if (isset($dao->$realField) && is_numeric($dao->$realField) && isset($dao->$labelField)) {
6187 $dao->$realField = $dao->$labelField;
6195 * Include pseudo fields LEFT JOIN.
6196 * @param string|array $sort can be a object or string
6198 * @return array|NULL
6200 public function includePseudoFieldsJoin($sort) {
6201 if (!$sort ||
empty($this->_pseudoConstantsSelect
)) {
6204 $sort = is_string($sort) ?
$sort : $sort->orderBy();
6207 foreach ($this->_pseudoConstantsSelect
as $name => $value) {
6208 if (!empty($value['table'])) {
6209 $regex = "/({$value['table']}\.|{$name})/";
6210 if (preg_match($regex, $sort)) {
6211 $this->_elemnt
[$value['element']] = 1;
6212 $this->_select
[$value['element']] = $value['select'];
6213 $this->_pseudoConstantsSelect
[$name]['sorting'] = 1;
6214 $present[$value['table']] = $value['join'];
6218 $presentSimpleFrom = $present;
6220 if (array_key_exists('civicrm_worldregion', $this->_whereTables
) &&
6221 array_key_exists('civicrm_country', $presentSimpleFrom)
6223 unset($presentSimpleFrom['civicrm_country']);
6225 if (array_key_exists('civicrm_worldregion', $this->_tables
) &&
6226 array_key_exists('civicrm_country', $present)
6228 unset($present['civicrm_country']);
6231 $presentClause = $presentSimpleFromClause = NULL;
6232 if (!empty($present)) {
6233 $presentClause = implode(' ', $present);
6235 if (!empty($presentSimpleFrom)) {
6236 $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
6239 $this->_fromClause
= $this->_fromClause
. $presentClause;
6240 $this->_simpleFromClause
= $this->_simpleFromClause
. $presentSimpleFromClause;
6242 return array($presentClause, $presentSimpleFromClause);
6246 * Build qill for field.
6248 * Qill refers to the query detail visible on the UI.
6250 * @param string $daoName
6251 * @param string $fieldName
6252 * @param mixed $fieldValue
6254 * @param array $pseudoExtraParam
6256 * Type of the field per CRM_Utils_Type
6260 public static function buildQillForFieldValue(
6265 $pseudoExtraParam = array(),
6266 $type = CRM_Utils_Type
::T_STRING
6268 $qillOperators = CRM_Core_SelectValues
::getSearchBuilderOperators();
6270 //API usually have fieldValue format as array(operator => array(values)),
6271 //so we need to separate operator out of fieldValue param
6272 if (is_array($fieldValue) && in_array(key($fieldValue), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
6273 $op = key($fieldValue);
6274 $fieldValue = $fieldValue[$op];
6277 // if Operator chosen is NULL/EMPTY then
6278 if (strpos($op, 'NULL') !== FALSE ||
strpos($op, 'EMPTY') !== FALSE) {
6279 return array(CRM_Utils_Array
::value($op, $qillOperators, $op), '');
6282 if ($fieldName == 'activity_type_id') {
6283 $pseudoOptions = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
6285 elseif ($fieldName == 'country_id') {
6286 $pseudoOptions = CRM_Core_PseudoConstant
::country();
6288 elseif ($fieldName == 'county_id') {
6289 $pseudoOptions = CRM_Core_PseudoConstant
::county();
6291 elseif ($fieldName == 'world_region') {
6292 $pseudoOptions = CRM_Core_PseudoConstant
::worldRegion();
6294 elseif ($daoName == 'CRM_Event_DAO_Event' && $fieldName == 'id') {
6295 $checkPermission = CRM_Utils_Array
::value('check_permission', $pseudoExtraParam, TRUE);
6296 $pseudoOptions = CRM_Event_BAO_Event
::getEvents(0, $fieldValue, TRUE, $checkPermission, TRUE);
6298 elseif ($fieldName == 'contribution_product_id') {
6299 $pseudoOptions = CRM_Contribute_PseudoConstant
::products();
6301 elseif ($daoName == 'CRM_Contact_DAO_Group' && $fieldName == 'id') {
6302 $pseudoOptions = CRM_Core_PseudoConstant
::group();
6304 elseif ($daoName == 'CRM_Batch_BAO_EntityBatch' && $fieldName == 'batch_id') {
6305 $pseudoOptions = CRM_Contribute_PseudoConstant
::batch();
6308 $pseudoOptions = CRM_Core_PseudoConstant
::get($daoName, $fieldName, $pseudoExtraParam);
6311 if (is_array($fieldValue)) {
6312 $qillString = array();
6313 if (!empty($pseudoOptions)) {
6314 foreach ((array) $fieldValue as $val) {
6315 $qillString[] = CRM_Utils_Array
::value($val, $pseudoOptions, $val);
6317 $fieldValue = implode(', ', $qillString);
6320 if ($type == CRM_Utils_Type
::T_DATE
) {
6321 foreach ($fieldValue as $index => $value) {
6322 $fieldValue[$index] = CRM_Utils_Date
::customFormat($value);
6326 // @todo - this is a bit specific (one operator).
6327 // However it is covered by a unit test so can be altered later with
6329 if ($op == 'BETWEEN') {
6330 $separator = ' AND ';
6332 $fieldValue = implode($separator, $fieldValue);
6335 elseif (!empty($pseudoOptions) && array_key_exists($fieldValue, $pseudoOptions)) {
6336 $fieldValue = $pseudoOptions[$fieldValue];
6338 elseif ($type === CRM_Utils_Type
::T_DATE
) {
6339 $fieldValue = CRM_Utils_Date
::customFormat($fieldValue);
6342 return array(CRM_Utils_Array
::value($op, $qillOperators, $op), $fieldValue);
6346 * Alter value to reflect wildcard settings.
6348 * The form will have tried to guess whether this is a good field to wildcard but there is
6349 * also a site-wide setting that specifies whether it is OK to append the wild card to the beginning
6350 * or only the end of the string
6352 * @param bool $wildcard
6353 * This is a bool made on an assessment 'elsewhere' on whether this is a good field to wildcard.
6355 * Generally '=' or 'LIKE'.
6356 * @param string $value
6357 * The search string.
6361 public static function getWildCardedValue($wildcard, $op, $value) {
6362 if ($wildcard && $op == 'LIKE') {
6363 if (CRM_Core_Config
::singleton()->includeWildCardInName
&& (substr($value, 0, 1) != '%')) {
6376 * Process special fields of Search Form in OK (Operator in Key) format
6378 * @param array $formValues
6379 * @param array $specialFields
6380 * Special params to be processed
6381 * @param array $changeNames
6382 * Array of fields whose name should be changed
6384 public static function processSpecialFormValue(&$formValues, $specialFields, $changeNames = array()) {
6385 // Array of special fields whose value are considered only for NULL or EMPTY operators
6386 $nullableFields = array('contribution_batch_id');
6388 foreach ($specialFields as $element) {
6389 $value = CRM_Utils_Array
::value($element, $formValues);
6391 if (is_array($value)) {
6392 if (in_array($element, array_keys($changeNames))) {
6393 unset($formValues[$element]);
6394 $element = $changeNames[$element];
6396 $formValues[$element] = array('IN' => $value);
6398 elseif (in_array($value, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
6399 $formValues[$element] = array($value => 1);
6401 elseif (!in_array($element, $nullableFields)) {
6402 // if wildcard is already present return searchString as it is OR append and/or prepend with wildcard
6403 $isWilcard = strstr($value, '%') ?
FALSE : CRM_Core_Config
::singleton()->includeWildCardInName
;
6404 $formValues[$element] = array('LIKE' => self
::getWildCardedValue($isWilcard, 'LIKE', $value));
6411 * Parse and assimilate the various sort options.
6413 * Side-effect: if sorting on a common column from a related table (`city`, `postal_code`,
6414 * `email`), the related table may be joined automatically.
6416 * At time of writing, this code is deeply flawed and should be rewritten. For the moment,
6417 * it's been extracted to a standalone function.
6419 * @param string|CRM_Utils_Sort $sort
6420 * The order by string.
6421 * @param bool $sortByChar
6422 * If true returns the distinct array of first characters for search results.
6423 * @param null $sortOrder
6424 * Who knows? Hu knows. He who knows Hu knows who.
6425 * @param string $additionalFromClause
6426 * Should be clause with proper joins, effective to reduce where clause load.
6428 * list(string $orderByClause, string $additionalFromClause).
6430 protected function prepareOrderBy($sort, $sortByChar, $sortOrder, $additionalFromClause) {
6432 $orderByArray = array();
6433 $config = CRM_Core_Config
::singleton();
6434 if ($config->includeOrderByClause ||
6435 isset($this->_distinctComponentClause
)
6438 if (is_string($sort)) {
6442 $orderBy = trim($sort->orderBy());
6444 // Deliberately remove the backticks again, as they mess up the evil
6445 // string munging below. This balanced by re-escaping before use.
6446 $orderBy = str_replace('`', '', $orderBy);
6448 if (!empty($orderBy)) {
6449 // this is special case while searching for
6450 // change log CRM-1718
6451 if (preg_match('/sort_name/i', $orderBy)) {
6452 $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
6455 $order = " ORDER BY $orderBy";
6458 $order .= " $sortOrder";
6461 // always add contact_a.id to the ORDER clause
6462 // so the order is deterministic
6463 if (strpos('contact_a.id', $order) === FALSE) {
6464 $order .= ", contact_a.id";
6468 elseif ($sortByChar) {
6469 $orderByArray = array("UPPER(LEFT(contact_a.sort_name, 1)) asc");
6472 $order = " ORDER BY contact_a.sort_name ASC, contact_a.id";
6475 if (!$order && empty($orderByArray)) {
6476 return array($order, $additionalFromClause);
6478 // Remove this here & add it at the end for simplicity.
6479 $order = trim(str_replace('ORDER BY', '', $order));
6481 // hack for order clause
6482 if (!empty($orderByArray)) {
6483 $order = implode(', ', $orderByArray);
6486 $orderByArray = explode(',', $order);
6488 foreach ($orderByArray as $orderByClause) {
6489 $orderByClauseParts = explode(' ', trim($orderByClause));
6490 $field = $orderByClauseParts[0];
6491 $direction = isset($orderByClauseParts[1]) ?
$orderByClauseParts[1] : 'asc';
6496 $this->_tables
["civicrm_address"] = $this->_whereTables
["civicrm_address"] = 1;
6497 $order = str_replace($field, "civicrm_address.{$field}", $order);
6501 case 'state_province':
6502 $this->_tables
["civicrm_{$field}"] = $this->_whereTables
["civicrm_{$field}"] = 1;
6503 if (is_array($this->_returnProperties
) && empty($this->_returnProperties
)) {
6504 $additionalFromClause .= " LEFT JOIN civicrm_{$field} ON civicrm_{$field}.id = civicrm_address.{$field}_id";
6506 $order = str_replace($field, "civicrm_{$field}.name", $order);
6510 $this->_tables
["civicrm_email"] = $this->_whereTables
["civicrm_email"] = 1;
6511 $order = str_replace($field, "civicrm_email.{$field}", $order);
6515 $cfID = CRM_Core_BAO_CustomField
::getKeyID($field);
6516 // add to cfIDs array if not present
6517 if (!empty($cfID) && !array_key_exists($cfID, $this->_cfIDs
)) {
6518 $this->_cfIDs
[$cfID] = array();
6519 $this->_customQuery
= new CRM_Core_BAO_CustomQuery($this->_cfIDs
, TRUE, $this->_locationSpecificCustomFields
);
6520 $this->_customQuery
->query();
6521 $this->_select
= array_merge($this->_select
, $this->_customQuery
->_select
);
6522 $this->_tables
= array_merge($this->_tables
, $this->_customQuery
->_tables
);
6524 foreach ($this->_pseudoConstantsSelect
as $key => $pseudoConstantMetadata) {
6525 // By replacing the join to the option value table with the mysql construct
6526 // ORDER BY field('contribution_status_id', 2,1,4)
6527 // we can remove a join. In the case of the option value join it is
6528 /// a join known to cause slow queries.
6529 // @todo cover other pseudoconstant types. Limited to option group ones in the
6530 // first instance for scope reasons. They require slightly different handling as the column (label)
6531 // is not declared for them.
6532 // @todo so far only integer fields are being handled. If we add string fields we need to look at
6534 if (isset($pseudoConstantMetadata['pseudoconstant'])
6535 && isset($pseudoConstantMetadata['pseudoconstant']['optionGroupName'])
6536 && $field === CRM_Utils_Array
::value('optionGroupName', $pseudoConstantMetadata['pseudoconstant'])
6538 $sortedOptions = $pseudoConstantMetadata['bao']::buildOptions($pseudoConstantMetadata['pseudoField'], NULL, array(
6539 'orderColumn' => 'label',
6541 $order = str_replace("$field $direction", "field({$pseudoConstantMetadata['pseudoField']}," . implode(',', array_keys($sortedOptions)) . ") $direction", $order);
6543 //CRM-12565 add "`" around $field if it is a pseudo constant
6544 // This appears to be for 'special' fields like locations with appended numbers or hyphens .. maybe.
6545 if (!empty($pseudoConstantMetadata['element']) && $pseudoConstantMetadata['element'] == $field) {
6546 $order = str_replace($field, "`{$field}`", $order);
6552 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
6553 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
6555 // The above code relies on crazy brittle string manipulation of a peculiarly-encoded ORDER BY
6556 // clause. But this magic helper which forgivingly reescapes ORDER BY.
6557 // Note: $sortByChar implies that $order was hard-coded/trusted, so it can do funky things.
6559 return array(' ORDER BY ' . $order, $additionalFromClause);
6562 $order = CRM_Utils_Type
::escape($order, 'MysqlOrderBy');
6563 return array(' ORDER BY ' . $order, $additionalFromClause);
6568 * Convert a string of group IDs to a string of group labels.
6570 * The original string may include duplicates and groups the user does not have
6571 * permission to see.
6573 * @param CRM_Core_DAO $dao
6574 * @param string $val
6578 public function convertGroupIDStringToLabelString(&$dao, $val) {
6579 $groupIDs = explode(',', $val);
6580 // Note that groups that the user does not have permission to will be excluded (good).
6581 $groups = array_intersect_key(CRM_Core_PseudoConstant
::group(), array_flip($groupIDs));
6582 return implode(', ', $groups);
6587 * Set the qill and where properties for a field.
6589 * This function is intended as a short-term function to encourage refactoring
6590 * & re-use - but really we should just have less special-casing.
6592 * @param string $name
6594 * @param string|array $value
6595 * @param string $grouping
6596 * @param string $field
6598 public function setQillAndWhere($name, $op, $value, $grouping, $field) {
6599 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $value);
6600 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue(NULL, $name, $value, $op);
6601 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(
6602 1 => $field['title'],
6609 * Has the pseudoconstant of the field been requested.
6611 * For example if the field is payment_instrument_id then it
6612 * has been requested if either payment_instrument_id or payment_instrument
6613 * have been requested. Payment_instrument is the option groun name field value.
6615 * @param array $field
6616 * @param string $fieldName
6617 * The unique name of the field - ie. the one it will be aliased to in the query.
6621 private function pseudoConstantNameIsInReturnProperties($field, $fieldName = NULL) {
6622 if (!isset($field['pseudoconstant']['optionGroupName'])) {
6626 if (CRM_Utils_Array
::value($field['pseudoconstant']['optionGroupName'], $this->_returnProperties
)) {
6629 if (CRM_Utils_Array
::value($fieldName, $this->_returnProperties
)) {
6632 // Is this still required - the above goes off the unique name. Test with things like
6633 // communication_prefferences & prefix_id.
6634 if (CRM_Utils_Array
::value($field['name'], $this->_returnProperties
)) {
6641 * Get Select Clause.
6645 public function getSelect() {
6646 $select = "SELECT ";
6647 if (isset($this->_distinctComponentClause
)) {
6648 $select .= "{$this->_distinctComponentClause}, ";
6650 $select .= implode(', ', $this->_select
);