3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * This class is 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 if ($config->mapAPIKey
&& $config->mapProvider
) {
265 self
::$_links[CRM_Core_Action
::MAP
] = array(
267 'url' => 'civicrm/contact/map',
268 'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
269 'title' => ts('Map Contact'),
273 // Adding Context Menu Links in more action
276 foreach ($contextMenu as $key => $value) {
277 $contextVal = '&context=' . $value['key'];
278 if ($value['key'] == 'delete') {
279 $contextVal = $searchContext;
281 $url = "civicrm/contact/view/{$value['key']}";
282 $qs = "reset=1&action=add&cid=%%id%%{$contextVal}{$extraParams}";
283 if ($value['key'] == 'activity') {
284 $qs = "action=browse&selectedChild=activity&reset=1&cid=%%id%%{$extraParams}";
286 elseif ($value['key'] == 'email') {
287 $url = "civicrm/contact/view/activity";
288 $qs = "atype=3&action=add&reset=1&cid=%%id%%{$extraParams}";
291 self
::$_links[$counter++
] = array(
292 'name' => $value['title'],
295 'title' => $value['title'],
296 'ref' => $value['ref'],
297 'class' => CRM_Utils_Array
::value('class', $value),
302 return self
::$_links;
306 * Getter for array of the parameters required for creating pager.
309 * @param array $params
311 public function getPagerParams($action, &$params) {
312 $params['status'] = ts('Contact %%StatusMessage%%');
313 $params['csvString'] = NULL;
314 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
316 $params['buttonTop'] = 'PagerTopButton';
317 $params['buttonBottom'] = 'PagerBottomButton';
321 * @param null $action
322 * @param null $output
326 public function &getColHeads($action = NULL, $output = NULL) {
327 $colHeads = self
::_getColumnHeaders();
328 $colHeads[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
333 * Returns the column headers as an array of tuples:
334 * (name, sortName (key to the sort array))
336 * @param string $action
337 * The action being performed.
338 * @param string $output
339 * What should the result set include (web/email/csv).
342 * the column headers that need to be displayed
344 public function &getColumnHeaders($action = NULL, $output = NULL) {
347 // unset return property elements that we don't care
348 if (!empty($this->_returnProperties
)) {
349 $doNotCareElements = array(
354 foreach ($doNotCareElements as $value) {
355 unset($this->_returnProperties
[$value]);
359 if ($output == CRM_Core_Selector_Controller
::EXPORT
) {
360 $csvHeaders = array(ts('Contact ID'), ts('Contact Type'));
361 foreach ($this->getColHeads($action, $output) as $column) {
362 if (array_key_exists('name', $column)) {
363 $csvHeaders[] = $column['name'];
366 $headers = $csvHeaders;
368 elseif ($output == CRM_Core_Selector_Controller
::SCREEN
) {
369 $csvHeaders = array(ts('Name'));
370 foreach ($this->getColHeads($action, $output) as $key => $column) {
371 if (array_key_exists('name', $column) &&
373 $column['name'] != ts('Name')
375 $csvHeaders[$key] = $column['name'];
378 $headers = $csvHeaders;
380 elseif ($this->_ufGroupID
) {
381 // we dont use the cached value of column headers
382 // since it potentially changed because of the profile selected
383 static $skipFields = array('group', 'tag');
384 $direction = CRM_Utils_Sort
::ASCENDING
;
386 if (!self
::$_columnHeaders) {
387 self
::$_columnHeaders = array(
390 'name' => ts('Name'),
391 'sort' => 'sort_name',
392 'direction' => CRM_Utils_Sort
::ASCENDING
,
396 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
398 foreach ($this->_fields
as $name => $field) {
399 if (!empty($field['in_selector']) &&
400 !in_array($name, $skipFields)
402 if (strpos($name, '-') !== FALSE) {
403 list($fieldName, $lType, $type) = CRM_Utils_System
::explode('-', $name, 3);
405 if ($lType == 'Primary') {
406 $locationTypeName = 1;
409 $locationTypeName = $locationTypes[$lType];
412 if (in_array($fieldName, array(
418 $name = "`$locationTypeName-$fieldName-$type`";
421 $name = "`$locationTypeName-$fieldName`";
425 $name = "`$locationTypeName-$fieldName`";
428 //to handle sort key for Internal contactId.CRM-2289
430 $name = 'contact_id';
433 self
::$_columnHeaders[] = array(
434 'name' => $field['title'],
436 'direction' => $direction,
438 $direction = CRM_Utils_Sort
::DONTCARE
;
443 // if we dont have any valid columns, dont add the implicit ones
444 // this allows the template to check on emptiness of column headers
446 self
::$_columnHeaders = array();
449 self
::$_columnHeaders[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
452 $headers = self
::$_columnHeaders;
454 elseif (!empty($this->_returnProperties
)) {
455 self
::$_columnHeaders = array(
458 'name' => ts('Name'),
459 'sort' => 'sort_name',
460 'direction' => CRM_Utils_Sort
::ASCENDING
,
463 $properties = self
::makeProperties($this->_returnProperties
);
465 foreach ($properties as $prop) {
466 if (strpos($prop, '-')) {
467 list($loc, $fld, $phoneType) = CRM_Utils_System
::explode('-', $prop, 3);
468 $title = $this->_query
->_fields
[$fld]['title'];
469 if (trim($phoneType) && !is_numeric($phoneType) && strtolower($phoneType) != $fld) {
470 $title .= "-{$phoneType}";
474 elseif (isset($this->_query
->_fields
[$prop]) && isset($this->_query
->_fields
[$prop]['title'])) {
475 $title = $this->_query
->_fields
[$prop]['title'];
481 self
::$_columnHeaders[] = array('name' => $title, 'sort' => $prop);
483 self
::$_columnHeaders[] = array('name' => ts('Actions'));
484 $headers = self
::$_columnHeaders;
487 $headers = $this->getColHeads($action, $output);
494 * Returns total number of rows for the query.
499 * Total number of rows
501 public function getTotalCount($action) {
502 // Use count from cache during paging/sorting
503 if (!empty($_GET['crmPID']) ||
!empty($_GET['crmSID'])) {
504 $count = CRM_Core_BAO_Cache
::getItem('Search Results Count', $this->_key
);
507 $count = $this->_query
->searchQuery(0, 0, NULL, TRUE);
508 CRM_Core_BAO_Cache
::setItem($count, 'Search Results Count', $this->_key
);
514 * Returns all the rows in the given offset and rowCount
516 * @param string $action
517 * The action being performed.
519 * The row number to start from.
520 * @param int $rowCount
521 * The number of rows to return.
522 * @param string $sort
523 * The sql string that describes the sort order.
524 * @param string $output
525 * What should the result set include (web/email/csv).
528 * the total number of rows for this action
530 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
531 $config = CRM_Core_Config
::singleton();
533 if (($output == CRM_Core_Selector_Controller
::EXPORT ||
534 $output == CRM_Core_Selector_Controller
::SCREEN
536 $this->_formValues
['radio_ts'] == 'ts_sel'
538 $includeContactIds = TRUE;
541 $includeContactIds = FALSE;
544 // note the formvalues were given by CRM_Contact_Form_Search to us
545 // and contain the search criteria (parameters)
546 // note that the default action is basic
548 $cacheKey = $this->buildPrevNextCache($sort);
549 $result = $this->_query
->getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds);
552 $result = $this->_query
->searchQuery($offset, $rowCount, $sort, FALSE, $includeContactIds);
555 // process the result of the query
557 $permissions = array(CRM_Core_Permission
::getPermission());
558 if (CRM_Core_Permission
::check('delete contacts')) {
559 $permissions[] = CRM_Core_Permission
::DELETE
;
561 $mask = CRM_Core_Action
::mask($permissions);
563 // mask value to hide map link if there are not lat/long
564 $mapMask = $mask & 4095;
566 if ($this->_searchContext
== 'smog') {
567 $gc = CRM_Core_SelectValues
::groupContactStatus();
570 if ($this->_ufGroupID
) {
571 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
574 static $skipFields = array('group', 'tag');
575 foreach ($this->_fields
as $key => $field) {
576 if (!empty($field['in_selector']) &&
577 !in_array($key, $skipFields)
579 if (strpos($key, '-') !== FALSE) {
580 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $key, 3);
582 if ($id == 'Primary') {
583 $locationTypeName = 1;
586 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
587 if (!$locationTypeName) {
592 $locationTypeName = str_replace(' ', '_', $locationTypeName);
593 if (in_array($fieldName, array(
599 $names[] = "{$locationTypeName}-{$fieldName}-{$type}";
602 $names[] = "{$locationTypeName}-{$fieldName}";
606 $names[] = "{$locationTypeName}-{$fieldName}";
610 $names[] = $field['name'];
617 elseif (!empty($this->_returnProperties
)) {
618 $names = self
::makeProperties($this->_returnProperties
);
621 $names = self
::$_properties;
624 $multipleSelectFields = array('preferred_communication_method' => 1);
626 $links = self
::links($this->_context
, $this->_contextMenu
, $this->_key
);
628 //check explicitly added contact to a Smart Group.
629 $groupID = CRM_Utils_Array
::key('1', $this->_formValues
['group']);
631 $pseudoconstants = array();
632 // for CRM-3157 purposes
633 if (in_array('world_region', $names)) {
634 $pseudoconstants['world_region'] = array(
635 'dbName' => 'world_region_id',
636 'values' => CRM_Core_PseudoConstant
::worldRegion(),
641 while ($result->fetch()) {
643 $this->_query
->convertToPseudoNames($result);
645 // the columns we are interested in
646 foreach ($names as $property) {
647 if ($property == 'status') {
650 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($property)) {
651 $row[$property] = CRM_Core_BAO_CustomField
::getDisplayValue(
659 $multipleSelectFields &&
660 array_key_exists($property, $multipleSelectFields)
663 $paramsNew = array($key => $result->$property);
664 $name = array($key => array('newName' => $key, 'groupName' => $key));
666 CRM_Core_OptionGroup
::lookupValues($paramsNew, $name, FALSE);
667 $row[$key] = $paramsNew[$key];
669 elseif (strpos($property, '-im')) {
670 $row[$property] = $result->$property;
671 if (!empty($result->$property)) {
672 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
673 $providerId = $property . "-provider_id";
674 $providerName = $imProviders[$result->$providerId];
675 $row[$property] = $result->$property . " ({$providerName})";
678 elseif (in_array($property, array(
683 $greeting = $property . '_display';
684 $row[$property] = $result->$greeting;
686 elseif (isset($pseudoconstants[$property])) {
687 $row[$property] = CRM_Utils_Array
::value(
688 $result->{$pseudoconstants[$property]['dbName']},
689 $pseudoconstants[$property]['values']
692 elseif (strpos($property, '-url') !== FALSE) {
694 $websiteKey = 'website-1';
695 $propertyArray = explode('-', $property);
696 $websiteFld = $websiteKey . '-' . array_pop($propertyArray);
697 if (!empty($result->$websiteFld)) {
698 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
699 $websiteType = $websiteTypes[$result->{"$websiteKey-website_type_id"}];
700 $websiteValue = $result->$websiteFld;
701 $websiteUrl = "<a href=\"{$websiteValue}\">{$websiteValue} ({$websiteType})</a>";
703 $row[$property] = $websiteUrl;
706 $row[$property] = isset($result->$property) ?
$result->$property : NULL;
710 if (!empty($result->postal_code_suffix
)) {
711 $row['postal_code'] .= "-" . $result->postal_code_suffix
;
714 if ($output != CRM_Core_Selector_Controller
::EXPORT
&&
715 $this->_searchContext
== 'smog'
717 if (empty($result->status
) &&
720 $contactID = $result->contact_id
;
723 'contact_id' => $contactID,
724 'group_id' => $groupID,
727 $gcDefaults = array();
728 CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_GroupContact', $gcParams, $gcDefaults);
730 if (empty($gcDefaults)) {
731 $row['status'] = ts('Smart');
734 $row['status'] = $gc[$gcDefaults['status']];
738 $row['status'] = NULL;
742 $row['status'] = $gc[$result->status
];
746 if ($output != CRM_Core_Selector_Controller
::EXPORT
) {
747 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->contact_id
;
749 if (!empty($this->_formValues
['deleted_contacts']) && CRM_Core_Permission
::check('access deleted contacts')
753 'name' => ts('View'),
754 'url' => 'civicrm/contact/view',
755 'qs' => 'reset=1&cid=%%id%%',
756 'class' => 'no-popup',
757 'title' => ts('View Contact Details'),
760 'name' => ts('Restore'),
761 'url' => 'civicrm/contact/view/delete',
762 'qs' => 'reset=1&cid=%%id%%&restore=1',
763 'title' => ts('Restore Contact'),
766 if (CRM_Core_Permission
::check('delete contacts')) {
768 'name' => ts('Delete Permanently'),
769 'url' => 'civicrm/contact/view/delete',
770 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
771 'title' => ts('Permanently Delete Contact'),
774 $row['action'] = CRM_Core_Action
::formLink(
777 array('id' => $result->contact_id
),
780 'contact.selector.row',
785 elseif ((is_numeric(CRM_Utils_Array
::value('geo_code_1', $row))) ||
786 ($config->mapGeoCoding
&& !empty($row['city']) &&
787 CRM_Utils_Array
::value('state_province', $row)
790 $row['action'] = CRM_Core_Action
::formLink(
793 array('id' => $result->contact_id
),
796 'contact.selector.row',
802 $row['action'] = CRM_Core_Action
::formLink(
805 array('id' => $result->contact_id
),
808 'contact.selector.row',
814 // allow components to add more actions
815 CRM_Core_Component
::searchAction($row, $result->contact_id
);
817 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
,
822 $row['contact_type_orig'] = $result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
;
823 $row['contact_sub_type'] = $result->contact_sub_type ? CRM_Contact_BAO_ContactType
::contactTypePairs(FALSE, $result->contact_sub_type
, ', ') : $result->contact_sub_type
;
824 $row['contact_id'] = $result->contact_id
;
825 $row['sort_name'] = $result->sort_name
;
826 if (array_key_exists('id', $row)) {
827 $row['id'] = $result->contact_id
;
832 if (in_array($row['contact_id'], $seenIDs) === FALSE) {
833 $seenIDs[] = $row['contact_id'];
842 * @param CRM_Utils_Sort $sort
846 public function buildPrevNextCache($sort) {
847 $cacheKey = 'civicrm search ' . $this->_key
;
849 // We should clear the cache in following conditions:
850 // 1. when starting from scratch, i.e new search
851 // 2. if records are sorted
853 // get current page requested
854 $pageNum = CRM_Utils_Request
::retrieve('crmPID', 'Integer', CRM_Core_DAO
::$_nullObject);
856 // get the current sort order
857 $currentSortID = CRM_Utils_Request
::retrieve('crmSID', 'String', CRM_Core_DAO
::$_nullObject);
859 $session = CRM_Core_Session
::singleton();
861 // get previous sort id
862 $previousSortID = $session->get('previousSortID');
864 // check for current != previous to ensure cache is not reset if paging is done without changing
866 if (!$pageNum ||
(!empty($currentSortID) && $currentSortID != $previousSortID)) {
867 CRM_Core_BAO_PrevNextCache
::deleteItem(NULL, $cacheKey, 'civicrm_contact');
868 // this means it's fresh search, so set pageNum=1
874 // set the current sort as previous sort
875 if (!empty($currentSortID)) {
876 $session->set('previousSortID', $currentSortID);
879 $pageSize = CRM_Utils_Request
::retrieve('crmRowCount', 'Integer', CRM_Core_DAO
::$_nullObject, FALSE, 50);
880 $firstRecord = ($pageNum - 1) * $pageSize;
882 //for alphabetic pagination selection save
883 $sortByCharacter = CRM_Utils_Request
::retrieve('sortByCharacter', 'String', CRM_Core_DAO
::$_nullObject);
885 //for text field pagination selection save
886 $countRow = CRM_Core_BAO_PrevNextCache
::getCount($cacheKey, NULL, "entity_table = 'civicrm_contact'");
888 // $sortByCharacter triggers a refresh in the prevNext cache
889 if ($sortByCharacter && $sortByCharacter != 'all') {
890 $cacheKey .= "_alphabet";
891 $this->fillupPrevNextCache($sort, $cacheKey);
893 elseif ($firstRecord >= $countRow) {
894 $this->fillupPrevNextCache($sort, $cacheKey, $countRow, 500);
902 public function addActions(&$rows) {
903 $config = CRM_Core_Config
::singleton();
905 $permissions = array(CRM_Core_Permission
::getPermission());
906 if (CRM_Core_Permission
::check('delete contacts')) {
907 $permissions[] = CRM_Core_Permission
::DELETE
;
909 $mask = CRM_Core_Action
::mask($permissions);
910 // mask value to hide map link if there are not lat/long
911 $mapMask = $mask & 4095;
913 // mask value to hide map link if there are not lat/long
914 $mapMask = $mask & 4095;
916 $links = self
::links($this->_context
, $this->_contextMenu
, $this->_key
);
918 foreach ($rows as $id => & $row) {
919 if (!empty($this->_formValues
['deleted_contacts']) && CRM_Core_Permission
::check('access deleted contacts')
923 'name' => ts('View'),
924 'url' => 'civicrm/contact/view',
925 'qs' => 'reset=1&cid=%%id%%',
926 'class' => 'no-popup',
927 'title' => ts('View Contact Details'),
930 'name' => ts('Restore'),
931 'url' => 'civicrm/contact/view/delete',
932 'qs' => 'reset=1&cid=%%id%%&restore=1',
933 'title' => ts('Restore Contact'),
936 if (CRM_Core_Permission
::check('delete contacts')) {
938 'name' => ts('Delete Permanently'),
939 'url' => 'civicrm/contact/view/delete',
940 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
941 'title' => ts('Permanently Delete Contact'),
944 $row['action'] = CRM_Core_Action
::formLink(
947 array('id' => $row['contact_id']),
950 'contact.selector.actions',
955 elseif ((is_numeric(CRM_Utils_Array
::value('geo_code_1', $row))) ||
956 ($config->mapGeoCoding
&& !empty($row['city']) &&
957 CRM_Utils_Array
::value('state_province', $row)
960 $row['action'] = CRM_Core_Action
::formLink(
963 array('id' => $row['contact_id']),
966 'contact.selector.actions',
972 $row['action'] = CRM_Core_Action
::formLink(
975 array('id' => $row['contact_id']),
978 'contact.selector.actions',
984 // allow components to add more actions
985 CRM_Core_Component
::searchAction($row, $row['contact_id']);
987 if (!empty($row['contact_type_orig'])) {
988 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($row['contact_type_orig'],
989 FALSE, $row['contact_id']);
997 public function removeActions(&$rows) {
998 foreach ($rows as $rid => & $rValue) {
999 unset($rValue['contact_type']);
1000 unset($rValue['action']);
1005 * @param CRM_Utils_Sort $sort
1006 * @param string $cacheKey
1010 public function fillupPrevNextCache($sort, $cacheKey, $start = 0, $end = 500) {
1012 // For custom searches, use the contactIDs method
1013 if (is_a($this, 'CRM_Contact_Selector_Custom')) {
1014 $sql = $this->_search
->contactIDs($start, $end, $sort, TRUE);
1015 $replaceSQL = "SELECT contact_a.id as contact_id";
1016 $coreSearch = FALSE;
1018 // For core searches use the searchQuery method
1020 $sql = $this->_query
->searchQuery($start, $end, $sort, FALSE, $this->_query
->_includeContactIds
,
1022 $replaceSQL = "SELECT contact_a.id as id";
1026 // due to limitations in our search query writer, the above query does not work
1027 // in cases where the query is being sorted on a non-contact table
1028 // this results in a fatal error :(
1029 // see below for the gross hack of trapping the error and not filling
1030 // the prev next cache in this situation
1031 // the other alternative of running the FULL query will just be incredibly inefficient
1032 // and slow things down way too much on large data sets / complex queries
1035 INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data )
1036 SELECT DISTINCT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.display_name
1039 $sql = str_replace($replaceSQL, $insertSQL, $sql);
1041 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
1042 $result = CRM_Core_DAO
::executeQuery($sql);
1045 if (is_a($result, 'DB_Error')) {
1046 // check if we get error during core search
1048 // in the case of error, try rebuilding cache using full sql which is used for search selector display
1049 // this fixes the bugs reported in CRM-13996 & CRM-14438
1050 $this->rebuildPreNextCache($start, $end, $sort, $cacheKey);
1053 // return if above query fails
1058 // also record an entry in the cache key table, so we can delete it periodically
1059 CRM_Core_BAO_Cache
::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
1063 * called to rebuild prev next cache using full sql in case of core search ( excluding custom search)
1066 * Start for limit clause.
1068 * End for limit clause.
1069 * @param CRM_Utils_Sort $sort
1070 * @param string $cacheKey
1075 public function rebuildPreNextCache($start, $end, $sort, $cacheKey) {
1076 // generate full SQL
1077 $sql = $this->_query
->searchQuery($start, $end, $sort, FALSE, $this->_query
->_includeContactIds
,
1078 FALSE, FALSE, TRUE);
1080 $dao = CRM_Core_DAO
::executeQuery($sql);
1082 // build insert query, note that currently we build cache for 500 contact records at a time, hence below approach
1083 $insertValues = array();
1084 while ($dao->fetch()) {
1085 $insertValues[] = "('civicrm_contact', {$dao->contact_id}, {$dao->contact_id}, '{$cacheKey}', '" . CRM_Core_DAO
::escapeString($dao->sort_name
) . "')";
1088 //update pre/next cache using single insert query
1089 if (!empty($insertValues)) {
1090 $sql = 'INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data ) VALUES
1091 ' . implode(',', $insertValues);
1093 $result = CRM_Core_DAO
::executeQuery($sql);
1100 public function getQILL() {
1101 return $this->_query
->qill();
1105 * Name of export file.
1107 * @param string $output
1113 public function getExportFileName($output = 'csv') {
1114 return ts('CiviCRM Contact Search');
1118 * Get colunmn headers for search selector
1122 private static function &_getColumnHeaders() {
1123 if (!isset(self
::$_columnHeaders)) {
1124 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
1125 'address_options', TRUE, NULL, TRUE
1128 self
::$_columnHeaders = array(
1129 'contact_type' => array('desc' => ts('Contact Type')),
1130 'sort_name' => array(
1131 'name' => ts('Name'),
1132 'sort' => 'sort_name',
1133 'direction' => CRM_Utils_Sort
::ASCENDING
,
1137 $defaultAddress = array(
1138 'street_address' => array('name' => ts('Address')),
1140 'name' => ts('City'),
1142 'direction' => CRM_Utils_Sort
::DONTCARE
,
1144 'state_province' => array(
1145 'name' => ts('State'),
1146 'sort' => 'state_province',
1147 'direction' => CRM_Utils_Sort
::DONTCARE
,
1149 'postal_code' => array(
1150 'name' => ts('Postal'),
1151 'sort' => 'postal_code',
1152 'direction' => CRM_Utils_Sort
::DONTCARE
,
1155 'name' => ts('Country'),
1156 'sort' => 'country',
1157 'direction' => CRM_Utils_Sort
::DONTCARE
,
1161 foreach ($defaultAddress as $columnName => $column) {
1162 if (!empty($addressOptions[$columnName])) {
1163 self
::$_columnHeaders[$columnName] = $column;
1167 self
::$_columnHeaders['email'] = array(
1168 'name' => ts('Email'),
1170 'direction' => CRM_Utils_Sort
::DONTCARE
,
1173 self
::$_columnHeaders['phone'] = array('name' => ts('Phone'));
1175 return self
::$_columnHeaders;
1179 * @return CRM_Contact_BAO_Query
1181 public function &getQuery() {
1182 return $this->_query
;
1186 * @return CRM_Contact_DAO_Contact
1188 public function alphabetQuery() {
1189 return $this->_query
->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
1193 * @param array $params
1195 * @param int $sortID
1196 * @param null $displayRelationshipType
1197 * @param string $queryOperator
1199 * @return CRM_Contact_DAO_Contact
1201 public function contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
1202 $sortOrder = &$this->getSortOrder($this->_action
);
1203 $sort = new CRM_Utils_Sort($sortOrder, $sortID);
1205 // rectify params to what proximity search expects if there is a value for prox_distance
1206 // CRM-7021 CRM-7905
1207 if (!empty($params)) {
1208 CRM_Contact_BAO_ProximityQuery
::fixInputParams($params);
1211 if (!$displayRelationshipType) {
1212 $query = new CRM_Contact_BAO_Query($params,
1213 $this->_returnProperties
,
1214 NULL, FALSE, FALSE, 1,
1215 FALSE, TRUE, TRUE, NULL,
1220 $query = new CRM_Contact_BAO_Query($params, $this->_returnProperties
,
1221 NULL, FALSE, FALSE, 1,
1222 FALSE, TRUE, TRUE, $displayRelationshipType,
1226 $value = $query->searchQuery(0, 0, $sort,
1227 FALSE, FALSE, FALSE,
1234 * @param $returnProperties
1238 public function &makeProperties(&$returnProperties) {
1239 $properties = array();
1240 foreach ($returnProperties as $name => $value) {
1241 if ($name != 'location') {
1242 // special handling for group and tag
1243 if (in_array($name, array('group', 'tag'))) {
1247 // special handling for notes
1248 if (in_array($name, array('note', 'note_subject', 'note_body'))) {
1252 $properties[] = $name;
1255 // extract all the location stuff
1256 foreach ($value as $n => $v) {
1257 foreach ($v as $n1 => $v1) {
1258 if (!strpos('_id', $n1) && $n1 != 'location_type') {
1259 $properties[] = "{$n}-{$n1}";