CRM/Profile/Selector/Listings.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  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.
  40  *
  41  */
  42 class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
  43
  44   /**
  45    * Array of supported links, currenly view and edit
  46    *
  47    * @var array
  48    * @static
  49    */
  50   static $_links = NULL;
  51
  52   /**
  53    * We use desc to remind us what that column is, name is used in the tpl
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_columnHeaders;
  59
  60   /**
  61    * The sql params we use to get the list of contacts
  62    *
  63    * @var string
  64    */
  65   protected $_params;
  66
  67   /**
  68    * The public visible fields to be shown to the user
  69    *
  70    * @var array
  71    */
  72   protected $_fields;
  73
  74   /**
  75    * The custom fields for this domain
  76    *
  77    * @var array
  78    */
  79   protected $_customFields;
  80
  81   /**
  82    * Cache the query object
  83    *
  84    * @var object
  85    */
  86   protected $_query;
  87
  88   /**
  89    * Cache the expanded options list if any
  90    *
  91    * @var object
  92    */
  93   protected $_options;
  94
  95   /**
  96    * The group id that we are editing
  97    *
  98    * @var int
  99    */
 100   protected $_gid;
 101
 102   /**
 103    * Do we enable mapping of users
 104    *
 105    * @var boolean
 106    */
 107   protected $_map;
 108
 109   /**
 110    * Do we enable edit link
 111    *
 112    * @var boolean
 113    */
 114   protected $_editLink;
 115
 116   /**
 117    * Should we link to the UF Profile
 118    *
 119    * @var boolean
 120    */
 121   protected $_linkToUF;
 122
 123   /**
 124    * Store profile ids if multiple profile ids are passed using comma separated.
 125    * Currently lets implement this functionality only for dialog mode
 126    */
 127   protected $_profileIds = array();
 128
 129   protected $_multiRecordTableName = NULL;
 130
 131   /**
 132    * Class constructor
 133    *
 134    * @param array $params
 135    * @param $customFields
 136    * @param string params the params for the where clause
 137    *
 138    * @param bool $map
 139    * @param bool $editLink
 140    * @param bool $linkToUF
 141    *
 142    * @return \CRM_Profile_Selector_Listings
 143    * @access public
 144    */
 145   function __construct(
 146     &$params,
 147     &$customFields,
 148     $ufGroupIds = NULL,
 149     $map = FALSE,
 150     $editLink = FALSE,
 151     $linkToUF = FALSE
 152   ) {
 153     $this->_params = $params;
 154
 155     if (is_array($ufGroupIds)) {
 156       $this->_profileIds = $ufGroupIds;
 157       $this->_gid = $ufGroupIds[0];
 158     }
 159     else {
 160       $this->_profileIds = array($ufGroupIds);
 161       $this->_gid = $ufGroupIds;
 162     }
 163
 164     $this->_map      = $map;
 165     $this->_editLink = $editLink;
 166     $this->_linkToUF = $linkToUF;
 167
 168     //get the details of the uf group
 169     if ($this->_gid) {
 170       $groupId = CRM_Core_DAO::getFieldValue('CRM_Core_BAO_UFGroup',
 171         $this->_gid, 'limit_listings_group_id'
 172       );
 173     }
 174
 175     // add group id to params if a uf group belong to a any group
 176     if ($groupId) {
 177       if (!empty($this->_params['group'])) {
 178         $this->_params['group'][$groupId] = 1;
 179       }
 180       else {
 181         $this->_params['group'] = array($groupId => 1);
 182       }
 183     }
 184
 185     $this->_fields = CRM_Core_BAO_UFGroup::getListingFields(CRM_Core_Action::VIEW,
 186       CRM_Core_BAO_UFGroup::PUBLIC_VISIBILITY |
 187       CRM_Core_BAO_UFGroup::LISTINGS_VISIBILITY,
 188       FALSE, $this->_profileIds
 189     );
 190
 191     $this->_customFields = &$customFields;
 192
 193     $returnProperties = CRM_Contact_BAO_Contact::makeHierReturnProperties($this->_fields);
 194     $returnProperties['contact_type'] = 1;
 195     $returnProperties['contact_sub_type'] = 1;
 196     $returnProperties['sort_name'] = 1;
 197
 198     $queryParams    = CRM_Contact_BAO_Query::convertFormValues($this->_params, 1);
 199     $this->_query   = new CRM_Contact_BAO_Query($queryParams, $returnProperties, $this->_fields);
 200
 201     //the below is done for query building for multirecord custom field listing
 202     //to show all the custom field multi valued records of a particular contact
 203     $this->setMultiRecordTableName($this->_fields);
 204
 205     $this->_options = &$this->_query->_options;
 206   }
 207
 208   /**
 209    * This method returns the links that are given for each search row.
 210    *
 211    * @param bool $map
 212    * @param bool $editLink
 213    * @param bool $ufLink
 214    * @param null $gids
 215    *
 216    * @return array
 217    */
 218   public static function &links($map = FALSE, $editLink = FALSE, $ufLink = FALSE, $gids = NULL) {
 219     if (!self::$_links) {
 220       self::$_links = array();
 221
 222       $viewPermission = TRUE;
 223       if ($gids) {
 224         // check view permission for each profile id, in case multiple profile ids are rendered
 225         // then view action is disabled if any profile returns false
 226         foreach ($gids as $profileId) {
 227           $viewPermission = CRM_Core_Permission::ufGroupValid($profileId, CRM_Core_Permission::VIEW);
 228           if (!$viewPermission) {
 229             break;
 230           }
 231         }
 232       }
 233
 234       if ($viewPermission) {
 235         self::$_links[CRM_Core_Action::VIEW] = array(
 236           'name' => ts('View'),
 237           'url' => 'civicrm/profile/view',
 238           'qs' => 'reset=1&id=%%id%%&gid=%%gid%%',
 239           'title' => ts('View Profile Details'),
 240         );
 241       }
 242
 243       if ($editLink) {
 244         self::$_links[CRM_Core_Action::UPDATE] = array(
 245           'name' => ts('Edit'),
 246           'url' => 'civicrm/profile/edit',
 247           'qs' => 'reset=1&id=%%id%%&gid=%%gid%%',
 248           'title' => ts('Edit'),
 249         );
 250       }
 251
 252       if ($ufLink) {
 253         self::$_links[CRM_Core_Action::PROFILE] = array(
 254           'name' => ts('Website Profile'),
 255           'url' => 'user/%%ufID%%',
 256           'qs' => ' ',
 257           'title' => ts('View Website Profile'),
 258         );
 259       }
 260
 261       if ($map) {
 262         self::$_links[CRM_Core_Action::MAP] = array(
 263           'name' => ts('Map'),
 264           'url' => 'civicrm/profile/map',
 265           'qs' => 'reset=1&cid=%%id%%&gid=%%gid%%',
 266           'title' => ts('Map'),
 267         );
 268       }
 269     }
 270     return self::$_links;
 271   }
 272
 273   /**
 274    * Getter for array of the parameters required for creating pager.
 275    *
 276    * @param $action
 277    * @param array $params
 278    */
 279   public function getPagerParams($action, &$params) {
 280     $status =
 281       CRM_Utils_System::isNull($this->_multiRecordTableName) ? ts('Contact %%StatusMessage%%') : ts('Contact Multi Records %%StatusMessage%%');
 282     $params['status']    = $status;
 283     $params['csvString'] = NULL;
 284     $params['rowCount']  = CRM_Utils_Pager::ROWCOUNT;
 285
 286     $params['buttonTop'] = 'PagerTopButton';
 287     $params['buttonBottom'] = 'PagerBottomButton';
 288   }
 289
 290   /**
 291    * Returns the column headers as an array of tuples:
 292    * (name, sortName (key to the sort array))
 293    *
 294    * @param string $action
 295    *   The action being performed.
 296    * @param enum $output
 297    *   What should the result set include (web/email/csv).
 298    *
 299    * @return array
 300    *   the column headers that need to be displayed
 301    */
 302   public function &getColumnHeaders($action = NULL, $output = NULL) {
 303     static $skipFields = array('group', 'tag');
 304     $multipleFields = array('url');
 305     $direction      = CRM_Utils_Sort::ASCENDING;
 306     $empty          = TRUE;
 307     if (!isset(self::$_columnHeaders)) {
 308       self::$_columnHeaders = array(array('name' => ''),
 309         array(
 310           'name' => ts('Name'),
 311           'sort' => 'sort_name',
 312           'direction' => CRM_Utils_Sort::ASCENDING,
 313           'field_name' => 'sort_name',
 314         ),
 315       );
 316
 317       $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 318
 319       foreach ($this->_fields as $name => $field) {
 320         // skip pseudo fields
 321         if (substr($name, 0, 9) == 'phone_ext') {
 322           continue;
 323         }
 324
 325         if (!empty($field['in_selector']) &&
 326           !in_array($name, $skipFields)
 327         ) {
 328
 329           if (strpos($name, '-') !== FALSE) {
 330             $value     = explode('-', $name);
 331             $fieldName = CRM_Utils_Array::value(0, $value);
 332             $lType     = CRM_Utils_Array::value(1, $value);
 333             $type      = CRM_Utils_Array::value(2, $value);
 334
 335             if (!in_array($fieldName, $multipleFields)) {
 336               if ($lType == 'Primary') {
 337                 $locationTypeName = 1;
 338               }
 339               else {
 340                 $locationTypeName = $locationTypes[$lType];
 341               }
 342
 343               if (in_array($fieldName, array(
 344                 'phone', 'im', 'email'))) {
 345                 if ($type) {
 346                   $name = "`$locationTypeName-$fieldName-$type`";
 347                 }
 348                 else {
 349                   $name = "`$locationTypeName-$fieldName`";
 350                 }
 351               }
 352               else {
 353                 $name = "`$locationTypeName-$fieldName`";
 354               }
 355             }
 356             else {
 357               $name = "website-{$lType}-{$fieldName}";
 358             }
 359           }
 360
 361           self::$_columnHeaders[] = array(
 362             'name' => $field['title'],
 363             'sort' => $name,
 364             'direction' => $direction,
 365             'field_name' => CRM_Core_BAO_UFField::isValidFieldName($name) ? $name : $fieldName,
 366           );
 367
 368           $direction = CRM_Utils_Sort::DONTCARE;
 369           $empty = FALSE;
 370         }
 371       }
 372
 373       // if we dont have any valid columns, dont add the implicit ones
 374       // this allows the template to check on emptiness of column headers
 375       if ($empty) {
 376         self::$_columnHeaders = array();
 377       }
 378       else {
 379         self::$_columnHeaders[] = array('desc' => ts('Actions'));
 380       }
 381     }
 382     return self::$_columnHeaders;
 383   }
 384
 385   /**
 386    * Returns total number of rows for the query.
 387    *
 388    * @param
 389    *
 390    * @return int
 391    *   Total number of rows
 392    */
 393   public function getTotalCount($action) {
 394     $additionalWhereClause = 'contact_a.is_deleted = 0';
 395     $additionalFromClause = NULL;
 396     $returnQuery = NULL;
 397
 398     if ($this->_multiRecordTableName &&
 399         !array_key_exists($this->_multiRecordTableName, $this->_query->_whereTables)) {
 400       $additionalFromClause = CRM_Utils_Array::value($this->_multiRecordTableName, $this->_query->_tables);
 401       $returnQuery = TRUE;
 402     }
 403
 404     $countVal = $this->_query->searchQuery(0, 0, NULL, TRUE, NULL, NULL, NULL,
 405       $returnQuery, $additionalWhereClause, NULL, $additionalFromClause
 406     );
 407
 408     if (!$returnQuery) {
 409       return $countVal;
 410     }
 411
 412     if ($returnQuery) {
 413       $sql = preg_replace('/DISTINCT/', '', $countVal);
 414       return CRM_Core_DAO::singleValueQuery($sql);
 415     }
 416   }
 417
 418   /**
 419    * Return the qill for this selector
 420    *
 421    * @return string
 422    */
 423   public function getQill() {
 424     return $this->_query->qill();
 425   }
 426
 427   /**
 428    * Returns all the rows in the given offset and rowCount
 429    *
 430    * @param enum $action
 431    *   The action being performed.
 432    * @param int $offset
 433    *   The row number to start from.
 434    * @param int $rowCount
 435    *   The number of rows to return.
 436    * @param string $sort
 437    *   The sql string that describes the sort order.
 438    * @param enum $output
 439    *   What should the result set include (web/email/csv).
 440    *
 441    * @return int
 442    *   the total number of rows for this action
 443    */
 444   public function &getRows($action, $offset, $rowCount, $sort, $output = NULL, $extraWhereClause = NULL) {
 445
 446     $multipleFields = array('url');
 447     //$sort object processing for location fields
 448     if ($sort) {
 449       $vars = $sort->_vars;
 450       $varArray = array();
 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`";
 462             }
 463             else {
 464               $field['name'] = "`" . $locationType->name . "-" . $fieldArray[0] . "`";
 465             }
 466           }
 467           else {
 468             $field['name'] = "`website-" . $fieldArray[1] . "-{$fieldType}`";
 469           }
 470         }
 471         $varArray[$key] = $field;
 472       }
 473       $sort->_vars = $varArray;
 474     }
 475
 476     $additionalWhereClause = 'contact_a.is_deleted = 0';
 477
 478     if ($extraWhereClause) {
 479       $additionalWhereClause .= " AND {$extraWhereClause}";
 480     }
 481
 482     $returnQuery = NULL;
 483     if ($this->_multiRecordTableName) {
 484       $returnQuery = TRUE;
 485     }
 486     $this->_query->_useGroupBy = TRUE;
 487     $result = $this->_query->searchQuery($offset, $rowCount, $sort, NULL, NULL,
 488       NULL, NULL, $returnQuery, $additionalWhereClause
 489     );
 490
 491     if ($returnQuery) {
 492       $resQuery = preg_replace('/GROUP BY contact_a.id[\s]+ORDER BY/', ' ORDER BY', $result);
 493       $result   = CRM_Core_DAO::executeQuery($resQuery);
 494     }
 495
 496     // process the result of the query
 497     $rows = array();
 498
 499     // check if edit is configured in profile settings
 500     if ($this->_gid) {
 501       $editLink = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $this->_gid, 'is_edit_link');
 502     }
 503
 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) {
 510         $this->_editLink = TRUE;
 511       }
 512     }
 513     $links = self::links($this->_map, $this->_editLink, $this->_linkToUF, $this->_profileIds);
 514
 515     $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id');
 516
 517     $names = array();
 518     static $skipFields = array('group', 'tag');
 519
 520     foreach ($this->_fields as $key => $field) {
 521       // skip pseudo fields
 522       if (substr($key, 0, 9) == 'phone_ext') {
 523         continue;
 524       }
 525
 526       if (!empty($field['in_selector']) &&
 527         !in_array($key, $skipFields)
 528       ) {
 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);
 534
 535           if (!in_array($fieldName, $multipleFields)) {
 536             $locationTypeName = NULL;
 537             if (is_numeric($id)) {
 538               $locationTypeName = CRM_Utils_Array::value($id, $locationTypes);
 539             }
 540             else {
 541               if ($id == 'Primary') {
 542                 $locationTypeName = 1;
 543               }
 544             }
 545
 546             if (!$locationTypeName) {
 547               continue;
 548             }
 549             $locationTypeName = str_replace(' ', '_', $locationTypeName);
 550             if (in_array($fieldName, array(
 551               'phone', 'im', 'email'))) {
 552               if ($type) {
 553                 $names[] = "{$locationTypeName}-{$fieldName}-{$type}";
 554               }
 555               else {
 556                 $names[] = "{$locationTypeName}-{$fieldName}";
 557               }
 558             }
 559             else {
 560               $names[] = "{$locationTypeName}-{$fieldName}";
 561             }
 562           }
 563           else {
 564             $names[] = "website-{$id}-{$fieldName}";
 565           }
 566         }
 567         elseif ($field['name'] == 'id') {
 568           $names[] = 'contact_id';
 569         }
 570         else {
 571           $names[] = $field['name'];
 572         }
 573       }
 574     }
 575
 576     $multipleSelectFields = array('preferred_communication_method' => 1);
 577     $multiRecordTableId = NULL;
 578     if ($this->_multiRecordTableName) {
 579       $multiRecordTableId = "{$this->_multiRecordTableName}_id";
 580     }
 581
 582     // we need to determine of overlay profile should be shown
 583     $showProfileOverlay = CRM_Core_BAO_UFGroup::showOverlayProfile();
 584
 585     while ($result->fetch()) {
 586       $this->_query->convertToPseudoNames($result);
 587
 588       if (isset($result->country)) {
 589         // the query returns the untranslated country name
 590         $i18n = CRM_Core_I18n::singleton();
 591         $result->country = $i18n->translate($result->country);
 592       }
 593       $row   = array();
 594       $empty = TRUE;
 595       $row[] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type,
 596         FALSE,
 597         $result->contact_id,
 598         $showProfileOverlay
 599       );
 600       if ($result->sort_name) {
 601         $row[] = $result->sort_name;
 602         $empty = FALSE;
 603       }
 604       else {
 605         continue;
 606       }
 607
 608       foreach ($names as $name) {
 609         if ($cfID = CRM_Core_BAO_CustomField::getKeyID($name)) {
 610           $row[] = CRM_Core_BAO_CustomField::getDisplayValue($result->$name,
 611             $cfID,
 612             $this->_options,
 613             $result->contact_id
 614           );
 615         }
 616         elseif (substr($name, -4) == '-url' &&
 617           !empty($result->$name)
 618         ) {
 619           $url      = CRM_Utils_System::fixURL($result->$name);
 620           $typeId   = substr($name, 0, -4) . "-website_type_id";
 621           $typeName = CRM_Core_PseudoConstant::getLabel('CRM_Core_DAO_Website', 'website_type_id', $result->$typeId);
 622           if ($typeName) {
 623             $row[] = "<a href=\"$url\">{$result->$name} (${typeName})</a>";
 624           }
 625           else {
 626             $row[] = "<a href=\"$url\">{$result->$name}</a>";
 627           }
 628         }
 629         elseif ($name == 'preferred_language') {
 630           $row[] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'preferred_language', $result->$name);
 631         }
 632         elseif ($multipleSelectFields &&
 633           array_key_exists($name, $multipleSelectFields)
 634         ) {
 635           $paramsNew = array($name => $result->$name);
 636           $name = array($name => array('newName' => $name, 'groupName' => $name));
 637
 638           CRM_Core_OptionGroup::lookupValues($paramsNew, $name, FALSE);
 639           $row[] = $paramsNew[$key];
 640         }
 641         elseif (strpos($name, '-im')) {
 642           if (!empty($result->$name)) {
 643             $providerId   = $name . "-provider_id";
 644             $providerName = CRM_Core_PseudoConstant::getLabel('CRM_Core_DAO_IM', 'provider_id', $result->$providerId);
 645             $row[]        = $result->$name . " ({$providerName})";
 646           }
 647           else {
 648             $row[] = '';
 649           }
 650         }
 651         elseif (strpos($name, '-phone-')) {
 652           $phoneExtField = str_replace('phone', 'phone_ext', $name);
 653           if (isset($result->$phoneExtField)) {
 654             $row[] = $result->$name . " (" . $result->$phoneExtField . ")";
 655           }
 656           else {
 657             $row[] = $result->$name;
 658           }
 659         }
 660         elseif (in_array($name, array(
 661           'addressee', 'email_greeting', 'postal_greeting'))) {
 662           $dname = $name . '_display';
 663           $row[] = $result->$dname;
 664         }
 665         elseif (in_array($name, array(
 666           'birth_date', 'deceased_date'))) {
 667           $row[] = CRM_Utils_Date::customFormat($result->$name);
 668         }
 669         elseif (isset($result->$name)) {
 670           $row[] = $result->$name;
 671         }
 672         else {
 673           $row[] = '';
 674         }
 675
 676         if (!empty($result->$name)) {
 677           $empty = FALSE;
 678         }
 679       }
 680
 681       $newLinks = $links;
 682       $params = array(
 683         'id' => $result->contact_id,
 684         'gid' => implode(',', $this->_profileIds),
 685       );
 686
 687       // pass record id param to view url for multi record view
 688       if ($multiRecordTableId && $newLinks) {
 689         if ($result->$multiRecordTableId) {
 690           if ($newLinks[CRM_Core_Action::VIEW]['url'] == 'civicrm/profile/view') {
 691             $newLinks[CRM_Core_Action::VIEW]['qs'] .= "&multiRecord=view&recordId=%%recordId%%&allFields=1";
 692             $params['recordId'] = $result->$multiRecordTableId;
 693           }
 694         }
 695       }
 696
 697       if ($this->_linkToUF) {
 698         $ufID = CRM_Core_BAO_UFMatch::getUFId($result->contact_id);
 699         if (!$ufID) {
 700           unset($newLinks[CRM_Core_Action::PROFILE]);
 701         }
 702         else {
 703           $params['ufID'] = $ufID;
 704         }
 705       }
 706
 707       $row[] = CRM_Core_Action::formLink($newLinks,
 708         $mask,
 709         $params,
 710         ts('more'),
 711         FALSE,
 712         'profile.selector.row',
 713         'Contact',
 714         $result->contact_id
 715       );
 716
 717       if (!$empty) {
 718         $rows[] = $row;
 719       }
 720     }
 721     return $rows;
 722   }
 723
 724   /**
 725    * Name of export file.
 726    *
 727    * @param string $output
 728    *   Type of output.
 729    *
 730    * @return string
 731    *   name of the file
 732    */
 733   public function getExportFileName($output = 'csv') {
 734     return ts('CiviCRM Profile Listings');
 735   }
 736
 737   /**
 738    *  set the _multiRecordTableName to display the result set
 739    *  according to multi record custom field values
 740    */
 741   public function setMultiRecordTableName($fields) {
 742     $customGroupId = $multiRecordTableName = NULL;
 743     $selectorSet = FALSE;
 744
 745     foreach ($fields as $field => $properties) {
 746       if (!CRM_Core_BAO_CustomField::getKeyID($field)) {
 747         continue;
 748       }
 749       if ($cgId = CRM_Core_BAO_CustomField::isMultiRecordField($field)) {
 750         $customGroupId = CRM_Utils_System::isNull($customGroupId) ? $cgId : $customGroupId;
 751
 752         //if the field is submitted set multiRecordTableName
 753         if ($customGroupId) {
 754           $isSubmitted = FALSE;
 755           foreach ($this->_query->_params as $key => $value) {
 756             //check the query params 'where' element
 757             if ($value[0] == $field) {
 758               $isSubmitted = TRUE;
 759               break;
 760             }
 761           }
 762
 763           if ($isSubmitted) {
 764             $this->_multiRecordTableName = $multiRecordTableName =
 765               CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupId, 'table_name');
 766             if ($multiRecordTableName) {
 767               return;
 768             }
 769           }
 770
 771           if (!empty($properties['in_selector'])) {
 772             $selectorSet = TRUE;
 773           }
 774         }
 775       }
 776     }
 777
 778     if (!isset($customGroupId) || !$customGroupId) {
 779       return;
 780     }
 781
 782     //if the field is in selector and not a searchable field
 783     //get the proper customvalue table name
 784     if ($selectorSet) {
 785       $this->_multiRecordTableName = $multiRecordTableName =
 786         CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $customGroupId, 'table_name');
 787     }
 788   } //func close
 789 }