3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
35 * This is the heart of the search query building mechanism.
37 class CRM_Contact_BAO_Query
{
40 * The various search modes.
50 MODE_PLEDGEBANK
= 256,
59 * The default set of return properties.
63 static $_defaultReturnProperties = NULL;
66 * The default set of hier return properties.
70 static $_defaultHierReturnProperties;
73 * The set of input params.
85 * The set of output params
89 public $_returnProperties;
99 * The name of the elements that are in the select clause
100 * used to extract the values
107 * The tables involved in the query
114 * The table involved in the where clause
118 public $_whereTables;
132 public $_whereClause;
135 * Additional permission Where Clause
139 public $_permissionWhereClause;
149 * Additional permission from clause
153 public $_permissionFromClause;
156 * The from clause for the simple select and alphabetical
161 public $_simpleFromClause;
171 * The english language version of the query
178 * All the fields that could potentially be involved in
186 * The cache to translate the option values into labels.
193 * Are we in search mode.
197 public $_search = TRUE;
200 * Should we skip permission checking.
204 public $_skipPermission = FALSE;
207 * Should we skip adding of delete clause.
211 public $_skipDeleteClause = FALSE;
214 * Are we in strict mode (use equality over LIKE)
218 public $_strict = FALSE;
221 * What operator to use to group the clauses.
225 public $_operator = 'AND';
230 * Should we only search on primary location.
234 public $_primaryLocation = TRUE;
237 * Are contact ids part of the query.
241 public $_includeContactIds = FALSE;
244 * Should we use the smart group cache.
248 public $_smartGroupCache = TRUE;
251 * Should we display contacts with a specific relationship type.
255 public $_displayRelationshipType = NULL;
258 * Reference to the query object for custom values.
262 public $_customQuery;
265 * Should we enable the distinct clause, used if we are including
266 * more than one group
270 public $_useDistinct = FALSE;
273 * Should we just display one contact record
275 public $_useGroupBy = FALSE;
278 * The relationship type direction
289 static $_activityRole;
292 * Consider the component activity type
293 * during activity search.
297 static $_considerCompActivities;
300 * Consider with contact activities only,
301 * during activity search.
305 static $_withContactActivitiesOnly;
308 * Use distinct component clause for component searches
312 public $_distinctComponentClause;
314 public $_rowCountClause;
317 * Use groupBy component clause for component searches
321 public $_groupByComponentClause;
324 * Track open panes, useful in advance search
328 public static $_openedPanes = array();
331 * For search builder - which custom fields are location-dependent
334 public $_locationSpecificCustomFields = array();
337 * The tables which have a dependency on location and/or address
341 static $_dependencies = array(
342 'civicrm_state_province' => 1,
343 'civicrm_country' => 1,
344 'civicrm_county' => 1,
345 'civicrm_address' => 1,
346 'civicrm_location_type' => 1,
350 * List of location specific fields.
352 static $_locationSpecificFields = array(
357 'supplemental_address_1',
358 'supplemental_address_2',
361 'postal_code_suffix',
374 * Remember if we handle either end of a number or date range
375 * so we can skip the other
377 protected $_rangeCache = array();
379 * Set to true when $this->relationship is run to avoid adding twice
382 protected $_relationshipValuesAdded = FALSE;
385 * Set to the name of the temp table if one has been created
388 static $_relationshipTempTable = NULL;
390 public $_pseudoConstantsSelect = array();
393 * Class constructor which also does all the work.
395 * @param array $params
396 * @param array $returnProperties
397 * @param array $fields
398 * @param bool $includeContactIds
399 * @param bool $strict
400 * @param bool|int $mode - mode the search is operating on
402 * @param bool $skipPermission
403 * @param bool $searchDescendentGroups
404 * @param bool $smartGroupCache
405 * @param null $displayRelationshipType
406 * @param string $operator
408 * @return \CRM_Contact_BAO_Query
410 public function __construct(
411 $params = NULL, $returnProperties = NULL, $fields = NULL,
412 $includeContactIds = FALSE, $strict = FALSE, $mode = 1,
413 $skipPermission = FALSE, $searchDescendentGroups = TRUE,
414 $smartGroupCache = TRUE, $displayRelationshipType = NULL,
417 $this->_params
= &$params;
418 if ($this->_params
== NULL) {
419 $this->_params
= array();
422 if (empty($returnProperties)) {
423 $this->_returnProperties
= self
::defaultReturnProperties($mode);
426 $this->_returnProperties
= &$returnProperties;
429 $this->_includeContactIds
= $includeContactIds;
430 $this->_strict
= $strict;
431 $this->_mode
= $mode;
432 $this->_skipPermission
= $skipPermission;
433 $this->_smartGroupCache
= $smartGroupCache;
434 $this->_displayRelationshipType
= $displayRelationshipType;
435 $this->setOperator($operator);
438 $this->_fields
= &$fields;
439 $this->_search
= FALSE;
440 $this->_skipPermission
= TRUE;
443 $this->_fields
= CRM_Contact_BAO_Contact
::exportableFields('All', FALSE, TRUE, TRUE);
445 $fields = CRM_Core_Component
::getQueryFields();
446 unset($fields['note']);
447 $this->_fields
= array_merge($this->_fields
, $fields);
449 // add activity fields
450 $fields = CRM_Activity_BAO_Activity
::exportableFields();
451 $this->_fields
= array_merge($this->_fields
, $fields);
453 // add any fields provided by hook implementers
454 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
455 $this->_fields
= array_merge($this->_fields
, $extFields);
458 // basically do all the work once, and then reuse it
463 * Function which actually does all the work for the constructor.
465 public function initialize() {
466 $this->_select
= array();
467 $this->_element
= array();
468 $this->_tables
= array();
469 $this->_whereTables
= array();
470 $this->_where
= array();
471 $this->_qill
= array();
472 $this->_options
= array();
473 $this->_cfIDs
= array();
474 $this->_paramLookup
= array();
475 $this->_having
= array();
477 $this->_customQuery
= NULL;
479 // reset cached static variables - CRM-5803
480 self
::$_activityRole = NULL;
481 self
::$_considerCompActivities = NULL;
482 self
::$_withContactActivitiesOnly = NULL;
484 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
485 $this->_element
['contact_id'] = 1;
486 $this->_tables
['civicrm_contact'] = 1;
488 if (!empty($this->_params
)) {
489 $this->buildParamsLookup();
492 $this->_whereTables
= $this->_tables
;
494 $this->selectClause();
495 $this->_whereClause
= $this->whereClause();
497 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
498 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
500 $this->openedSearchPanes(TRUE);
504 * Function for same purpose as convertFormValues.
506 * Like convert form values this function exists to pre-Process parameters from the form.
508 * It is unclear why they are different functions & likely relates to advances search
509 * versus search builder.
511 * The direction we are going is having the form convert values to a standardised format &
512 * moving away from wierd & wonderful where clause switches.
514 * Fix and handle contact deletion nicely.
516 * this code is primarily for search builder use case where different clauses can specify if they want deleted.
520 public function buildParamsLookup() {
521 $trashParamExists = FALSE;
522 $paramByGroup = array();
523 foreach ($this->_params
as $k => $param) {
524 if (!empty($param[0]) && $param[0] == 'contact_is_deleted') {
525 $trashParamExists = TRUE;
527 if (!empty($param[3])) {
528 $paramByGroup[$param[3]][$k] = $param;
532 if ($trashParamExists) {
533 $this->_skipDeleteClause
= TRUE;
535 //cycle through group sets and explicitly add trash param if not set
536 foreach ($paramByGroup as $setID => $set) {
538 !in_array(array('contact_is_deleted', '=', '1', $setID, '0'), $this->_params
) &&
539 !in_array(array('contact_is_deleted', '=', '0', $setID, '0'), $this->_params
)
541 $this->_params
[] = array(
542 'contact_is_deleted',
552 foreach ($this->_params
as $value) {
553 if (empty($value[0])) {
556 $cfID = CRM_Core_BAO_CustomField
::getKeyID($value[0]);
558 if (!array_key_exists($cfID, $this->_cfIDs
)) {
559 $this->_cfIDs
[$cfID] = array();
561 // Set wildcard value based on "and/or" selection
562 foreach ($this->_params
as $key => $param) {
563 if ($param[0] == $value[0] . '_operator') {
564 $value[4] = $param[2] == 'or';
568 $this->_cfIDs
[$cfID][] = $value;
571 if (!array_key_exists($value[0], $this->_paramLookup
)) {
572 $this->_paramLookup
[$value[0]] = array();
574 $this->_paramLookup
[$value[0]][] = $value;
579 * Some composite fields do not appear in the fields array hack to make them part of the query.
581 public function addSpecialFields() {
582 static $special = array('contact_type', 'contact_sub_type', 'sort_name', 'display_name');
583 foreach ($special as $name) {
584 if (!empty($this->_returnProperties
[$name])) {
585 $this->_select
[$name] = "contact_a.{$name} as $name";
586 $this->_element
[$name] = 1;
592 * Given a list of conditions in params and a list of desired
593 * return Properties generate the required select and from
594 * clauses. Note that since the where clause introduces new
595 * tables, the initial attempt also retrieves all variables used
598 public function selectClause() {
600 $this->addSpecialFields();
602 foreach ($this->_fields
as $name => $field) {
603 // skip component fields
604 // there are done by the alter query below
605 // and need not be done on every field
607 (substr($name, 0, 12) == 'participant_') ||
608 (substr($name, 0, 7) == 'pledge_') ||
609 (substr($name, 0, 5) == 'case_') ||
610 (substr($name, 0, 13) == 'contribution_' &&
611 (strpos($name, 'source') !== FALSE && strpos($name, 'recur') !== FALSE)) ||
612 (substr($name, 0, 8) == 'payment_')
617 // redirect to activity select clause
619 (substr($name, 0, 9) == 'activity_') ||
620 ($name == 'parent_id')
622 CRM_Activity_BAO_Query
::select($this);
626 // if this is a hierarchical name, we ignore it
627 $names = explode('-', $name);
628 if (count($names) > 1 && isset($names[1]) && is_numeric($names[1])) {
632 // make an exception for special cases, to add the field in select clause
633 $makeException = FALSE;
635 //special handling for groups/tags
636 if (in_array($name, array('groups', 'tags', 'notes'))
637 && isset($this->_returnProperties
[substr($name, 0, -1)])
639 $makeException = TRUE;
642 // since note has 3 different options we need special handling
643 // note / note_subject / note_body
644 if ($name == 'notes') {
645 foreach (array('note', 'note_subject', 'note_body') as $noteField) {
646 if (isset($this->_returnProperties
[$noteField])) {
647 $makeException = TRUE;
653 if (in_array($name, array('prefix_id', 'suffix_id', 'gender_id', 'communication_style_id'))) {
654 if (CRM_Utils_Array
::value($field['pseudoconstant']['optionGroupName'], $this->_returnProperties
)) {
655 $makeException = TRUE;
659 $cfID = CRM_Core_BAO_CustomField
::getKeyID($name);
660 if (!empty($this->_paramLookup
[$name]) ||
!empty($this->_returnProperties
[$name]) ||
664 // add to cfIDs array if not present
665 if (!array_key_exists($cfID, $this->_cfIDs
)) {
666 $this->_cfIDs
[$cfID] = array();
669 elseif (isset($field['where'])) {
670 list($tableName, $fieldName) = explode('.', $field['where'], 2);
671 if (isset($tableName)) {
672 if (CRM_Utils_Array
::value($tableName, self
::$_dependencies)) {
673 $this->_tables
['civicrm_address'] = 1;
674 $this->_select
['address_id'] = 'civicrm_address.id as address_id';
675 $this->_element
['address_id'] = 1;
678 if ($tableName == 'im_provider' ||
$tableName == 'email_greeting' ||
679 $tableName == 'postal_greeting' ||
$tableName == 'addressee'
681 if ($tableName == 'im_provider') {
682 CRM_Core_OptionValue
::select($this);
685 if (in_array($tableName,
686 array('email_greeting', 'postal_greeting', 'addressee'))) {
687 $this->_element
["{$name}_id"] = 1;
688 $this->_select
["{$name}_id"] = "contact_a.{$name}_id as {$name}_id";
689 $this->_pseudoConstantsSelect
[$name] = array('pseudoField' => $tableName, 'idCol' => "{$name}_id");
690 $this->_pseudoConstantsSelect
[$name]['select'] = "{$name}.{$fieldName} as $name";
691 $this->_pseudoConstantsSelect
[$name]['element'] = $name;
693 if ($tableName == 'email_greeting') {
694 $this->_pseudoConstantsSelect
[$name]['join']
695 = " LEFT JOIN civicrm_option_group option_group_email_greeting ON (option_group_email_greeting.name = 'email_greeting')";
696 $this->_pseudoConstantsSelect
[$name]['join'] .=
697 " 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 ) ";
699 elseif ($tableName == 'postal_greeting') {
700 $this->_pseudoConstantsSelect
[$name]['join']
701 = " LEFT JOIN civicrm_option_group option_group_postal_greeting ON (option_group_postal_greeting.name = 'postal_greeting')";
702 $this->_pseudoConstantsSelect
[$name]['join'] .=
703 " 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 ) ";
705 elseif ($tableName == 'addressee') {
706 $this->_pseudoConstantsSelect
[$name]['join']
707 = " LEFT JOIN civicrm_option_group option_group_addressee ON (option_group_addressee.name = 'addressee')";
708 $this->_pseudoConstantsSelect
[$name]['join'] .=
709 " LEFT JOIN civicrm_option_value addressee ON (contact_a.addressee_id = addressee.value AND option_group_addressee.id = addressee.option_group_id ) ";
711 $this->_pseudoConstantsSelect
[$name]['table'] = $tableName;
714 $greetField = "{$name}_display";
715 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
716 $this->_element
[$greetField] = 1;
718 $greetField = "{$name}_custom";
719 $this->_select
[$greetField] = "contact_a.{$greetField} as {$greetField}";
720 $this->_element
[$greetField] = 1;
724 if (!in_array($tableName, array('civicrm_state_province', 'civicrm_country', 'civicrm_county'))) {
725 $this->_tables
[$tableName] = 1;
728 // also get the id of the tableName
729 $tName = substr($tableName, 8);
730 if (in_array($tName, array('country', 'state_province', 'county'))) {
731 if ($tName == 'state_province') {
732 $this->_pseudoConstantsSelect
['state_province_name'] = array(
733 'pseudoField' => "{$tName}",
734 'idCol' => "{$tName}_id",
735 'bao' => 'CRM_Core_BAO_Address',
736 'table' => "civicrm_{$tName}",
737 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
740 $this->_pseudoConstantsSelect
[$tName] = array(
741 'pseudoField' => 'state_province_abbreviation',
742 'idCol' => "{$tName}_id",
743 'table' => "civicrm_{$tName}",
744 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
748 $this->_pseudoConstantsSelect
[$name] = array(
749 'pseudoField' => "{$tName}_id",
750 'idCol' => "{$tName}_id",
751 'bao' => 'CRM_Core_BAO_Address',
752 'table' => "civicrm_{$tName}",
753 'join' => " LEFT JOIN civicrm_{$tName} ON civicrm_address.{$tName}_id = civicrm_{$tName}.id ",
757 $this->_select
["{$tName}_id"] = "civicrm_address.{$tName}_id as {$tName}_id";
758 $this->_element
["{$tName}_id"] = 1;
760 elseif ($tName != 'contact') {
761 $this->_select
["{$tName}_id"] = "{$tableName}.id as {$tName}_id";
762 $this->_element
["{$tName}_id"] = 1;
765 //special case for phone
766 if ($name == 'phone') {
767 $this->_select
['phone_type_id'] = "civicrm_phone.phone_type_id as phone_type_id";
768 $this->_element
['phone_type_id'] = 1;
771 // if IM then select provider_id also
772 // to get "IM Service Provider" in a file to be exported, CRM-3140
774 $this->_select
['provider_id'] = "civicrm_im.provider_id as provider_id";
775 $this->_element
['provider_id'] = 1;
778 if ($tName == 'contact') {
779 // special case, when current employer is set for Individual contact
780 if ($fieldName == 'organization_name') {
781 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', NULL, contact_a.organization_name ) as organization_name";
783 elseif ($fieldName != 'id') {
784 if ($fieldName == 'prefix_id') {
785 $this->_pseudoConstantsSelect
['individual_prefix'] = array(
786 'pseudoField' => 'prefix_id',
787 'idCol' => "prefix_id",
788 'bao' => 'CRM_Contact_BAO_Contact',
791 if ($fieldName == 'suffix_id') {
792 $this->_pseudoConstantsSelect
['individual_suffix'] = array(
793 'pseudoField' => 'suffix_id',
794 'idCol' => "suffix_id",
795 'bao' => 'CRM_Contact_BAO_Contact',
798 if ($fieldName == 'gender_id') {
799 $this->_pseudoConstantsSelect
['gender'] = array(
800 'pseudoField' => 'gender_id',
801 'idCol' => "gender_id",
802 'bao' => 'CRM_Contact_BAO_Contact',
805 if ($name == 'communication_style_id') {
806 $this->_pseudoConstantsSelect
['communication_style'] = array(
807 'pseudoField' => 'communication_style_id',
808 'idCol' => "communication_style_id",
809 'bao' => 'CRM_Contact_BAO_Contact',
812 $this->_select
[$name] = "contact_a.{$fieldName} as `$name`";
815 elseif (in_array($tName, array('country', 'county'))) {
816 $this->_pseudoConstantsSelect
[$name]['select'] = "{$field['where']} as `$name`";
817 $this->_pseudoConstantsSelect
[$name]['element'] = $name;
819 elseif ($tName == 'state_province') {
820 $this->_pseudoConstantsSelect
[$tName]['select'] = "{$field['where']} as `$name`";
821 $this->_pseudoConstantsSelect
[$tName]['element'] = $name;
824 $this->_select
[$name] = "{$field['where']} as `$name`";
826 if (!in_array($tName, array('state_province', 'country', 'county'))) {
827 $this->_element
[$name] = 1;
832 elseif ($name === 'tags') {
833 $this->_useGroupBy
= TRUE;
834 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_tag.name)) as tags";
835 $this->_element
[$name] = 1;
836 $this->_tables
['civicrm_tag'] = 1;
837 $this->_tables
['civicrm_entity_tag'] = 1;
839 elseif ($name === 'groups') {
840 $this->_useGroupBy
= TRUE;
841 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_group.title)) as groups";
842 $this->_element
[$name] = 1;
843 $this->_tables
['civicrm_group'] = 1;
845 elseif ($name === 'notes') {
846 // if note field is subject then return subject else body of the note
847 $noteColumn = 'note';
848 if (isset($noteField) && $noteField == 'note_subject') {
849 $noteColumn = 'subject';
852 $this->_useGroupBy
= TRUE;
853 $this->_select
[$name] = "GROUP_CONCAT(DISTINCT(civicrm_note.$noteColumn)) as notes";
854 $this->_element
[$name] = 1;
855 $this->_tables
['civicrm_note'] = 1;
857 elseif ($name === 'current_employer') {
858 $this->_select
[$name] = "IF ( contact_a.contact_type = 'Individual', contact_a.organization_name, NULL ) as current_employer";
859 $this->_element
[$name] = 1;
863 if ($cfID && !empty($field['is_search_range'])) {
864 // this is a custom field with range search enabled, so we better check for two/from values
865 if (!empty($this->_paramLookup
[$name . '_from'])) {
866 if (!array_key_exists($cfID, $this->_cfIDs
)) {
867 $this->_cfIDs
[$cfID] = array();
869 foreach ($this->_paramLookup
[$name . '_from'] as $pID => $p) {
870 // search in the cdID array for the same grouping
872 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
873 if ($c[3] == $p[3]) {
874 $this->_cfIDs
[$cfID][$cID][2]['from'] = $p[2];
879 $p[2] = array('from' => $p[2]);
880 $this->_cfIDs
[$cfID][] = $p;
884 if (!empty($this->_paramLookup
[$name . '_to'])) {
885 if (!array_key_exists($cfID, $this->_cfIDs
)) {
886 $this->_cfIDs
[$cfID] = array();
888 foreach ($this->_paramLookup
[$name . '_to'] as $pID => $p) {
889 // search in the cdID array for the same grouping
891 foreach ($this->_cfIDs
[$cfID] as $cID => $c) {
892 if ($c[4] == $p[4]) {
893 $this->_cfIDs
[$cfID][$cID][2]['to'] = $p[2];
898 $p[2] = array('to' => $p[2]);
899 $this->_cfIDs
[$cfID][] = $p;
906 // add location as hierarchical elements
907 $this->addHierarchicalElements();
909 // add multiple field like website
910 $this->addMultipleElements();
913 CRM_Core_Component
::alterQuery($this, 'select');
915 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'select');
917 if (!empty($this->_cfIDs
)) {
918 // @todo This function is the select function but instead of running 'select' it
919 // is running the whole query.
920 $this->_customQuery
= new CRM_Core_BAO_CustomQuery($this->_cfIDs
, TRUE, $this->_locationSpecificCustomFields
);
921 $this->_customQuery
->query();
922 $this->_select
= array_merge($this->_select
, $this->_customQuery
->_select
);
923 $this->_element
= array_merge($this->_element
, $this->_customQuery
->_element
);
924 $this->_tables
= array_merge($this->_tables
, $this->_customQuery
->_tables
);
925 $this->_whereTables
= array_merge($this->_whereTables
, $this->_customQuery
->_whereTables
);
926 $this->_options
= $this->_customQuery
->_options
;
931 * If the return Properties are set in a hierarchy, traverse the hierarchy to get the return values.
933 public function addHierarchicalElements() {
934 if (empty($this->_returnProperties
['location'])) {
937 if (!is_array($this->_returnProperties
['location'])) {
941 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
942 $processed = array();
945 $addressCustomFields = CRM_Core_BAO_CustomField
::getFieldsForImport('Address');
946 $addressCustomFieldIds = array();
948 foreach ($this->_returnProperties
['location'] as $name => $elements) {
949 $lCond = self
::getPrimaryCondition($name);
952 $locationTypeId = array_search($name, $locationTypes);
953 if ($locationTypeId === FALSE) {
956 $lCond = "location_type_id = $locationTypeId";
957 $this->_useDistinct
= TRUE;
959 //commented for CRM-3256
960 $this->_useGroupBy
= TRUE;
963 $name = str_replace(' ', '_', $name);
965 $tName = "$name-location_type";
966 $ltName = "`$name-location_type`";
967 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
968 $this->_select
["{$tName}"] = "`$tName`.name as `{$tName}`";
969 $this->_element
["{$tName}_id"] = 1;
970 $this->_element
["{$tName}"] = 1;
972 $locationTypeName = $tName;
973 $locationTypeJoin = array();
977 foreach ($elements as $elementFullName => $dontCare) {
979 $elementName = $elementCmpName = $elementFullName;
981 if (substr($elementCmpName, 0, 5) == 'phone') {
982 $elementCmpName = 'phone';
985 if (in_array($elementCmpName, array_keys($addressCustomFields))) {
986 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($elementCmpName)) {
987 $addressCustomFieldIds[$cfID][$name] = 1;
990 //add address table only once
991 if ((in_array($elementCmpName, self
::$_locationSpecificFields) ||
!empty($addressCustomFieldIds))
993 && !in_array($elementCmpName, array('email', 'phone', 'im', 'openid'))
995 $tName = "$name-address";
996 $aName = "`$name-address`";
997 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
998 $this->_element
["{$tName}_id"] = 1;
999 $addressJoin = "\nLEFT JOIN civicrm_address $aName ON ($aName.contact_id = contact_a.id AND $aName.$lCond)";
1000 $this->_tables
[$tName] = $addressJoin;
1001 $locationTypeJoin[$tName] = " ( $aName.location_type_id = $ltName.id ) ";
1002 $processed[$aName] = 1;
1006 $cond = $elementType = '';
1007 if (strpos($elementName, '-') !== FALSE) {
1008 // this is either phone, email or IM
1009 list($elementName, $elementType) = explode('-', $elementName);
1011 if (($elementName != 'phone') && ($elementName != 'im')) {
1012 $cond = self
::getPrimaryCondition($elementType);
1014 // CRM-13011 : If location type is primary, do not restrict search to the phone
1015 // type id - we want the primary phone, regardless of what type it is.
1016 // Otherwise, restrict to the specified phone type for the given field.
1017 if ((!$cond) && ($elementName == 'phone')) {
1018 $cond = "phone_type_id = '$elementType'";
1020 elseif ((!$cond) && ($elementName == 'im')) {
1021 // IM service provider id, CRM-3140
1022 $cond = "provider_id = '$elementType'";
1024 $elementType = '-' . $elementType;
1027 $field = CRM_Utils_Array
::value($elementName, $this->_fields
);
1029 // hack for profile, add location id
1032 // fix for CRM-882( to handle phone types )
1033 !is_numeric($elementType)
1035 if (is_numeric($name)) {
1036 $field = CRM_Utils_Array
::value($elementName . "-Primary$elementType", $this->_fields
);
1039 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
1042 elseif (is_numeric($name)) {
1043 //this for phone type to work
1044 if (in_array($elementName, array('phone', 'phone_ext'))) {
1045 $field = CRM_Utils_Array
::value($elementName . "-Primary" . $elementType, $this->_fields
);
1048 $field = CRM_Utils_Array
::value($elementName . "-Primary", $this->_fields
);
1052 //this is for phone type to work for profile edit
1053 if (in_array($elementName, array('phone', 'phone_ext'))) {
1054 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId$elementType", $this->_fields
);
1057 $field = CRM_Utils_Array
::value($elementName . "-$locationTypeId", $this->_fields
);
1062 // Check if there is a value, if so also add to where Clause
1064 if ($this->_params
) {
1066 if (isset($locationTypeId)) {
1067 $nm .= "-$locationTypeId";
1069 if (!is_numeric($elementType)) {
1070 $nm .= "$elementType";
1073 foreach ($this->_params
as $id => $values) {
1074 if ((is_array($values) && $values[0] == $nm) ||
1075 (in_array($elementName, array('phone', 'im'))
1076 && (strpos($values[0], $nm) !== FALSE)
1086 if ($field && isset($field['where'])) {
1087 list($tableName, $fieldName) = explode('.', $field['where'], 2);
1088 $pf = substr($tableName, 8);
1089 $tName = $name . '-' . $pf . $elementType;
1090 if (isset($tableName)) {
1091 if ($tableName == 'civicrm_state_province' ||
$tableName == 'civicrm_country' ||
$tableName == 'civicrm_county') {
1092 $this->_select
["{$tName}_id"] = "{$aName}.{$pf}_id as `{$tName}_id`";
1095 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1098 $this->_element
["{$tName}_id"] = 1;
1099 if (substr($tName, -15) == '-state_province') {
1100 // FIXME: hack to fix CRM-1900
1101 $a = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1105 if (substr_count($a, 'state_province_name') > 0) {
1106 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] = array(
1107 'pseudoField' => "{$pf}_id",
1108 'idCol' => "{$tName}_id",
1109 'bao' => 'CRM_Core_BAO_Address',
1111 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.name as `{$name}-{$elementFullName}`";
1114 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] = array(
1115 'pseudoField' => 'state_province_abbreviation',
1116 'idCol' => "{$tName}_id",
1118 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.abbreviation as `{$name}-{$elementFullName}`";
1122 if (substr($elementFullName, 0, 2) == 'im') {
1123 $provider = "{$name}-{$elementFullName}-provider_id";
1124 $this->_select
[$provider] = "`$tName`.provider_id as `{$name}-{$elementFullName}-provider_id`";
1125 $this->_element
[$provider] = 1;
1127 if ($pf == 'country' ||
$pf == 'county') {
1128 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"] = array(
1129 'pseudoField' => "{$pf}_id",
1130 'idCol' => "{$tName}_id",
1131 'bao' => 'CRM_Core_BAO_Address',
1133 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['select'] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1136 $this->_select
["{$name}-{$elementFullName}"] = "`$tName`.$fieldName as `{$name}-{$elementFullName}`";
1140 if (in_array($pf, array('state_province', 'country', 'county'))) {
1141 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['element'] = "{$name}-{$elementFullName}";
1144 $this->_element
["{$name}-{$elementFullName}"] = 1;
1147 if (empty($processed["`$tName`"])) {
1148 $processed["`$tName`"] = 1;
1149 $newName = $tableName . '_' . $index;
1150 switch ($tableName) {
1151 case 'civicrm_phone':
1152 case 'civicrm_email':
1154 case 'civicrm_openid':
1156 $this->_tables
[$tName] = "\nLEFT JOIN $tableName `$tName` ON contact_a.id = `$tName`.contact_id";
1157 if ($tableName != 'civicrm_phone') {
1158 $this->_tables
[$tName] .= " AND `$tName`.$lCond";
1160 elseif (is_numeric($name)) {
1161 $this->_select
[$tName] = "IF (`$tName`.is_primary = $name, `$tName`.phone, NULL) as `$tName`";
1164 // this special case to add phone type
1166 $phoneTypeCondition = " AND `$tName`.$cond ";
1167 //gross hack to pickup corrupted data also, CRM-7603
1168 if (strpos($cond, 'phone_type_id') !== FALSE) {
1169 $phoneTypeCondition = " AND ( `$tName`.$cond OR `$tName`.phone_type_id IS NULL ) ";
1170 if (!empty($lCond)) {
1171 $phoneTypeCondition .= " AND ( `$tName`.$lCond ) ";
1174 $this->_tables
[$tName] .= $phoneTypeCondition;
1177 //build locationType join
1178 $locationTypeJoin[$tName] = " ( `$tName`.location_type_id = $ltName.id )";
1181 $this->_whereTables
[$tName] = $this->_tables
[$tName];
1185 case 'civicrm_state_province':
1186 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $tName;
1187 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join']
1188 = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.state_province_id";
1190 $this->_whereTables
["{$name}-address"] = $addressJoin;
1194 case 'civicrm_country':
1195 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1196 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join']
1197 = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.country_id";
1199 $this->_whereTables
["{$name}-address"] = $addressJoin;
1203 case 'civicrm_county':
1204 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['table'] = $newName;
1205 $this->_pseudoConstantsSelect
["{$name}-{$elementFullName}"]['join']
1206 = "\nLEFT JOIN $tableName `$tName` ON `$tName`.id = $aName.county_id";
1208 $this->_whereTables
["{$name}-address"] = $addressJoin;
1214 $this->_whereTables
["{$name}-address"] = $addressJoin;
1223 // add location type join
1224 $ltypeJoin = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locationTypeJoin) . " )";
1225 $this->_tables
[$locationTypeName] = $ltypeJoin;
1227 // table should be present in $this->_whereTables,
1228 // to add its condition in location type join, CRM-3939.
1229 if ($addWhereCount) {
1230 $locClause = array();
1231 foreach ($this->_whereTables
as $tableName => $clause) {
1232 if (!empty($locationTypeJoin[$tableName])) {
1233 $locClause[] = $locationTypeJoin[$tableName];
1237 if (!empty($locClause)) {
1238 $this->_whereTables
[$locationTypeName] = "\nLEFT JOIN civicrm_location_type $ltName ON ( " . implode('OR', $locClause) . " )";
1243 if (!empty($addressCustomFieldIds)) {
1244 $customQuery = new CRM_Core_BAO_CustomQuery($addressCustomFieldIds);
1245 foreach ($addressCustomFieldIds as $cfID => $locTypeName) {
1246 foreach ($locTypeName as $name => $dnc) {
1247 $this->_locationSpecificCustomFields
[$cfID] = array($name, array_search($name, $locationTypes));
1248 $fieldName = "$name-custom_{$cfID}";
1249 $tName = "$name-address-custom-{$cfID}";
1250 $aName = "`$name-address-custom-{$cfID}`";
1251 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1252 $this->_element
["{$tName}_id"] = 1;
1253 $this->_select
[$fieldName] = "`$tName`.{$customQuery->_fields[$cfID]['column_name']} as `{$fieldName}`";
1254 $this->_element
[$fieldName] = 1;
1255 $this->_tables
[$tName] = "\nLEFT JOIN {$customQuery->_fields[$cfID]['table_name']} $aName ON ($aName.entity_id = `$name-address`.id)";
1262 * If the return Properties are set in a hierarchy, traverse the hierarchy to get the return values.
1264 public function addMultipleElements() {
1265 if (empty($this->_returnProperties
['website'])) {
1268 if (!is_array($this->_returnProperties
['website'])) {
1272 foreach ($this->_returnProperties
['website'] as $key => $elements) {
1273 foreach ($elements as $elementFullName => $dontCare) {
1274 $tName = "website-{$key}-{$elementFullName}";
1275 $this->_select
["{$tName}_id"] = "`$tName`.id as `{$tName}_id`";
1276 $this->_select
["{$tName}"] = "`$tName`.url as `{$tName}`";
1277 $this->_element
["{$tName}_id"] = 1;
1278 $this->_element
["{$tName}"] = 1;
1280 $type = "website-{$key}-website_type_id";
1281 $this->_select
[$type] = "`$tName`.website_type_id as `{$type}`";
1282 $this->_element
[$type] = 1;
1283 $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website `$tName` ON (`$tName`.contact_id = contact_a.id AND `$tName`.website_type_id = $key )";
1289 * Generate the query based on what type of query we need.
1291 * @param bool $count
1292 * @param bool $sortByChar
1293 * @param bool $groupContacts
1294 * @param bool $onlyDeleted
1297 * sql query parts as an array
1299 public function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE, $onlyDeleted = FALSE) {
1300 // build permission clause
1301 $this->generatePermissionClause($onlyDeleted, $count);
1304 if (isset($this->_rowCountClause
)) {
1305 $select = "SELECT {$this->_rowCountClause}";
1307 elseif (isset($this->_distinctComponentClause
)) {
1308 // we add distinct to get the right count for components
1309 // for the more complex result set, we use GROUP BY the same id
1311 $select = "SELECT count( DISTINCT {$this->_distinctComponentClause} )";
1314 $select = 'SELECT count(DISTINCT contact_a.id) as rowCount';
1316 $from = $this->_simpleFromClause
;
1317 if ($this->_useDistinct
) {
1318 $this->_useGroupBy
= TRUE;
1321 elseif ($sortByChar) {
1322 $select = 'SELECT DISTINCT UPPER(LEFT(contact_a.sort_name, 1)) as sort_name';
1323 $from = $this->_simpleFromClause
;
1325 elseif ($groupContacts) {
1326 $select = 'SELECT contact_a.id as id';
1327 if ($this->_useDistinct
) {
1328 $this->_useGroupBy
= TRUE;
1330 $from = $this->_simpleFromClause
;
1333 if (!empty($this->_paramLookup
['group'])) {
1335 list($name, $op, $value, $grouping, $wildcard) = $this->_paramLookup
['group'][0];
1337 if (is_array($value) && in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
1338 $this->_paramLookup
['group'][0][1] = key($value);
1341 // make sure there is only one element
1342 // this is used when we are running under smog and need to know
1343 // how the contact was added (CRM-1203)
1344 $groups = (array) CRM_Utils_Array
::value($this->_paramLookup
['group'][0][1], $this->_paramLookup
['group'][0][2], $this->_paramLookup
['group'][0][2]);
1345 if ((count($this->_paramLookup
['group']) == 1) &&
1346 (count($groups) == 1)
1348 $groupId = $groups[0];
1350 //check if group is saved search
1351 $group = new CRM_Contact_BAO_Group();
1352 $group->id
= $groupId;
1355 if (!isset($group->saved_search_id
)) {
1356 $tbName = "`civicrm_group_contact-{$groupId}`";
1357 $this->_select
['group_contact_id'] = "$tbName.id as group_contact_id";
1358 $this->_element
['group_contact_id'] = 1;
1359 $this->_select
['status'] = "$tbName.status as status";
1360 $this->_element
['status'] = 1;
1363 $this->_useGroupBy
= TRUE;
1365 if ($this->_useDistinct
&& !isset($this->_distinctComponentClause
)) {
1366 if (!($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
)) {
1368 $this->_select
['contact_id'] = 'contact_a.id as contact_id';
1369 $this->_useDistinct
= FALSE;
1370 $this->_useGroupBy
= TRUE;
1374 $select = "SELECT ";
1375 if (isset($this->_distinctComponentClause
)) {
1376 $select .= "{$this->_distinctComponentClause}, ";
1378 $select .= implode(', ', $this->_select
);
1379 $from = $this->_fromClause
;
1383 if (!empty($this->_whereClause
)) {
1384 $where = "WHERE {$this->_whereClause}";
1387 if (!empty($this->_permissionWhereClause
) && empty($this->_displayRelationshipType
)) {
1388 if (empty($where)) {
1389 $where = "WHERE $this->_permissionWhereClause";
1392 $where = "$where AND $this->_permissionWhereClause";
1397 if (!empty($this->_having
)) {
1398 foreach ($this->_having
as $havingSets) {
1399 foreach ($havingSets as $havingSet) {
1400 $havingValue[] = $havingSet;
1403 $having = ' HAVING ' . implode(' AND ', $havingValue);
1406 // if we are doing a transform, do it here
1407 // use the $from, $where and $having to get the contact ID
1408 if ($this->_displayRelationshipType
) {
1409 $this->filterRelatedContacts($from, $where, $having);
1412 return array($select, $from, $where, $having);
1416 * Get where values from the parameters.
1418 * @param string $name
1419 * @param mixed $grouping
1423 public function getWhereValues($name, $grouping) {
1425 foreach ($this->_params
as $values) {
1426 if ($values[0] == $name && $values[3] == $grouping) {
1437 * @param bool $relative
1438 * @param string $from
1441 public static function fixDateValues($relative, &$from, &$to) {
1443 list($from, $to) = CRM_Utils_Date
::getFromTo($relative, $from, $to);
1448 * Convert values from form-appropriate to query-object appropriate.
1450 * The query object is increasingly supporting the sql-filter syntax which is the most flexible syntax.
1451 * So, ideally we would convert all fields to look like
1454 * // Set the operator for legacy reasons, but it is ignored
1456 * // array in sql filter syntax
1457 * 2 => array('BETWEEN' => array(1,60),
1462 * There are some examples of the syntax in
1463 * https://github.com/civicrm/civicrm-core/tree/master/api/v3/examples/Relationship
1465 * More notes at CRM_Core_DAO::createSQLFilter
1467 * and a list of supported operators in CRM_Core_DAO
1469 * @param array $formValues
1470 * @param int $wildcard
1471 * @param bool $useEquals
1473 * @param string $apiEntity
1475 * @param array $entityReferenceFields
1476 * Field names of any entity reference fields (which will need reformatting to IN syntax).
1480 public static function convertFormValues(&$formValues, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL,
1481 $entityReferenceFields = array()) {
1483 if (empty($formValues)) {
1487 foreach ($formValues as $id => $values) {
1489 self
::legacyConvertFormValues($id, $values);
1491 if (self
::isAlreadyProcessedForQueryFormat($values)) {
1492 $params[] = $values;
1495 if ($id == 'privacy') {
1496 if (is_array($formValues['privacy'])) {
1497 $op = !empty($formValues['privacy']['do_not_toggle']) ?
'=' : '!=';
1498 foreach ($formValues['privacy'] as $key => $value) {
1500 $params[] = array($key, $op, $value, 0, 0);
1505 elseif ($id == 'email_on_hold') {
1506 if ($formValues['email_on_hold']['on_hold']) {
1507 $params[] = array('on_hold', '=', $formValues['email_on_hold']['on_hold'], 0, 0);
1510 elseif (substr($id, 0, 7) == 'custom_'
1512 substr($id, -9, 9) == '_relative'
1513 ||
substr($id, -5, 5) == '_from'
1514 ||
substr($id, -3, 3) == '_to'
1517 self
::convertCustomDateRelativeFields($formValues, $params, $values, $id);
1519 elseif (preg_match('/_date_relative$/', $id) ||
1520 $id == 'event_relative' ||
1521 $id == 'case_from_relative' ||
1522 $id == 'case_to_relative' ||
1523 $id == 'participant_relative'
1525 if ($id == 'event_relative') {
1526 $fromRange = 'event_start_date_low';
1527 $toRange = 'event_end_date_high';
1529 elseif ($id == 'participant_relative') {
1530 $fromRange = 'participant_register_date_low';
1531 $toRange = 'participant_register_date_high';
1533 elseif ($id == 'case_from_relative') {
1534 $fromRange = 'case_from_start_date_low';
1535 $toRange = 'case_from_start_date_high';
1537 elseif ($id == 'case_to_relative') {
1538 $fromRange = 'case_to_end_date_low';
1539 $toRange = 'case_to_end_date_high';
1542 $dateComponent = explode('_date_relative', $id);
1543 $fromRange = "{$dateComponent[0]}_date_low";
1544 $toRange = "{$dateComponent[0]}_date_high";
1547 if (array_key_exists($fromRange, $formValues) && array_key_exists($toRange, $formValues)) {
1548 CRM_Contact_BAO_Query
::fixDateValues($formValues[$id], $formValues[$fromRange], $formValues[$toRange]);
1552 elseif (in_array($id, $entityReferenceFields) && !empty($values) && is_string($values) && (strpos($values, ',') !=
1554 $params[] = array($id, 'IN', explode(',', $values), 0, 0);
1557 $values = CRM_Contact_BAO_Query
::fixWhereValues($id, $values, $wildcard, $useEquals, $apiEntity);
1562 $params[] = $values;
1569 * Function to support legacy format for groups and tags.
1572 * @param array|int $values
1575 public static function legacyConvertFormValues($id, &$values) {
1576 if (in_array($id, array('group', 'tag')) && is_array($values)) {
1577 // prior to 4.7, formValues for some attributes (e.g. group, tag) are stored in array(id1 => 1, id2 => 1),
1578 // as per the recent Search fixes $values need to be in standard array(id1, id2) format
1579 $ids = array_keys($values, 1);
1580 if (count($ids) > 1 ||
(count($ids) == 1 && key($values) > 1)) {
1587 * Fix values from query from/to something no-one cared enough to document.
1590 * @param array $values
1591 * @param int $wildcard
1592 * @param bool $useEquals
1594 * @param string $apiEntity
1596 * @return array|null
1598 public static function fixWhereValues($id, &$values, $wildcard = 0, $useEquals = FALSE, $apiEntity = NULL) {
1599 // skip a few search variables
1600 static $skipWhere = NULL;
1601 static $likeNames = NULL;
1603 // Change camelCase EntityName to lowercase with underscores
1604 $apiEntity = _civicrm_api_get_entity_name_from_camel($apiEntity);
1606 if (CRM_Utils_System
::isNull($values)) {
1618 'display_relationship_type',
1622 if (in_array($id, $skipWhere) ||
1623 substr($id, 0, 4) == '_qf_' ||
1624 substr($id, 0, 7) == 'hidden_'
1630 (substr($id, 0, strlen($apiEntity)) != $apiEntity) &&
1631 (substr($id, 0, 10) != 'financial_' && substr($id, 0, 8) != 'payment_')
1633 $id = $apiEntity . '_' . $id;
1637 $likeNames = array('sort_name', 'email', 'note', 'display_name');
1640 // email comes in via advanced search
1641 // so use wildcard always
1642 if ($id == 'email') {
1646 if (!$useEquals && in_array($id, $likeNames)) {
1647 $result = array($id, 'LIKE', $values, 0, 1);
1649 elseif (is_string($values) && strpos($values, '%') !== FALSE) {
1650 $result = array($id, 'LIKE', $values, 0, 0);
1652 elseif ($id == 'contact_type' ||
1653 (!empty($values) && is_array($values) && !in_array(key($values), CRM_Core_DAO
::acceptedSQLOperators(), TRUE))
1655 $result = array($id, 'IN', $values, 0, $wildcard);
1658 $result = array($id, '=', $values, 0, $wildcard);
1665 * Get the where clause for a single field.
1667 * @param array $values
1669 public function whereClauseSingle(&$values) {
1670 // do not process custom fields or prefixed contact ids or component params
1671 if (CRM_Core_BAO_CustomField
::getKeyID($values[0]) ||
1672 (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) ||
1673 (substr($values[0], 0, 13) == 'contribution_') ||
1674 (substr($values[0], 0, 6) == 'event_') ||
1675 (substr($values[0], 0, 12) == 'participant_') ||
1676 (substr($values[0], 0, 7) == 'member_') ||
1677 (substr($values[0], 0, 6) == 'grant_') ||
1678 (substr($values[0], 0, 7) == 'pledge_') ||
1679 (substr($values[0], 0, 5) == 'case_') ||
1680 (substr($values[0], 0, 10) == 'financial_') ||
1681 (substr($values[0], 0, 8) == 'payment_') ||
1682 (substr($values[0], 0, 11) == 'membership_')
1687 // skip for hook injected fields / params
1688 $extFields = CRM_Contact_BAO_Query_Hook
::singleton()->getFields();
1689 if (array_key_exists($values[0], $extFields)) {
1693 switch ($values[0]) {
1694 case 'deleted_contacts':
1695 $this->deletedContacts($values);
1698 case 'contact_type':
1699 $this->contactType($values);
1702 case 'contact_sub_type':
1703 $this->contactSubType($values);
1707 $this->group($values);
1711 // so we resolve this into a list of groups & proceed as if they had been
1713 list($name, $op, $value, $grouping, $wildcard) = $values;
1714 $values[0] = 'group';
1716 $this->_paramLookup
['group'][0][0] = 'group';
1717 $this->_paramLookup
['group'][0][1] = 'IN';
1718 $this->_paramLookup
['group'][0][2] = $values[2] = $this->getGroupsFromTypeCriteria($value);
1719 $this->group($values);
1722 // case tag comes from find contacts
1724 $this->tagSearch($values);
1728 case 'contact_tags':
1729 $this->tag($values);
1734 case 'note_subject':
1735 $this->notes($values);
1739 $this->ufUser($values);
1743 case 'display_name':
1744 $this->sortName($values);
1748 case 'postal_greeting':
1749 case 'email_greeting':
1750 $this->greetings($values);
1754 $this->email($values);
1757 case 'phone_numeric':
1758 $this->phone_numeric($values);
1761 case 'phone_phone_type_id':
1762 case 'phone_location_type_id':
1763 $this->phone_option_group($values);
1766 case 'street_address':
1767 $this->street_address($values);
1770 case 'street_number':
1771 $this->street_number($values);
1774 case 'sortByCharacter':
1775 $this->sortByCharacter($values);
1778 case 'location_type':
1779 $this->locationType($values);
1783 $this->county($values);
1786 case 'state_province':
1787 $this->stateProvince($values);
1791 $this->country($values, FALSE);
1795 case 'postal_code_low':
1796 case 'postal_code_high':
1797 $this->postalCode($values);
1800 case 'activity_date':
1801 case 'activity_date_low':
1802 case 'activity_date_high':
1803 case 'activity_role':
1804 case 'activity_status_id':
1805 case 'activity_status':
1806 case 'followup_parent_id':
1808 case 'source_contact_id':
1809 case 'activity_subject':
1810 case 'test_activities':
1811 case 'activity_type_id':
1812 case 'activity_type':
1813 case 'activity_survey_id':
1814 case 'activity_tags':
1815 case 'activity_taglist':
1816 case 'activity_test':
1817 case 'activity_campaign_id':
1818 case 'activity_engagement_level':
1820 case 'activity_result':
1821 case 'source_contact':
1822 CRM_Activity_BAO_Query
::whereClauseSingle($values, $this);
1827 case 'birth_date_low':
1828 case 'birth_date_high':
1829 case 'deceased_date_low':
1830 case 'deceased_date_high':
1831 $this->demographics($values);
1834 case 'age_asof_date':
1835 // handled by demographics
1838 case 'log_date_low':
1839 case 'log_date_high':
1840 $this->modifiedDates($values);
1844 $this->changeLog($values);
1847 case 'do_not_phone':
1848 case 'do_not_email':
1851 case 'do_not_trade':
1853 $this->privacy($values);
1856 case 'privacy_options':
1857 $this->privacyOptions($values);
1860 case 'privacy_operator':
1861 case 'privacy_toggle':
1862 // these are handled by privacy options
1865 case 'preferred_communication_method':
1866 $this->preferredCommunication($values);
1869 case 'relation_type_id':
1870 case 'relation_start_date_high':
1871 case 'relation_start_date_low':
1872 case 'relation_end_date_high':
1873 case 'relation_end_date_low':
1874 case 'relation_target_name':
1875 case 'relation_status':
1876 case 'relation_date_low':
1877 case 'relation_date_high':
1878 $this->relationship($values);
1879 $this->_relationshipValuesAdded
= TRUE;
1882 case 'task_status_id':
1883 $this->task($values);
1887 // since this case is handled with the above
1890 case 'prox_distance':
1891 CRM_Contact_BAO_ProximityQuery
::process($this, $values);
1894 case 'prox_street_address':
1896 case 'prox_postal_code':
1897 case 'prox_state_province_id':
1898 case 'prox_country_id':
1899 // handled by the proximity_distance clause
1903 $this->restWhere($values);
1909 * Given a list of conditions in params generate the required where clause.
1913 public function whereClause() {
1914 $this->_where
[0] = array();
1915 $this->_qill
[0] = array();
1917 $this->includeContactIds();
1918 if (!empty($this->_params
)) {
1919 foreach (array_keys($this->_params
) as $id) {
1920 if (empty($this->_params
[$id][0])) {
1923 // check for both id and contact_id
1924 if ($this->_params
[$id][0] == 'id' ||
$this->_params
[$id][0] == 'contact_id') {
1925 $this->_where
[0][] = self
::buildClause("contact_a.id", $this->_params
[$id][1], $this->_params
[$id][2]);
1928 $this->whereClauseSingle($this->_params
[$id]);
1932 CRM_Core_Component
::alterQuery($this, 'where');
1934 CRM_Contact_BAO_Query_Hook
::singleton()->alterSearchQuery($this, 'where');
1937 if ($this->_customQuery
) {
1938 // Added following if condition to avoid the wrong value display for 'my account' / any UF info.
1939 // Hope it wont affect the other part of civicrm.. if it does please remove it.
1940 if (!empty($this->_customQuery
->_where
)) {
1941 $this->_where
= CRM_Utils_Array
::crmArrayMerge($this->_where
, $this->_customQuery
->_where
);
1944 $this->_qill
= CRM_Utils_Array
::crmArrayMerge($this->_qill
, $this->_customQuery
->_qill
);
1948 $andClauses = array();
1951 if (!empty($this->_where
)) {
1952 foreach ($this->_where
as $grouping => $values) {
1953 if ($grouping > 0 && !empty($values)) {
1954 $clauses[$grouping] = ' ( ' . implode(" {$this->_operator} ", $values) . ' ) ';
1959 if (!empty($this->_where
[0])) {
1960 $andClauses[] = ' ( ' . implode(" {$this->_operator} ", $this->_where
[0]) . ' ) ';
1962 if (!empty($clauses)) {
1963 $andClauses[] = ' ( ' . implode(' OR ', $clauses) . ' ) ';
1966 if ($validClauses > 1) {
1967 $this->_useDistinct
= TRUE;
1971 return implode(' AND ', $andClauses);
1975 * Generate where clause for any parameters not already handled.
1977 * @param array $values
1981 public function restWhere(&$values) {
1982 $name = CRM_Utils_Array
::value(0, $values);
1983 $op = CRM_Utils_Array
::value(1, $values);
1984 $value = CRM_Utils_Array
::value(2, $values);
1985 $grouping = CRM_Utils_Array
::value(3, $values);
1986 $wildcard = CRM_Utils_Array
::value(4, $values);
1988 if (isset($grouping) && empty($this->_where
[$grouping])) {
1989 $this->_where
[$grouping] = array();
1992 $multipleFields = array('url');
1994 //check if the location type exits for fields
1996 $locType = explode('-', $name);
1998 if (!in_array($locType[0], $multipleFields)) {
1999 //add phone type if exists
2000 if (isset($locType[2]) && $locType[2]) {
2001 $locType[2] = CRM_Core_DAO
::escapeString($locType[2]);
2005 $field = CRM_Utils_Array
::value($name, $this->_fields
);
2008 $field = CRM_Utils_Array
::value($locType[0], $this->_fields
);
2017 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
2018 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
2020 if (substr($name, 0, 14) === 'state_province') {
2021 if (isset($locType[1]) && is_numeric($locType[1])) {
2023 $aName = "{$locationType[$locType[1]]}-address";
2024 $where = "`$aName`.state_province_id";
2027 $where = "civicrm_address.state_province_id";
2030 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value);
2031 list($qillop, $qillVal) = self
::buildQillForFieldValue('CRM_Core_DAO_Address', "state_province_id", $value, $op);
2032 $this->_qill
[$grouping][] = ts("State %1 %2", array(1 => $qillop, 2 => $qillVal));
2034 elseif (!empty($field['pseudoconstant'])) {
2035 $this->optionValueQuery(
2036 $name, $op, $value, $grouping,
2037 'CRM_Contact_DAO_Contact',
2043 if ($name == 'gender_id') {
2044 self
::$_openedPanes[ts('Demographics')] = TRUE;
2047 elseif (substr($name, 0, 7) === 'country' ||
substr($name, 0, 6) === 'county') {
2048 $name = (substr($name, 0, 7) === 'country') ?
"country_id" : "county_id";
2049 if (isset($locType[1]) && is_numeric($locType[1])) {
2051 $aName = "{$locationType[$locType[1]]}-address";
2052 $where = "`$aName`.$name";
2055 $where = "civicrm_address.$name";
2058 $this->_where
[$grouping][] = self
::buildClause($where, $op, $value, 'Positive');
2061 $field['title'] .= " ($lType)";
2063 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue(NULL, $name, $value, $op);
2064 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(1 => $field['title'], 2 => $qillop, 3 => $qillVal));
2066 elseif ($name === 'world_region') {
2067 $this->optionValueQuery(
2068 $name, $op, $value, $grouping,
2076 elseif ($name === 'is_deceased') {
2077 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $value);
2078 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2079 self
::$_openedPanes[ts('Demographics')] = TRUE;
2081 elseif ($name === 'created_date' ||
$name === 'modified_date' ||
$name === 'deceased_date' ||
$name === 'birth_date') {
2082 $appendDateTime = TRUE;
2083 if ($name === 'deceased_date' ||
$name === 'birth_date') {
2084 $appendDateTime = FALSE;
2085 self
::$_openedPanes[ts('Demographics')] = TRUE;
2087 $this->dateQueryBuilder($values, 'contact_a', $name, $name, $field['title'], $appendDateTime);
2089 elseif ($name === 'contact_id') {
2090 if (is_int($value)) {
2091 $this->_where
[$grouping][] = self
::buildClause($field['where'], $op, $value);
2092 $this->_qill
[$grouping][] = "$field[title] $op $value";
2095 elseif ($name === 'name') {
2096 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
2098 $value = "%$value%";
2101 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
2102 $this->_where
[$grouping][] = self
::buildClause($wc, $op, "'$value'");
2103 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2105 elseif ($name === 'current_employer') {
2106 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
2108 $value = "%$value%";
2111 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.organization_name)" : "contact_a.organization_name";
2112 $ceWhereClause = self
::buildClause($wc, $op,
2115 $ceWhereClause .= " AND contact_a.contact_type = 'Individual'";
2116 $this->_where
[$grouping][] = $ceWhereClause;
2117 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2119 elseif ($name === 'email_greeting') {
2120 $filterCondition = array('greeting_type' => 'email_greeting');
2121 $this->optionValueQuery(
2122 $name, $op, $value, $grouping,
2123 CRM_Core_PseudoConstant
::greeting($filterCondition),
2125 ts('Email Greeting')
2128 elseif ($name === 'postal_greeting') {
2129 $filterCondition = array('greeting_type' => 'postal_greeting');
2130 $this->optionValueQuery(
2131 $name, $op, $value, $grouping,
2132 CRM_Core_PseudoConstant
::greeting($filterCondition),
2134 ts('Postal Greeting')
2137 elseif ($name === 'addressee') {
2138 $filterCondition = array('greeting_type' => 'addressee');
2139 $this->optionValueQuery(
2140 $name, $op, $value, $grouping,
2141 CRM_Core_PseudoConstant
::greeting($filterCondition),
2146 elseif (substr($name, 0, 4) === 'url-') {
2147 $tName = 'civicrm_website';
2148 $this->_whereTables
[$tName] = $this->_tables
[$tName] = "\nLEFT JOIN civicrm_website ON ( civicrm_website.contact_id = contact_a.id )";
2149 $value = $strtolower(CRM_Core_DAO
::escapeString($value));
2151 $value = "%$value%";
2155 $wc = 'civicrm_website.url';
2156 $this->_where
[$grouping][] = $d = self
::buildClause($wc, $op, $value);
2157 $this->_qill
[$grouping][] = "$field[title] $op \"$value\"";
2159 elseif ($name === 'contact_is_deleted') {
2160 $this->_where
[$grouping][] = self
::buildClause("contact_a.is_deleted", $op, $value);
2161 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue(NULL, $name, $value, $op);
2162 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(1 => $field['title'], 2 => $qillop, 3 => $qillVal));
2164 elseif (!empty($field['where'])) {
2166 if (!empty($field['type'])) {
2167 $type = CRM_Utils_Type
::typeToString($field['type']);
2170 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2172 if (isset($locType[1]) &&
2173 is_numeric($locType[1])
2177 //get the location name
2178 list($tName, $fldName) = self
::getLocationTableName($field['where'], $locType);
2180 $fieldName = "LOWER(`$tName`.$fldName)";
2182 // we set both _tables & whereTables because whereTables doesn't seem to do what the name implies it should
2183 $this->_tables
[$tName] = $this->_whereTables
[$tName] = 1;
2187 if ($tableName == 'civicrm_contact') {
2188 $fieldName = "LOWER(contact_a.{$fieldName})";
2191 if ($op != 'IN' && !is_numeric($value)) {
2192 $fieldName = "LOWER({$field['where']})";
2195 $fieldName = "{$field['where']}";
2200 list($qillop, $qillVal) = self
::buildQillForFieldValue(NULL, $field['title'], $value, $op);
2201 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(
2202 1 => $field['title'],
2204 3 => (strpos($op, 'NULL') !== FALSE ||
strpos($op, 'EMPTY') !== FALSE) ?
$qillVal : "'$qillVal'"));
2206 if (is_array($value)) {
2207 // traditionally an array being passed has been a fatal error. We can take advantage of this to add support
2208 // for api style operators for functions that hit this point without worrying about regression
2209 // (the previous comments indicated the condition for hitting this point were unknown
2210 // per CRM-14743 we are adding modified_date & created_date operator support
2211 $operations = array_keys($value);
2212 foreach ($operations as $operator) {
2213 if (!in_array($operator, CRM_Core_DAO
::acceptedSQLOperators())) {
2214 //Via Contact get api value is not in array(operator => array(values)) format ONLY for IN/NOT IN operators
2215 //so this condition will satisfy the search for now
2216 if (strpos($op, 'IN') !== FALSE) {
2217 $value = array($op => $value);
2219 // we don't know when this might happen
2221 CRM_Core_Error
::fatal(ts("%1 is not a valid operator", array(1 => $operator)));
2225 $this->_where
[$grouping][] = CRM_Core_DAO
::createSQLFilter($fieldName, $value, $type);
2228 if (!strpos($op, 'IN')) {
2229 $value = $strtolower($value);
2232 $value = "%$value%";
2236 $this->_where
[$grouping][] = self
::buildClause($fieldName, $op, $value, $type);
2240 if ($setTables && isset($field['where'])) {
2241 list($tableName, $fieldName) = explode('.', $field['where'], 2);
2242 if (isset($tableName)) {
2243 $this->_tables
[$tableName] = 1;
2244 $this->_whereTables
[$tableName] = 1;
2257 public static function getLocationTableName(&$where, &$locType) {
2258 if (isset($locType[1]) && is_numeric($locType[1])) {
2259 list($tbName, $fldName) = explode(".", $where);
2261 //get the location name
2262 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
2263 $specialFields = array('email', 'im', 'phone', 'openid', 'phone_ext');
2264 if (in_array($locType[0], $specialFields)) {
2265 //hack to fix / special handing for phone_ext
2266 if ($locType[0] == 'phone_ext') {
2267 $locType[0] = 'phone';
2269 if (isset($locType[2]) && $locType[2]) {
2270 $tName = "{$locationType[$locType[1]]}-{$locType[0]}-{$locType[2]}";
2273 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2276 elseif (in_array($locType[0],
2281 'street_number_suffix',
2283 'supplemental_address_1',
2284 'supplemental_address_2',
2287 'postal_code_suffix',
2293 //fix for search by profile with address fields.
2294 $tName = "{$locationType[$locType[1]]}-address";
2296 elseif (in_array($locType[0],
2304 $tName = "{$locationType[$locType[1]]}-email";
2306 elseif ($locType[0] == 'provider_id') {
2307 $tName = "{$locationType[$locType[1]]}-im";
2309 elseif ($locType[0] == 'openid') {
2310 $tName = "{$locationType[$locType[1]]}-openid";
2313 $tName = "{$locationType[$locType[1]]}-{$locType[0]}";
2315 $tName = str_replace(' ', '_', $tName);
2316 return array($tName, $fldName);
2318 CRM_Core_Error
::fatal();
2322 * Given a result dao, extract the values and return that array
2324 * @param CRM_Core_DAO $dao
2327 * values for this query
2329 public function store($dao) {
2332 foreach ($this->_element
as $key => $dontCare) {
2333 if (property_exists($dao, $key)) {
2334 if (strpos($key, '-') !== FALSE) {
2335 $values = explode('-', $key);
2336 $lastElement = array_pop($values);
2338 $cnt = count($values);
2340 foreach ($values as $v) {
2341 if (!array_key_exists($v, $current)) {
2342 $current[$v] = array();
2344 //bad hack for im_provider
2345 if ($lastElement == 'provider_id') {
2346 if ($count < $cnt) {
2347 $current = &$current[$v];
2350 $lastElement = "{$v}_{$lastElement}";
2354 $current = &$current[$v];
2359 $current[$lastElement] = $dao->$key;
2362 $value[$key] = $dao->$key;
2370 * Getter for tables array.
2374 public function tables() {
2375 return $this->_tables
;
2379 * Where tables is sometimes used to create the from clause, but, not reliably, set this AND set tables
2380 * It's unclear the intent - there is a 'simpleFrom' clause which takes whereTables into account & a fromClause which doesn't
2381 * logic may have eroded
2384 public function whereTables() {
2385 return $this->_whereTables
;
2389 * Generate the where clause (used in match contacts and permissions)
2391 * @param array $params
2392 * @param array $fields
2393 * @param array $tables
2394 * @param $whereTables
2395 * @param bool $strict
2399 public static function getWhereClause($params, $fields, &$tables, &$whereTables, $strict = FALSE) {
2400 $query = new CRM_Contact_BAO_Query($params, NULL, $fields,
2404 $tables = array_merge($query->tables(), $tables);
2405 $whereTables = array_merge($query->whereTables(), $whereTables);
2407 return $query->_whereClause
;
2411 * Create the from clause.
2413 * @param array $tables
2414 * Tables that need to be included in this from clause.
2415 * if null, return mimimal from clause (i.e. civicrm_contact)
2416 * @param array $inner
2417 * Tables that should be inner-joined.
2418 * @param array $right
2419 * Tables that should be right-joined.
2421 * @param bool $primaryLocation
2427 public static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
2429 $from = ' FROM civicrm_contact contact_a';
2430 if (empty($tables)) {
2434 if (!empty($tables['civicrm_worldregion'])) {
2435 $tables = array_merge(array('civicrm_country' => 1), $tables);
2438 if ((!empty($tables['civicrm_state_province']) ||
!empty($tables['civicrm_country']) ||
2439 CRM_Utils_Array
::value('civicrm_county', $tables)
2440 ) && empty($tables['civicrm_address'])
2442 $tables = array_merge(array('civicrm_address' => 1),
2447 // add group_contact and group_contact_cache table if group table is present
2448 if (!empty($tables['civicrm_group'])) {
2449 if (empty($tables['civicrm_group_contact'])) {
2450 $tables['civicrm_group_contact'] = " LEFT JOIN civicrm_group_contact ON civicrm_group_contact.contact_id = contact_a.id AND civicrm_group_contact.status = 'Added' ";
2452 if (empty($tables['civicrm_group_contact_cache'])) {
2453 $tables['civicrm_group_contact_cache'] = " LEFT JOIN civicrm_group_contact_cache ON civicrm_group_contact_cache.contact_id = contact_a.id ";
2457 // add group_contact and group table is subscription history is present
2458 if (!empty($tables['civicrm_subscription_history']) && empty($tables['civicrm_group'])) {
2459 $tables = array_merge(array(
2460 'civicrm_group' => 1,
2461 'civicrm_group_contact' => 1,
2467 // to handle table dependencies of components
2468 CRM_Core_Component
::tableNames($tables);
2469 // to handle table dependencies of hook injected tables
2470 CRM_Contact_BAO_Query_Hook
::singleton()->setTableDependency($tables);
2472 //format the table list according to the weight
2473 $info = CRM_Core_TableHierarchy
::info();
2475 foreach ($tables as $key => $value) {
2477 if (strpos($key, '-') !== FALSE) {
2478 $keyArray = explode('-', $key);
2479 $k = CRM_Utils_Array
::value('civicrm_' . $keyArray[1], $info, 99);
2481 elseif (strpos($key, '_') !== FALSE) {
2482 $keyArray = explode('_', $key);
2483 if (is_numeric(array_pop($keyArray))) {
2484 $k = CRM_Utils_Array
::value(implode('_', $keyArray), $info, 99);
2487 $k = CRM_Utils_Array
::value($key, $info, 99);
2491 $k = CRM_Utils_Array
::value($key, $info, 99);
2493 $tempTable[$k . ".$key"] = $key;
2496 $newTables = array();
2497 foreach ($tempTable as $key) {
2498 $newTables[$key] = $tables[$key];
2501 $tables = $newTables;
2503 foreach ($tables as $name => $value) {
2508 if (!empty($inner[$name])) {
2511 elseif (!empty($right[$name])) {
2519 // if there is already a join statement in value, use value itself
2520 if (strpos($value, 'JOIN')) {
2521 $from .= " $value ";
2524 $from .= " $side JOIN $name ON ( $value ) ";
2529 case 'civicrm_address':
2530 if ($primaryLocation) {
2531 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id AND civicrm_address.is_primary = 1 )";
2534 //CRM-14263 further handling of address joins further down...
2535 $from .= " $side JOIN civicrm_address ON ( contact_a.id = civicrm_address.contact_id ) ";
2539 case 'civicrm_phone':
2540 $from .= " $side JOIN civicrm_phone ON (contact_a.id = civicrm_phone.contact_id AND civicrm_phone.is_primary = 1) ";
2543 case 'civicrm_email':
2544 $from .= " $side JOIN civicrm_email ON (contact_a.id = civicrm_email.contact_id AND civicrm_email.is_primary = 1) ";
2548 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id AND civicrm_im.is_primary = 1) ";
2552 $from .= " $side JOIN civicrm_im ON (contact_a.id = civicrm_im.contact_id) ";
2553 $from .= " $side JOIN civicrm_option_group option_group_imProvider ON option_group_imProvider.name = 'instant_messenger_service'";
2554 $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)";
2557 case 'civicrm_openid':
2558 $from .= " $side JOIN civicrm_openid ON ( civicrm_openid.contact_id = contact_a.id AND civicrm_openid.is_primary = 1 )";
2561 case 'civicrm_worldregion':
2562 $from .= " $side JOIN civicrm_country ON civicrm_address.country_id = civicrm_country.id ";
2563 $from .= " $side JOIN civicrm_worldregion ON civicrm_country.region_id = civicrm_worldregion.id ";
2566 case 'civicrm_location_type':
2567 $from .= " $side JOIN civicrm_location_type ON civicrm_address.location_type_id = civicrm_location_type.id ";
2570 case 'civicrm_group':
2571 $from .= " $side JOIN civicrm_group ON (civicrm_group.id = civicrm_group_contact.group_id OR civicrm_group.id = civicrm_group_contact_cache.group_id) ";
2574 case 'civicrm_group_contact':
2575 $from .= " $side JOIN civicrm_group_contact ON contact_a.id = civicrm_group_contact.contact_id ";
2578 case 'civicrm_group_contact_cache':
2579 $from .= " $side JOIN civicrm_group_contact_cache ON contact_a.id = civicrm_group_contact_cache.contact_id ";
2582 case 'civicrm_activity':
2583 case 'civicrm_activity_tag':
2584 case 'activity_type':
2585 case 'activity_status':
2587 case 'civicrm_activity_contact':
2588 case 'source_contact':
2589 $from .= CRM_Activity_BAO_Query
::from($name, $mode, $side);
2592 case 'civicrm_entity_tag':
2593 $from .= " $side JOIN civicrm_entity_tag ON ( civicrm_entity_tag.entity_table = 'civicrm_contact' AND
2594 civicrm_entity_tag.entity_id = contact_a.id ) ";
2597 case 'civicrm_note':
2598 $from .= " $side JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND
2599 contact_a.id = civicrm_note.entity_id ) ";
2602 case 'civicrm_subscription_history':
2603 $from .= " $side JOIN civicrm_subscription_history
2604 ON civicrm_group_contact.contact_id = civicrm_subscription_history.contact_id
2605 AND civicrm_group_contact.group_id = civicrm_subscription_history.group_id";
2608 case 'civicrm_relationship':
2609 if (self
::$_relType == 'reciprocal') {
2610 if (self
::$_relationshipTempTable) {
2611 // we have a temptable to join on
2612 $tbl = self
::$_relationshipTempTable;
2613 $from .= " INNER JOIN {$tbl} civicrm_relationship ON civicrm_relationship.contact_id = contact_a.id";
2616 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id OR civicrm_relationship.contact_id_a = contact_a.id)";
2617 $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)";
2620 elseif (self
::$_relType == 'b') {
2621 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_b = contact_a.id )";
2622 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_a = contact_b.id )";
2625 $from .= " $side JOIN civicrm_relationship ON (civicrm_relationship.contact_id_a = contact_a.id )";
2626 $from .= " $side JOIN civicrm_contact contact_b ON (civicrm_relationship.contact_id_b = contact_b.id )";
2631 $from .= " INNER JOIN civicrm_log ON (civicrm_log.entity_id = contact_a.id AND civicrm_log.entity_table = 'civicrm_contact')";
2632 $from .= " INNER JOIN civicrm_contact contact_b_log ON (civicrm_log.modified_id = contact_b_log.id)";
2636 $from .= " $side JOIN civicrm_tag ON civicrm_entity_tag.tag_id = civicrm_tag.id ";
2639 case 'civicrm_grant':
2640 $from .= CRM_Grant_BAO_Query
::from($name, $mode, $side);
2643 case 'civicrm_website':
2644 $from .= " $side JOIN civicrm_website ON contact_a.id = civicrm_website.contact_id ";
2648 $locationTypeName = '';
2649 if (strpos($name, '-address') != 0) {
2650 $locationTypeName = 'address';
2652 elseif (strpos($name, '-phone') != 0) {
2653 $locationTypeName = 'phone';
2655 elseif (strpos($name, '-email') != 0) {
2656 $locationTypeName = 'email';
2658 elseif (strpos($name, '-im') != 0) {
2659 $locationTypeName = 'im';
2661 elseif (strpos($name, '-openid') != 0) {
2662 $locationTypeName = 'openid';
2665 if ($locationTypeName) {
2666 //we have a join on an location table - possibly in conjunction with search builder - CRM-14263
2667 $parts = explode('-', $name);
2668 $locationID = array_search($parts[0], CRM_Core_BAO_Address
::buildOptions('location_type_id', 'get', array('name' => $parts[0])));
2669 $from .= " $side JOIN civicrm_{$locationTypeName} `{$name}` ON ( contact_a.id = `{$name}`.contact_id ) and `{$name}`.location_type_id = $locationID ";
2672 $from .= CRM_Core_Component
::from($name, $mode, $side);
2674 $from .= CRM_Contact_BAO_Query_Hook
::singleton()->buildSearchfrom($name, $mode, $side);
2683 * WHERE / QILL clause for deleted_contacts
2685 * @param array $values
2687 public function deletedContacts($values) {
2688 list($_, $_, $value, $grouping, $_) = $values;
2690 // *prepend* to the relevant grouping as this is quite an important factor
2691 array_unshift($this->_qill
[$grouping], ts('Search in Trash'));
2696 * Where / qill clause for contact_type
2700 public function contactType(&$values) {
2701 list($name, $op, $value, $grouping, $wildcard) = $values;
2703 $subTypes = array();
2706 // account for search builder mapping multiple values
2707 if (!is_array($value)) {
2708 $values = self
::parseSearchBuilderString($value, 'String');
2709 if (is_array($values)) {
2710 $value = array_flip($values);
2714 if (is_array($value)) {
2715 foreach ($value as $k => $v) {
2720 if (strpos($k, CRM_Core_DAO
::VALUE_SEPARATOR
)) {
2721 list($contactType, $subType) = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $k, 2);
2724 if (!empty($subType)) {
2725 $subTypes[$subType] = 1;
2727 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2732 $contactTypeANDSubType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value, 2);
2733 $contactType = $contactTypeANDSubType[0];
2734 $subType = CRM_Utils_Array
::value(1, $contactTypeANDSubType);
2735 if (!empty($subType)) {
2736 $subTypes[$subType] = 1;
2738 $clause[$contactType] = "'" . CRM_Utils_Type
::escape($contactType, 'String') . "'";
2742 if (!empty($clause)) {
2744 if ($op == 'IN' ||
$op == 'NOT IN') {
2745 $this->_where
[$grouping][] = "contact_a.contact_type $op (" . implode(',', $clause) . ')';
2748 $type = array_pop($clause);
2749 $this->_where
[$grouping][] = self
::buildClause("contact_a.contact_type", $op, $contactType);
2752 $this->_qill
[$grouping][] = ts('Contact Type') . " $op " . implode(' ' . ts('or') . ' ', $quill);
2754 if (!empty($subTypes)) {
2755 $this->includeContactSubTypes($subTypes, $grouping);
2761 * Where / qill clause for contact_sub_type
2765 public function contactSubType(&$values) {
2766 list($name, $op, $value, $grouping, $wildcard) = $values;
2767 $this->includeContactSubTypes($value, $grouping, $op);
2775 public function includeContactSubTypes($value, $grouping, $op = 'LIKE') {
2778 $alias = "contact_a.contact_sub_type";
2779 $qillOperators = array('NOT LIKE' => ts('Not Like')) + CRM_Core_SelectValues
::getSearchBuilderOperators();
2781 $op = str_replace('IN', 'LIKE', $op);
2782 $op = str_replace('=', 'LIKE', $op);
2783 $op = str_replace('!', 'NOT ', $op);
2785 if (strpos($op, 'NULL') !== FALSE ||
strpos($op, 'EMPTY') !== FALSE) {
2786 $this->_where
[$grouping][] = self
::buildClause($alias, $op, $value, 'String');
2788 elseif (is_array($value)) {
2789 foreach ($value as $k => $v) {
2791 $clause[$k] = "($alias $op '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($k, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2796 $clause[$value] = "($alias $op '%" . CRM_Core_DAO
::VALUE_SEPARATOR
. CRM_Utils_Type
::escape($value, 'String') . CRM_Core_DAO
::VALUE_SEPARATOR
. "%')";
2799 if (!empty($clause)) {
2800 $this->_where
[$grouping][] = "( " . implode(' OR ', $clause) . " )";
2802 $this->_qill
[$grouping][] = ts('Contact Subtype %1 ', array(1 => $qillOperators[$op])) . implode(' ' . ts('or') . ' ', array_keys($clause));
2806 * Where / qill clause for groups
2810 public function group(&$values) {
2811 list($name, $op, $value, $grouping, $wildcard) = $values;
2813 // If the $value is in OK (operator as key) array format we need to extract the key as operator and value first
2814 if (is_array($value) && in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
2816 $value = $value[$op];
2819 // Replace pseudo operators from search builder
2820 $op = str_replace('EMPTY', 'NULL', $op);
2822 if (strpos($op, 'NULL')) {
2826 if (count($value) > 1) {
2827 if (strpos($op, 'IN') === FALSE && strpos($op, 'NULL') === FALSE) {
2828 CRM_Core_Error
::fatal(ts("%1 is not a valid operator", array(1 => $op)));
2830 $this->_useDistinct
= TRUE;
2833 if (isset($value)) {
2834 $value = CRM_Utils_Array
::value($op, $value, $value);
2840 $isNotOp = ($op == 'NOT IN' ||
$op == '!=');
2843 $gcsValues = $this->getWhereValues('group_contact_status', $grouping);
2845 is_array($gcsValues[2])
2847 foreach ($gcsValues[2] as $k => $v) {
2849 $statii[] = "'" . CRM_Utils_Type
::escape($k, 'String') . "'";
2854 $statii[] = '"Added"';
2858 if (!is_array($value) &&
2859 count($statii) == 1 &&
2860 $statii[0] == '"Added"' &&
2863 if (!empty($value) && CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Group', $value, 'saved_search_id')) {
2868 $ssClause = $this->addGroupContactCache($value, NULL, "contact_a", $op);
2869 $isSmart = (!$ssClause) ?
FALSE : $isSmart;
2870 $groupClause = NULL;
2873 $groupIds = implode(',', (array) $value);
2874 $gcTable = "`civicrm_group_contact-{$groupIds}`";
2875 $joinClause = array("contact_a.id = {$gcTable}.contact_id");
2877 $joinClause[] = "{$gcTable}.status IN (" . implode(', ', $statii) . ")";
2879 $this->_tables
[$gcTable] = $this->_whereTables
[$gcTable] = " LEFT JOIN civicrm_group_contact {$gcTable} ON (" . implode(' AND ', $joinClause) . ")";
2880 if (strpos($op, 'IN') !== FALSE) {
2881 $groupClause = "{$gcTable}.group_id $op ( $groupIds )";
2883 elseif ($op == '!=') {
2884 $groupClause = "{$gcTable}.contact_id NOT IN (SELECT contact_id FROM civicrm_group_contact cgc WHERE cgc.group_id = $groupIds)";
2887 $groupClause = "{$gcTable}.group_id $op $groupIds";
2892 $and = ($op == 'IS NULL') ?
'AND' : 'OR';
2894 $groupClause = "( ( $groupClause ) $and ( $ssClause ) )";
2897 $groupClause = $ssClause;
2901 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contact_DAO_Group', 'id', $value, $op);
2902 $this->_qill
[$grouping][] = ts("Group(s) %1 %2", array(1 => $qillop, 2 => $qillVal));
2903 if (strpos($op, 'NULL') === FALSE) {
2904 $this->_qill
[$grouping][] = ts("Group Status %1", array(1 => implode(' ' . ts('or') . ' ', $statii)));
2907 $this->_where
[$grouping][] = $groupClause;
2912 * Function translates selection of group type into a list of groups.
2917 public function getGroupsFromTypeCriteria($value) {
2918 $groupIds = array();
2919 foreach ((array) $value as $groupTypeValue) {
2920 $groupList = CRM_Core_PseudoConstant
::group($groupTypeValue);
2921 $groupIds = ($groupIds +
$groupList);
2927 * @param array $groups
2928 * @param string $tableAlias
2929 * @param string $joinTable
2932 * @return null|string
2934 public function addGroupContactCache($groups, $tableAlias = NULL, $joinTable = "contact_a", $op) {
2935 $isNullOp = (strpos($op, 'NULL') !== FALSE);
2936 $groupsIds = $groups;
2937 if (!$isNullOp && !$groups) {
2940 elseif (strpos($op, 'IN') !== FALSE) {
2941 $groups = array($op => $groups);
2943 elseif (is_array($groups) && count($groups)) {
2944 $groups = array('IN' => $groups);
2947 // Find all the groups that are part of a saved search.
2948 $smartGroupClause = self
::buildClause("id", $op, $groups, 'Int');
2950 SELECT id, cache_date, saved_search_id, children
2952 WHERE $smartGroupClause
2953 AND ( saved_search_id != 0
2954 OR saved_search_id IS NOT NULL
2955 OR children IS NOT NULL )
2958 $group = CRM_Core_DAO
::executeQuery($sql);
2960 while ($group->fetch()) {
2961 $this->_useDistinct
= TRUE;
2962 if (!$this->_smartGroupCache ||
$group->cache_date
== NULL) {
2963 CRM_Contact_BAO_GroupContactCache
::load($group);
2968 $tableAlias = "`civicrm_group_contact_cache_";
2969 $tableAlias .= ($isNullOp) ?
"a`" : implode(',', (array) $groupsIds) . "`";
2972 $this->_tables
[$tableAlias] = $this->_whereTables
[$tableAlias] = " LEFT JOIN civicrm_group_contact_cache {$tableAlias} ON {$joinTable}.id = {$tableAlias}.contact_id ";
2973 return self
::buildClause("{$tableAlias}.group_id", $op, $groups, 'Int');
2977 * Where / qill clause for cms users
2981 public function ufUser(&$values) {
2982 list($name, $op, $value, $grouping, $wildcard) = $values;
2985 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' INNER JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2987 $this->_qill
[$grouping][] = ts('CMS User');
2989 elseif ($value == 0) {
2990 $this->_tables
['civicrm_uf_match'] = $this->_whereTables
['civicrm_uf_match'] = ' LEFT JOIN civicrm_uf_match ON civicrm_uf_match.contact_id = contact_a.id ';
2992 $this->_where
[$grouping][] = " civicrm_uf_match.contact_id IS NULL";
2993 $this->_qill
[$grouping][] = ts('Not a CMS User');
2998 * All tag search specific.
3000 * @param array $values
3002 public function tagSearch(&$values) {
3003 list($name, $op, $value, $grouping, $wildcard) = $values;
3006 $value = "%{$value}%";
3008 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3009 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3011 $etTable = "`civicrm_entity_tag-" . $value . "`";
3012 $tTable = "`civicrm_tag-" . $value . "`";
3014 if ($useAllTagTypes[2]) {
3015 $this->_tables
[$etTable] = $this->_whereTables
[$etTable]
3016 = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id)
3017 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id )";
3019 // search tag in cases
3020 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3021 $tCaseTable = "`civicrm_case_tag-" . $value . "`";
3022 $this->_tables
[$etCaseTable] = $this->_whereTables
[$etCaseTable]
3023 = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3024 LEFT JOIN civicrm_case
3025 ON (civicrm_case_contact.case_id = civicrm_case.id
3026 AND civicrm_case.is_deleted = 0 )
3027 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id )
3028 LEFT JOIN civicrm_tag {$tCaseTable} ON ( {$etCaseTable}.tag_id = {$tCaseTable}.id )";
3029 // search tag in activities
3030 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3031 $tActTable = "`civicrm_act_tag-" . $value . "`";
3032 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3033 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
3035 $this->_tables
[$etActTable] = $this->_whereTables
[$etActTable]
3036 = " LEFT JOIN civicrm_activity_contact
3037 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3038 LEFT JOIN civicrm_activity
3039 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3040 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3041 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id )
3042 LEFT JOIN civicrm_tag {$tActTable} ON ( {$etActTable}.tag_id = {$tActTable}.id )";
3044 $this->_where
[$grouping][] = "({$tTable}.name $op '" . $value . "' OR {$tCaseTable}.name $op '" . $value . "' OR {$tActTable}.name $op '" . $value . "')";
3045 $this->_qill
[$grouping][] = ts('Tag %1 %2', array(1 => $tagTypesText[2], 2 => $op)) . ' ' . $value;
3048 $etTable = "`civicrm_entity_tag-" . $value . "`";
3049 $tTable = "`civicrm_tag-" . $value . "`";
3050 $this->_tables
[$etTable] = $this->_whereTables
[$etTable] = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND
3051 {$etTable}.entity_table = 'civicrm_contact' )
3052 LEFT JOIN civicrm_tag {$tTable} ON ( {$etTable}.tag_id = {$tTable}.id ) ";
3054 $this->_where
[$grouping][] = self
::buildClause("{$tTable}.name", $op, $value, 'String');
3055 $this->_qill
[$grouping][] = ts('Tagged %1', array(1 => $op)) . ' ' . $value;
3060 * Where / qill clause for tag
3062 * @param array $values
3064 public function tag(&$values) {
3065 list($name, $op, $value, $grouping, $wildcard) = $values;
3067 list($qillop, $qillVal) = self
::buildQillForFieldValue('CRM_Core_DAO_EntityTag', "tag_id", $value, $op, array('onlyActive' => FALSE));
3068 // API/Search Builder format array(operator => array(values))
3069 if (is_array($value)) {
3070 if (in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
3072 $value = $value[$op];
3074 if (count($value) > 1) {
3075 $this->_useDistinct
= TRUE;
3077 $value = implode(',', (array) $value);
3080 $useAllTagTypes = $this->getWhereValues('all_tag_types', $grouping);
3081 $tagTypesText = $this->getWhereValues('tag_types_text', $grouping);
3083 $etTable = "`civicrm_entity_tag-" . $value . "`";
3085 if ($useAllTagTypes[2]) {
3086 $this->_tables
[$etTable] = $this->_whereTables
[$etTable]
3087 = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
3089 // search tag in cases
3090 $etCaseTable = "`civicrm_entity_case_tag-" . $value . "`";
3091 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
3092 $targetID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
3094 $this->_tables
[$etCaseTable] = $this->_whereTables
[$etCaseTable]
3095 = " LEFT JOIN civicrm_case_contact ON civicrm_case_contact.contact_id = contact_a.id
3096 LEFT JOIN civicrm_case
3097 ON (civicrm_case_contact.case_id = civicrm_case.id
3098 AND civicrm_case.is_deleted = 0 )
3099 LEFT JOIN civicrm_entity_tag {$etCaseTable} ON ( {$etCaseTable}.entity_table = 'civicrm_case' AND {$etCaseTable}.entity_id = civicrm_case.id ) ";
3100 // search tag in activities
3101 $etActTable = "`civicrm_entity_act_tag-" . $value . "`";
3102 $this->_tables
[$etActTable] = $this->_whereTables
[$etActTable]
3103 = " LEFT JOIN civicrm_activity_contact
3104 ON ( civicrm_activity_contact.contact_id = contact_a.id AND civicrm_activity_contact.record_type_id = {$targetID} )
3105 LEFT JOIN civicrm_activity
3106 ON ( civicrm_activity.id = civicrm_activity_contact.activity_id
3107 AND civicrm_activity.is_deleted = 0 AND civicrm_activity.is_current_revision = 1 )
3108 LEFT JOIN civicrm_entity_tag as {$etActTable} ON ( {$etActTable}.entity_table = 'civicrm_activity' AND {$etActTable}.entity_id = civicrm_activity.id ) ";
3111 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3112 $this->_where
[$grouping][] = "({$etTable}.tag_id $op OR {$etCaseTable}.tag_id $op OR {$etActTable}.tag_id $op)";
3115 $this->_where
[$grouping][] = "({$etTable}.tag_id $op (" . $value . ") OR {$etCaseTable}.tag_id $op (" . $value . ") OR {$etActTable}.tag_id $op (" . $value . "))";
3119 $this->_tables
[$etTable] = $this->_whereTables
[$etTable]
3120 = " LEFT JOIN civicrm_entity_tag {$etTable} ON ( {$etTable}.entity_id = contact_a.id AND {$etTable}.entity_table = 'civicrm_contact') ";
3123 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3124 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3125 $op = str_replace('EMPTY', 'NULL', $op);
3126 $this->_where
[$grouping][] = "{$etTable}.tag_id $op";
3128 // CRM-16941: for tag tried with != operator we don't show contact who don't have given $value AND also in other tag
3129 elseif ($op == '!=') {
3130 $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') . ")";
3132 elseif ($op == '=' ||
strstr($op, 'IN')) {
3133 $op = ($op == '=') ?
'IN' : $op;
3134 $this->_where
[$grouping][] = "{$etTable}.tag_id $op ( $value )";
3137 $this->_qill
[$grouping][] = ts('Tagged %1 %2', array(1 => $qillop, 2 => $qillVal));
3141 * Where/qill clause for notes
3143 * @param array $values
3145 public function notes(&$values) {
3146 list($name, $op, $value, $grouping, $wildcard) = $values;
3148 $noteOptionValues = $this->getWhereValues('note_option', $grouping);
3149 $noteOption = CRM_Utils_Array
::value('2', $noteOptionValues, '6');
3150 $noteOption = ($name == 'note_body') ?
2 : (($name == 'note_subject') ?
3 : $noteOption);
3152 $this->_useDistinct
= TRUE;
3154 $this->_tables
['civicrm_note'] = $this->_whereTables
['civicrm_note']
3155 = " LEFT JOIN civicrm_note ON ( civicrm_note.entity_table = 'civicrm_contact' AND contact_a.id = civicrm_note.entity_id ) ";
3157 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
3159 $value = $strtolower(CRM_Core_DAO
::escapeString($n));
3161 if (strpos($value, '%') === FALSE) {
3162 $value = "%$value%";
3166 elseif ($op == 'IS NULL' ||
$op == 'IS NOT NULL') {
3172 if ($noteOption %
2 == 0) {
3173 $clauses[] = self
::buildClause('civicrm_note.note', $op, $value, 'String');
3174 $label = ts('Note: Body Only');
3176 if ($noteOption %
3 == 0) {
3177 $clauses[] = self
::buildClause('civicrm_note.subject', $op, $value, 'String');
3178 $label = $label ?
ts('Note: Body and Subject') : ts('Note: Subject Only');
3180 $this->_where
[$grouping][] = "( " . implode(' OR ', $clauses) . " )";
3181 list($qillOp, $qillVal) = self
::buildQillForFieldValue(NULL, $name, $n, $op);
3182 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(1 => $label, 2 => $qillOp, 3 => $qillVal));
3186 * @param string $name
3192 public function nameNullOrEmptyOp($name, $op, $grouping) {
3196 $this->_where
[$grouping][] = "contact_a.$name $op";
3197 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
3201 $this->_where
[$grouping][] = "(contact_a.$name IS NULL OR contact_a.$name = '')";
3202 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
3205 case 'IS NOT EMPTY':
3206 $this->_where
[$grouping][] = "(contact_a.$name IS NOT NULL AND contact_a.$name <> '')";
3207 $this->_qill
[$grouping][] = ts('Name') . ' ' . $op;
3216 * Where / qill clause for sort_name
3218 * @param array $values
3220 public function sortName(&$values) {
3221 list($fieldName, $op, $value, $grouping, $wildcard) = $values;
3223 // handle IS NULL / IS NOT NULL / IS EMPTY / IS NOT EMPTY
3224 if ($this->nameNullOrEmptyOp($fieldName, $op, $grouping)) {
3228 $input = $value = trim($value);
3230 if (!strlen($value)) {
3234 $config = CRM_Core_Config
::singleton();
3238 //By default, $sub elements should be joined together with OR statements (don't change this variable).
3241 $strtolower = function_exists('mb_strtolower') ?
'mb_strtolower' : 'strtolower';
3243 $firstChar = substr($value, 0, 1);
3244 $lastChar = substr($value, -1, 1);
3245 $quotes = array("'", '"');
3246 // If string is quoted, strip quotes and otherwise don't alter it
3247 if ((strlen($value) > 2) && in_array($firstChar, $quotes) && in_array($lastChar, $quotes)) {
3248 $value = trim($value, implode('', $quotes));
3250 // Replace spaces with wildcards for a LIKE operation
3251 // UNLESS string contains a comma (this exception is a tiny bit questionable)
3252 elseif ($op == 'LIKE' && strpos($value, ',') === FALSE) {
3253 $value = str_replace(' ', '%', $value);
3255 $value = $strtolower(CRM_Core_DAO
::escapeString(trim($value)));
3256 if (strlen($value)) {
3257 $fieldsub = array();
3258 if ($wildcard && $op == 'LIKE') {
3259 if ($config->includeWildCardInName
) {
3260 $value = "'%$value%'";
3263 $value = "'$value%'";
3268 $value = "'$value'";
3270 if ($fieldName == 'sort_name') {
3271 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.sort_name)" : "contact_a.sort_name";
3274 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.display_name)" : "contact_a.display_name";
3276 $fieldsub[] = " ( $wc $op $value )";
3277 if ($config->includeNickNameInName
) {
3278 $wc = self
::caseImportant($op) ?
"LOWER(contact_a.nick_name)" : "contact_a.nick_name";
3279 $fieldsub[] = " ( $wc $op $value )";
3281 if ($config->includeEmailInName
) {
3282 $fieldsub[] = " ( civicrm_email.email $op $value ) ";
3284 $sub[] = ' ( ' . implode(' OR ', $fieldsub) . ' ) ';
3287 $sub = ' ( ' . implode($subGlue, $sub) . ' ) ';
3289 $this->_where
[$grouping][] = $sub;
3290 if ($config->includeEmailInName
) {
3291 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3292 $this->_qill
[$grouping][] = ts('Name or Email') . " $op - '$input'";
3295 $this->_qill
[$grouping][] = ts('Name') . " $op - '$input'";
3300 * Where/qill clause for greeting fields.
3302 * @param array $values
3304 public function greetings(&$values) {
3305 list($name, $op, $value, $grouping, $wildcard) = $values;
3306 $name .= '_display';
3308 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue(NULL, $name, $value, $op);
3309 $this->_qill
[$grouping][] = ts('Greeting %1 %2', array(1 => $qillop, 2 => $qillVal));
3310 $this->_where
[$grouping][] = self
::buildClause("contact_a.{$name}", $op, $value, 'String');
3314 * Where / qill clause for email
3316 * @param array $values
3318 public function email(&$values) {
3319 list($name, $op, $value, $grouping, $wildcard) = $values;
3323 $config = CRM_Core_Config
::singleton();
3325 if (substr($n, 0, 1) == '"' &&
3326 substr($n, -1, 1) == '"'
3328 $n = substr($n, 1, -1);
3329 $value = strtolower(CRM_Core_DAO
::escapeString($n));
3330 $value = "'$value'";
3334 $value = strtolower($n);
3336 if (strpos($value, '%') === FALSE) {
3337 $value = "%{$value}%";
3342 $this->_qill
[$grouping][] = ts('Email') . " $op '$n'";
3343 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, $value, 'String');
3346 $this->_qill
[$grouping][] = ts('Email') . " $op ";
3347 $this->_where
[$grouping][] = self
::buildClause('civicrm_email.email', $op, NULL, 'String');
3350 $this->_tables
['civicrm_email'] = $this->_whereTables
['civicrm_email'] = 1;
3354 * Where / qill clause for phone number
3356 * @param array $values
3358 public function phone_numeric(&$values) {
3359 list($name, $op, $value, $grouping, $wildcard) = $values;
3360 // Strip non-numeric characters; allow wildcards
3361 $number = preg_replace('/[^\d%]/', '', $value);
3363 if (strpos($number, '%') === FALSE) {
3364 $number = "%$number%";
3367 $this->_qill
[$grouping][] = ts('Phone number contains') . " $number";
3368 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.phone_numeric', 'LIKE', "$number", 'String');
3369 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3374 * Where / qill clause for phone type/location
3376 * @param array $values
3378 public function phone_option_group($values) {
3379 list($name, $op, $value, $grouping, $wildcard) = $values;
3380 $option = ($name == 'phone_phone_type_id' ?
'phone_type_id' : 'location_type_id');
3381 $options = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Phone', $option);
3382 $optionName = $options[$value];
3383 $this->_qill
[$grouping][] = ts('Phone') . ' ' . ($name == 'phone_phone_type_id' ?
ts('type') : ('location')) . " $op $optionName";
3384 $this->_where
[$grouping][] = self
::buildClause('civicrm_phone.' . substr($name, 6), $op, $value, 'Integer');
3385 $this->_tables
['civicrm_phone'] = $this->_whereTables
['civicrm_phone'] = 1;
3389 * Where / qill clause for street_address.
3391 * @param array $values
3393 public function street_address(&$values) {
3394 list($name, $op, $value, $grouping, $wildcard) = $values;
3403 $value = strtolower($n);
3404 if (strpos($value, '%') === FALSE) {
3405 // only add wild card if not there
3406 $value = "%{$value}%";
3409 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_address)', $op, $value, 'String');
3410 $this->_qill
[$grouping][] = ts('Street') . " $op '$n'";
3413 $this->_where
[$grouping][] = self
::buildClause('civicrm_address.street_address', $op, NULL, 'String');
3414 $this->_qill
[$grouping][] = ts('Street') . " $op ";
3417 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3421 * Where / qill clause for street_unit.
3423 * @param array $values
3425 public function street_number(&$values) {
3426 list($name, $op, $value, $grouping, $wildcard) = $values;
3434 if (strtolower($n) == 'odd') {
3435 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 1 )";
3436 $this->_qill
[$grouping][] = ts('Street Number is odd');
3438 elseif (strtolower($n) == 'even') {
3439 $this->_where
[$grouping][] = " ( civicrm_address.street_number % 2 = 0 )";
3440 $this->_qill
[$grouping][] = ts('Street Number is even');
3443 $value = strtolower($n);
3445 $this->_where
[$grouping][] = self
::buildClause('LOWER(civicrm_address.street_number)', $op, $value, 'String');
3446 $this->_qill
[$grouping][] = ts('Street Number') . " $op '$n'";
3449 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3453 * Where / qill clause for sorting by character.
3455 * @param array $values
3457 public function sortByCharacter(&$values) {
3458 list($name, $op, $value, $grouping, $wildcard) = $values;
3460 $name = trim($value);
3461 $cond = " contact_a.sort_name LIKE '" . strtolower(CRM_Core_DAO
::escapeWildCardString($name)) . "%'";
3462 $this->_where
[$grouping][] = $cond;
3463 $this->_qill
[$grouping][] = ts('Showing only Contacts starting with: \'%1\'', array(1 => $name));
3467 * Where / qill clause for including contact ids.
3469 public function includeContactIDs() {
3470 if (!$this->_includeContactIds ||
empty($this->_params
)) {
3474 $contactIds = array();
3475 foreach ($this->_params
as $id => $values) {
3476 if (substr($values[0], 0, CRM_Core_Form
::CB_PREFIX_LEN
) == CRM_Core_Form
::CB_PREFIX
) {
3477 $contactIds[] = substr($values[0], CRM_Core_Form
::CB_PREFIX_LEN
);
3480 if (!empty($contactIds)) {
3481 $this->_where
[0][] = " ( contact_a.id IN (" . implode(',', $contactIds) . " ) ) ";
3486 * Where / qill clause for postal code.
3488 * @param array $values
3490 public function postalCode(&$values) {
3491 // skip if the fields dont have anything to do with postal_code
3492 if (empty($this->_fields
['postal_code'])) {
3496 list($name, $op, $value, $grouping, $wildcard) = $values;
3498 // Handle numeric postal code range searches properly by casting the column as numeric
3499 if (is_numeric($value)) {
3500 $field = 'ROUND(civicrm_address.postal_code)';
3501 $val = CRM_Utils_Type
::escape($value, 'Integer');
3504 $field = 'civicrm_address.postal_code';
3505 // Per CRM-17060 we might be looking at an 'IN' syntax so don't case arrays to string.
3506 if (!is_array($value)) {
3507 $val = CRM_Utils_Type
::escape($value, 'String');
3510 // Do we need to escape values here? I would expect buildClause does.
3515 $this->_tables
['civicrm_address'] = $this->_whereTables
['civicrm_address'] = 1;
3517 if ($name == 'postal_code') {
3518 $this->_where
[$grouping][] = self
::buildClause($field, $op, $val, 'String');
3519 $this->_qill
[$grouping][] = ts('Postal code') . " {$op} {$value}";
3521 elseif ($name == 'postal_code_low') {
3522 $this->_where
[$grouping][] = " ( $field >= '$val' ) ";
3523 $this->_qill
[$grouping][] = ts('Postal code greater than or equal to \'%1\'', array(1 => $value));
3525 elseif ($name == 'postal_code_high') {
3526 $this->_where
[$grouping][] = " ( $field <= '$val' ) ";
3527 $this->_qill
[$grouping][] = ts('Postal code less than or equal to \'%1\'', array(1 => $value));
3532 * Where / qill clause for location type.
3534 * @param array $values
3535 * @param null $status
3539 public function locationType(&$values, $status = NULL) {
3540 list($name, $op, $value, $grouping, $wildcard) = $values;
3542 if (is_array($value)) {
3543 $this->_where
[$grouping][] = 'civicrm_address.location_type_id IN (' . implode(',', $value) . ')';
3544 $this->_tables
['civicrm_address'] = 1;
3545 $this->_whereTables
['civicrm_address'] = 1;
3547 $locationType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
3549 foreach ($value as $id) {
3550 $names[] = $locationType[$id];
3553 $this->_primaryLocation
= FALSE;
3556 $this->_qill
[$grouping][] = ts('Location Type') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3559 return implode(' ' . ts('or') . ' ', $names);
3566 * @param bool $fromStateProvince
3568 * @return array|NULL
3570 public function country(&$values, $fromStateProvince = TRUE) {
3571 list($name, $op, $value, $grouping, $wildcard) = $values;
3573 if (!$fromStateProvince) {
3574 $stateValues = $this->getWhereValues('state_province', $grouping);
3575 if (!empty($stateValues)) {
3576 // return back to caller if there are state province values
3577 // since that handles this case
3582 $countryClause = $countryQill = NULL;
3588 $this->_tables
['civicrm_address'] = 1;
3589 $this->_whereTables
['civicrm_address'] = 1;
3591 $countryClause = self
::buildClause('civicrm_address.country_id', $op, $value, 'Positive');
3592 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue(NULL, 'country_id', $value, $op);
3593 $countryQill = ts("%1 %2 %3", array(1 => 'Country', 2 => $qillop, 3 => $qillVal));
3595 if (!$fromStateProvince) {
3596 $this->_where
[$grouping][] = $countryClause;
3597 $this->_qill
[$grouping][] = $countryQill;
3601 if ($fromStateProvince) {
3602 if (!empty($countryClause)) {
3605 " ...AND... " . $countryQill,
3609 return array(NULL, NULL);
3615 * Where / qill clause for county (if present).
3617 * @param array $values
3618 * @param null $status
3622 public function county(&$values, $status = NULL) {
3623 list($name, $op, $value, $grouping, $wildcard) = $values;
3625 if (!is_array($value)) {
3626 // force the county to be an array
3627 $value = array($value);
3630 // check if the values are ids OR names of the counties
3631 $inputFormat = 'id';
3632 foreach ($value as $v) {
3633 if (!is_numeric($v)) {
3634 $inputFormat = 'name';
3642 elseif ($op == '!=') {
3646 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3647 $op = str_replace('EMPTY', 'NULL', $op);
3650 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3651 $clause = "civicrm_address.county_id $op";
3653 elseif ($inputFormat == 'id') {
3654 $clause = 'civicrm_address.county_id IN (' . implode(',', $value) . ')';
3656 $county = CRM_Core_PseudoConstant
::county();
3657 foreach ($value as $id) {
3658 $names[] = CRM_Utils_Array
::value($id, $county);
3662 $inputClause = array();
3663 $county = CRM_Core_PseudoConstant
::county();
3664 foreach ($value as $name) {
3665 $name = trim($name);
3666 $inputClause[] = CRM_Utils_Array
::key($name, $county);
3668 $clause = 'civicrm_address.county_id IN (' . implode(',', $inputClause) . ')';
3671 $this->_tables
['civicrm_address'] = 1;
3672 $this->_whereTables
['civicrm_address'] = 1;
3674 $this->_where
[$grouping][] = $clause;
3676 $this->_qill
[$grouping][] = ts('County') . ' - ' . implode(' ' . ts('or') . ' ', $names);
3679 return implode(' ' . ts('or') . ' ', $names);
3684 * Where / qill clause for state/province AND country (if present).
3686 * @param array $values
3687 * @param null $status
3691 public function stateProvince(&$values, $status = NULL) {
3692 list($name, $op, $value, $grouping, $wildcard) = $values;
3694 // quick escape for IS NULL
3695 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3698 elseif (!is_array($value)) {
3699 // force the state to be an array
3700 // check if its in the mapper format!
3701 $values = self
::parseSearchBuilderString($value);
3702 if (is_array($values)) {
3706 $value = array($value);
3710 // check if the values are ids OR names of the states
3711 $inputFormat = 'id';
3713 foreach ($value as $v) {
3714 if (!is_numeric($v)) {
3715 $inputFormat = 'name';
3725 elseif ($op == '!=') {
3729 // this converts IS (NOT)? EMPTY to IS (NOT)? NULL
3730 $op = str_replace('EMPTY', 'NULL', $op);
3732 if (in_array($op, array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) {
3733 $stateClause = "civicrm_address.state_province_id $op";
3735 elseif ($inputFormat == 'id') {
3736 if ($op != 'NOT IN') {
3739 $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $value) . ')';
3741 foreach ($value as $id) {
3742 $names[] = CRM_Core_PseudoConstant
::stateProvince($id, FALSE);
3746 $inputClause = array();
3747 $stateProvince = CRM_Core_PseudoConstant
::stateProvince();
3748 foreach ($value as $name) {
3749 $name = trim($name);
3750 $inputClause[] = CRM_Utils_Array
::key($name, $stateProvince);
3752 $stateClause = "civicrm_address.state_province_id $op (" . implode(',', $inputClause) . ')';
3755 $this->_tables
['civicrm_address'] = 1;
3756 $this->_whereTables
['civicrm_address'] = 1;
3758 $countryValues = $this->getWhereValues('country', $grouping);
3759 list($countryClause, $countryQill) = $this->country($countryValues, TRUE);
3761 if ($countryClause) {
3762 $clause = "( $stateClause AND $countryClause )";
3765 $clause = $stateClause;
3768 $this->_where
[$grouping][] = $clause;
3770 $this->_qill
[$grouping][] = ts('State/Province') . " $op " . implode(' ' . ts('or') . ' ', $names) . $countryQill;
3773 return implode(' ' . ts('or') . ' ', $names) . $countryQill;
3778 * Where / qill clause for change log.
3780 * @param array $values
3782 public function changeLog(&$values) {
3783 list($name, $op, $value, $grouping, $wildcard) = $values;
3785 $targetName = $this->getWhereValues('changed_by', $grouping);
3790 $name = trim($targetName[2]);
3791 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3792 $name = $targetName[4] ?
"%$name%" : $name;
3793 $this->_where
[$grouping][] = "contact_b_log.sort_name LIKE '%$name%'";
3794 $this->_tables
['civicrm_log'] = $this->_whereTables
['civicrm_log'] = 1;
3795 $this->_qill
[$grouping][] = ts('Modified By') . " $name";
3801 public function modifiedDates($values) {
3802 $this->_useDistinct
= TRUE;
3804 // CRM-11281, default to added date if not set
3805 $fieldTitle = ts('Added Date');
3806 $fieldName = 'created_date';
3807 foreach (array_keys($this->_params
) as $id) {
3808 if ($this->_params
[$id][0] == 'log_date') {
3809 if ($this->_params
[$id][2] == 2) {
3810 $fieldTitle = ts('Modified Date');
3811 $fieldName = 'modified_date';
3816 $this->dateQueryBuilder($values, 'contact_a', 'log_date', $fieldName, $fieldTitle);
3818 self
::$_openedPanes[ts('Change Log')] = TRUE;
3824 public function demographics(&$values) {
3825 list($name, $op, $value, $grouping, $wildcard) = $values;
3827 if (($name == 'age_low') ||
($name == 'age_high')) {
3828 $this->ageRangeQueryBuilder($values,
3829 'contact_a', 'age', 'birth_date', ts('Age')
3832 elseif (($name == 'birth_date_low') ||
($name == 'birth_date_high')) {
3834 $this->dateQueryBuilder($values,
3835 'contact_a', 'birth_date', 'birth_date', ts('Birth Date')
3838 elseif (($name == 'deceased_date_low') ||
($name == 'deceased_date_high')) {
3840 $this->dateQueryBuilder($values,
3841 'contact_a', 'deceased_date', 'deceased_date', ts('Deceased Date')
3845 self
::$_openedPanes[ts('Demographics')] = TRUE;
3851 public function privacy(&$values) {
3852 list($name, $op, $value, $grouping, $wildcard) = $values;
3853 //fixed for profile search listing CRM-4633
3854 if (strpbrk($value, "[")) {
3855 $value = "'{$value}'";
3857 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3860 $this->_where
[$grouping][] = "contact_a.{$name} $op $value";
3862 $field = CRM_Utils_Array
::value($name, $this->_fields
);
3863 $op = CRM_Utils_Array
::value($op, CRM_Core_SelectValues
::getSearchBuilderOperators(), $op);
3864 $title = $field ?
$field['title'] : $name;
3865 $this->_qill
[$grouping][] = "$title $op $value";
3871 public function privacyOptions($values) {
3872 list($name, $op, $value, $grouping, $wildcard) = $values;
3874 if (empty($value) ||
!is_array($value)) {
3878 // get the operator and toggle values
3879 $opValues = $this->getWhereValues('privacy_operator', $grouping);
3882 strtolower($opValues[2] == 'AND')
3887 $toggleValues = $this->getWhereValues('privacy_toggle', $grouping);
3889 if ($toggleValues &&
3890 $toggleValues[2] == 2
3897 foreach ($value as $dontCare => $pOption) {
3898 $clauses[] = " ( contact_a.{$pOption} = 1 ) ";
3899 $field = CRM_Utils_Array
::value($pOption, $this->_fields
);
3900 $title = $field ?
$field['title'] : $pOption;
3901 $qill[] = " $title = 1 ";
3904 $this->_where
[$grouping][] = $compareOP . '( ' . implode($operator, $clauses) . ' )';
3905 $this->_qill
[$grouping][] = $compareOP . '( ' . implode($operator, $qill) . ' )';
3911 public function preferredCommunication(&$values) {
3912 list($name, $op, $value, $grouping, $wildcard) = $values;
3914 if (!is_array($value)) {
3915 $value = str_replace(array('(', ')'), '', explode(",", $value));
3917 elseif (in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
3919 $value = $value[$op];
3921 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue('CRM_Contact_DAO_Contact', $name, $value, $op);
3923 if (self
::caseImportant($op)) {
3924 $value = implode("[[:cntrl:]]|[[:cntrl:]]", (array) $value);
3925 $op = (strstr($op, '!') ||
strstr($op, 'NOT')) ?
'NOT RLIKE' : 'RLIKE';
3926 $value = "[[:cntrl:]]" . $value . "[[:cntrl:]]";
3929 $this->_where
[$grouping][] = self
::buildClause("contact_a.preferred_communication_method", $op, $value);
3930 $this->_qill
[$grouping][] = ts('Preferred Communication Method %1 %2', array(1 => $qillop, 2 => $qillVal));
3934 * Where / qill clause for relationship.
3936 * @param array $values
3938 public function relationship(&$values) {
3939 list($name, $op, $value, $grouping, $wildcard) = $values;
3940 if ($this->_relationshipValuesAdded
) {
3943 // also get values array for relation_target_name
3944 // for relationship search we always do wildcard
3945 $relationType = $this->getWhereValues('relation_type_id', $grouping);
3946 $targetName = $this->getWhereValues('relation_target_name', $grouping);
3947 $relStatus = $this->getWhereValues('relation_status', $grouping);
3948 $relPermission = $this->getWhereValues('relation_permission', $grouping);
3949 $targetGroup = $this->getWhereValues('relation_target_group', $grouping);
3951 $nameClause = $name = NULL;
3953 $name = trim($targetName[2]);
3954 if (substr($name, 0, 1) == '"' &&
3955 substr($name, -1, 1) == '"'
3957 $name = substr($name, 1, -1);
3958 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3959 $nameClause = "= '$name'";
3962 $name = strtolower(CRM_Core_DAO
::escapeString($name));
3963 $nameClause = "LIKE '%{$name}%'";
3967 $rTypeValues = array();
3968 if (!empty($relationType)) {
3969 $rel = explode('_', $relationType[2]);
3970 self
::$_relType = $rel[1];
3971 $params = array('id' => $rel[0]);
3972 $rType = CRM_Contact_BAO_RelationshipType
::retrieve($params, $rTypeValues);
3974 if (!empty($rTypeValues) && $rTypeValues['name_a_b'] == $rTypeValues['name_b_a']) {
3975 // if we don't know which end of the relationship we are dealing with we'll create a temp table
3976 //@todo unless we are dealing with a target group
3977 self
::$_relType = 'reciprocal';
3979 // if we are creating a temp table we build our own where for the relationship table
3980 $relationshipTempTable = NULL;
3981 if (self
::$_relType == 'reciprocal' && empty($targetGroup)) {
3983 self
::$_relationshipTempTable = $relationshipTempTable = CRM_Core_DAO
::createTempTableName('civicrm_rel');
3985 $where[$grouping][] = " sort_name $nameClause ";
3989 $where = &$this->_where
;
3991 $where[$grouping][] = "( contact_b.sort_name $nameClause AND contact_b.id != contact_a.id )";
3995 $allRelationshipType = CRM_Contact_BAO_Relationship
::getContactRelationshipType(NULL, 'null', NULL, NULL, TRUE);
3997 if ($nameClause ||
!$targetGroup) {
3998 if (!empty($relationType)) {
3999 $this->_qill
[$grouping][] = $allRelationshipType[$relationType[2]] . " $name";
4002 $this->_qill
[$grouping][] = $name;
4006 //check to see if the target contact is in specified group
4008 //add contacts from static groups
4009 $this->_tables
['civicrm_relationship_group_contact'] = $this->_whereTables
['civicrm_relationship_group_contact']
4010 = " LEFT JOIN civicrm_group_contact civicrm_relationship_group_contact ON civicrm_relationship_group_contact.contact_id = contact_b.id AND civicrm_relationship_group_contact.status = 'Added'";
4011 $groupWhere[] = "( civicrm_relationship_group_contact.group_id IN (" .
4012 implode(",", $targetGroup[2]) . ") ) ";
4014 //add contacts from saved searches
4015 $ssWhere = $this->addGroupContactCache($targetGroup[2], "civicrm_relationship_group_contact_cache", "contact_b", $op);
4017 //set the group where clause
4019 $groupWhere[] = "( " . $ssWhere . " )";
4021 $this->_where
[$grouping][] = "( " . implode(" OR ", $groupWhere) . " )";
4023 //Get the names of the target groups for the qill
4024 $groupNames = CRM_Core_PseudoConstant
::group();
4025 $qillNames = array();
4026 foreach ($targetGroup[2] as $groupId) {
4027 if (array_key_exists($groupId, $groupNames)) {
4028 $qillNames[] = $groupNames[$groupId];
4031 if (!empty($relationType)) {
4032 $this->_qill
[$grouping][] = $allRelationshipType[$relationType[2]] . " ( " . implode(", ", $qillNames) . " )";
4035 $this->_qill
[$grouping][] = implode(", ", $qillNames);
4039 // Note we do not currently set mySql to handle timezones, so doing this the old-fashioned way
4040 $today = date('Ymd');
4041 //check for active, inactive and all relation status
4042 if ($relStatus[2] == 0) {
4043 $where[$grouping][] = "(
4044 civicrm_relationship.is_active = 1 AND
4045 ( civicrm_relationship.end_date IS NULL OR civicrm_relationship.end_date >= {$today} ) AND
4046 ( civicrm_relationship.start_date IS NULL OR civicrm_relationship.start_date <= {$today} )
4048 $this->_qill
[$grouping][] = ts('Relationship - Active and Current');
4050 elseif ($relStatus[2] == 1) {
4051 $where[$grouping][] = "(
4052 civicrm_relationship.is_active = 0 OR
4053 civicrm_relationship.end_date < {$today} OR
4054 civicrm_relationship.start_date > {$today}
4056 $this->_qill
[$grouping][] = ts('Relationship - Inactive or not Current');
4060 if (in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
)) {
4063 $where[$grouping][] = "(contact_b.is_deleted = {$onlyDeleted})";
4065 //check for permissioned, non-permissioned and all permissioned relations
4066 if ($relPermission[2] == 1) {
4067 $where[$grouping][] = "(
4068 civicrm_relationship.is_permission_a_b = 1
4070 $this->_qill
[$grouping][] = ts('Relationship - Permissioned');
4072 elseif ($relPermission[2] == 2) {
4073 //non-allowed permission relationship.
4074 $where[$grouping][] = "(
4075 civicrm_relationship.is_permission_a_b = 0
4077 $this->_qill
[$grouping][] = ts('Relationship - Non-permissioned');
4080 $this->addRelationshipDateClauses($grouping, $where);
4081 if (!empty($relationType) && !empty($rType) && isset($rType->id
)) {
4082 $where[$grouping][] = 'civicrm_relationship.relationship_type_id = ' . $rType->id
;
4084 $this->_tables
['civicrm_relationship'] = $this->_whereTables
['civicrm_relationship'] = 1;
4085 $this->_useDistinct
= TRUE;
4086 $this->_relationshipValuesAdded
= TRUE;
4087 // it could be a or b, using an OR creates an unindexed join - better to create a temp table &
4089 // @todo creating a temp table could be expanded to group filter
4090 // as even creating a temp table of all relationships is much much more efficient than
4091 // an OR in the join
4092 if ($relationshipTempTable) {
4094 if (!empty($where[$grouping])) {
4095 $whereClause = ' WHERE ' . implode(' AND ', $where[$grouping]);
4096 $whereClause = str_replace('contact_b', 'c', $whereClause);
4099 CREATE TEMPORARY TABLE {$relationshipTempTable}
4100 (SELECT contact_id_b as contact_id, civicrm_relationship.id
4101 FROM civicrm_relationship
4102 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_a = c.id
4105 (SELECT contact_id_a as contact_id, civicrm_relationship.id
4106 FROM civicrm_relationship
4107 INNER JOIN civicrm_contact c ON civicrm_relationship.contact_id_b = c.id
4110 CRM_Core_DAO
::executeQuery($sql);
4116 * Add start & end date criteria in
4117 * @param string $grouping
4118 * @param array $where
4119 * = array to add where clauses to, in case you are generating a temp table.
4120 * not the main query.
4122 public function addRelationshipDateClauses($grouping, &$where) {
4123 $dateValues = array();
4129 foreach ($dateTypes as $dateField) {
4130 $dateValueLow = $this->getWhereValues('relation_' . $dateField . '_low', $grouping);
4131 $dateValueHigh = $this->getWhereValues('relation_' . $dateField . '_high', $grouping);
4132 if (!empty($dateValueLow)) {
4133 $date = date('Ymd', strtotime($dateValueLow[2]));
4134 $where[$grouping][] = "civicrm_relationship.$dateField >= $date";
4135 $this->_qill
[$grouping][] = ($dateField == 'end_date' ?
ts('Relationship Ended on or After') : ts('Relationship Recorded Start Date On or Before')) . " " . CRM_Utils_Date
::customFormat($date);
4137 if (!empty($dateValueHigh)) {
4138 $date = date('Ymd', strtotime($dateValueHigh[2]));
4139 $where[$grouping][] = "civicrm_relationship.$dateField <= $date";
4140 $this->_qill
[$grouping][] = ($dateField == 'end_date' ?
ts('Relationship Ended on or Before') : ts('Relationship Recorded Start Date On or After')) . " " . CRM_Utils_Date
::customFormat($date);
4146 * Default set of return properties.
4151 * derault return properties
4153 public static function &defaultReturnProperties($mode = 1) {
4154 if (!isset(self
::$_defaultReturnProperties)) {
4155 self
::$_defaultReturnProperties = array();
4158 if (!isset(self
::$_defaultReturnProperties[$mode])) {
4159 // add activity return properties
4160 if ($mode & CRM_Contact_BAO_Query
::MODE_ACTIVITY
) {
4161 self
::$_defaultReturnProperties[$mode] = CRM_Activity_BAO_Query
::defaultReturnProperties($mode, FALSE);
4164 self
::$_defaultReturnProperties[$mode] = CRM_Core_Component
::defaultReturnProperties($mode, FALSE);
4167 if (empty(self
::$_defaultReturnProperties[$mode])) {
4168 self
::$_defaultReturnProperties[$mode] = array(
4171 'legal_identifier' => 1,
4172 'external_identifier' => 1,
4173 'contact_type' => 1,
4174 'contact_sub_type' => 1,
4176 'display_name' => 1,
4177 'preferred_mail_format' => 1,
4184 'formal_title' => 1,
4185 'communication_style_id' => 1,
4188 'street_address' => 1,
4189 'supplemental_address_1' => 1,
4190 'supplemental_address_2' => 1,
4193 'postal_code_suffix' => 1,
4194 'state_province' => 1,
4196 'world_region' => 1,
4203 'household_name' => 1,
4204 'organization_name' => 1,
4205 'deceased_date' => 1,
4210 'current_employer' => 1,
4211 // FIXME: should we use defaultHierReturnProperties() for the below?
4212 'do_not_email' => 1,
4215 'do_not_phone' => 1,
4216 'do_not_trade' => 1,
4218 'contact_is_deleted' => 1,
4219 'preferred_communication_method' => 1,
4220 'preferred_language' => 1,
4224 return self
::$_defaultReturnProperties[$mode];
4228 * Get primary condition for a sql clause.
4232 * @return string|NULL
4234 public static function getPrimaryCondition($value) {
4235 if (is_numeric($value)) {
4236 $value = (int ) $value;
4237 return ($value == 1) ?
'is_primary = 1' : 'is_primary = 0';
4243 * Wrapper for a simple search query.
4245 * @param array $params
4246 * @param array $returnProperties
4247 * @param bool $count
4251 public static function getQuery($params = NULL, $returnProperties = NULL, $count = FALSE) {
4252 $query = new CRM_Contact_BAO_Query($params, $returnProperties);
4253 list($select, $from, $where, $having) = $query->query();
4255 return "$select $from $where $having";
4259 * These are stub comments as this function needs more explanation - particularly in terms of how it
4260 * relates to $this->searchQuery and why it replicates rather than calles $this->searchQuery.
4262 * This function was originally written as a wrapper for the api query but is called from multiple places
4263 * in the core code directly so the name is misleading. This function does not use the searchQuery function
4264 * but it is unclear as to whehter that is historical or there is a reason
4265 * CRM-11290 led to the permissioning action being extracted from searchQuery & shared with this function
4267 * @param array $params
4268 * @param array $returnProperties
4269 * @param null $fields
4270 * @param string $sort
4271 * @param int $offset
4272 * @param int $row_count
4273 * @param bool $smartGroupCache
4274 * ?? update smart group cache?.
4275 * @param bool $count
4276 * Return count obnly.
4277 * @param bool $skipPermissions
4278 * Should permissions be ignored or should the logged in user's permissions be applied.
4283 public static function apiQuery(
4285 $returnProperties = NULL,
4290 $smartGroupCache = TRUE,
4292 $skipPermissions = TRUE
4295 $query = new CRM_Contact_BAO_Query(
4296 $params, $returnProperties,
4297 NULL, TRUE, FALSE, 1,
4299 TRUE, $smartGroupCache
4302 //this should add a check for view deleted if permissions are enabled
4303 if ($skipPermissions) {
4304 $query->_skipDeleteClause
= TRUE;
4306 $query->generatePermissionClause(FALSE, $count);
4308 // note : this modifies _fromClause and _simpleFromClause
4309 $query->includePseudoFieldsJoin($sort);
4311 list($select, $from, $where, $having) = $query->query($count);
4313 $options = $query->_options
;
4314 if (!empty($query->_permissionWhereClause
)) {
4315 if (empty($where)) {
4316 $where = "WHERE $query->_permissionWhereClause";
4319 $where = "$where AND $query->_permissionWhereClause";
4323 $sql = "$select $from $where $having";
4326 if ($query->_useGroupBy
) {
4327 $sql .= ' GROUP BY contact_a.id';
4329 if (!empty($sort)) {
4330 $sort = CRM_Utils_Type
::escape($sort, 'String');
4331 $sql .= " ORDER BY $sort ";
4333 if ($row_count > 0 && $offset >= 0) {
4334 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4335 $rowCount = CRM_Utils_Type
::escape($row_count, 'Int');
4336 $sql .= " LIMIT $offset, $row_count ";
4339 $dao = CRM_Core_DAO
::executeQuery($sql);
4342 while ($dao->fetch()) {
4344 $noRows = $dao->rowCount
;
4346 return array($noRows, NULL);
4348 $val = $query->store($dao);
4349 $convertedVals = $query->convertToPseudoNames($dao, TRUE);
4351 if (!empty($convertedVals)) {
4352 $val = array_replace_recursive($val, $convertedVals);
4354 $values[$dao->contact_id
] = $val;
4357 return array($values, $options);
4361 * Get the actual custom field name by stripping off the appended string.
4363 * The string could be _relative, _from, or _to
4365 * @todo use metadata rather than convention to do this.
4367 * @param string $parameterName
4368 * The name of the parameter submitted to the form.
4375 public static function getCustomFieldName($parameterName) {
4376 if (substr($parameterName, -5, 5) == '_from') {
4377 return substr($parameterName, 0, strpos($parameterName, '_from'));
4379 if (substr($parameterName, -9, 9) == '_relative') {
4380 return substr($parameterName, 0, strpos($parameterName, '_relative'));
4382 if (substr($parameterName, -3, 3) == '_to') {
4383 return substr($parameterName, 0, strpos($parameterName, '_to'));
4388 * Convert submitted values for relative custom date fields to query object format.
4390 * The query will support the sqlOperator format so convert to that format.
4392 * @param array $formValues
4394 * @param array $params
4395 * Converted parameters for the query object.
4396 * @param string $values
4398 * @param string $fieldName
4399 * Submitted field name. (Matches form field not DB field.)
4401 protected static function convertCustomDateRelativeFields(&$formValues, &$params, $values, $fieldName) {
4402 if (empty($values)) {
4403 // e.g we might have relative set & from & to empty. The form flow is a bit funky &
4404 // this function gets called again after they fields have been converted which can get ugly.
4407 $customFieldName = self
::getCustomFieldName($fieldName);
4409 if (substr($fieldName, -9, 9) == '_relative') {
4410 list($from, $to) = CRM_Utils_Date
::getFromTo($values, NULL, NULL);
4413 if ($fieldName == $customFieldName . '_to' && CRM_Utils_Array
::value($customFieldName . '_from', $formValues)) {
4414 // Both to & from are set. We only need to acton one, choosing from.
4418 list($from, $to) = CRM_Utils_Date
::getFromTo(
4420 (empty($formValues[$customFieldName . '_from']) ?
NULL : $formValues[$customFieldName . '_from']),
4421 CRM_Utils_Array
::value($customFieldName . '_to', $formValues)
4427 $relativeFunction = array('BETWEEN' => array($from, $to));
4430 $relativeFunction = array('>=' => $from);
4434 $relativeFunction = array('<=' => $to);
4446 * Has this field already been reformatting to Query object syntax.
4448 * The form layer passed formValues to this function in preProcess & postProcess. Reason unknown. This seems
4449 * to come with associated double queries & is possibly damaging performance.
4451 * However, here we add a tested function to ensure convertFormValues identifies pre-processed fields & returns
4454 * @param mixed $values
4455 * Value in formValues for the field.
4459 protected static function isAlreadyProcessedForQueryFormat($values) {
4460 if (!is_array($values)) {
4463 if (($operator = CRM_Utils_Array
::value(1, $values)) == FALSE) {
4466 return in_array($operator, CRM_Core_DAO
::acceptedSQLOperators());
4470 * Create and query the db for an contact search.
4472 * @param int $offset
4473 * The offset for the query.
4474 * @param int $rowCount
4475 * The number of rows to return.
4476 * @param string $sort
4477 * The order by string.
4478 * @param bool $count
4479 * Is this a count only query ?.
4480 * @param bool $includeContactIds
4481 * Should we include contact ids?.
4482 * @param bool $sortByChar
4483 * If true returns the distinct array of first characters for search results.
4484 * @param bool $groupContacts
4485 * If true, return only the contact ids.
4486 * @param bool $returnQuery
4487 * Should we return the query as a string.
4488 * @param string $additionalWhereClause
4489 * If the caller wants to further restrict the search (used for components).
4490 * @param null $sortOrder
4491 * @param string $additionalFromClause
4492 * Should be clause with proper joins, effective to reduce where clause load.
4494 * @param bool $skipOrderAndLimit
4496 * @return CRM_Core_DAO
4498 public function searchQuery(
4499 $offset = 0, $rowCount = 0, $sort = NULL,
4500 $count = FALSE, $includeContactIds = FALSE,
4501 $sortByChar = FALSE, $groupContacts = FALSE,
4502 $returnQuery = FALSE,
4503 $additionalWhereClause = NULL, $sortOrder = NULL,
4504 $additionalFromClause = NULL, $skipOrderAndLimit = FALSE
4507 if ($includeContactIds) {
4508 $this->_includeContactIds
= TRUE;
4509 $this->_whereClause
= $this->whereClause();
4512 $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
);
4514 // if we’re explicitly looking for a certain contact’s contribs, events, etc.
4515 // and that contact happens to be deleted, set $onlyDeleted to true
4516 foreach ($this->_params
as $values) {
4517 $name = CRM_Utils_Array
::value(0, $values);
4518 $op = CRM_Utils_Array
::value(1, $values);
4519 $value = CRM_Utils_Array
::value(2, $values);
4520 if ($name == 'contact_id' and $op == '=') {
4521 if (CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'is_deleted')) {
4522 $onlyDeleted = TRUE;
4528 // building the query string
4531 if (isset($this->_groupByComponentClause
)) {
4532 $groupBy = $this->_groupByComponentClause
;
4534 elseif ($this->_useGroupBy
) {
4535 $groupBy = ' GROUP BY contact_a.id';
4538 if ($this->_mode
& CRM_Contact_BAO_Query
::MODE_ACTIVITY
&& (!$count)) {
4539 $groupBy = 'GROUP BY civicrm_activity.id ';
4542 $order = $orderBy = $limit = '';
4544 $config = CRM_Core_Config
::singleton();
4545 if ($config->includeOrderByClause ||
4546 isset($this->_distinctComponentClause
)
4549 if (is_string($sort)) {
4553 $orderBy = trim($sort->orderBy());
4555 if (!empty($orderBy)) {
4556 // this is special case while searching for
4557 // change log CRM-1718
4558 if (preg_match('/sort_name/i', $orderBy)) {
4559 $orderBy = str_replace('sort_name', 'contact_a.sort_name', $orderBy);
4562 $orderBy = CRM_Utils_Type
::escape($orderBy, 'String');
4563 $order = " ORDER BY $orderBy";
4566 $sortOrder = CRM_Utils_Type
::escape($sortOrder, 'String');
4567 $order .= " $sortOrder";
4570 // always add contact_a.id to the ORDER clause
4571 // so the order is deterministic
4572 if (strpos('contact_a.id', $order) === FALSE) {
4573 $order .= ", contact_a.id";
4577 elseif ($sortByChar) {
4578 $order = " ORDER BY UPPER(LEFT(contact_a.sort_name, 1)) asc";
4581 $order = " ORDER BY contact_a.sort_name asc, contact_a.id";
4585 // hack for order clause
4587 $fieldStr = trim(str_replace('ORDER BY', '', $order));
4588 $fieldOrder = explode(' ', $fieldStr);
4589 $field = $fieldOrder[0];
4595 $this->_whereTables
["civicrm_address"] = 1;
4596 $order = str_replace($field, "civicrm_address.{$field}", $order);
4600 case 'state_province':
4601 $this->_whereTables
["civicrm_{$field}"] = 1;
4602 $order = str_replace($field, "civicrm_{$field}.name", $order);
4606 $this->_whereTables
["civicrm_email"] = 1;
4607 $order = str_replace($field, "civicrm_email.{$field}", $order);
4611 //CRM-12565 add "`" around $field if it is a pseudo constant
4612 foreach ($this->_pseudoConstantsSelect
as $key => $value) {
4613 if (!empty($value['element']) && $value['element'] == $field) {
4614 $order = str_replace($field, "`{$field}`", $order);
4618 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4619 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4623 if ($rowCount > 0 && $offset >= 0) {
4624 $offset = CRM_Utils_Type
::escape($offset, 'Int');
4625 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
4626 $limit = " LIMIT $offset, $rowCount ";
4631 $this->_sort
= $sort;
4633 list($select, $from, $where, $having) = $this->query($count, $sortByChar, $groupContacts, $onlyDeleted);
4635 if ($additionalWhereClause) {
4636 $where = $where . ' AND ' . $additionalWhereClause;
4639 //additional from clause should be w/ proper joins.
4640 if ($additionalFromClause) {
4641 $from .= "\n" . $additionalFromClause;
4644 // if we are doing a transform, do it here
4645 // use the $from, $where and $having to get the contact ID
4646 if ($this->_displayRelationshipType
) {
4647 $this->filterRelatedContacts($from, $where, $having);
4650 if ($skipOrderAndLimit) {
4651 $query = "$select $from $where $having $groupBy";
4654 $query = "$select $from $where $having $groupBy $order $limit";
4661 return CRM_Core_DAO
::singleValueQuery($query);
4664 $dao = CRM_Core_DAO
::executeQuery($query);
4665 if ($groupContacts) {
4667 while ($dao->fetch()) {
4670 return implode(',', $ids);
4677 * Fetch a list of contacts from the prev/next cache for displaying a search results page
4679 * @param string $cacheKey
4680 * @param int $offset
4681 * @param int $rowCount
4682 * @param bool $includeContactIds
4683 * @return CRM_Core_DAO
4685 public function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
4686 $this->_includeContactIds
= $includeContactIds;
4687 $onlyDeleted = in_array(array('deleted_contacts', '=', '1', '0', '0'), $this->_params
);
4688 list($select, $from, $where) = $this->query(FALSE, FALSE, FALSE, $onlyDeleted);
4689 $from = " FROM civicrm_prevnext_cache pnc INNER JOIN civicrm_contact contact_a ON contact_a.id = pnc.entity_id1 AND pnc.cacheKey = '$cacheKey' " . substr($from, 31);
4690 $order = " ORDER BY pnc.id";
4691 $groupBy = " GROUP BY contact_a.id";
4692 $limit = " LIMIT $offset, $rowCount";
4693 $query = "$select $from $where $groupBy $order $limit";
4695 return CRM_Core_DAO
::executeQuery($query);
4699 * Populate $this->_permissionWhereClause with permission related clause and update other
4700 * query related properties.
4702 * Function calls ACL permission class and hooks to filter the query appropriately
4704 * Note that these 2 params were in the code when extracted from another function
4705 * and a second round extraction would be to make them properties of the class
4707 * @param bool $onlyDeleted
4708 * Only get deleted contacts.
4709 * @param bool $count
4710 * Return Count only.
4712 public function generatePermissionClause($onlyDeleted = FALSE, $count = FALSE) {
4713 if (!$this->_skipPermission
) {
4714 $this->_permissionWhereClause
= CRM_ACL_API
::whereClause(
4715 CRM_Core_Permission
::VIEW
,
4717 $this->_whereTables
,
4720 $this->_skipDeleteClause
4723 // regenerate fromClause since permission might have added tables
4724 if ($this->_permissionWhereClause
) {
4725 //fix for row count in qill (in contribute/membership find)
4727 $this->_useDistinct
= TRUE;
4730 $this->_fromClause
= self
::fromClause($this->_tables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4731 $this->_simpleFromClause
= self
::fromClause($this->_whereTables
, NULL, NULL, $this->_primaryLocation
, $this->_mode
);
4732 // note : this modifies _fromClause and _simpleFromClause
4733 $this->includePseudoFieldsJoin($this->_sort
);
4737 // add delete clause if needed even if we are skipping permission
4739 if (!$this->_skipDeleteClause
) {
4740 if (CRM_Core_Permission
::check('access deleted contacts') and $onlyDeleted) {
4741 $this->_permissionWhereClause
= '(contact_a.is_deleted)';
4745 $this->_permissionWhereClause
= '(contact_a.is_deleted = 0)';
4754 public function setSkipPermission($val) {
4755 $this->_skipPermission
= $val;
4759 * @param null $context
4763 public function &summaryContribution($context = NULL) {
4764 list($innerselect, $from, $where, $having) = $this->query(TRUE);
4768 SELECT COUNT( conts.total_amount ) as total_count,
4769 SUM( conts.total_amount ) as total_amount,
4770 AVG( conts.total_amount ) as total_avg,
4771 conts.total_amount as amount,
4772 conts.currency as currency";
4773 if ($this->_permissionWhereClause
) {
4774 $where .= " AND " . $this->_permissionWhereClause
;
4776 if ($context == 'search') {
4777 $where .= " AND contact_a.is_deleted = 0 ";
4780 // make sure contribution is completed - CRM-4989
4781 $completedWhere = $where . " AND civicrm_contribution.contribution_status_id = 1 ";
4784 $summary['total'] = array();
4785 $summary['total']['count'] = $summary['total']['amount'] = $summary['total']['avg'] = "n/a";
4786 $innerQuery = "SELECT civicrm_contribution.total_amount, COUNT(civicrm_contribution.total_amount) as civicrm_contribution_total_amount_count,
4787 civicrm_contribution.currency $from $completedWhere";
4789 $query = "$select FROM (
4790 $innerQuery GROUP BY civicrm_contribution.id
4794 $dao = CRM_Core_DAO
::executeQuery($query);
4796 $summary['total']['count'] = 0;
4797 $summary['total']['amount'] = $summary['total']['avg'] = array();
4798 while ($dao->fetch()) {
4799 $summary['total']['count'] +
= $dao->total_count
;
4800 $summary['total']['amount'][] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
4801 $summary['total']['avg'][] = CRM_Utils_Money
::format($dao->total_avg
, $dao->currency
);
4804 $orderBy = 'ORDER BY civicrm_contribution_total_amount_count DESC';
4805 $groupBy = 'GROUP BY currency, civicrm_contribution.total_amount';
4806 $modeSQL = "$select, conts.civicrm_contribution_total_amount_count as civicrm_contribution_total_amount_count FROM ($innerQuery
4807 $groupBy $orderBy) as conts
4810 $summary['total']['mode'] = CRM_Contribute_BAO_Contribution
::computeStats('mode', $modeSQL);
4812 $medianSQL = "{$from} {$completedWhere}";
4813 $summary['total']['median'] = CRM_Contribute_BAO_Contribution
::computeStats('median', $medianSQL, 'civicrm_contribution');
4814 $summary['total']['currencyCount'] = count($summary['total']['median']);
4816 if (!empty($summary['total']['amount'])) {
4817 $summary['total']['amount'] = implode(', ', $summary['total']['amount']);
4818 $summary['total']['avg'] = implode(', ', $summary['total']['avg']);
4819 $summary['total']['mode'] = implode(', ', $summary['total']['mode']);
4820 $summary['total']['median'] = implode(', ', $summary['total']['median']);
4823 $summary['total']['amount'] = $summary['total']['avg'] = $summary['total']['median'] = 0;
4826 // soft credit summary
4827 if (CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled()) {
4828 $softCreditWhere = "{$completedWhere} AND civicrm_contribution_soft.id IS NOT NULL";
4831 SELECT civicrm_contribution_soft.amount as total_amount, civicrm_contribution_soft.currency $from $softCreditWhere
4832 GROUP BY civicrm_contribution_soft.id
4835 $dao = CRM_Core_DAO
::executeQuery($query);
4836 $summary['soft_credit']['count'] = 0;
4837 $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = array();
4838 while ($dao->fetch()) {
4839 $summary['soft_credit']['count'] +
= $dao->total_count
;
4840 $summary['soft_credit']['amount'][] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
4841 $summary['soft_credit']['avg'][] = CRM_Utils_Money
::format($dao->total_avg
, $dao->currency
);
4843 if (!empty($summary['soft_credit']['amount'])) {
4844 $summary['soft_credit']['amount'] = implode(', ', $summary['soft_credit']['amount']);
4845 $summary['soft_credit']['avg'] = implode(', ', $summary['soft_credit']['avg']);
4848 $summary['soft_credit']['amount'] = $summary['soft_credit']['avg'] = 0;
4853 //@todo - this could be one query using the IF in mysql - eg
4854 // SELECT sum(total_completed), sum(count_completed), sum(count_cancelled), sum(total_cancelled) FROM (
4855 // SELECT civicrm_contribution.total_amount, civicrm_contribution.currency ,
4856 // IF(civicrm_contribution.contribution_status_id = 1, 1, 0 ) as count_completed,
4857 // IF(civicrm_contribution.contribution_status_id = 1, total_amount, 0 ) as total_completed,
4858 // IF(civicrm_contribution.cancel_date IS NOT NULL = 1, 1, 0 ) as count_cancelled,
4859 // IF(civicrm_contribution.cancel_date IS NOT NULL = 1, total_amount, 0 ) as total_cancelled
4860 // FROM civicrm_contact contact_a
4861 // LEFT JOIN civicrm_contribution ON civicrm_contribution.contact_id = contact_a.id
4862 // WHERE ( ... where clause....
4863 // AND (civicrm_contribution.cancel_date IS NOT NULL OR civicrm_contribution.contribution_status_id = 1)
4867 SELECT COUNT( conts.total_amount ) as cancel_count,
4868 SUM( conts.total_amount ) as cancel_amount,
4869 AVG( conts.total_amount ) as cancel_avg,
4870 conts.currency as currency";
4872 $where .= " AND civicrm_contribution.cancel_date IS NOT NULL ";
4873 if ($context == 'search') {
4874 $where .= " AND contact_a.is_deleted = 0 ";
4877 $query = "$select FROM (
4878 SELECT civicrm_contribution.total_amount, civicrm_contribution.currency $from $where
4879 GROUP BY civicrm_contribution.id
4883 $dao = CRM_Core_DAO
::executeQuery($query);
4886 if ($dao->fetch()) {
4887 $summary['cancel']['count'] = $dao->cancel_count
;
4888 $summary['cancel']['amount'] = $dao->cancel_amount
;
4889 $summary['cancel']['avg'] = $dao->cancel_avg
;
4893 $summary['cancel']['count'] = 0;
4894 $summary['cancel']['amount'] = $summary['cancel']['avg'] = array();
4895 while ($dao->fetch()) {
4896 $summary['cancel']['count'] +
= $dao->cancel_count
;
4897 $summary['cancel']['amount'][] = CRM_Utils_Money
::format($dao->cancel_amount
, $dao->currency
);
4898 $summary['cancel']['avg'][] = CRM_Utils_Money
::format($dao->cancel_avg
, $dao->currency
);
4900 $summary['cancel']['amount'] = implode(', ', $summary['cancel']['amount']);
4901 $summary['cancel']['avg'] = implode(', ', $summary['cancel']['avg']);
4908 * Getter for the qill object.
4912 public function qill() {
4913 return $this->_qill
;
4917 * Default set of return default hier return properties.
4921 public static function &defaultHierReturnProperties() {
4922 if (!isset(self
::$_defaultHierReturnProperties)) {
4923 self
::$_defaultHierReturnProperties = array(
4926 'legal_identifier' => 1,
4927 'external_identifier' => 1,
4928 'contact_type' => 1,
4929 'contact_sub_type' => 1,
4931 'display_name' => 1,
4938 'formal_title' => 1,
4939 'communication_style_id' => 1,
4940 'email_greeting' => 1,
4941 'postal_greeting' => 1,
4945 'preferred_communication_method' => 1,
4946 'do_not_phone' => 1,
4947 'do_not_email' => 1,
4950 'do_not_trade' => 1,
4951 'location' => array(
4953 'location_type' => 1,
4954 'street_address' => 1,
4956 'state_province' => 1,
4958 'postal_code_suffix' => 1,
4961 'phone-Mobile' => 1,
4974 'location_type' => 1,
4975 'street_address' => 1,
4977 'state_province' => 1,
4979 'postal_code_suffix' => 1,
4982 'phone-Mobile' => 1,
4996 return self
::$_defaultHierReturnProperties;
5000 * Build query for a date field.
5002 * @param array $values
5003 * @param string $tableName
5004 * @param string $fieldName
5005 * @param string $dbFieldName
5006 * @param string $fieldTitle
5007 * @param bool $appendTimeStamp
5009 public function dateQueryBuilder(
5010 &$values, $tableName, $fieldName,
5011 $dbFieldName, $fieldTitle,
5012 $appendTimeStamp = TRUE
5014 list($name, $op, $value, $grouping, $wildcard) = $values;
5016 if ($name == "{$fieldName}_low" ||
5017 $name == "{$fieldName}_high"
5019 if (isset($this->_rangeCache
[$fieldName]) ||
!$value) {
5022 $this->_rangeCache
[$fieldName] = 1;
5024 $secondOP = $secondPhrase = $secondValue = $secondDate = $secondDateFormat = NULL;
5026 if ($name == $fieldName . '_low') {
5028 $firstPhrase = ts('greater than or equal to');
5029 $firstDate = CRM_Utils_Date
::processDate($value);
5031 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5032 if (!empty($secondValues) && $secondValues[2]) {
5034 $secondPhrase = ts('less than or equal to');
5035 $secondValue = $secondValues[2];
5037 if ($appendTimeStamp && strlen($secondValue) == 10) {
5038 $secondValue .= ' 23:59:59';
5040 $secondDate = CRM_Utils_Date
::processDate($secondValue);
5043 elseif ($name == $fieldName . '_high') {
5045 $firstPhrase = ts('less than or equal to');
5047 if ($appendTimeStamp && strlen($value) == 10) {
5048 $value .= ' 23:59:59';
5050 $firstDate = CRM_Utils_Date
::processDate($value);
5052 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5053 if (!empty($secondValues) && $secondValues[2]) {
5055 $secondPhrase = ts('greater than or equal to');
5056 $secondValue = $secondValues[2];
5057 $secondDate = CRM_Utils_Date
::processDate($secondValue);
5061 if (!$appendTimeStamp) {
5062 $firstDate = substr($firstDate, 0, 8);
5064 $firstDateFormat = CRM_Utils_Date
::customFormat($firstDate);
5067 if (!$appendTimeStamp) {
5068 $secondDate = substr($secondDate, 0, 8);
5070 $secondDateFormat = CRM_Utils_Date
::customFormat($secondDate);
5073 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5075 $this->_where
[$grouping][] = "
5076 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5077 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5079 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\" " . ts('AND') . " $secondPhrase \"$secondDateFormat\"";
5082 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5083 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$firstDateFormat\"";
5087 if ($name == $fieldName) {
5088 //In Get API, for operators other then '=' the $value is in array(op => value) format
5089 if (is_array($value) && !empty($value) && in_array(key($value), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
5091 $value = $value[$op];
5094 $date = $format = NULL;
5095 if (strstr($op, 'IN')) {
5097 foreach ($value as &$date) {
5098 $date = CRM_Utils_Date
::processDate($date);
5099 if (!$appendTimeStamp) {
5100 $date = substr($date, 0, 8);
5102 $format[] = CRM_Utils_Date
::customFormat($date);
5104 $date = "('" . implode("','", $value) . "')";
5105 $format = implode(', ', $format);
5107 elseif ($value && (!strstr($op, 'NULL') && !strstr($op, 'EMPTY'))) {
5108 $date = CRM_Utils_Date
::processDate($value);
5109 if (!$appendTimeStamp) {
5110 $date = substr($date, 0, 8);
5112 $format = CRM_Utils_Date
::customFormat($date);
5117 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op $date";
5120 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op";
5123 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5125 $op = CRM_Utils_Array
::value($op, CRM_Core_SelectValues
::getSearchBuilderOperators(), $op);
5126 $this->_qill
[$grouping][] = "$fieldTitle $op $format";
5132 * @param string $tableName
5133 * @param string $fieldName
5134 * @param string $dbFieldName
5135 * @param $fieldTitle
5136 * @param null $options
5138 public function numberRangeBuilder(
5140 $tableName, $fieldName,
5141 $dbFieldName, $fieldTitle,
5144 list($name, $op, $value, $grouping, $wildcard) = $values;
5146 if ($name == "{$fieldName}_low" ||
5147 $name == "{$fieldName}_high"
5149 if (isset($this->_rangeCache
[$fieldName])) {
5152 $this->_rangeCache
[$fieldName] = 1;
5154 $secondOP = $secondPhrase = $secondValue = NULL;
5156 if ($name == "{$fieldName}_low") {
5158 $firstPhrase = ts('greater than');
5160 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5161 if (!empty($secondValues)) {
5163 $secondPhrase = ts('less than');
5164 $secondValue = $secondValues[2];
5169 $firstPhrase = ts('less than');
5171 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5172 if (!empty($secondValues)) {
5174 $secondPhrase = ts('greater than');
5175 $secondValue = $secondValues[2];
5180 $this->_where
[$grouping][] = "
5181 ( {$tableName}.{$dbFieldName} $firstOP {$value} ) AND
5182 ( {$tableName}.{$dbFieldName} $secondOP {$secondValue} )
5184 $displayValue = $options ?
$options[$value] : $value;
5185 $secondDisplayValue = $options ?
$options[$secondValue] : $secondValue;
5187 $this->_qill
[$grouping][]
5188 = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5191 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP {$value}";
5192 $displayValue = $options ?
$options[$value] : $value;
5193 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5195 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5200 if ($name == $fieldName) {
5204 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $op {$value}";
5206 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5207 $displayValue = $options ?
$options[$value] : $value;
5208 $this->_qill
[$grouping][] = "$fieldTitle - $phrase \"$displayValue\"";
5215 * @param string $tableName
5216 * @param string $fieldName
5217 * @param string $dbFieldName
5218 * @param $fieldTitle
5219 * @param null $options
5221 public function ageRangeQueryBuilder(
5223 $tableName, $fieldName,
5224 $dbFieldName, $fieldTitle,
5227 list($name, $op, $value, $grouping, $wildcard) = $values;
5229 $asofDateValues = $this->getWhereValues("{$fieldName}_asof_date", $grouping);
5230 $asofDate = NULL; // will be treated as current day
5231 if ($asofDateValues) {
5232 $asofDate = CRM_Utils_Date
::processDate($asofDateValues[2]);
5233 $asofDateFormat = CRM_Utils_Date
::customFormat(substr($asofDate, 0, 8));
5234 $fieldTitle .= ' ' . ts('as of') . ' ' . $asofDateFormat;
5237 if ($name == "{$fieldName}_low" ||
5238 $name == "{$fieldName}_high"
5240 if (isset($this->_rangeCache
[$fieldName])) {
5243 $this->_rangeCache
[$fieldName] = 1;
5245 $secondOP = $secondPhrase = $secondValue = NULL;
5247 if ($name == "{$fieldName}_low") {
5248 $firstPhrase = ts('greater than or equal to');
5249 // NB: age > X means date of birth < Y
5251 $firstDate = self
::calcDateFromAge($asofDate, $value, 'min');
5253 $secondValues = $this->getWhereValues("{$fieldName}_high", $grouping);
5254 if (!empty($secondValues)) {
5256 $secondPhrase = ts('less than or equal to');
5257 $secondValue = $secondValues[2];
5258 $secondDate = self
::calcDateFromAge($asofDate, $secondValue, 'max');
5263 $firstPhrase = ts('less than or equal to');
5264 $firstDate = self
::calcDateFromAge($asofDate, $value, 'max');
5266 $secondValues = $this->getWhereValues("{$fieldName}_low", $grouping);
5267 if (!empty($secondValues)) {
5269 $secondPhrase = ts('greater than or equal to');
5270 $secondValue = $secondValues[2];
5271 $secondDate = self
::calcDateFromAge($asofDate, $secondValue, 'min');
5276 $this->_where
[$grouping][] = "
5277 ( {$tableName}.{$dbFieldName} $firstOP '$firstDate' ) AND
5278 ( {$tableName}.{$dbFieldName} $secondOP '$secondDate' )
5280 $displayValue = $options ?
$options[$value] : $value;
5281 $secondDisplayValue = $options ?
$options[$secondValue] : $secondValue;
5283 $this->_qill
[$grouping][]
5284 = "$fieldTitle - $firstPhrase \"$displayValue\" " . ts('AND') . " $secondPhrase \"$secondDisplayValue\"";
5287 $this->_where
[$grouping][] = "{$tableName}.{$dbFieldName} $firstOP '$firstDate'";
5288 $displayValue = $options ?
$options[$value] : $value;
5289 $this->_qill
[$grouping][] = "$fieldTitle - $firstPhrase \"$displayValue\"";
5291 $this->_tables
[$tableName] = $this->_whereTables
[$tableName] = 1;
5296 public static function calcDateFromAge($asofDate, $age, $type) {
5297 $date = new DateTime($asofDate);
5298 if ($type == "min") {
5299 // minimum age is $age: dob <= date - age "235959"
5300 $date->sub(new DateInterval("P" . $age . "Y"));
5301 return $date->format('Ymd') . "235959";
5304 // max age is $age: dob >= date - (age + 1y) + 1d "000000"
5305 $date->sub(new DateInterval("P" . ($age +
1) . "Y"))->add(new DateInterval("P1D"));
5306 return $date->format('Ymd') . "000000";
5311 * Given the field name, operator, value & its data type
5312 * builds the where Clause for the query
5313 * used for handling 'IS NULL'/'IS NOT NULL' operators
5315 * @param string $field
5319 * @param string $value
5321 * @param string $dataType
5322 * Data type of the field.
5325 * Where clause for the query.
5327 public static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
5329 $clause = "$field $op";
5337 $clause = " (NULLIF($field, '') IS NULL) ";
5340 case 'IS NOT EMPTY':
5341 $clause = " (NULLIF($field, '') IS NOT NULL) ";
5346 // I feel like this would be escaped properly if passed through $queryString = CRM_Core_DAO::createSqlFilter.
5347 if (!empty($value) && is_array($value) && !array_key_exists($op, $value)) {
5348 $value = array($op => $value);
5352 if (empty($dataType)) {
5353 $dataType = 'String';
5355 if (is_array($value)) {
5356 //this could have come from the api - as in the restWhere section we potentially use the api operator syntax which is becoming more
5357 // widely used and consistent across the codebase
5358 // adding this here won't accept the search functions which don't submit an array
5359 if (($queryString = CRM_Core_DAO
::createSqlFilter($field, $value, $dataType)) != FALSE) {
5361 return $queryString;
5364 // This is the here-be-dragons zone. We have no other hopes left for an array so lets assume it 'should' be array('IN' => array(2,5))
5365 // but we got only array(2,5) from the form.
5366 // We could get away with keeping this in 4.6 if we make it such that it throws an enotice in 4.7 so
5367 // people have to de-slopify it.
5368 if (!empty($value[0])) {
5369 $dragonPlace = $iAmAnIntentionalENoticeThatWarnsOfAProblemYouShouldReport;
5370 if (($queryString = CRM_Core_DAO
::createSqlFilter($field, array($op => $value), $dataType)) != FALSE) {
5371 return $queryString;
5376 $dragonPlace = $iAmAnIntentionalENoticeThatWarnsOfAProblemYouShouldReportUsingOldFormat;
5377 if (($queryString = CRM_Core_DAO
::createSqlFilter($field, array($op => array_keys($value)), $dataType)) != FALSE) {
5378 return $queryString;
5383 $value = CRM_Utils_Type
::escape($value, $dataType);
5384 // if we don't have a dataType we should assume
5385 if ($dataType == 'String' ||
$dataType == 'Text') {
5386 $value = "'" . strtolower($value) . "'";
5388 return "$clause $value";
5393 * @param bool $reset
5397 public function openedSearchPanes($reset = FALSE) {
5398 if (!$reset ||
empty($this->_whereTables
)) {
5399 return self
::$_openedPanes;
5402 // pane name to table mapper
5403 $panesMapper = array(
5404 ts('Contributions') => 'civicrm_contribution',
5405 ts('Memberships') => 'civicrm_membership',
5406 ts('Events') => 'civicrm_participant',
5407 ts('Relationships') => 'civicrm_relationship',
5408 ts('Activities') => 'civicrm_activity',
5409 ts('Pledges') => 'civicrm_pledge',
5410 ts('Cases') => 'civicrm_case',
5411 ts('Grants') => 'civicrm_grant',
5412 ts('Address Fields') => 'civicrm_address',
5413 ts('Notes') => 'civicrm_note',
5414 ts('Change Log') => 'civicrm_log',
5415 ts('Mailings') => 'civicrm_mailing_event_queue',
5417 CRM_Contact_BAO_Query_Hook
::singleton()->getPanesMapper($panesMapper);
5419 foreach (array_keys($this->_whereTables
) as $table) {
5420 if ($panName = array_search($table, $panesMapper)) {
5421 self
::$_openedPanes[$panName] = TRUE;
5425 return self
::$_openedPanes;
5431 public function setOperator($operator) {
5432 $validOperators = array('AND', 'OR');
5433 if (!in_array($operator, $validOperators)) {
5436 $this->_operator
= $operator;
5442 public function getOperator() {
5443 return $this->_operator
;
5451 public function filterRelatedContacts(&$from, &$where, &$having) {
5452 static $_rTypeProcessed = NULL;
5453 static $_rTypeFrom = NULL;
5454 static $_rTypeWhere = NULL;
5456 if (!$_rTypeProcessed) {
5457 $_rTypeProcessed = TRUE;
5459 // create temp table with contact ids
5460 $tableName = CRM_Core_DAO
::createTempTableName('civicrm_transform', TRUE);
5461 $sql = "CREATE TEMPORARY TABLE $tableName ( contact_id int primary key) ENGINE=HEAP";
5462 CRM_Core_DAO
::executeQuery($sql);
5465 REPLACE INTO $tableName ( contact_id )
5471 CRM_Core_DAO
::executeQuery($sql);
5473 $qillMessage = ts('Contacts with a Relationship Type of: ');
5474 $rTypes = CRM_Core_PseudoConstant
::relationshipType();
5476 if (is_numeric($this->_displayRelationshipType
)) {
5477 $relationshipTypeLabel = $rTypes[$this->_displayRelationshipType
]['label_a_b'];
5479 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id OR displayRelType.contact_id_b = contact_a.id )
5480 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a OR transform_temp.contact_id = displayRelType.contact_id_b )
5483 WHERE displayRelType.relationship_type_id = {$this->_displayRelationshipType}
5484 AND displayRelType.is_active = 1
5488 list($relType, $dirOne, $dirTwo) = explode('_', $this->_displayRelationshipType
);
5489 if ($dirOne == 'a') {
5490 $relationshipTypeLabel = $rTypes[$relType]['label_a_b'];
5492 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_a = contact_a.id )
5493 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_b )
5497 $relationshipTypeLabel = $rTypes[$relType]['label_b_a'];
5499 INNER JOIN civicrm_relationship displayRelType ON ( displayRelType.contact_id_b = contact_a.id )
5500 INNER JOIN $tableName transform_temp ON ( transform_temp.contact_id = displayRelType.contact_id_a )
5504 WHERE displayRelType.relationship_type_id = $relType
5505 AND displayRelType.is_active = 1
5508 $this->_qill
[0][] = $qillMessage . "'" . $relationshipTypeLabel . "'";
5511 if (!empty($this->_permissionWhereClause
)) {
5512 $_rTypeWhere .= "AND $this->_permissionWhereClause";
5515 if (strpos($from, $_rTypeFrom) === FALSE) {
5516 // lets replace all the INNER JOIN's in the $from so we dont exclude other data
5517 // this happens when we have an event_type in the quert (CRM-7969)
5518 $from = str_replace("INNER JOIN", "LEFT JOIN", $from);
5519 $from .= $_rTypeFrom;
5520 $where = $_rTypeWhere;
5531 public static function caseImportant($op) {
5533 in_array($op, array('LIKE', 'IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) ?
FALSE : TRUE;
5537 * @param $returnProperties
5542 public static function componentPresent(&$returnProperties, $prefix) {
5543 foreach ($returnProperties as $name => $dontCare) {
5544 if (substr($name, 0, strlen($prefix)) == $prefix) {
5552 * Builds the necessary structures for all fields that are similar to option value look-ups.
5554 * @param string $name
5555 * the name of the field.
5557 * the sql operator, this function should handle ALL SQL operators.
5558 * @param string $value
5559 * depends on the operator and who's calling the query builder.
5560 * @param int $grouping
5561 * the index where to place the where clause.
5562 * @param $selectValues
5563 * The key value pairs for this element. This allows us to use this function for things besides option-value pairs.
5564 * @param array $field
5565 * an array that contains various properties of the field identified by $name.
5566 * @param string $label
5567 * The label for this field element.
5568 * @param string $dataType
5569 * The data type for this element.
5570 * @param bool $useIDsOnly
5572 public function optionValueQuery(
5580 $dataType = 'String',
5584 $pseudoFields = array(
5591 'communication_style_id',
5595 list($tableName, $fieldName) = explode('.', $field['where'], 2);
5596 if ($tableName == 'civicrm_contact') {
5597 $wc = "contact_a.$fieldName";
5600 $wc = "$tableName.id";
5604 $wc = self
::caseImportant($op) ?
"LOWER({$field['where']})" : "{$field['where']}";
5606 if (in_array($name, $pseudoFields)) {
5607 if (!in_array($name, array('gender_id', 'prefix_id', 'suffix_id', 'communication_style_id'))) {
5608 $wc = "contact_a.{$name}_id";
5610 $dataType = 'Positive';
5611 $value = (!$value) ?
0 : $value;
5613 if ($name == "world_region") {
5614 $field['name'] = $name;
5617 list($qillop, $qillVal) = CRM_Contact_BAO_Query
::buildQillForFieldValue($daoName, $field['name'], $value, $op);
5618 $this->_qill
[$grouping][] = ts("%1 %2 %3", array(1 => $label, 2 => $qillop, 3 => $qillVal));
5619 $this->_where
[$grouping][] = self
::buildClause($wc, $op, $value, $dataType);
5623 * Check and explode a user defined numeric string into an array
5624 * this was the protocol used by search builder in the old old days before we had
5625 * super nice js widgets to do the hard work
5627 * @param string $string
5628 * @param string $dataType
5629 * The dataType we should check for the values, default integer.
5631 * @return bool|array
5632 * false if string does not match the pattern
5633 * array of numeric values if string does match the pattern
5635 public static function parseSearchBuilderString($string, $dataType = 'Integer') {
5636 $string = trim($string);
5637 if (substr($string, 0, 1) != '(' ||
substr($string, -1, 1) != ')') {
5641 $string = substr($string, 1, -1);
5642 $values = explode(',', $string);
5643 if (empty($values)) {
5647 $returnValues = array();
5648 foreach ($values as $v) {
5649 if ($dataType == 'Integer' && !is_numeric($v)) {
5652 elseif ($dataType == 'String' && !is_string($v)) {
5655 $returnValues[] = trim($v);
5658 if (empty($returnValues)) {
5662 return $returnValues;
5666 * Convert the pseudo constants id's to their names
5668 * @param CRM_Core_DAO $dao
5669 * @param bool $return
5670 * @param bool $usedForAPI
5672 * @return array|NULL
5674 public function convertToPseudoNames(&$dao, $return = FALSE, $usedForAPI = FALSE) {
5675 if (empty($this->_pseudoConstantsSelect
)) {
5679 foreach ($this->_pseudoConstantsSelect
as $key => $value) {
5680 if (!empty($this->_pseudoConstantsSelect
[$key]['sorting'])) {
5684 if (is_object($dao) && property_exists($dao, $value['idCol'])) {
5685 $val = $dao->$value['idCol'];
5687 if (CRM_Utils_System
::isNull($val)) {
5690 elseif ($baoName = CRM_Utils_Array
::value('bao', $value, NULL)) {
5692 $idColumn = "{$key}_id";
5693 $dao->$idColumn = $val;
5695 if ($key == 'state_province_name') {
5696 $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($val);
5699 $dao->$value['pseudoField'] = $dao->$key = CRM_Core_PseudoConstant
::getLabel($baoName, $value['pseudoField'], $val);
5702 elseif ($value['pseudoField'] == 'state_province_abbreviation') {
5703 $dao->$key = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($val);
5705 // FIX ME: we should potentially move this to component Query and write a wrapper function that
5706 // handles pseudoconstant fixes for all component
5707 elseif (in_array($value['pseudoField'], array('participant_role_id', 'participant_role'))) {
5708 $viewValues = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $val);
5710 if ($value['pseudoField'] == 'participant_role') {
5711 $pseudoOptions = CRM_Core_PseudoConstant
::get('CRM_Event_DAO_Participant', 'role_id');
5712 foreach ($viewValues as $k => $v) {
5713 $viewValues[$k] = $pseudoOptions[$v];
5716 $dao->$key = ($usedForAPI && count($viewValues) > 1) ?
$viewValues : implode(', ', $viewValues);
5719 $labels = CRM_Core_OptionGroup
::values($value['pseudoField']);
5720 $dao->$key = $labels[$val];
5723 // return converted values in array format
5725 if (strpos($key, '-') !== FALSE) {
5726 $keyVal = explode('-', $key);
5727 $current = &$values;
5728 $lastElement = array_pop($keyVal);
5729 foreach ($keyVal as $v) {
5730 if (!array_key_exists($v, $current)) {
5731 $current[$v] = array();
5733 $current = &$current[$v];
5735 $current[$lastElement] = $dao->$key;
5738 $values[$key] = $dao->$key;
5747 * Include pseudo fields LEFT JOIN.
5748 * @param string|array $sort can be a object or string
5750 * @return array|NULL
5752 public function includePseudoFieldsJoin($sort) {
5753 if (!$sort ||
empty($this->_pseudoConstantsSelect
)) {
5756 $sort = is_string($sort) ?
$sort : $sort->orderBy();
5759 foreach ($this->_pseudoConstantsSelect
as $name => $value) {
5760 if (!empty($value['table'])) {
5761 $regex = "/({$value['table']}\.|{$name})/";
5762 if (preg_match($regex, $sort)) {
5763 $this->_elemnt
[$value['element']] = 1;
5764 $this->_select
[$value['element']] = $value['select'];
5765 $this->_pseudoConstantsSelect
[$name]['sorting'] = 1;
5766 $present[$value['table']] = $value['join'];
5770 $presentSimpleFrom = $present;
5772 if (array_key_exists('civicrm_worldregion', $this->_whereTables
) &&
5773 array_key_exists('civicrm_country', $presentSimpleFrom)
5775 unset($presentSimpleFrom['civicrm_country']);
5777 if (array_key_exists('civicrm_worldregion', $this->_tables
) &&
5778 array_key_exists('civicrm_country', $present)
5780 unset($present['civicrm_country']);
5783 $presentClause = $presentSimpleFromClause = NULL;
5784 if (!empty($present)) {
5785 $presentClause = implode(' ', $present);
5787 if (!empty($presentSimpleFrom)) {
5788 $presentSimpleFromClause = implode(' ', $presentSimpleFrom);
5791 $this->_fromClause
= $this->_fromClause
. $presentClause;
5792 $this->_simpleFromClause
= $this->_simpleFromClause
. $presentSimpleFromClause;
5794 return array($presentClause, $presentSimpleFromClause);
5798 * Build qill for field.
5800 * Qill refers to the query detail visible on the UI.
5802 * @param string $daoName
5803 * @param string $fieldName
5804 * @param mixed $fieldValue
5806 * @param array $pseudoExtraParam
5808 * Type of the field per CRM_Utils_Type
5812 public static function buildQillForFieldValue(
5817 $pseudoExtraParam = array(),
5818 $type = CRM_Utils_Type
::T_STRING
5820 $qillOperators = CRM_Core_SelectValues
::getSearchBuilderOperators();
5822 // if Operator chosen is NULL/EMPTY then
5823 if (strpos($op, 'NULL') !== FALSE ||
strpos($op, 'EMPTY') !== FALSE) {
5824 return array(CRM_Utils_Array
::value($op, $qillOperators, $op), '');
5827 if ($fieldName == 'activity_type_id') {
5828 $pseudoOptions = CRM_Core_PseudoConstant
::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
5830 elseif ($fieldName == 'country_id') {
5831 $pseduoOptions = CRM_Core_PseudoConstant
::country();
5833 elseif ($fieldName == 'county_id') {
5834 $pseduoOptions = CRM_Core_PseudoConstant
::county();
5836 elseif ($fieldName == 'world_region') {
5837 $pseduoOptions = CRM_Core_PseudoConstant
::worldRegion();
5839 elseif ($daoName == 'CRM_Event_DAO_Event' && $fieldName == 'id') {
5840 $pseudoOptions = CRM_Event_BAO_Event
::getEvents(0, $fieldValue, TRUE, TRUE, TRUE);
5842 elseif ($fieldName == 'contribution_product_id') {
5843 $pseudoOptions = CRM_Contribute_PseudoConstant
::products();
5845 elseif ($daoName == 'CRM_Contact_DAO_Group' && $fieldName == 'id') {
5846 $pseudoOptions = CRM_Core_PseudoConstant
::group();
5848 elseif ($fieldName == 'country_id') {
5849 $pseudoOptions = CRM_Core_PseudoConstant
::country();
5852 $pseudoOptions = CRM_Core_PseudoConstant
::get($daoName, $fieldName, $pseudoExtraParam);
5855 //API usually have fieldValue format as array(operator => array(values)),
5856 //so we need to separate operator out of fieldValue param
5857 if (is_array($fieldValue) && in_array(key($fieldValue), CRM_Core_DAO
::acceptedSQLOperators(), TRUE)) {
5858 $op = key($fieldValue);
5859 $fieldValue = $fieldValue[$op];
5862 if (is_array($fieldValue)) {
5863 $qillString = array();
5864 if (!empty($pseudoOptions)) {
5865 foreach ((array) $fieldValue as $val) {
5866 $qillString[] = CRM_Utils_Array
::value($val, $pseudoOptions, $val);
5868 $fieldValue = implode(', ', $qillString);
5871 if ($type == CRM_Utils_Type
::T_DATE
) {
5872 foreach ($fieldValue as $index => $value) {
5873 $fieldValue[$index] = CRM_Utils_Date
::customFormat($value);
5877 // @todo - this is a bit specific (one operator).
5878 // However it is covered by a unit test so can be altered later with
5880 if ($op == 'BETWEEN') {
5881 $separator = ' AND ';
5883 $fieldValue = implode($separator, $fieldValue);
5886 elseif (!empty($pseudoOptions) && array_key_exists($fieldValue, $pseudoOptions)) {
5887 $fieldValue = $pseudoOptions[$fieldValue];
5889 elseif ($type === CRM_Utils_Type
::T_DATE
) {
5890 $fieldValue = CRM_Utils_Date
::customFormat($fieldValue);
5893 return array(CRM_Utils_Array
::value($op, $qillOperators, $op), $fieldValue);