3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
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.
50 static $_links = NULL;
53 * we use desc to remind us what that column is, name is used in the tpl
58 static $_columnHeaders;
61 * Properties of contact we're interested in displaying
65 static $_properties = array(
66 'contact_id', 'contact_type', 'contact_sub_type',
67 'sort_name', 'street_address',
68 'city', 'state_province', 'postal_code', 'country',
69 'geo_code_1', 'geo_code_2', 'is_deceased',
70 'email', 'on_hold', 'phone', 'status',
71 'do_not_email', 'do_not_phone', 'do_not_mail',
75 * formValues is the array returned by exportValues called on
76 * the HTML_QuickForm_Controller for that page.
89 protected $_contextMenu;
92 * params is the array in a value used by the search query creator
100 * The return properties used for search
105 protected $_returnProperties;
108 * represent the type of selector
115 protected $_searchContext;
124 protected $_ufGroupID;
127 * the public visible fields to be shown to the user
137 * @param array $formValues array of form values imported
138 * @param array $params array of parameters for query
139 * @param int $action - action of search basic or advanced.
141 * @return CRM_Contact_Selector
144 function __construct(
148 $returnProperties = NULL,
149 $action = CRM_Core_Action
::NONE
,
150 $includeContactIds = FALSE,
151 $searchDescendentGroups = TRUE,
152 $searchContext = 'search',
155 //don't build query constructor, if form is not submitted
156 $force = CRM_Utils_Request
::retrieve('force', 'Boolean', CRM_Core_DAO
::$_nullObject);
157 if (empty($formValues) && !$force) {
161 // submitted form values
162 $this->_formValues
= &$formValues;
163 $this->_params
= &$params;
164 $this->_returnProperties
= &$returnProperties;
165 $this->_contextMenu
= &$contextMenu;
166 $this->_context
= $searchContext;
169 $this->_action
= $action;
171 $this->_searchContext
= $searchContext;
173 $this->_ufGroupID
= CRM_Utils_Array
::value('uf_group_id', $this->_formValues
);
175 if ($this->_ufGroupID
) {
176 $this->_fields
= CRM_Core_BAO_UFGroup
::getListingFields(CRM_Core_Action
::VIEW
,
177 CRM_Core_BAO_UFGroup
::PUBLIC_VISIBILITY |
178 CRM_Core_BAO_UFGroup
::LISTINGS_VISIBILITY
,
179 FALSE, $this->_ufGroupID
181 self
::$_columnHeaders = NULL;
183 $this->_customFields
= CRM_Core_BAO_CustomField
::getFieldsForImport('Individual');
185 $this->_returnProperties
= CRM_Contact_BAO_Contact
::makeHierReturnProperties($this->_fields
);
186 $this->_returnProperties
['contact_type'] = 1;
187 $this->_returnProperties
['contact_sub_type'] = 1;
188 $this->_returnProperties
['sort_name'] = 1;
191 $displayRelationshipType = CRM_Utils_Array
::value('display_relationship_type', $this->_formValues
);
192 $operator = CRM_Utils_Array
::value('operator', $this->_formValues
, 'AND');
194 // rectify params to what proximity search expects if there is a value for prox_distance
196 if (!empty($this->_params
)) {
197 CRM_Contact_BAO_ProximityQuery
::fixInputParams($this->_params
);
200 $this->_query
= new CRM_Contact_BAO_Query(
202 $this->_returnProperties
,
206 CRM_Contact_BAO_Query
::MODE_CONTACTS
,
208 $searchDescendentGroups,
210 $displayRelationshipType,
214 $this->_options
= &$this->_query
->_options
;
219 * This method returns the links that are given for each search row.
220 * currently the links added for each row are
229 static function &links() {
230 list($context, $contextMenu, $key) = func_get_args();
231 $extraParams = ($key) ?
"&key={$key}" : NULL;
232 $searchContext = ($context) ?
"&context=$context" : NULL;
234 if (!(self
::$_links)) {
235 self
::$_links = array(
236 CRM_Core_Action
::VIEW
=> array(
237 'name' => ts('View'),
238 'url' => 'civicrm/contact/view',
239 'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
240 'title' => ts('View Contact Details'),
241 'ref' => 'view-contact',
243 CRM_Core_Action
::UPDATE
=> array(
244 'name' => ts('Edit'),
245 'url' => 'civicrm/contact/add',
246 'qs' => "reset=1&action=update&cid=%%id%%{$searchContext}{$extraParams}",
247 'title' => ts('Edit Contact Details'),
248 'ref' => 'edit-contact',
252 $config = CRM_Core_Config
::singleton();
253 if ($config->mapAPIKey
&& $config->mapProvider
) {
254 self
::$_links[CRM_Core_Action
::MAP
] = array(
256 'url' => 'civicrm/contact/map',
257 'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}",
258 'title' => ts('Map Contact'),
262 // Adding Context Menu Links in more action
265 foreach ($contextMenu as $key => $value) {
266 $contextVal = '&context=' . $value['key'];
267 if ($value['key'] == 'delete') {
268 $contextVal = $searchContext;
271 $url = "civicrm/contact/view/{$value['key']}";
272 $qs = "reset=1&action=add&cid=%%id%%{$contextVal}{$extraParams}";
273 if ($value['key'] == 'activity') {
274 $qs = "action=browse&selectedChild=activity&reset=1&cid=%%id%%{$extraParams}";
276 elseif ($value['key'] == 'email') {
277 $url = "civicrm/contact/view/activity";
278 $qs = "atype=3&action=add&reset=1&cid=%%id%%{$extraParams}";
281 self
::$_links[$counter++
] = array(
282 'name' => $value['title'],
285 'title' => $value['title'],
286 'ref' => $value['ref'],
291 return self
::$_links;
296 * getter for array of the parameters required for creating pager.
301 function getPagerParams($action, &$params) {
302 $params['status'] = ts('Contact %%StatusMessage%%');
303 $params['csvString'] = NULL;
304 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
306 $params['buttonTop'] = 'PagerTopButton';
307 $params['buttonBottom'] = 'PagerBottomButton';
311 function &getColHeads($action = NULL, $output = NULL) {
312 $colHeads = self
::_getColumnHeaders();
313 $colHeads[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
318 * returns the column headers as an array of tuples:
319 * (name, sortName (key to the sort array))
321 * @param string $action the action being performed
322 * @param enum $output what should the result set include (web/email/csv)
324 * @return array the column headers that need to be displayed
327 function &getColumnHeaders($action = NULL, $output = NULL) {
329 if ($output == CRM_Core_Selector_Controller
::EXPORT
) {
330 $csvHeaders = array(ts('Contact Id'), ts('Contact Type'));
331 foreach ($this->getColHeads($action, $output) as $column) {
332 if (array_key_exists('name', $column)) {
333 $csvHeaders[] = $column['name'];
336 $headers = $csvHeaders;
338 elseif ($output == CRM_Core_Selector_Controller
::SCREEN
) {
339 $csvHeaders = array(ts('Name'));
340 foreach ($this->getColHeads($action, $output) as $key => $column) {
341 if (array_key_exists('name', $column) &&
343 $column['name'] != ts('Name')
345 $csvHeaders[$key] = $column['name'];
348 $headers = $csvHeaders;
350 elseif ($this->_ufGroupID
) {
351 // we dont use the cached value of column headers
352 // since it potentially changed because of the profile selected
353 static $skipFields = array('group', 'tag');
354 $direction = CRM_Utils_Sort
::ASCENDING
;
356 if (!self
::$_columnHeaders) {
357 self
::$_columnHeaders = array(array('name' => ''),
359 'name' => ts('Name'),
360 'sort' => 'sort_name',
361 'direction' => CRM_Utils_Sort
::ASCENDING
,
365 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
367 foreach ($this->_fields
as $name => $field) {
368 if (CRM_Utils_Array
::value('in_selector', $field) &&
369 !in_array($name, $skipFields)
371 if (strpos($name, '-') !== FALSE) {
372 list($fieldName, $lType, $type) = CRM_Utils_System
::explode('-', $name, 3);
374 if ($lType == 'Primary') {
375 $locationTypeName = 1;
378 $locationTypeName = $locationTypes[$lType];
381 if (in_array($fieldName, array(
382 'phone', 'im', 'email'))) {
384 $name = "`$locationTypeName-$fieldName-$type`";
387 $name = "`$locationTypeName-$fieldName`";
391 $name = "`$locationTypeName-$fieldName`";
394 //to handle sort key for Internal contactId.CRM-2289
396 $name = 'contact_id';
399 self
::$_columnHeaders[] = array(
400 'name' => $field['title'],
402 'direction' => $direction,
404 $direction = CRM_Utils_Sort
::DONTCARE
;
409 // if we dont have any valid columns, dont add the implicit ones
410 // this allows the template to check on emptiness of column headers
412 self
::$_columnHeaders = array();
415 self
::$_columnHeaders[] = array('desc' => ts('Actions'), 'name' => ts('Action'));
418 $headers = self
::$_columnHeaders;
420 elseif (!empty($this->_returnProperties
)) {
421 self
::$_columnHeaders = array(array('name' => ''),
423 'name' => ts('Name'),
424 'sort' => 'sort_name',
425 'direction' => CRM_Utils_Sort
::ASCENDING
,
428 $properties = self
::makeProperties($this->_returnProperties
);
430 foreach ($properties as $prop) {
431 if ($prop == 'contact_type' ||
$prop == 'contact_sub_type' ||
$prop == 'sort_name') {
435 if (strpos($prop, '-')) {
436 list($loc, $fld, $phoneType) = CRM_Utils_System
::explode('-', $prop, 3);
437 $title = $this->_query
->_fields
[$fld]['title'];
438 if (trim($phoneType) && !is_numeric($phoneType) && strtolower($phoneType) != $fld) {
439 $title .= "-{$phoneType}";
443 elseif (isset($this->_query
->_fields
[$prop]) && isset($this->_query
->_fields
[$prop]['title'])) {
444 $title = $this->_query
->_fields
[$prop]['title'];
449 self
::$_columnHeaders[] = array('name' => $title, 'sort' => $prop);
451 self
::$_columnHeaders[] = array('name' => ts('Actions'));
452 $headers = self
::$_columnHeaders;
455 $headers = $this->getColHeads($action, $output);
462 * Returns total number of rows for the query.
466 * @return int Total number of rows
469 function getTotalCount($action) {
470 return $this->_query
->searchQuery(0, 0, NULL, TRUE);
474 * returns all the rows in the given offset and rowCount
476 * @param enum $action the action being performed
477 * @param int $offset the row number to start from
478 * @param int $rowCount the number of rows to return
479 * @param string $sort the sql string that describes the sort order
480 * @param enum $output what should the result set include (web/email/csv)
482 * @return int the total number of rows for this action
484 function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
485 $config = CRM_Core_Config
::singleton();
487 if (($output == CRM_Core_Selector_Controller
::EXPORT ||
488 $output == CRM_Core_Selector_Controller
::SCREEN
490 $this->_formValues
['radio_ts'] == 'ts_sel'
492 $includeContactIds = TRUE;
495 $includeContactIds = FALSE;
498 // note the formvalues were given by CRM_Contact_Form_Search to us
499 // and contain the search criteria (parameters)
500 // note that the default action is basic
501 $result = $this->_query
->searchQuery($offset, $rowCount, $sort, FALSE, $includeContactIds);
503 // process the result of the query
505 $permissions = array(CRM_Core_Permission
::getPermission());
506 if (CRM_Core_Permission
::check('delete contacts')) {
507 $permissions[] = CRM_Core_Permission
::DELETE
;
509 $mask = CRM_Core_Action
::mask($permissions);
511 // mask value to hide map link if there are not lat/long
512 $mapMask = $mask & 4095;
514 if ($this->_searchContext
== 'smog') {
515 $gc = CRM_Core_SelectValues
::groupContactStatus();
518 if ($this->_ufGroupID
) {
519 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
522 static $skipFields = array('group', 'tag');
523 foreach ($this->_fields
as $key => $field) {
525 CRM_Utils_Array
::value('in_selector', $field) &&
526 !in_array($key, $skipFields)
528 if (strpos($key, '-') !== FALSE) {
529 list($fieldName, $id, $type) = CRM_Utils_System
::explode('-', $key, 3);
531 if ($id == 'Primary') {
532 $locationTypeName = 1;
535 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
536 if (!$locationTypeName) {
541 $locationTypeName = str_replace(' ', '_', $locationTypeName);
542 if (in_array($fieldName, array(
543 'phone', 'im', 'email'))) {
545 $names[] = "{$locationTypeName}-{$fieldName}-{$type}";
548 $names[] = "{$locationTypeName}-{$fieldName}";
552 $names[] = "{$locationTypeName}-{$fieldName}";
556 $names[] = $field['name'];
563 elseif (!empty($this->_returnProperties
)) {
564 $names = self
::makeProperties($this->_returnProperties
);
567 $names = self
::$_properties;
570 $multipleSelectFields = array('preferred_communication_method' => 1);
572 $links = self
::links($this->_context
, $this->_contextMenu
, $this->_key
);
574 //check explicitly added contact to a Smart Group.
575 $groupID = CRM_Utils_Array
::key('1', $this->_formValues
['group']);
577 $pseudoconstants = array();
578 if (!empty($this->_fields
)) {
579 // get all the pseudoconstant values
580 foreach ($this->_fields
as $name => $values) {
581 if (isset($this->_fields
[$name]['pseudoconstant'])) {
582 $pseudoconstants[$name] =
584 'dbName' => $this->_fields
[$name]['name'],
585 'values' => CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', $name),
591 // for CRM-3157 purposes
592 if (in_array('country', $names)) {
593 $pseudoconstants['country'] = array(
594 'dbName' => 'country_id',
595 'values' => CRM_Core_PseudoConstant
::country()
599 if (in_array('state_province', $names)) {
600 $pseudoconstants['state_province'] = array(
601 'dbName' => 'state_province_id',
602 'values' => CRM_Core_PseudoConstant
::stateProvince()
606 if (in_array('world_region', $names)) {
607 $pseudoconstants['world_region'] = array(
608 'dbName' => 'world_region_id',
609 'values' => CRM_Core_PseudoConstant
::worldRegion()
614 while ($result->fetch()) {
617 // the columns we are interested in
618 foreach ($names as $property) {
619 if ($property == 'status') {
622 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($property)) {
623 $row[$property] = CRM_Core_BAO_CustomField
::getDisplayValue(
631 $multipleSelectFields &&
632 array_key_exists($property, $multipleSelectFields)
635 $paramsNew = array($key => $result->$property);
636 $name = array($key => array('newName' => $key, 'groupName' => $key));
638 CRM_Core_OptionGroup
::lookupValues($paramsNew, $name, FALSE);
639 $row[$key] = $paramsNew[$key];
641 elseif (strpos($property, '-im')) {
642 $row[$property] = $result->$property;
643 if (!empty($result->$property)) {
644 $imProviders = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_IM', 'provider_id');
645 $providerId = $property . "-provider_id";
646 $providerName = $imProviders[$result->$providerId];
647 $row[$property] = $result->$property . " ({$providerName})";
650 elseif (in_array($property, array(
651 'addressee', 'email_greeting', 'postal_greeting'))) {
652 $greeting = $property . '_display';
653 $row[$property] = $result->$greeting;
655 elseif (isset($pseudoconstants[$property])) {
656 $row[$property] = CRM_Utils_Array
::value(
657 $result->{$pseudoconstants[$property]['dbName']},
658 $pseudoconstants[$property]['values']
661 elseif (strpos($property, '-url') !== FALSE) {
663 $websiteKey = 'website-1';
664 $propertyArray = explode('-', $property);
665 $websiteFld = $websiteKey . '-' . array_pop($propertyArray);
666 if (!empty($result->$websiteFld)) {
667 $websiteTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Website', 'website_type_id');
668 $websiteType = $websiteTypes[$result->{"$websiteKey-website_type_id"}];
669 $websiteValue = $result->$websiteFld;
670 $websiteUrl = "<a href=\"{$websiteValue}\">{$websiteValue} ({$websiteType})</a>";
672 $row[$property] = $websiteUrl;
675 $row[$property] = isset($result->$property) ?
$result->$property : NULL;
679 if (!empty($result->postal_code_suffix
)) {
680 $row['postal_code'] .= "-" . $result->postal_code_suffix
;
683 if ($output != CRM_Core_Selector_Controller
::EXPORT
&&
684 $this->_searchContext
== 'smog'
686 if (empty($result->status
) &&
689 $contactID = $result->contact_id
;
692 'contact_id' => $contactID,
693 'group_id' => $groupID,
696 $gcDefaults = array();
697 CRM_Core_DAO
::commonRetrieve('CRM_Contact_DAO_GroupContact', $gcParams, $gcDefaults);
699 if (empty($gcDefaults)) {
700 $row['status'] = ts('Smart');
703 $row['status'] = $gc[$gcDefaults['status']];
707 $row['status'] = NULL;
711 $row['status'] = $gc[$result->status
];
715 if ($output != CRM_Core_Selector_Controller
::EXPORT
) {
716 $row['checkbox'] = CRM_Core_Form
::CB_PREFIX
. $result->contact_id
;
718 if (CRM_Utils_Array
::value('deleted_contacts', $this->_formValues
)
719 && CRM_Core_Permission
::check('access deleted contacts')
723 'name' => ts('View'),
724 'url' => 'civicrm/contact/view',
725 'qs' => 'reset=1&cid=%%id%%',
726 'title' => ts('View Contact Details'),
729 'name' => ts('Restore'),
730 'url' => 'civicrm/contact/view/delete',
731 'qs' => 'reset=1&cid=%%id%%&restore=1',
732 'title' => ts('Restore Contact'),
735 if (CRM_Core_Permission
::check('delete contacts')) {
737 'name' => ts('Delete Permanently'),
738 'url' => 'civicrm/contact/view/delete',
739 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
740 'title' => ts('Permanently Delete Contact'),
743 $row['action'] = CRM_Core_Action
::formLink($links, NULL, array('id' => $result->contact_id
));
745 elseif ((is_numeric(CRM_Utils_Array
::value('geo_code_1', $row))) ||
746 ($config->mapGeoCoding
&&
747 CRM_Utils_Array
::value('city', $row) &&
748 CRM_Utils_Array
::value('state_province', $row)
751 $row['action'] = CRM_Core_Action
::formLink($links, $mask, array('id' => $result->contact_id
));
754 $row['action'] = CRM_Core_Action
::formLink($links, $mapMask, array('id' => $result->contact_id
));
757 // allow components to add more actions
758 CRM_Core_Component
::searchAction($row, $result->contact_id
);
760 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
761 $result->contact_sub_type
: $result->contact_type
,
766 $row['contact_type_orig'] = $result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
;
767 $row['contact_sub_type'] = $result->contact_sub_type ?
768 CRM_Contact_BAO_ContactType
::contactTypePairs(FALSE, $result->contact_sub_type
, ', ') : $result->contact_sub_type
;
769 $row['contact_id'] = $result->contact_id
;
770 $row['sort_name'] = $result->sort_name
;
771 if (array_key_exists('id', $row)) {
772 $row['id'] = $result->contact_id
;
777 if (in_array($row['contact_id'], $seenIDs) === FALSE) {
778 $seenIDs[] = $row['contact_id'];
783 $this->buildPrevNextCache($sort);
788 function buildPrevNextCache($sort) {
789 $cacheKey = CRM_Utils_Array
::value('qfKey', $this->_formValues
);
791 //for prev/next pagination
792 $crmPID = CRM_Utils_Request
::retrieve('crmPID', 'Integer', CRM_Core_DAO
::$_nullObject);
794 //for alphabetic pagination selection save
795 $sortByCharacter = CRM_Utils_Request
::retrieve('sortByCharacter', 'String', CRM_Core_DAO
::$_nullObject);
797 //for text field pagination selection save
798 $countRow = CRM_Core_BAO_PrevNextCache
::getCount("%civicrm search {$cacheKey}%", NULL, "entity_table = 'civicrm_contact'", "LIKE");
800 if ((!$crmPID ||
$countRow == 0) && !$sortByCharacter) {
801 $this->fillupPrevNextCache($sort);
803 elseif ($sortByCharacter) {
804 $cacheKeyCharacter = "civicrm search {$cacheKey}_alphabet";
805 if ($sortByCharacter == 'all') {
806 //delete the alphabet key corresponding records in prevnext_cache
807 CRM_Core_BAO_PrevNextCache
::deleteItem(NULL, $cacheKeyCharacter, 'civicrm_contact');
808 $cacheKeyCharacter = NULL;
810 $this->fillupPrevNextCache($sort, $cacheKeyCharacter);
814 function addActions(&$rows) {
815 $config = CRM_Core_Config
::singleton();
817 $permissions = array(CRM_Core_Permission
::getPermission());
818 if (CRM_Core_Permission
::check('delete contacts')) {
819 $permissions[] = CRM_Core_Permission
::DELETE
;
821 $mask = CRM_Core_Action
::mask($permissions);
822 // mask value to hide map link if there are not lat/long
823 $mapMask = $mask & 4095;
825 // mask value to hide map link if there are not lat/long
826 $mapMask = $mask & 4095;
828 $links = self
::links($this->_context
, $this->_contextMenu
, $this->_key
);
831 foreach ($rows as $id => & $row) {
832 if (CRM_Utils_Array
::value('deleted_contacts', $this->_formValues
)
833 && CRM_Core_Permission
::check('access deleted contacts')
837 'name' => ts('View'),
838 'url' => 'civicrm/contact/view',
839 'qs' => 'reset=1&cid=%%id%%',
840 'title' => ts('View Contact Details'),
843 'name' => ts('Restore'),
844 'url' => 'civicrm/contact/view/delete',
845 'qs' => 'reset=1&cid=%%id%%&restore=1',
846 'title' => ts('Restore Contact'),
849 if (CRM_Core_Permission
::check('delete contacts')) {
851 'name' => ts('Delete Permanently'),
852 'url' => 'civicrm/contact/view/delete',
853 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1',
854 'title' => ts('Permanently Delete Contact'),
857 $row['action'] = CRM_Core_Action
::formLink($links, NULL, array('id' => $row['contact_id']));
859 elseif ((is_numeric(CRM_Utils_Array
::value('geo_code_1', $row))) ||
860 ($config->mapGeoCoding
&&
861 CRM_Utils_Array
::value('city', $row) &&
862 CRM_Utils_Array
::value('state_province', $row)
865 $row['action'] = CRM_Core_Action
::formLink($links, $mask, array('id' => $row['contact_id']));
868 $row['action'] = CRM_Core_Action
::formLink($links, $mapMask, array('id' => $row['contact_id']));
871 // allow components to add more actions
872 CRM_Core_Component
::searchAction($row, $row['contact_id']);
874 if (!empty($row['contact_type_orig'])) {
875 $row['contact_type'] = CRM_Contact_BAO_Contact_Utils
::getImage($row['contact_type_orig'],
876 FALSE, $row['contact_id']);
881 function removeActions(&$rows) {
882 foreach ($rows as $rid => & $rValue) {
883 unset($rValue['contact_type']);
884 unset($rValue['action']);
888 function fillupPrevNextCache($sort, $cacheKey = NULL) {
890 $cacheKey = "civicrm search {$this->_key}";
893 CRM_Core_BAO_PrevNextCache
::deleteItem(NULL, $cacheKey, 'civicrm_contact');
895 // lets fill up the prev next cache here, so view can scroll thru
896 if (is_a($this, 'CRM_Contact_Selector_Custom')) {
897 $sql = $this->_search
->contactIDs(0, 0, $sort, TRUE);
898 $replaceSQL = "SELECT contact_a.id as contact_id";
901 $sql = $this->_query
->searchQuery(
904 FALSE, TRUE, TRUE, NULL
906 $replaceSQL = "SELECT contact_a.id as id";
910 // due to limitations in our search query writer, the above query does not work
911 // in cases where the query is being sorted on a non-contact table
912 // this results in a fatal error :(
913 // see below for the gross hack of trapping the error and not filling
914 // the prev next cache in this situation
915 // the other alternative of running the FULL query will just be incredibly inefficient
916 // and slow things down way too much on large data sets / complex queries
919 INSERT INTO civicrm_prevnext_cache ( entity_table, entity_id1, entity_id2, cacheKey, data )
920 SELECT 'civicrm_contact', contact_a.id, contact_a.id, '$cacheKey', contact_a.display_name
923 $sql = str_replace($replaceSQL, $insertSQL, $sql);
926 CRM_Core_Error
::ignoreException();
927 $result = CRM_Core_DAO
::executeQuery($sql);
928 CRM_Core_Error
::setCallback();
930 if (is_a($result, 'DB_Error')) {
931 // oops the above query failed, so lets just ignore it
933 // we print a sorry cant figure it out on view page
937 // also record an entry in the cache key table, so we can delete it periodically
938 CRM_Core_BAO_Cache
::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey);
942 * Given the current formValues, gets the query in local
946 reference) $formValues submitted formValues
948 * @return array $qill which contains an array of strings
952 // the current internationalisation is bad, but should more or less work
953 // for most of "European" languages
954 public function getQILL() {
955 return $this->_query
->qill();
959 * name of export file.
961 * @param string $output type of output
963 * @return string name of the file
965 function getExportFileName($output = 'csv') {
966 return ts('CiviCRM Contact Search');
970 * get colunmn headers for search selector
973 * @return array $_columnHeaders
976 private static function &_getColumnHeaders() {
977 if (!isset(self
::$_columnHeaders)) {
978 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
979 'address_options', TRUE, NULL, TRUE
982 self
::$_columnHeaders = array(
983 'contact_type' => array('desc' => ts('Contact Type')),
984 'sort_name' => array(
985 'name' => ts('Name'),
986 'sort' => 'sort_name',
987 'direction' => CRM_Utils_Sort
::ASCENDING
,
991 $defaultAddress = array(
992 'street_address' => array('name' => ts('Address')),
994 'name' => ts('City'),
996 'direction' => CRM_Utils_Sort
::DONTCARE
,
998 'state_province' => array(
999 'name' => ts('State'),
1000 'sort' => 'state_province',
1001 'direction' => CRM_Utils_Sort
::DONTCARE
,
1003 'postal_code' => array(
1004 'name' => ts('Postal'),
1005 'sort' => 'postal_code',
1006 'direction' => CRM_Utils_Sort
::DONTCARE
,
1009 'name' => ts('Country'),
1010 'sort' => 'country',
1011 'direction' => CRM_Utils_Sort
::DONTCARE
,
1015 foreach ($defaultAddress as $columnName => $column) {
1016 if (CRM_Utils_Array
::value($columnName, $addressOptions)) {
1017 self
::$_columnHeaders[$columnName] = $column;
1021 self
::$_columnHeaders['email'] = array(
1022 'name' => ts('Email'),
1024 'direction' => CRM_Utils_Sort
::DONTCARE
,
1027 self
::$_columnHeaders['phone'] = array('name' => ts('Phone'));
1029 return self
::$_columnHeaders;
1032 function &getQuery() {
1033 return $this->_query
;
1036 function alphabetQuery() {
1037 return $this->_query
->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
1040 function contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') {
1041 $sortOrder = &$this->getSortOrder($this->_action
);
1042 $sort = new CRM_Utils_Sort($sortOrder, $sortID);
1044 // rectify params to what proximity search expects if there is a value for prox_distance
1045 // CRM-7021 CRM-7905
1046 if (!empty($params)) {
1047 CRM_Contact_BAO_ProximityQuery
::fixInputParams($params);
1050 if (!$displayRelationshipType) {
1051 $query = new CRM_Contact_BAO_Query($params,
1052 $this->_returnProperties
,
1053 NULL, FALSE, FALSE, 1,
1054 FALSE, TRUE, TRUE, NULL,
1059 $query = new CRM_Contact_BAO_Query($params, $this->_returnProperties
,
1060 NULL, FALSE, FALSE, 1,
1061 FALSE, TRUE, TRUE, $displayRelationshipType,
1065 $value = $query->searchQuery(0, 0, $sort,
1066 FALSE, FALSE, FALSE,
1072 function &makeProperties(&$returnProperties) {
1073 $properties = array();
1074 foreach ($returnProperties as $name => $value) {
1075 if ($name != 'location') {
1076 // special handling for group and tag
1077 if (in_array($name, array('group', 'tag'))) {
1081 // special handling for notes
1082 if (in_array($name, array('note', 'note_subject', 'note_body'))) {
1086 $properties[] = $name;
1089 // extract all the location stuff
1090 foreach ($value as $n => $v) {
1091 foreach ($v as $n1 => $v1) {
1092 if (!strpos('_id', $n1) && $n1 != 'location_type') {
1093 $properties[] = "{$n}-{$n1}";