3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
37 * This class is used to retrieve and display a range of
38 * contacts that match the given criteria (specifically for
39 * results of advanced search options.
42 class CRM_Contact_Selector
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
45 * This defines two actions- View and Edit.
49 static $_links = NULL;
52 * We use desc to remind us what that column is, name is used in the tpl
56 static $_columnHeaders;
59 * Properties of contact we're interested in displaying
62 static $_properties = array(
85 * FormValues is the array returned by exportValues called on
86 * the HTML_QuickForm_Controller for that page.
97 protected $_contextMenu;
100 * Params is the array in a value used by the search query creator
107 * The return properties used for search
111 protected $_returnProperties;
114 * Represent the type of selector
120 protected $_searchContext;
129 protected $_ufGroupID;
132 * The public visible fields to be shown to the user
141 * @param $customSearchClass
142 * @param array $formValues
143 * Array of form values imported.
144 * @param array $params
145 * Array of parameters for query.
146 * @param null $returnProperties
147 * @param \const|int $action - action of search basic or advanced.
149 * @param bool $includeContactIds
150 * @param bool $searchDescendentGroups
151 * @param string $searchContext
152 * @param null $contextMenu
154 * @return CRM_Contact_Selector
156 public function __construct(
160 $returnProperties = NULL,
161 $action = CRM_Core_Action
::NONE
,
162 $includeContactIds = FALSE,
163 $searchDescendentGroups = TRUE,
164 $searchContext = 'search',
167 //don't build query constructor, if form is not submitted
168 $force = CRM_Utils_Request
::retrieve('force', 'Boolean', CRM_Core_DAO
::$_nullObject);
169 if (empty($formValues) && !$force) {
173 // submitted form values
174 $this->_formValues
= &$formValues;
175 $this->_params
= &$params;
176 $this->_returnProperties
= &$returnProperties;
177 $this->_contextMenu
= &$contextMenu;
178 $this->_context
= $searchContext;
181 $this->_action
= $action;
183 $this->_searchContext
= $searchContext;
185 $this->_ufGroupID
= CRM_Utils_Array
::value('uf_group_id', $this->_formValues
);
187 if ($this->_ufGroupID
) {
188 $this->_fields
= CRM_Core_BAO_UFGroup
::getListingFields(CRM_Core_Action
::VIEW
,
189 CRM_Core_BAO_UFGroup
::PUBLIC_VISIBILITY |
190 CRM_Core_BAO_UFGroup
::LISTINGS_VISIBILITY
,
191 FALSE, $this->_ufGroupID
193 self
::$_columnHeaders = NULL;
195 $this->_customFields
= CRM_Core_BAO_CustomField
::getFieldsForImport('Individual');
197 $this->_returnProperties
= CRM_Contact_BAO_Contact
::makeHierReturnProperties($this->_fields
);
198 $this->_returnProperties
['contact_type'] = 1;
199 $this->_returnProperties
['contact_sub_type'] = 1;
200 $this->_returnProperties
['sort_name'] = 1;
203 $displayRelationshipType = CRM_Utils_Array
::value('display_relationship_type', $this->_formValues
);
204 $operator = CRM_Utils_Array
::value('operator', $this->_formValues
, 'AND');
206 // rectify params to what proximity search expects if there is a value for prox_distance
208 if (!empty($this->_params
)) {
209 CRM_Contact_BAO_ProximityQuery
::fixInputParams($this->_params
);
212 $this->_query
= new CRM_Contact_BAO_Query(
214 $this->_returnProperties
,
218 CRM_Contact_BAO_Query
::MODE_CONTACTS
,
220 $searchDescendentGroups,
222 $displayRelationshipType,
226 $this->_options
= &$this->_query
->_options
;
230 * This method returns the links that are given for each search row.
231 * currently the links added for each row are
238 public static function &links() {
239 list($context, $contextMenu, $key) = func_get_args();
240 $extraParams = ($key) ?
"&key={$key}" : NULL;
241 $searchContext = ($context) ?
"&context=$context" : NULL;
243 if (!(self
::$_links)) {
244 self
::$_links = array(
245 CRM_Core_Action
::VIEW
=> array(
246 'name' => ts('View'),
247 'url' => 'civicrm/contact/view',
248 'class' => 'no-popup',
249 'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
250 'title' => ts('View Contact Details'),
251 'ref' => 'view-contact',
253 CRM_Core_Action
::UPDATE
=> array(
254 'name' => ts('Edit'),
255 'url' => 'civicrm/contact/add',
256 'class' => 'no-popup',
257 'qs' => "reset=1&action=update&cid=%%id%%{$searchContext}{$extraParams}",
258 'title' => ts('Edit Contact Details'),
259 'ref' => 'edit-contact',
263 $config = CRM_Core_Config
::singleton();
264 //CRM-16552: mapAPIKey is not mandatory as google no longer requires an API Key
265 if ($config->mapProvider
&& ($config->mapAPIKey ||
$config->mapProvider
== 'Google')) {
266 self
::$_links[CRM_Core_Action
::MAP
] = array(
268 'url' => 'civicrm/contact/map',
269 'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
270 'title' => ts('Map Contact'),
274 // Adding Context Menu Links in more action
277 foreach ($contextMenu as $key => $value) {
278 $contextVal = '&context=' . $value['key'];
279 if ($value['key'] == 'delete') {
280 $contextVal = $searchContext;
282 $url = "civicrm/contact/view/{$value['key']}";
283 $qs = "reset=1&action=add&cid=%%id%%{$contextVal}{$extraParams}";
284 if ($value['key'] == 'activity') {
285 $qs = "action=browse&selectedChild=activity&reset=1&cid=%%id%%{$extraParams}";
287 elseif ($value['key'] == 'email') {
288 $url = "civicrm/contact/view/activity";
289 $qs = "atype=3&action=add&reset=1&cid=%%id%%{$extraParams}";
292 self
::$_links[$counter++
] = array(
293 'name' => $value['title'],
296 'title' => $value['title'],
297 'ref' => $value['ref'],
298 'class' => CRM_Utils_Array
::value('class', $value),
303 return self
::$_links;
307 * Getter for array of the parameters required for creating pager.
310 * @param array $params
312 public function getPagerParams($action, &$params) {
313 $params['status'] = ts('Contact %%StatusMessage%%');
314 $params['csvString'] = NULL;
315 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
317 $params['buttonTop'] = 'PagerTopButton';
318 $params['buttonBottom'] = 'PagerBottomButton';
322 * @param null $action
323 * @param null $output
327 public function &getColHeads($action = NULL, $output = NULL) {
328 $colHeads = self
::_getColumnHeaders();
329 $colHeads[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
334 * Returns the column headers as an array of tuples:
335 * (name, sortName (key to the sort array))
337 * @param string $action
338 * The action being performed.
339 * @param string $output
340 * What should the result set include (web/email/csv).
343 * the column headers that need to be displayed
345 public function &getColumnHeaders($action = NULL, $output = NULL) {
348 // unset return property elements that we don't care
349 if (!empty($this->_returnProperties
)) {
350 $doNotCareElements = array(
355 foreach ($doNotCareElements as $value) {
356 unset($this->_returnProperties
[$value]);
360 if ($output == CRM_Core_Selector_Controller
::EXPORT
) {
361 $csvHeaders = array(ts('Contact ID'), ts('Contact Type'));
362 foreach ($this->getColHeads($action, $output) as $column) {
363 if (array_key_exists('name', $column)) {
364 $csvHeaders[] = $column['name'];
367 $headers = $csvHeaders;
369 elseif ($output == CRM_Core_Selector_Controller
::SCREEN
) {
370 $csvHeaders = array(ts('Name'));
371 foreach ($this->getColHeads($action, $output) as $key => $column) {
372 if (array_key_exists('name', $column) &&
374 $column['name'] != ts('Name')
376 $csvHeaders[$key] = $column['name'];
379 $headers = $csvHeaders;
381 elseif ($this->_ufGroupID
) {
382 // we dont use the cached value of column headers
383 // since it potentially changed because of the profile selected
384 static $skipFields = array('group', 'tag');
385 $direction = CRM_Utils_Sort
::ASCENDING
;
387 if (!self
::$_columnHeaders) {
388 self
::$_columnHeaders = array(
391 'name' => ts('Name'),
392 'sort' => 'sort_name',
393 'direction' => CRM_Utils_Sort
::ASCENDING
,
397 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
399 foreach ($this->_fields
as $name => $field) {
400 if (!empty($field['in_selector']) &&
401 !in_array($name, $skipFields)
403 if (strpos($name, '-') !== FALSE) {
404 list($fieldName, $lType, $type) = CRM_Utils_System
::explode('-', $name, 3);
406 if ($lType == 'Primary') {
407 $locationTypeName = 1;
410 $locationTypeName = $locationTypes[$lType];
413 if (in_array($fieldName, array(
419 $name = "`$locationTypeName-$fieldName-$type`";
422 $name = "`$locationTypeName-$fieldName`";
426 $name = "`$locationTypeName-$fieldName`";
429 //to handle sort key for Internal contactId.CRM-2289
431 $name = 'contact_id';
434 self
::$_columnHeaders[] = array(
435 'name' => $field['title'],
437 'direction' => $direction,
439 $direction = CRM_Utils_Sort
::DONTCARE
;
444 // if we dont have any valid columns, dont add the implicit ones
445 // this allows the template to check on emptiness of column headers
447 self
::$_columnHeaders = array();
450 self
::$_columnHeaders[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
453 $headers = self
::$_columnHeaders;
455 elseif (!empty($this->_returnProperties
)) {
456 self
::$_columnHeaders = array(
459 'name' => ts('Name'),
460 'sort' => 'sort_name',
461 'direction' => CRM_Utils_Sort
::ASCENDING
,
464 $properties = self
::makeProperties($this->_returnProperties
);
466 foreach ($properties as $prop) {
467 if (strpos($prop, '-')) {
468 list($loc, $fld, $phoneType) = CRM_Utils_System
::explode('-', $prop, 3);
469 $title = $this->_query
->_fields
[$fld]['title'];
470 if (trim($phoneType) && !is_numeric($phoneType) && strtolower($phoneType) != $fld) {
471 $title .= "-{$phoneType}";
475 elseif (isset($this->_query
->_fields
[$prop]) && isset($this->_query
->_fields
[$prop]['title'])) {
476 $title = $this->_query
->_fields
[$prop]['title'];
482 self
::$_columnHeaders[] = array('name' => $title, 'sort' => $prop);
484 self
::$_columnHeaders[] = array('name' => ts('Actions'));
485 $headers = self
::$_columnHeaders;
488 $headers = $this->getColHeads($action, $output);
495 * Returns total number of rows for the query.
500 * Total number of rows
502 public function getTotalCount($action) {
503 // Use count from cache during paging/sorting
504 if (!empty($_GET['crmPID']) ||
!empty($_GET['crmSID'])) {
505 $count = CRM_Core_BAO_Cache
::getItem('Search Results Count', $this->_key
);
508 $count = $this->_query
->searchQuery(0, 0, NULL, TRUE);
509 CRM_Core_BAO_Cache
::setItem($count, 'Search Results Count', $this->_key
);
515 * Returns all the rows in the given offset and rowCount.
517 * @param string $action
518 * The action being performed.
520 * The row number to start from.
521 * @param int $rowCount
522 * The number of rows to return.
523 * @param string $sort
524 * The sql string that describes the sort order.
525 * @param string $output
526 * What should the result set include (web/email/csv).
529 * the total number of rows for this action
531 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
532 $config = CRM_Core_Config
::singleton();
534 if (($output == CRM_Core_Selector_Controller
::EXPORT ||
535 $output == CRM_Core_Selector_Controller
::SCREEN
537 $this->_formValues
['radio_ts'] == 'ts_sel'
539 $includeContactIds = TRUE;
542 $includeContactIds = FALSE;
545 // note the formvalues were given by CRM_Contact_Form_Search to us
546 // and contain the search criteria (parameters)
547 // note that the default action is basic
549 $cacheKey = $this->buildPrevNextCache($sort);
550 $result = $this->_query
->getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds);
553 $result = $this->_query
->searchQuery($offset, $rowCount, $sort, FALSE, $includeContactIds);
556 // process the result of the query
558 $permissions = array(CRM_Core_Permission
::getPermission());
559 if (CRM_Core_Permission
::check('delete contacts')) {
560 $permissions[] = CRM_Core_Permission
::DELETE
;
562 $mask = CRM_Core_Action
::mask($permissions);
564 // mask value to hide map link if there are not lat/long
565 $mapMask = $mask & 4095;
567 if ($this->_searchContext
== 'smog') {
568 $gc = CRM_Core_SelectValues
::groupContactStatus();
571 if ($this->_ufGroupID
) {
572 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
575 static $skipFields = array('group', 'tag');
576 foreach ($this->_fields
as $key => $field) {
577 if (!empty($field['in_selector']) &&
578 !in_array($key, $skipFields)
580 if (strpos($key, '-') !== FALSE) {
581 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $key, 3);
583 if ($id == 'Primary') {
584 $locationTypeName = 1;
586 elseif ($fieldName == 'url') {
587 $locationTypeName = "website-{$id}";
590 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
591 if (!$locationTypeName) {
596 $locationTypeName = str_replace(' ', '_', $locationTypeName);
597 if (in_array($fieldName, array(
603 $names[] = "{$locationTypeName}-{$fieldName}-{$type}";
606 $names[] = "{$locationTypeName}-{$fieldName}";
610 $names[] = "{$locationTypeName}-{$fieldName}";
614 $names[] = $field['name'];
621 elseif (!empty($this->_returnProperties
)) {
622 $names = self
::makeProperties($this->_returnProperties
);
625 $names = self
::$_properties;
628 $multipleSelectFields = array('preferred_communication_method' => 1);
630 $links = self
::links($this->_context
, $this->_contextMenu
, $this->_key
);
632 //check explicitly added contact to a Smart Group.
633 $groupID = CRM_Utils_Array
::key('1', $this->_formValues
['group']);
635 $pseudoconstants = array();
636 // for CRM-3157 purposes
637 if (in_array('world_region', $names)) {
638 $pseudoconstants['world_region'] = array(
639 'dbName' => 'world_region_id',
640 'values' => CRM_Core_PseudoConstant
::worldRegion(),
645 while ($result->fetch()) {
647 $this->_query
->convertToPseudoNames($result);
649 // the columns we are interested in
650 foreach ($names as $property) {
651 if ($property == 'status') {
654 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($property)) {
655 $row[$property] = CRM_Core_BAO_CustomField
::getDisplayValue(
663 $multipleSelectFields &&
664 array_key_exists($property, $multipleSelectFields)
667 $paramsNew = array($key => $result->$property);
668 $name = array($key => array('newName' => $key, 'groupName' => $key));
670 CRM_Core_OptionGroup
::lookupValues($paramsNew, $name, FALSE);
671 $row[$key] = $paramsNew[$key];
673 elseif (strpos($property, '-im')) {
674 $row[$property] = $result->$property;
675 if (!empty($result->$property)) {
676 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
677 $providerId = $property . "-provider_id";
678 $providerName = $imProviders[$result->$providerId];
679 $row[$property] = $result->$property . " ({$providerName})";
682 elseif (in_array($property, array(
687 $greeting = $property . '_display';
688 $row[$property] = $result->$greeting;
690 elseif (isset($pseudoconstants[$property])) {
691 $row[$property] = CRM_Utils_Array
::value(
692 $result->{$pseudoconstants[$property]['dbName']},
693 $pseudoconstants[$property]['values']
696 elseif (strpos($property, '-url') !== FALSE) {
698 $websiteKey = str_replace('-url', '', $property);
699 $propertyArray = explode('-', $property);
700 $websiteFld = $websiteKey . '-' . array_pop($propertyArray);
701 if (!empty($result->$websiteFld)) {
702 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
703 $websiteType = $websiteTypes[$result->{"$websiteKey-website_type_id"}];
704 $websiteValue = $result->$websiteFld;
705 $websiteUrl = "<a href=\"{$websiteValue}\">{$websiteValue} ({$websiteType})</a>";
707 $row[$property] = $websiteUrl;
710 $row[$property] = isset($result->$property) ?
$result->$property : NULL;
714 if (!empty($result->postal_code_suffix
)) {
715 $row['postal_code'] .= "-" . $result->postal_code_suffix
;
718 if ($output != CRM_Core_Selector_Controller
::EXPORT
&&
719 $this->_searchContext
== 'smog'
721 if (empty($result->status
) &&
724 $contactID = $result->contact_id
;
727 'contact_id' => $contactID,
728 'group_id' => $groupID,
731 $gcDefaults = array();
732 CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_GroupContact', $gcParams, $gcDefaults);
734 if (empty($gcDefaults)) {
735 $row['status'] = ts('Smart');
738 $row['status'] = $gc[$gcDefaults['status']];
742 $row['status'] = NULL;
746 $row['status'] = $gc[$result->status
];
750 if ($output != CRM_Core_Selector_Controller
::EXPORT
) {
751 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->contact_id
;
753 if (!empty($this->_formValues
['deleted_contacts']) && CRM_Core_Permission
::check('access deleted contacts')
757 'name' => ts('View'),
758 'url' => 'civicrm/contact/view',
759 'qs' => 'reset=1&cid=%%id%%',
760 'class' => 'no-popup',
761 'title' => ts('View Contact Details'),
764 'name' => ts('Restore'),
765 'url' => 'civicrm/contact/view/delete',
766 'qs' => 'reset=1&cid=%%id%%&restore=1',
767 'title' => ts('Restore Contact'),
770 if (CRM_Core_Permission
::check('delete contacts')) {
772 'name' => ts('Delete Permanently'),
773 'url' => 'civicrm/contact/view/delete',
774 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
775 'title' => ts('Permanently Delete Contact'),
778 $row['action'] = CRM_Core_Action
::formLink(
781 array('id' => $result->contact_id
),
784 'contact.selector.row',
789 elseif ((is_numeric(CRM_Utils_Array
::value('geo_code_1', $row))) ||
790 ($config->mapGeoCoding
&& !empty($row['city']) &&
791 CRM_Utils_Array
::value('state_province', $row)
794 $row['action'] = CRM_Core_Action
::formLink(
797 array('id' => $result->contact_id
),
800 'contact.selector.row',
806 $row['action'] = CRM_Core_Action
::formLink(
809 array('id' => $result->contact_id
),
812 'contact.selector.row',
818 // allow components to add more actions
819 CRM_Core_Component
::searchAction($row, $result->contact_id
);
821 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
,
826 $row['contact_type_orig'] = $result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
;
827 $row['contact_sub_type'] = $result->contact_sub_type ? CRM_Contact_BAO_ContactType
::contactTypePairs(FALSE, $result->contact_sub_type
, ', ') : $result->contact_sub_type
;
828 $row['contact_id'] = $result->contact_id
;
829 $row['sort_name'] = $result->sort_name
;
830 if (array_key_exists('id', $row)) {
831 $row['id'] = $result->contact_id
;
836 if (in_array($row['contact_id'], $seenIDs) === FALSE) {
837 $seenIDs[] = $row['contact_id'];
846 * @param CRM_Utils_Sort $sort
850 public function buildPrevNextCache($sort) {
851 $cacheKey = 'civicrm search ' . $this->_key
;
853 // We should clear the cache in following conditions:
854 // 1. when starting from scratch, i.e new search
855 // 2. if records are sorted
857 // get current page requested
858 $pageNum = CRM_Utils_Request
::retrieve('crmPID', 'Integer', CRM_Core_DAO
::$_nullObject);
860 // get the current sort order
861 $currentSortID = CRM_Utils_Request
::retrieve('crmSID', 'String', CRM_Core_DAO
::$_nullObject);
863 $session = CRM_Core_Session
::singleton();
865 // get previous sort id
866 $previousSortID = $session->get('previousSortID');
868 // check for current != previous to ensure cache is not reset if paging is done without changing
870 if (!$pageNum ||
(!empty($currentSortID) && $currentSortID != $previousSortID)) {
871 CRM_Core_BAO_PrevNextCache
::deleteItem(NULL, $cacheKey, 'civicrm_contact');
872 // this means it's fresh search, so set pageNum=1
878 // set the current sort as previous sort
879 if (!empty($currentSortID)) {
880 $session->set('previousSortID', $currentSortID);
883 $pageSize = CRM_Utils_Request
::retrieve('crmRowCount', 'Integer', CRM_Core_DAO
::$_nullObject, FALSE, 50);
884 $firstRecord = ($pageNum - 1) * $pageSize;
886 //for alphabetic pagination selection save
887 $sortByCharacter = CRM_Utils_Request
::retrieve('sortByCharacter', 'String', CRM_Core_DAO
::$_nullObject);
889 //for text field pagination selection save
890 $countRow = CRM_Core_BAO_PrevNextCache
::getCount($cacheKey, NULL, "entity_table = 'civicrm_contact'");
891 // $sortByCharacter triggers a refresh in the prevNext cache
892 if ($sortByCharacter && $sortByCharacter != 'all') {
893 $cacheKey .= "_alphabet";
894 $this->fillupPrevNextCache($sort, $cacheKey);
896 elseif ($firstRecord >= $countRow) {
897 $this->fillupPrevNextCache($sort, $cacheKey, $countRow, 500 +
$firstRecord - $countRow);
905 public function addActions(&$rows) {
906 $config = CRM_Core_Config
::singleton();
908 $permissions = array(CRM_Core_Permission
::getPermission());
909 if (CRM_Core_Permission
::check('delete contacts')) {
910 $permissions[] = CRM_Core_Permission
::DELETE
;
912 $mask = CRM_Core_Action
::mask($permissions);
913 // mask value to hide map link if there are not lat/long
914 $mapMask = $mask & 4095;
916 // mask value to hide map link if there are not lat/long
917 $mapMask = $mask & 4095;
919 $links = self
::links($this->_context
, $this->_contextMenu
, $this->_key
);
921 foreach ($rows as $id => & $row) {
922 if (!empty($this->_formValues
['deleted_contacts']) && CRM_Core_Permission
::check('access deleted contacts')
926 'name' => ts('View'),
927 'url' => 'civicrm/contact/view',
928 'qs' => 'reset=1&cid=%%id%%',
929 'class' => 'no-popup',
930 'title' => ts('View Contact Details'),
933 'name' => ts('Restore'),
934 'url' => 'civicrm/contact/view/delete',
935 'qs' => 'reset=1&cid=%%id%%&restore=1',
936 'title' => ts('Restore Contact'),
939 if (CRM_Core_Permission
::check('delete contacts')) {
941 'name' => ts('Delete Permanently'),
942 'url' => 'civicrm/contact/view/delete',
943 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
944 'title' => ts('Permanently Delete Contact'),
947 $row['action'] = CRM_Core_Action
::formLink(
950 array('id' => $row['contact_id']),
953 'contact.selector.actions',
958 elseif ((is_numeric(CRM_Utils_Array
::value('geo_code_1', $row))) ||
959 ($config->mapGeoCoding
&& !empty($row['city']) &&
960 CRM_Utils_Array
::value('state_province', $row)
963 $row['action'] = CRM_Core_Action
::formLink(
966 array('id' => $row['contact_id']),
969 'contact.selector.actions',
975 $row['action'] = CRM_Core_Action
::formLink(
978 array('id' => $row['contact_id']),
981 'contact.selector.actions',
987 // allow components to add more actions
988 CRM_Core_Component
::searchAction($row, $row['contact_id']);
990 if (!empty($row['contact_type_orig'])) {
991 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($row['contact_type_orig'],
992 FALSE, $row['contact_id']);
1000 public function removeActions(&$rows) {
1001 foreach ($rows as $rid => & $rValue) {
1002 unset($rValue['contact_type']);
1003 unset($rValue['action']);
1008 * @param CRM_Utils_Sort $sort
1009 * @param string $cacheKey
1013 public function fillupPrevNextCache($sort, $cacheKey, $start = 0, $end = 500) {
1015 // For custom searches, use the contactIDs method
1016 if (is_a($this, 'CRM_Contact_Selector_Custom')) {
1017 $sql = $this->_search
->contactIDs($start, $end, $sort, TRUE);
1018 $replaceSQL = "SELECT contact_a.id as contact_id";
1019 $coreSearch = FALSE;
1021 // For core searches use the searchQuery method
1023 $sql = $this->_query
->searchQuery($start, $end, $sort, FALSE, $this->_query
->_includeContactIds
,
1025 $replaceSQL = "SELECT contact_a.id as id";
1029 // due to limitations in our search query writer, the above query does not work
1030 // in cases where the query is being sorted on a non-contact table
1031 // this results in a fatal error :(
1032 // see below for the gross hack of trapping the error and not filling
1033 // the prev next cache in this situation
1034 // the other alternative of running the FULL query will just be incredibly inefficient
1035 // and slow things down way too much on large data sets / complex queries
1038 INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data )
1039 SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.display_name
1042 $sql = str_replace($replaceSQL, $insertSQL, $sql);
1044 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
1045 $result = CRM_Core_DAO
::executeQuery($sql);
1048 if (is_a($result, 'DB_Error')) {
1049 // check if we get error during core search
1051 // in the case of error, try rebuilding cache using full sql which is used for search selector display
1052 // this fixes the bugs reported in CRM-13996 & CRM-14438
1053 $this->rebuildPreNextCache($start, $end, $sort, $cacheKey);
1056 // return if above query fails
1061 // also record an entry in the cache key table, so we can delete it periodically
1062 CRM_Core_BAO_Cache
::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
1066 * called to rebuild prev next cache using full sql in case of core search ( excluding custom search)
1069 * Start for limit clause.
1071 * End for limit clause.
1072 * @param CRM_Utils_Sort $sort
1073 * @param string $cacheKey
1078 public function rebuildPreNextCache($start, $end, $sort, $cacheKey) {
1079 // generate full SQL
1080 $sql = $this->_query
->searchQuery($start, $end, $sort, FALSE, $this->_query
->_includeContactIds
,
1081 FALSE, FALSE, TRUE);
1083 $dao = CRM_Core_DAO
::executeQuery($sql);
1085 // build insert query, note that currently we build cache for 500 contact records at a time, hence below approach
1086 $insertValues = array();
1087 while ($dao->fetch()) {
1088 $insertValues[] = "('civicrm_contact', {$dao->contact_id}, {$dao->contact_id}, '{$cacheKey}', '" . CRM_Core_DAO
::escapeString($dao->sort_name
) . "')";
1091 //update pre/next cache using single insert query
1092 if (!empty($insertValues)) {
1093 $sql = 'INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data ) VALUES
1094 ' . implode(',', $insertValues);
1096 $result = CRM_Core_DAO
::executeQuery($sql);
1103 public function getQILL() {
1104 return $this->_query
->qill();
1108 * Name of export file.
1110 * @param string $output
1116 public function getExportFileName($output = 'csv') {
1117 return ts('CiviCRM Contact Search');
1121 * Get colunmn headers for search selector.
1125 private static function &_getColumnHeaders() {
1126 if (!isset(self
::$_columnHeaders)) {
1127 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1128 'address_options', TRUE, NULL, TRUE
1131 self
::$_columnHeaders = array(
1132 'contact_type' => array('desc' => ts('Contact Type')),
1133 'sort_name' => array(
1134 'name' => ts('Name'),
1135 'sort' => 'sort_name',
1136 'direction' => CRM_Utils_Sort
::ASCENDING
,
1140 $defaultAddress = array(
1141 'street_address' => array('name' => ts('Address')),
1143 'name' => ts('City'),
1145 'direction' => CRM_Utils_Sort
::DONTCARE
,
1147 'state_province' => array(
1148 'name' => ts('State'),
1149 'sort' => 'state_province',
1150 'direction' => CRM_Utils_Sort
::DONTCARE
,
1152 'postal_code' => array(
1153 'name' => ts('Postal'),
1154 'sort' => 'postal_code',
1155 'direction' => CRM_Utils_Sort
::DONTCARE
,
1158 'name' => ts('Country'),
1159 'sort' => 'country',
1160 'direction' => CRM_Utils_Sort
::DONTCARE
,
1164 foreach ($defaultAddress as $columnName => $column) {
1165 if (!empty($addressOptions[$columnName])) {
1166 self
::$_columnHeaders[$columnName] = $column;
1170 self
::$_columnHeaders['email'] = array(
1171 'name' => ts('Email'),
1173 'direction' => CRM_Utils_Sort
::DONTCARE
,
1176 self
::$_columnHeaders['phone'] = array('name' => ts('Phone'));
1178 return self
::$_columnHeaders;
1182 * @return CRM_Contact_BAO_Query
1184 public function &getQuery() {
1185 return $this->_query
;
1189 * @return CRM_Contact_DAO_Contact
1191 public function alphabetQuery() {
1192 return $this->_query
->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
1196 * @param array $params
1198 * @param int $sortID
1199 * @param null $displayRelationshipType
1200 * @param string $queryOperator
1202 * @return CRM_Contact_DAO_Contact
1204 public function contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
1205 $sortOrder = &$this->getSortOrder($this->_action
);
1206 $sort = new CRM_Utils_Sort($sortOrder, $sortID);
1208 // rectify params to what proximity search expects if there is a value for prox_distance
1209 // CRM-7021 CRM-7905
1210 if (!empty($params)) {
1211 CRM_Contact_BAO_ProximityQuery
::fixInputParams($params);
1214 if (!$displayRelationshipType) {
1215 $query = new CRM_Contact_BAO_Query($params,
1216 $this->_returnProperties
,
1217 NULL, FALSE, FALSE, 1,
1218 FALSE, TRUE, TRUE, NULL,
1223 $query = new CRM_Contact_BAO_Query($params, $this->_returnProperties
,
1224 NULL, FALSE, FALSE, 1,
1225 FALSE, TRUE, TRUE, $displayRelationshipType,
1229 $value = $query->searchQuery(0, 0, $sort,
1230 FALSE, FALSE, FALSE,
1237 * @param $returnProperties
1241 public function &makeProperties(&$returnProperties) {
1242 $properties = array();
1243 foreach ($returnProperties as $name => $value) {
1244 if ($name != 'location') {
1245 // special handling for group and tag
1246 if (in_array($name, array('group', 'tag'))) {
1250 // special handling for notes
1251 if (in_array($name, array('note', 'note_subject', 'note_body'))) {
1255 $properties[] = $name;
1258 // extract all the location stuff
1259 foreach ($value as $n => $v) {
1260 foreach ($v as $n1 => $v1) {
1261 if (!strpos('_id', $n1) && $n1 != 'location_type') {
1262 $properties[] = "{$n}-{$n1}";