3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * Class is to retrieve and display a range of contacts that match the given criteria.
37 * It is specifically for results of advanced search options.
39 class CRM_Contact_Selector
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
41 const CACHE_SIZE
= 500;
44 * This defines two actions- View and Edit.
48 static $_links = NULL;
51 * We use desc to remind us what that column is, name is used in the tpl
55 static $_columnHeaders;
58 * Properties of contact we're interested in displaying
61 static $_properties = array(
84 * FormValues is the array returned by exportValues called on
85 * the HTML_QuickForm_Controller for that page.
96 protected $_contextMenu;
99 * Params is the array in a value used by the search query creator
106 * The return properties used for search
110 protected $_returnProperties;
113 * Represent the type of selector
119 protected $_searchContext;
122 * Query object for this selector.
124 * @var CRM_Contact_BAO_Query
129 * Get the query object for this selector.
131 * @return CRM_Contact_BAO_Query
133 public function getQueryObject() {
134 return $this->_query
;
142 protected $_ufGroupID;
145 * The public visible fields to be shown to the user
154 * @param $customSearchClass
155 * @param array $formValues
156 * Array of form values imported.
157 * @param array $params
158 * Array of parameters for query.
159 * @param null $returnProperties
160 * @param \const|int $action - action of search basic or advanced.
162 * @param bool $includeContactIds
163 * @param bool $searchDescendentGroups
164 * @param string $searchContext
165 * @param null $contextMenu
167 * @return CRM_Contact_Selector
169 public function __construct(
173 $returnProperties = NULL,
174 $action = CRM_Core_Action
::NONE
,
175 $includeContactIds = FALSE,
176 $searchDescendentGroups = TRUE,
177 $searchContext = 'search',
180 //don't build query constructor, if form is not submitted
181 $force = CRM_Utils_Request
::retrieve('force', 'Boolean');
182 if (empty($formValues) && !$force) {
186 // submitted form values
187 $this->_formValues
= &$formValues;
188 $this->_params
= &$params;
189 $this->_returnProperties
= &$returnProperties;
190 $this->_contextMenu
= &$contextMenu;
191 $this->_context
= $searchContext;
194 $this->_action
= $action;
196 $this->_searchContext
= $searchContext;
198 $this->_ufGroupID
= CRM_Utils_Array
::value('uf_group_id', $this->_formValues
);
200 if ($this->_ufGroupID
) {
201 $this->_fields
= CRM_Core_BAO_UFGroup
::getListingFields(CRM_Core_Action
::VIEW
,
202 CRM_Core_BAO_UFGroup
::PUBLIC_VISIBILITY |
203 CRM_Core_BAO_UFGroup
::LISTINGS_VISIBILITY
,
204 FALSE, $this->_ufGroupID
206 self
::$_columnHeaders = NULL;
208 $this->_customFields
= CRM_Core_BAO_CustomField
::getFieldsForImport('Individual');
210 $this->_returnProperties
= CRM_Contact_BAO_Contact
::makeHierReturnProperties($this->_fields
);
211 $this->_returnProperties
['contact_type'] = 1;
212 $this->_returnProperties
['contact_sub_type'] = 1;
213 $this->_returnProperties
['sort_name'] = 1;
216 $displayRelationshipType = CRM_Utils_Array
::value('display_relationship_type', $this->_formValues
);
217 $operator = CRM_Utils_Array
::value('operator', $this->_formValues
, 'AND');
219 // rectify params to what proximity search expects if there is a value for prox_distance
221 if (!empty($this->_params
)) {
222 CRM_Contact_BAO_ProximityQuery
::fixInputParams($this->_params
);
225 $this->_query
= new CRM_Contact_BAO_Query(
227 $this->_returnProperties
,
231 CRM_Contact_BAO_Query
::MODE_CONTACTS
,
233 $searchDescendentGroups,
235 $displayRelationshipType,
239 $this->_options
= &$this->_query
->_options
;
243 * This method set cache key, later used in test environment
247 public function setKey($key) {
252 * This method returns the links that are given for each search row.
253 * currently the links added for each row are
260 public static function &links() {
261 list($context, $contextMenu, $key) = func_get_args();
262 $extraParams = ($key) ?
"&key={$key}" : NULL;
263 $searchContext = ($context) ?
"&context=$context" : NULL;
265 if (!(self
::$_links)) {
266 self
::$_links = array(
267 CRM_Core_Action
::VIEW
=> array(
268 'name' => ts('View'),
269 'url' => 'civicrm/contact/view',
270 'class' => 'no-popup',
271 'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
272 'title' => ts('View Contact Details'),
273 'ref' => 'view-contact',
275 CRM_Core_Action
::UPDATE
=> array(
276 'name' => ts('Edit'),
277 'url' => 'civicrm/contact/add',
278 'class' => 'no-popup',
279 'qs' => "reset=1&action=update&cid=%%id%%{$searchContext}{$extraParams}",
280 'title' => ts('Edit Contact Details'),
281 'ref' => 'edit-contact',
285 $config = CRM_Core_Config
::singleton();
286 //CRM-16552: mapAPIKey is not mandatory as google no longer requires an API Key
287 if ($config->mapProvider
&& ($config->mapAPIKey ||
$config->mapProvider
== 'Google')) {
288 self
::$_links[CRM_Core_Action
::MAP
] = array(
290 'url' => 'civicrm/contact/map',
291 'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
292 'title' => ts('Map Contact'),
296 // Adding Context Menu Links in more action
299 foreach ($contextMenu as $key => $value) {
300 $contextVal = '&context=' . $value['key'];
301 if ($value['key'] == 'delete') {
302 $contextVal = $searchContext;
304 $url = "civicrm/contact/view/{$value['key']}";
305 $qs = "reset=1&action=add&cid=%%id%%{$contextVal}{$extraParams}";
306 if ($value['key'] == 'activity') {
307 $qs = "action=browse&selectedChild=activity&reset=1&cid=%%id%%{$extraParams}";
309 elseif ($value['key'] == 'email') {
310 $url = "civicrm/contact/view/activity";
311 $qs = "atype=3&action=add&reset=1&cid=%%id%%{$extraParams}";
314 self
::$_links[$counter++
] = array(
315 'name' => $value['title'],
318 'title' => $value['title'],
319 'ref' => $value['ref'],
320 'class' => CRM_Utils_Array
::value('class', $value),
325 return self
::$_links;
329 * Getter for array of the parameters required for creating pager.
332 * @param array $params
334 public function getPagerParams($action, &$params) {
335 $params['status'] = ts('Contact %%StatusMessage%%');
336 $params['csvString'] = NULL;
337 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
339 $params['buttonTop'] = 'PagerTopButton';
340 $params['buttonBottom'] = 'PagerBottomButton';
344 * @param null $action
345 * @param null $output
349 public function &getColHeads($action = NULL, $output = NULL) {
350 $colHeads = self
::_getColumnHeaders();
351 $colHeads[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
356 * Returns the column headers as an array of tuples:
357 * (name, sortName (key to the sort array))
359 * @param string $action
360 * The action being performed.
361 * @param string $output
362 * What should the result set include (web/email/csv).
365 * the column headers that need to be displayed
367 public function &getColumnHeaders($action = NULL, $output = NULL) {
370 // unset return property elements that we don't care
371 if (!empty($this->_returnProperties
)) {
372 $doNotCareElements = array(
377 foreach ($doNotCareElements as $value) {
378 unset($this->_returnProperties
[$value]);
382 if ($output == CRM_Core_Selector_Controller
::EXPORT
) {
383 $csvHeaders = array(ts('Contact ID'), ts('Contact Type'));
384 foreach ($this->getColHeads($action, $output) as $column) {
385 if (array_key_exists('name', $column)) {
386 $csvHeaders[] = $column['name'];
389 $headers = $csvHeaders;
391 elseif ($output == CRM_Core_Selector_Controller
::SCREEN
) {
392 $csvHeaders = array(ts('Name'));
393 foreach ($this->getColHeads($action, $output) as $key => $column) {
394 if (array_key_exists('name', $column) &&
396 $column['name'] != ts('Name')
398 $csvHeaders[$key] = $column['name'];
401 $headers = $csvHeaders;
403 elseif ($this->_ufGroupID
) {
404 // we dont use the cached value of column headers
405 // since it potentially changed because of the profile selected
406 static $skipFields = array('group', 'tag');
407 $direction = CRM_Utils_Sort
::ASCENDING
;
409 if (!self
::$_columnHeaders) {
410 self
::$_columnHeaders = array(
413 'name' => ts('Name'),
414 'sort' => 'sort_name',
415 'direction' => CRM_Utils_Sort
::ASCENDING
,
419 $locationTypes = CRM_Core_DAO_Address
::buildOptions('location_type_id', 'validate');
421 foreach ($this->_fields
as $name => $field) {
422 if (!empty($field['in_selector']) &&
423 !in_array($name, $skipFields)
425 if (strpos($name, '-') !== FALSE) {
426 list($fieldName, $lType, $type) = CRM_Utils_System
::explode('-', $name, 3);
428 if ($lType == 'Primary') {
429 $locationTypeName = 1;
432 $locationTypeName = $locationTypes[$lType];
435 if (in_array($fieldName, array(
441 $name = "`$locationTypeName-$fieldName-$type`";
444 $name = "`$locationTypeName-$fieldName`";
448 $name = "`$locationTypeName-$fieldName`";
451 //to handle sort key for Internal contactId.CRM-2289
453 $name = 'contact_id';
456 self
::$_columnHeaders[] = array(
457 'name' => $field['title'],
459 'direction' => $direction,
461 $direction = CRM_Utils_Sort
::DONTCARE
;
466 // if we dont have any valid columns, dont add the implicit ones
467 // this allows the template to check on emptiness of column headers
469 self
::$_columnHeaders = array();
472 self
::$_columnHeaders[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
475 $headers = self
::$_columnHeaders;
477 elseif (!empty($this->_returnProperties
)) {
478 self
::$_columnHeaders = array(
481 'name' => ts('Name'),
482 'sort' => 'sort_name',
483 'direction' => CRM_Utils_Sort
::ASCENDING
,
486 $properties = self
::makeProperties($this->_returnProperties
);
488 foreach ($properties as $prop) {
489 if (strpos($prop, '-')) {
490 list($loc, $fld, $phoneType) = CRM_Utils_System
::explode('-', $prop, 3);
491 $title = $this->_query
->_fields
[$fld]['title'];
492 if (trim($phoneType) && !is_numeric($phoneType) && strtolower($phoneType) != $fld) {
493 $title .= "-{$phoneType}";
495 // fetch Location type label from name as $loc, which will be later used in column header
496 $title .= sprintf(" (%s)",
497 CRM_Core_PseudoConstant
::getLabel(
498 'CRM_Core_DAO_Address',
500 CRM_Core_PseudoConstant
::getKey('CRM_Core_DAO_Address', 'location_type_id', $loc)
503 // use field name instead of table alias
506 elseif (isset($this->_query
->_fields
[$prop]) && isset($this->_query
->_fields
[$prop]['title'])) {
507 $title = $this->_query
->_fields
[$prop]['title'];
509 elseif (isset($this->_query
->_pseudoConstantsSelect
[$prop]) && isset($this->_query
->_pseudoConstantsSelect
[$prop]['pseudoconstant']['optionGroupName'])) {
510 $title = CRM_Core_BAO_OptionGroup
::getTitleByName($this->_query
->_pseudoConstantsSelect
[$prop]['pseudoconstant']['optionGroupName']);
516 self
::$_columnHeaders[] = array('name' => $title, 'sort' => $prop);
518 self
::$_columnHeaders[] = array('name' => ts('Actions'));
519 $headers = self
::$_columnHeaders;
522 $headers = $this->getColHeads($action, $output);
529 * Returns total number of rows for the query.
534 * Total number of rows
536 public function getTotalCount($action) {
537 // Use count from cache during paging/sorting
538 if (!empty($_GET['crmPID']) ||
!empty($_GET['crmSID'])) {
539 $count = Civi
::cache('long')->get("Search Results Count $this->_key");
542 $count = $this->_query
->searchQuery(0, 0, NULL, TRUE);
543 Civi
::cache('long')->set("Search Results Count $this->_key", $count);
549 * Returns all the rows in the given offset and rowCount.
551 * @param string $action
552 * The action being performed.
554 * The row number to start from.
555 * @param int $rowCount
556 * The number of rows to return.
557 * @param string $sort
558 * The sql string that describes the sort order.
559 * @param string $output
560 * What should the result set include (web/email/csv).
563 * the total number of rows for this action
565 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
566 if (($output == CRM_Core_Selector_Controller
::EXPORT ||
567 $output == CRM_Core_Selector_Controller
::SCREEN
569 $this->_formValues
['radio_ts'] == 'ts_sel'
571 $includeContactIds = TRUE;
574 $includeContactIds = FALSE;
577 // note the formvalues were given by CRM_Contact_Form_Search to us
578 // and contain the search criteria (parameters)
579 // note that the default action is basic
581 /** @var CRM_Core_PrevNextCache_Interface $prevNext */
582 $prevNext = Civi
::service('prevnext');
583 $cacheKey = $this->buildPrevNextCache($sort);
584 $cids = $prevNext->fetch($cacheKey, $offset, $rowCount);
585 $resultSet = empty($cids) ?
[] : $this->_query
->getCachedContacts($cids, $includeContactIds)->fetchGenerator();
588 $resultSet = $this->_query
->searchQuery($offset, $rowCount, $sort, FALSE, $includeContactIds)->fetchGenerator();
591 // process the result of the query
593 $permissions = array(CRM_Core_Permission
::getPermission());
594 if (CRM_Core_Permission
::check('delete contacts')) {
595 $permissions[] = CRM_Core_Permission
::DELETE
;
597 $mask = CRM_Core_Action
::mask($permissions);
599 // mask value to hide map link if there are not lat/long
600 $mapMask = $mask & 4095;
602 if ($this->_searchContext
== 'smog') {
603 $gc = CRM_Core_SelectValues
::groupContactStatus();
606 if ($this->_ufGroupID
) {
607 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
610 static $skipFields = array('group', 'tag');
611 foreach ($this->_fields
as $key => $field) {
612 if (!empty($field['in_selector']) &&
613 !in_array($key, $skipFields)
615 if (strpos($key, '-') !== FALSE) {
616 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $key, 3);
618 if ($id == 'Primary') {
619 $locationTypeName = 1;
621 elseif ($fieldName == 'url') {
622 $locationTypeName = "website-{$id}";
625 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
626 if (!$locationTypeName) {
631 $locationTypeName = str_replace(' ', '_', $locationTypeName);
632 if (in_array($fieldName, array(
638 $names[] = "{$locationTypeName}-{$fieldName}-{$type}";
641 $names[] = "{$locationTypeName}-{$fieldName}";
645 $names[] = "{$locationTypeName}-{$fieldName}";
649 $names[] = $field['name'];
656 elseif (!empty($this->_returnProperties
)) {
657 $names = self
::makeProperties($this->_returnProperties
);
660 $names = self
::$_properties;
663 $links = self
::links($this->_context
, $this->_contextMenu
, $this->_key
);
665 //check explicitly added contact to a Smart Group.
666 $groupID = CRM_Utils_Array
::value('group', $this->_formValues
);
668 $pseudoconstants = array();
669 // for CRM-3157 purposes
670 if (in_array('world_region', $names)) {
671 $pseudoconstants['world_region'] = array(
672 'dbName' => 'worldregion_id',
673 'values' => CRM_Core_PseudoConstant
::worldRegion(),
677 foreach ($resultSet as $result) {
679 $this->_query
->convertToPseudoNames($result);
680 // the columns we are interested in
681 foreach ($names as $property) {
682 if ($property == 'status') {
685 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($property)) {
686 $row[$property] = CRM_Core_BAO_CustomField
::displayValue(
692 elseif (strpos($property, '-im')) {
693 $row[$property] = $result->$property;
694 if (!empty($result->$property)) {
695 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
696 $providerId = $property . "-provider_id";
697 $providerName = $imProviders[$result->$providerId];
698 $row[$property] = $result->$property . " ({$providerName})";
701 elseif (in_array($property, array(
706 $greeting = $property . '_display';
707 $row[$property] = $result->$greeting;
709 elseif (isset($pseudoconstants[$property])) {
710 $row[$property] = CRM_Utils_Array
::value(
711 $result->{$pseudoconstants[$property]['dbName']},
712 $pseudoconstants[$property]['values']
715 elseif (strpos($property, '-url') !== FALSE) {
717 $websiteKey = str_replace('-url', '', $property);
718 $propertyArray = explode('-', $property);
719 $websiteFld = $websiteKey . '-' . array_pop($propertyArray);
720 if (!empty($result->$websiteFld)) {
721 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
722 $websiteType = $websiteTypes[$result->{"$websiteKey-website_type_id"}];
723 $websiteValue = $result->$websiteFld;
724 $websiteUrl = "<a href=\"{$websiteValue}\">{$websiteValue} ({$websiteType})</a>";
726 $row[$property] = $websiteUrl;
729 $row[$property] = isset($result->$property) ?
$result->$property : NULL;
733 if (!empty($result->postal_code_suffix
)) {
734 $row['postal_code'] .= "-" . $result->postal_code_suffix
;
737 if ($output != CRM_Core_Selector_Controller
::EXPORT
&&
738 $this->_searchContext
== 'smog'
740 if (empty($result->status
) &&
743 $contactID = $result->contact_id
;
746 'contact_id' => $contactID,
747 'group_id' => $groupID,
750 $gcDefaults = array();
751 CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_GroupContact', $gcParams, $gcDefaults);
753 if (empty($gcDefaults)) {
754 $row['status'] = ts('Smart');
757 $row['status'] = $gc[$gcDefaults['status']];
761 $row['status'] = NULL;
765 $row['status'] = $gc[$result->status
];
769 if ($output != CRM_Core_Selector_Controller
::EXPORT
) {
770 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->contact_id
;
772 if (!empty($this->_formValues
['deleted_contacts']) && CRM_Core_Permission
::check('access deleted contacts')
776 'name' => ts('View'),
777 'url' => 'civicrm/contact/view',
778 'qs' => 'reset=1&cid=%%id%%',
779 'class' => 'no-popup',
780 'title' => ts('View Contact Details'),
783 'name' => ts('Restore'),
784 'url' => 'civicrm/contact/view/delete',
785 'qs' => 'reset=1&cid=%%id%%&restore=1',
786 'title' => ts('Restore Contact'),
789 if (CRM_Core_Permission
::check('delete contacts')) {
791 'name' => ts('Delete Permanently'),
792 'url' => 'civicrm/contact/view/delete',
793 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
794 'title' => ts('Permanently Delete Contact'),
797 $row['action'] = CRM_Core_Action
::formLink(
800 array('id' => $result->contact_id
),
803 'contact.selector.row',
808 elseif ((is_numeric(CRM_Utils_Array
::value('geo_code_1', $row))) ||
809 (!empty($row['city']) &&
810 CRM_Utils_Array
::value('state_province', $row)
813 $row['action'] = CRM_Core_Action
::formLink(
816 array('id' => $result->contact_id
),
819 'contact.selector.row',
825 $row['action'] = CRM_Core_Action
::formLink(
828 array('id' => $result->contact_id
),
831 'contact.selector.row',
837 // allow components to add more actions
838 CRM_Core_Component
::searchAction($row, $result->contact_id
);
840 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
,
845 $row['contact_type_orig'] = $result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
;
846 $row['contact_sub_type'] = $result->contact_sub_type ? CRM_Contact_BAO_ContactType
::contactTypePairs(FALSE, $result->contact_sub_type
, ', ') : $result->contact_sub_type
;
847 $row['contact_id'] = $result->contact_id
;
848 $row['sort_name'] = $result->sort_name
;
849 // Surely this if should be if NOT - otherwise it's just wierd.
850 if (array_key_exists('id', $row)) {
851 $row['id'] = $result->contact_id
;
855 $rows[$row['contact_id']] = $row;
862 * @param CRM_Utils_Sort $sort
866 public function buildPrevNextCache($sort) {
867 $cacheKey = 'civicrm search ' . $this->_key
;
869 // We should clear the cache in following conditions:
870 // 1. when starting from scratch, i.e new search
871 // 2. if records are sorted
873 // get current page requested
874 $pageNum = CRM_Utils_Request
::retrieve('crmPID', 'Integer');
876 // get the current sort order
877 $currentSortID = CRM_Utils_Request
::retrieve('crmSID', 'String');
879 $session = CRM_Core_Session
::singleton();
881 // get previous sort id
882 $previousSortID = $session->get('previousSortID');
884 // check for current != previous to ensure cache is not reset if paging is done without changing
886 if (!$pageNum ||
(!empty($currentSortID) && $currentSortID != $previousSortID)) {
887 Civi
::service('prevnext')->deleteItem(NULL, $cacheKey, 'civicrm_contact');
888 // this means it's fresh search, so set pageNum=1
894 // set the current sort as previous sort
895 if (!empty($currentSortID)) {
896 $session->set('previousSortID', $currentSortID);
899 $pageSize = CRM_Utils_Request
::retrieve('crmRowCount', 'Integer', CRM_Core_DAO
::$_nullObject, FALSE, 50);
900 $firstRecord = ($pageNum - 1) * $pageSize;
902 //for alphabetic pagination selection save
903 $sortByCharacter = CRM_Utils_Request
::retrieve('sortByCharacter', 'String');
905 //for text field pagination selection save
906 $countRow = Civi
::service('prevnext')->getCount($cacheKey);
907 // $sortByCharacter triggers a refresh in the prevNext cache
908 if ($sortByCharacter && $sortByCharacter != 'all') {
909 $this->fillupPrevNextCache($sort, $cacheKey, 0, max(self
::CACHE_SIZE
, $pageSize));
911 elseif (($firstRecord +
$pageSize) >= $countRow) {
912 $this->fillupPrevNextCache($sort, $cacheKey, $countRow, max(self
::CACHE_SIZE
, $pageSize) +
$firstRecord - $countRow);
920 public function addActions(&$rows) {
922 $basicPermissions = CRM_Core_Permission
::check('delete contacts') ?
array(CRM_Core_Permission
::DELETE
) : array();
924 // get permissions on an individual level (CRM-12645)
925 // @todo look at storing this to the session as this is called twice during search results render.
926 $can_edit_list = CRM_Contact_BAO_Contact_Permission
::allowList(array_keys($rows), CRM_Core_Permission
::EDIT
);
928 $links_template = self
::links($this->_context
, $this->_contextMenu
, $this->_key
);
930 foreach ($rows as $id => & $row) {
931 $links = $links_template;
932 if (in_array($id, $can_edit_list)) {
933 $mask = CRM_Core_Action
::mask(array_merge(array(CRM_Core_Permission
::EDIT
), $basicPermissions));
936 $mask = CRM_Core_Action
::mask(array_merge(array(CRM_Core_Permission
::VIEW
), $basicPermissions));
939 if ((!is_numeric(CRM_Utils_Array
::value('geo_code_1', $row))) &&
940 (empty($row['city']) ||
941 !CRM_Utils_Array
::value('state_province', $row)
944 $mask = $mask & 4095;
947 if (!empty($this->_formValues
['deleted_contacts']) && CRM_Core_Permission
::check('access deleted contacts')
951 'name' => ts('View'),
952 'url' => 'civicrm/contact/view',
953 'qs' => 'reset=1&cid=%%id%%',
954 'class' => 'no-popup',
955 'title' => ts('View Contact Details'),
958 'name' => ts('Restore'),
959 'url' => 'civicrm/contact/view/delete',
960 'qs' => 'reset=1&cid=%%id%%&restore=1',
961 'title' => ts('Restore Contact'),
964 if (CRM_Core_Permission
::check('delete contacts')) {
966 'name' => ts('Delete Permanently'),
967 'url' => 'civicrm/contact/view/delete',
968 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
969 'title' => ts('Permanently Delete Contact'),
972 $row['action'] = CRM_Core_Action
::formLink(
975 array('id' => $row['contact_id']),
978 'contact.selector.actions',
984 $row['action'] = CRM_Core_Action
::formLink(
987 array('id' => $row['contact_id']),
990 'contact.selector.actions',
996 // allow components to add more actions
997 CRM_Core_Component
::searchAction($row, $row['contact_id']);
999 if (!empty($row['contact_type_orig'])) {
1000 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($row['contact_type_orig'],
1001 FALSE, $row['contact_id']);
1009 public function removeActions(&$rows) {
1010 foreach ($rows as $rid => & $rValue) {
1011 unset($rValue['contact_type']);
1012 unset($rValue['action']);
1017 * @param CRM_Utils_Sort $sort
1018 * @param string $cacheKey
1022 public function fillupPrevNextCache($sort, $cacheKey, $start = 0, $end = self
::CACHE_SIZE
) {
1024 // For custom searches, use the contactIDs method
1025 if (is_a($this, 'CRM_Contact_Selector_Custom')) {
1026 $sql = $this->_search
->contactIDs($start, $end, $sort, TRUE);
1027 $coreSearch = FALSE;
1029 // For core searches use the searchQuery method
1031 $sql = $this->_query
->getSearchSQL($start, $end, $sort, FALSE, $this->_query
->_includeContactIds
,
1036 // due to limitations in our search query writer, the above query does not work
1037 // in cases where the query is being sorted on a non-contact table
1038 // this results in a fatal error :(
1039 // see below for the gross hack of trapping the error and not filling
1040 // the prev next cache in this situation
1041 // the other alternative of running the FULL query will just be incredibly inefficient
1042 // and slow things down way too much on large data sets / complex queries
1044 $selectSQL = "SELECT DISTINCT %1, contact_a.id, contact_a.sort_name";
1046 $sql = str_ireplace(array("SELECT contact_a.id as contact_id", "SELECT contact_a.id as id"), $selectSQL, $sql);
1048 Civi
::service('prevnext')->fillWithSql($cacheKey, $sql, [1 => [$cacheKey, 'String']]);
1050 catch (CRM_Core_Exception
$e) {
1052 // in the case of error, try rebuilding cache using full sql which is used for search selector display
1053 // this fixes the bugs reported in CRM-13996 & CRM-14438
1054 $this->rebuildPreNextCache($start, $end, $sort, $cacheKey);
1057 // This will always show for CiviRules :-( as a) it orders by 'rule_label'
1058 // which is not available in the query & b) it uses contact not contact_a
1060 // CRM_Core_Session::setStatus(ts('Query Failed'));
1065 if (Civi
::service('prevnext') instanceof CRM_Core_PrevNextCache_Sql
) {
1066 // SQL-backed prevnext cache uses an extra record for pruning the cache.
1067 CRM_Core_BAO_Cache
::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
1072 * called to rebuild prev next cache using full sql in case of core search ( excluding custom search)
1075 * Start for limit clause.
1077 * End for limit clause.
1078 * @param CRM_Utils_Sort $sort
1079 * @param string $cacheKey
1082 public function rebuildPreNextCache($start, $end, $sort, $cacheKey) {
1083 // generate full SQL
1084 $sql = $this->_query
->searchQuery($start, $end, $sort, FALSE, $this->_query
->_includeContactIds
,
1085 FALSE, FALSE, TRUE);
1087 $dao = CRM_Core_DAO
::executeQuery($sql);
1089 // build insert query, note that currently we build cache for 500 (self::CACHE_SIZE) contact records at a time, hence below approach
1091 while ($dao->fetch()) {
1093 'entity_table' => 'civicrm_contact',
1094 'entity_id1' => $dao->contact_id
,
1095 'entity_id2' => $dao->contact_id
,
1096 'data' => $dao->sort_name
,
1100 Civi
::service('prevnext')->fillWithArray($cacheKey, $rows);
1106 public function getQILL() {
1107 return $this->_query
->qill();
1111 * Name of export file.
1113 * @param string $output
1119 public function getExportFileName($output = 'csv') {
1120 return ts('CiviCRM Contact Search');
1124 * Get colunmn headers for search selector.
1128 private static function &_getColumnHeaders() {
1129 if (!isset(self
::$_columnHeaders)) {
1130 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1131 'address_options', TRUE, NULL, TRUE
1134 self
::$_columnHeaders = array(
1135 'contact_type' => array('desc' => ts('Contact Type')),
1136 'sort_name' => array(
1137 'name' => ts('Name'),
1138 'sort' => 'sort_name',
1139 'direction' => CRM_Utils_Sort
::ASCENDING
,
1143 $defaultAddress = array(
1144 'street_address' => array('name' => ts('Address')),
1146 'name' => ts('City'),
1148 'direction' => CRM_Utils_Sort
::DONTCARE
,
1150 'state_province' => array(
1151 'name' => ts('State'),
1152 'sort' => 'state_province',
1153 'direction' => CRM_Utils_Sort
::DONTCARE
,
1155 'postal_code' => array(
1156 'name' => ts('Postal'),
1157 'sort' => 'postal_code',
1158 'direction' => CRM_Utils_Sort
::DONTCARE
,
1161 'name' => ts('Country'),
1162 'sort' => 'country',
1163 'direction' => CRM_Utils_Sort
::DONTCARE
,
1167 foreach ($defaultAddress as $columnName => $column) {
1168 if (!empty($addressOptions[$columnName])) {
1169 self
::$_columnHeaders[$columnName] = $column;
1173 self
::$_columnHeaders['email'] = array(
1174 'name' => ts('Email'),
1176 'direction' => CRM_Utils_Sort
::DONTCARE
,
1179 self
::$_columnHeaders['phone'] = array('name' => ts('Phone'));
1181 return self
::$_columnHeaders;
1185 * @return CRM_Contact_BAO_Query
1187 public function getQuery() {
1188 return $this->_query
;
1192 * @return CRM_Contact_DAO_Contact
1194 public function alphabetQuery() {
1195 return $this->_query
->alphabetQuery();
1199 * @param array $params
1200 * @param int $sortID
1201 * @param null $displayRelationshipType
1202 * @param string $queryOperator
1204 * @return CRM_Contact_DAO_Contact
1206 public function contactIDQuery($params, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
1207 $sortOrder = &$this->getSortOrder($this->_action
);
1208 $sort = new CRM_Utils_Sort($sortOrder, $sortID);
1210 // rectify params to what proximity search expects if there is a value for prox_distance
1211 // CRM-7021 CRM-7905
1212 if (!empty($params)) {
1213 CRM_Contact_BAO_ProximityQuery
::fixInputParams($params);
1216 if (!$displayRelationshipType) {
1217 $query = new CRM_Contact_BAO_Query($params,
1218 CRM_Contact_BAO_Query
::NO_RETURN_PROPERTIES
,
1219 NULL, FALSE, FALSE, 1,
1220 FALSE, TRUE, TRUE, NULL,
1225 $query = new CRM_Contact_BAO_Query($params,
1226 CRM_Contact_BAO_Query
::NO_RETURN_PROPERTIES
,
1227 NULL, FALSE, FALSE, 1,
1228 FALSE, TRUE, TRUE, $displayRelationshipType,
1232 $value = $query->searchQuery(0, 0, $sort,
1233 FALSE, FALSE, FALSE,
1240 * @param $returnProperties
1244 public function &makeProperties(&$returnProperties) {
1245 $properties = array();
1246 foreach ($returnProperties as $name => $value) {
1247 if ($name != 'location') {
1248 // special handling for group and tag
1249 if (in_array($name, array('group', 'tag'))) {
1253 // special handling for notes
1254 if (in_array($name, array('note', 'note_subject', 'note_body'))) {
1258 $properties[] = $name;
1261 // extract all the location stuff
1262 foreach ($value as $n => $v) {
1263 foreach ($v as $n1 => $v1) {
1264 if (!strpos('_id', $n1) && $n1 != 'location_type') {
1265 $n = str_replace(' ', '_', $n);
1266 $properties[] = "{$n}-{$n1}";