3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * This class is used to retrieve and display a range of
36 * contacts that match the given criteria (specifically for
37 * results of advanced search options.
40 class CRM_Profile_Selector_Listings
extends CRM_Core_Selector_Base
implements CRM_Core_Selector_API
{
43 * Array of supported links, currently view and edit
47 static $_links = NULL;
50 * We use desc to remind us what that column is, name is used in the tpl
54 static $_columnHeaders;
57 * The sql params we use to get the list of contacts.
64 * The public visible fields to be shown to the user.
71 * The custom fields for this domain.
75 protected $_customFields;
78 * Cache the query object.
85 * Cache the expanded options list if any.
92 * The group id that we are editing.
99 * Do we enable mapping of users.
106 * Do we enable edit link.
110 protected $_editLink;
113 * Should we link to the UF Profile.
117 protected $_linkToUF;
120 * Store profile ids if multiple profile ids are passed using comma separated.
121 * Currently lets implement this functionality only for dialog mode
123 protected $_profileIds = array();
125 protected $_multiRecordTableName = NULL;
130 * @param array $params the params for the where clause
131 * @param array $customFields
132 * @param array $ufGroupIds
134 * @param bool $editLink
135 * @param bool $linkToUF
137 * @return \CRM_Profile_Selector_Listings
139 public function __construct(
147 $this->_params
= $params;
149 if (is_array($ufGroupIds)) {
150 $this->_profileIds
= $ufGroupIds;
151 $this->_gid
= $ufGroupIds[0];
154 $this->_profileIds
= array($ufGroupIds);
155 $this->_gid
= $ufGroupIds;
159 $this->_editLink
= $editLink;
160 $this->_linkToUF
= $linkToUF;
162 //get the details of the uf group
164 $groupId = CRM_Core_DAO
::getFieldValue('CRM_Core_BAO_UFGroup',
165 $this->_gid
, 'limit_listings_group_id'
169 // add group id to params if a uf group belong to a any group
171 if (!empty($this->_params
['group'])) {
172 $this->_params
['group'][$groupId] = 1;
175 $this->_params
['group'] = array($groupId => 1);
179 $this->_fields
= CRM_Core_BAO_UFGroup
::getListingFields(CRM_Core_Action
::VIEW
,
180 CRM_Core_BAO_UFGroup
::PUBLIC_VISIBILITY |
181 CRM_Core_BAO_UFGroup
::LISTINGS_VISIBILITY
,
182 FALSE, $this->_profileIds
185 $this->_customFields
= &$customFields;
187 $returnProperties = CRM_Contact_BAO_Contact
::makeHierReturnProperties($this->_fields
);
188 $returnProperties['contact_type'] = 1;
189 $returnProperties['contact_sub_type'] = 1;
190 $returnProperties['sort_name'] = 1;
192 $queryParams = CRM_Contact_BAO_Query
::convertFormValues($this->_params
, 1);
193 $this->_query
= new CRM_Contact_BAO_Query($queryParams, $returnProperties, $this->_fields
);
195 //the below is done for query building for multirecord custom field listing
196 //to show all the custom field multi valued records of a particular contact
197 $this->setMultiRecordTableName($this->_fields
);
199 $this->_options
= &$this->_query
->_options
;
203 * This method returns the links that are given for each search row.
206 * @param bool $editLink
207 * @param bool $ufLink
212 public static function &links($map = FALSE, $editLink = FALSE, $ufLink = FALSE, $gids = NULL) {
213 if (!self
::$_links) {
214 self
::$_links = array();
216 $viewPermission = TRUE;
218 // check view permission for each profile id, in case multiple profile ids are rendered
219 // then view action is disabled if any profile returns false
220 foreach ($gids as $profileId) {
221 $viewPermission = CRM_Core_Permission
::ufGroupValid($profileId, CRM_Core_Permission
::VIEW
);
222 if (!$viewPermission) {
228 if ($viewPermission) {
229 self
::$_links[CRM_Core_Action
::VIEW
] = array(
230 'name' => ts('View'),
231 'url' => 'civicrm/profile/view',
232 'qs' => 'reset=1&id=%%id%%&gid=%%gid%%',
233 'title' => ts('View Profile Details'),
238 self
::$_links[CRM_Core_Action
::UPDATE
] = array(
239 'name' => ts('Edit'),
240 'url' => 'civicrm/profile/edit',
241 'qs' => 'reset=1&id=%%id%%&gid=%%gid%%',
242 'title' => ts('Edit'),
247 self
::$_links[CRM_Core_Action
::PROFILE
] = array(
248 'name' => ts('Website Profile'),
249 'url' => 'user/%%ufID%%',
251 'title' => ts('View Website Profile'),
256 self
::$_links[CRM_Core_Action
::MAP
] = array(
258 'url' => 'civicrm/profile/map',
259 'qs' => 'reset=1&cid=%%id%%&gid=%%gid%%',
260 'title' => ts('Map'),
264 return self
::$_links;
268 * Getter for array of the parameters required for creating pager.
271 * @param array $params
273 public function getPagerParams($action, &$params) {
274 $status = CRM_Utils_System
::isNull($this->_multiRecordTableName
) ?
ts('Contact %%StatusMessage%%') : ts('Contact Multi Records %%StatusMessage%%');
275 $params['status'] = $status;
276 $params['csvString'] = NULL;
277 $params['rowCount'] = CRM_Utils_Pager
::ROWCOUNT
;
279 $params['buttonTop'] = 'PagerTopButton';
280 $params['buttonBottom'] = 'PagerBottomButton';
284 * Returns the column headers as an array of tuples:
285 * (name, sortName (key to the sort array))
287 * @param string $action
288 * The action being performed.
289 * @param string $output
290 * What should the result set include (web/email/csv).
293 * the column headers that need to be displayed
295 public function &getColumnHeaders($action = NULL, $output = NULL) {
296 static $skipFields = array('group', 'tag');
297 $multipleFields = array('url');
298 $direction = CRM_Utils_Sort
::ASCENDING
;
300 if (!isset(self
::$_columnHeaders)) {
301 self
::$_columnHeaders = array(
304 'name' => ts('Name'),
305 'sort' => 'sort_name',
306 'direction' => CRM_Utils_Sort
::ASCENDING
,
307 'field_name' => 'sort_name',
311 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
313 foreach ($this->_fields
as $name => $field) {
314 // skip pseudo fields
315 if (substr($name, 0, 9) == 'phone_ext') {
319 if (!empty($field['in_selector']) &&
320 !in_array($name, $skipFields)
323 if (strpos($name, '-') !== FALSE) {
324 $value = explode('-', $name);
325 $fieldName = CRM_Utils_Array
::value(0, $value);
326 $lType = CRM_Utils_Array
::value(1, $value);
327 $type = CRM_Utils_Array
::value(2, $value);
329 if (!in_array($fieldName, $multipleFields)) {
330 if ($lType == 'Primary') {
331 $locationTypeName = 1;
334 $locationTypeName = $locationTypes[$lType];
337 if (in_array($fieldName, array(
343 $name = "`$locationTypeName-$fieldName-$type`";
346 $name = "`$locationTypeName-$fieldName`";
350 $name = "`$locationTypeName-$fieldName`";
354 $name = "website-{$lType}-{$fieldName}";
358 self
::$_columnHeaders[] = array(
359 'name' => $field['title'],
361 'direction' => $direction,
362 'field_name' => CRM_Core_BAO_UFField
::isValidFieldName($name) ?
$name : $fieldName,
365 $direction = CRM_Utils_Sort
::DONTCARE
;
370 // if we don't have any valid columns, don't add the implicit ones
371 // this allows the template to check on emptiness of column headers
373 self
::$_columnHeaders = array();
376 self
::$_columnHeaders[] = array('desc' => ts('Actions'));
379 return self
::$_columnHeaders;
383 * Returns total number of rows for the query.
388 * Total number of rows
390 public function getTotalCount($action) {
391 $additionalWhereClause = 'contact_a.is_deleted = 0';
392 $additionalFromClause = NULL;
395 if ($this->_multiRecordTableName
&&
396 !array_key_exists($this->_multiRecordTableName
, $this->_query
->_whereTables
)
398 $additionalFromClause = CRM_Utils_Array
::value($this->_multiRecordTableName
, $this->_query
->_tables
);
402 $countVal = $this->_query
->searchQuery(0, 0, NULL, TRUE, NULL, NULL, NULL,
403 $returnQuery, $additionalWhereClause, NULL, $additionalFromClause
411 $sql = preg_replace('/DISTINCT/', '', $countVal);
412 return CRM_Core_DAO
::singleValueQuery($sql);
417 * Return the qill for this selector.
421 public function getQill() {
422 return $this->_query
->qill();
426 * Returns all the rows in the given offset and rowCount.
428 * @param string $action
429 * The action being performed.
431 * The row number to start from.
432 * @param int $rowCount
433 * The number of rows to return.
434 * @param string $sort
435 * The sql string that describes the sort order.
436 * @param string $output
437 * What should the result set include (web/email/csv).
439 * @param string $extraWhereClause
442 * the total number of rows for this action
444 public function &getRows($action, $offset, $rowCount, $sort, $output = NULL, $extraWhereClause = NULL) {
446 $multipleFields = array('url');
447 //$sort object processing for location fields
449 $vars = $sort->_vars
;
451 foreach ($vars as $key => $field) {
452 $field = $vars[$key];
453 $fieldArray = explode('-', $field['name']);
454 $fieldType = CRM_Utils_Array
::value('2', $fieldArray);
455 if (is_numeric(CRM_Utils_Array
::value('1', $fieldArray))) {
456 if (!in_array($fieldType, $multipleFields)) {
457 $locationType = new CRM_Core_DAO_LocationType();
458 $locationType->id
= $fieldArray[1];
459 $locationType->find(TRUE);
460 if ($fieldArray[0] == 'email' ||
$fieldArray[0] == 'im' ||
$fieldArray[0] == 'phone') {
461 $field['name'] = "`" . $locationType->name
. "-" . $fieldArray[0] . "-1`";
464 $field['name'] = "`" . $locationType->name
. "-" . $fieldArray[0] . "`";
468 $field['name'] = "`website-" . $fieldArray[1] . "-{$fieldType}`";
471 $varArray[$key] = $field;
473 $sort->_vars
= $varArray;
476 $additionalWhereClause = 'contact_a.is_deleted = 0';
478 if ($extraWhereClause) {
479 $additionalWhereClause .= " AND {$extraWhereClause}";
483 if ($this->_multiRecordTableName
) {
486 $this->_query
->_useGroupBy
= TRUE;
487 $result = $this->_query
->searchQuery($offset, $rowCount, $sort, NULL, NULL,
488 NULL, NULL, $returnQuery, $additionalWhereClause
492 $resQuery = preg_replace('/GROUP BY contact_a.id[\s]+ORDER BY/', ' ORDER BY', $result);
493 $result = CRM_Core_DAO
::executeQuery($resQuery);
496 // process the result of the query
499 // check if edit is configured in profile settings
501 $editLink = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid
, 'is_edit_link');
504 //FIXME : make sure to handle delete separately. CRM-4418
505 $mask = CRM_Core_Action
::mask(array(CRM_Core_Permission
::getPermission()));
506 if ($editLink && ($mask & CRM_Core_Permission
::EDIT
)) {
507 // do not allow edit for anon users in joomla frontend, CRM-4668
508 $config = CRM_Core_Config
::singleton();
509 if (!$config->userFrameworkFrontend || CRM_Core_Session
::singleton()->getLoggedInContactID()) {
510 $this->_editLink
= TRUE;
513 $links = self
::links($this->_map
, $this->_editLink
, $this->_linkToUF
, $this->_profileIds
);
515 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
518 static $skipFields = array('group', 'tag');
520 foreach ($this->_fields
as $key => $field) {
521 // skip pseudo fields
522 if (substr($key, 0, 9) == 'phone_ext') {
526 if (!empty($field['in_selector']) &&
527 !in_array($key, $skipFields)
529 if (strpos($key, '-') !== FALSE) {
530 $value = explode('-', $key);
531 $fieldName = CRM_Utils_Array
::value(0, $value);
532 $id = CRM_Utils_Array
::value(1, $value);
533 $type = CRM_Utils_Array
::value(2, $value);
535 if (!in_array($fieldName, $multipleFields)) {
536 $locationTypeName = NULL;
537 if (is_numeric($id)) {
538 $locationTypeName = CRM_Utils_Array
::value($id, $locationTypes);
541 if ($id == 'Primary') {
542 $locationTypeName = 1;
546 if (!$locationTypeName) {
549 $locationTypeName = str_replace(' ', '_', $locationTypeName);
550 if (in_array($fieldName, array(
556 $names[] = "{$locationTypeName}-{$fieldName}-{$type}";
559 $names[] = "{$locationTypeName}-{$fieldName}";
563 $names[] = "{$locationTypeName}-{$fieldName}";
567 $names[] = "website-{$id}-{$fieldName}";
570 elseif ($field['name'] == 'id') {
571 $names[] = 'contact_id';
574 $names[] = $field['name'];
579 $multipleSelectFields = array('preferred_communication_method' => 1);
580 $multiRecordTableId = NULL;
581 if ($this->_multiRecordTableName
) {
582 $multiRecordTableId = "{$this->_multiRecordTableName}_id";
585 // we need to determine of overlay profile should be shown
586 $showProfileOverlay = CRM_Core_BAO_UFGroup
::showOverlayProfile();
588 while ($result->fetch()) {
589 $this->_query
->convertToPseudoNames($result);
591 if (isset($result->country
)) {
592 // the query returns the untranslated country name
593 $i18n = CRM_Core_I18n
::singleton();
594 $result->country
= $i18n->translate($result->country
);
598 $row[] = CRM_Contact_BAO_Contact_Utils
::getImage($result->contact_sub_type ?
$result->contact_sub_type
: $result->contact_type
,
603 if ($result->sort_name
) {
604 $row[] = $result->sort_name
;
611 foreach ($names as $name) {
612 if ($cfID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
613 $row[] = CRM_Core_BAO_CustomField
::displayValue($result->$name,
618 elseif (substr($name, -4) == '-url' &&
619 !empty($result->$name)
621 $url = CRM_Utils_System
::fixURL($result->$name);
622 $typeId = substr($name, 0, -4) . "-website_type_id";
623 $typeName = CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_Website', 'website_type_id', $result->$typeId);
625 $row[] = "<a href=\"$url\">{$result->$name} (${typeName})</a>";
628 $row[] = "<a href=\"$url\">{$result->$name}</a>";
631 elseif ($name == 'preferred_language') {
632 $row[] = CRM_Core_PseudoConstant
::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $result->$name);
634 elseif ($multipleSelectFields &&
635 array_key_exists($name, $multipleSelectFields)
637 $paramsNew = array($name => $result->$name);
638 $name = array($name => array('newName' => $name, 'groupName' => $name));
640 CRM_Core_OptionGroup
::lookupValues($paramsNew, $name, FALSE);
641 $row[] = $paramsNew[$key];
643 elseif (strpos($name, '-im')) {
644 if (!empty($result->$name)) {
645 $providerId = $name . "-provider_id";
646 $providerName = CRM_Core_PseudoConstant
::getLabel('CRM_Core_DAO_IM', 'provider_id', $result->$providerId);
647 $row[] = $result->$name . " ({$providerName})";
653 elseif (strpos($name, '-phone-')) {
654 $phoneExtField = str_replace('phone', 'phone_ext', $name);
655 if (isset($result->$phoneExtField)) {
656 $row[] = $result->$name . " (" . $result->$phoneExtField . ")";
659 $row[] = $result->$name;
662 elseif (in_array($name, array(
667 $dname = $name . '_display';
668 $row[] = $result->$dname;
670 elseif (in_array($name, array(
674 $row[] = CRM_Utils_Date
::customFormat($result->$name);
676 elseif (isset($result->$name)) {
677 $row[] = $result->$name;
683 if (!empty($result->$name)) {
690 'id' => $result->contact_id
,
691 'gid' => implode(',', $this->_profileIds
),
694 // pass record id param to view url for multi record view
695 if ($multiRecordTableId && $newLinks) {
696 if ($result->$multiRecordTableId) {
697 if ($newLinks[CRM_Core_Action
::VIEW
]['url'] == 'civicrm/profile/view') {
698 $newLinks[CRM_Core_Action
::VIEW
]['qs'] .= "&multiRecord=view&recordId=%%recordId%%&allFields=1";
699 $params['recordId'] = $result->$multiRecordTableId;
704 if ($this->_linkToUF
) {
705 $ufID = CRM_Core_BAO_UFMatch
::getUFId($result->contact_id
);
707 unset($newLinks[CRM_Core_Action
::PROFILE
]);
710 $params['ufID'] = $ufID;
714 $row[] = CRM_Core_Action
::formLink($newLinks,
719 'profile.selector.row',
732 * Name of export file.
734 * @param string $output
740 public function getExportFileName($output = 'csv') {
741 return ts('CiviCRM Profile Listings');
745 * Set the _multiRecordTableName to display the result set.
747 * (according to multi record custom field values).
749 * @param array $fields
751 public function setMultiRecordTableName($fields) {
752 $customGroupId = $multiRecordTableName = NULL;
753 $selectorSet = FALSE;
755 foreach ($fields as $field => $properties) {
756 if (!CRM_Core_BAO_CustomField
::getKeyID($field)) {
759 if ($cgId = CRM_Core_BAO_CustomField
::isMultiRecordField($field)) {
760 $customGroupId = CRM_Utils_System
::isNull($customGroupId) ?
$cgId : $customGroupId;
762 //if the field is submitted set multiRecordTableName
763 if ($customGroupId) {
764 $isSubmitted = FALSE;
765 foreach ($this->_query
->_params
as $key => $value) {
766 //check the query params 'where' element
767 if ($value[0] == $field) {
774 $this->_multiRecordTableName
775 = $multiRecordTableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupId, 'table_name');
776 if ($multiRecordTableName) {
781 if (!empty($properties['in_selector'])) {
788 if (!isset($customGroupId) ||
!$customGroupId) {
792 //if the field is in selector and not a searchable field
793 //get the proper custom value table name
795 $this->_multiRecordTableName
796 = $multiRecordTableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupId, 'table_name');