| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 5 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| 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-2019 |
| 32 | */ |
| 33 | |
| 34 | /** |
| 35 | * Class is to retrieve and display a range of contacts that match the given criteria. |
| 36 | * |
| 37 | * It is specifically for results of advanced search options. |
| 38 | */ |
| 39 | class CRM_Contact_Selector extends CRM_Core_Selector_Base implements CRM_Core_Selector_API { |
| 40 | |
| 41 | const CACHE_SIZE = 500; |
| 42 | |
| 43 | /** |
| 44 | * This defines two actions- View and Edit. |
| 45 | * |
| 46 | * @var array |
| 47 | */ |
| 48 | static $_links = NULL; |
| 49 | |
| 50 | /** |
| 51 | * We use desc to remind us what that column is, name is used in the tpl |
| 52 | * |
| 53 | * @var array |
| 54 | */ |
| 55 | static $_columnHeaders; |
| 56 | |
| 57 | /** |
| 58 | * Properties of contact we're interested in displaying |
| 59 | * @var array |
| 60 | */ |
| 61 | static $_properties = array( |
| 62 | 'contact_id', |
| 63 | 'contact_type', |
| 64 | 'contact_sub_type', |
| 65 | 'sort_name', |
| 66 | 'street_address', |
| 67 | 'city', |
| 68 | 'state_province', |
| 69 | 'postal_code', |
| 70 | 'country', |
| 71 | 'geo_code_1', |
| 72 | 'geo_code_2', |
| 73 | 'is_deceased', |
| 74 | 'email', |
| 75 | 'on_hold', |
| 76 | 'phone', |
| 77 | 'status', |
| 78 | 'do_not_email', |
| 79 | 'do_not_phone', |
| 80 | 'do_not_mail', |
| 81 | ); |
| 82 | |
| 83 | /** |
| 84 | * FormValues is the array returned by exportValues called on |
| 85 | * the HTML_QuickForm_Controller for that page. |
| 86 | * |
| 87 | * @var array |
| 88 | */ |
| 89 | public $_formValues; |
| 90 | |
| 91 | /** |
| 92 | * The contextMenu |
| 93 | * |
| 94 | * @var array |
| 95 | */ |
| 96 | protected $_contextMenu; |
| 97 | |
| 98 | /** |
| 99 | * Params is the array in a value used by the search query creator |
| 100 | * |
| 101 | * @var array |
| 102 | */ |
| 103 | public $_params; |
| 104 | |
| 105 | /** |
| 106 | * The return properties used for search |
| 107 | * |
| 108 | * @var array |
| 109 | */ |
| 110 | protected $_returnProperties; |
| 111 | |
| 112 | /** |
| 113 | * Represent the type of selector |
| 114 | * |
| 115 | * @var int |
| 116 | */ |
| 117 | protected $_action; |
| 118 | |
| 119 | protected $_searchContext; |
| 120 | |
| 121 | /** |
| 122 | * Query object for this selector. |
| 123 | * |
| 124 | * @var CRM_Contact_BAO_Query |
| 125 | */ |
| 126 | protected $_query; |
| 127 | |
| 128 | /** |
| 129 | * Get the query object for this selector. |
| 130 | * |
| 131 | * @return CRM_Contact_BAO_Query |
| 132 | */ |
| 133 | public function getQueryObject() { |
| 134 | return $this->_query; |
| 135 | } |
| 136 | |
| 137 | /** |
| 138 | * Group id |
| 139 | * |
| 140 | * @var int |
| 141 | */ |
| 142 | protected $_ufGroupID; |
| 143 | |
| 144 | /** |
| 145 | * The public visible fields to be shown to the user |
| 146 | * |
| 147 | * @var array |
| 148 | */ |
| 149 | protected $_fields; |
| 150 | |
| 151 | /** |
| 152 | * Class constructor. |
| 153 | * |
| 154 | * @param $customSearchClass |
| 155 | * @param array $formValues |
| 156 | * Array of form values imported. |
| 157 | * @param array $params |
| 158 | * Array of parameters for query. |
| 159 | * @param null $returnProperties |
| 160 | * @param \const|int $action - action of search basic or advanced. |
| 161 | * |
| 162 | * @param bool $includeContactIds |
| 163 | * @param bool $searchDescendentGroups |
| 164 | * @param string $searchContext |
| 165 | * @param null $contextMenu |
| 166 | * |
| 167 | * @return CRM_Contact_Selector |
| 168 | */ |
| 169 | public function __construct( |
| 170 | $customSearchClass, |
| 171 | $formValues = NULL, |
| 172 | $params = NULL, |
| 173 | $returnProperties = NULL, |
| 174 | $action = CRM_Core_Action::NONE, |
| 175 | $includeContactIds = FALSE, |
| 176 | $searchDescendentGroups = TRUE, |
| 177 | $searchContext = 'search', |
| 178 | $contextMenu = NULL |
| 179 | ) { |
| 180 | //don't build query constructor, if form is not submitted |
| 181 | $force = CRM_Utils_Request::retrieve('force', 'Boolean'); |
| 182 | if (empty($formValues) && !$force) { |
| 183 | return; |
| 184 | } |
| 185 | |
| 186 | // submitted form values |
| 187 | $this->_formValues = &$formValues; |
| 188 | $this->_params = &$params; |
| 189 | $this->_returnProperties = &$returnProperties; |
| 190 | $this->_contextMenu = &$contextMenu; |
| 191 | $this->_context = $searchContext; |
| 192 | |
| 193 | // type of selector |
| 194 | $this->_action = $action; |
| 195 | |
| 196 | $this->_searchContext = $searchContext; |
| 197 | |
| 198 | $this->_ufGroupID = CRM_Utils_Array::value('uf_group_id', $this->_formValues); |
| 199 | |
| 200 | if ($this->_ufGroupID) { |
| 201 | $this->_fields = CRM_Core_BAO_UFGroup::getListingFields(CRM_Core_Action::VIEW, |
| 202 | CRM_Core_BAO_UFGroup::PUBLIC_VISIBILITY | |
| 203 | CRM_Core_BAO_UFGroup::LISTINGS_VISIBILITY, |
| 204 | FALSE, $this->_ufGroupID |
| 205 | ); |
| 206 | self::$_columnHeaders = NULL; |
| 207 | |
| 208 | $this->_customFields = CRM_Core_BAO_CustomField::getFieldsForImport('Individual'); |
| 209 | |
| 210 | $this->_returnProperties = CRM_Contact_BAO_Contact::makeHierReturnProperties($this->_fields); |
| 211 | $this->_returnProperties['contact_type'] = 1; |
| 212 | $this->_returnProperties['contact_sub_type'] = 1; |
| 213 | $this->_returnProperties['sort_name'] = 1; |
| 214 | } |
| 215 | |
| 216 | $displayRelationshipType = CRM_Utils_Array::value('display_relationship_type', $this->_formValues); |
| 217 | $operator = CRM_Utils_Array::value('operator', $this->_formValues, 'AND'); |
| 218 | |
| 219 | // rectify params to what proximity search expects if there is a value for prox_distance |
| 220 | // CRM-7021 |
| 221 | if (!empty($this->_params)) { |
| 222 | CRM_Contact_BAO_ProximityQuery::fixInputParams($this->_params); |
| 223 | } |
| 224 | |
| 225 | $this->_query = new CRM_Contact_BAO_Query( |
| 226 | $this->_params, |
| 227 | $this->_returnProperties, |
| 228 | NULL, |
| 229 | $includeContactIds, |
| 230 | FALSE, |
| 231 | CRM_Contact_BAO_Query::MODE_CONTACTS, |
| 232 | FALSE, |
| 233 | $searchDescendentGroups, |
| 234 | FALSE, |
| 235 | $displayRelationshipType, |
| 236 | $operator |
| 237 | ); |
| 238 | |
| 239 | $this->_options = &$this->_query->_options; |
| 240 | } |
| 241 | |
| 242 | /** |
| 243 | * This method set cache key, later used in test environment |
| 244 | * |
| 245 | * @param string $key |
| 246 | */ |
| 247 | public function setKey($key) { |
| 248 | $this->_key = $key; |
| 249 | } |
| 250 | |
| 251 | /** |
| 252 | * This method returns the links that are given for each search row. |
| 253 | * currently the links added for each row are |
| 254 | * |
| 255 | * - View |
| 256 | * - Edit |
| 257 | * |
| 258 | * @return array |
| 259 | */ |
| 260 | public static function &links() { |
| 261 | list($context, $contextMenu, $key) = func_get_args(); |
| 262 | $extraParams = ($key) ? "&key={$key}" : NULL; |
| 263 | $searchContext = ($context) ? "&context=$context" : NULL; |
| 264 | |
| 265 | if (!(self::$_links)) { |
| 266 | self::$_links = array( |
| 267 | CRM_Core_Action::VIEW => array( |
| 268 | 'name' => ts('View'), |
| 269 | 'url' => 'civicrm/contact/view', |
| 270 | 'class' => 'no-popup', |
| 271 | 'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}", |
| 272 | 'title' => ts('View Contact Details'), |
| 273 | 'ref' => 'view-contact', |
| 274 | ), |
| 275 | CRM_Core_Action::UPDATE => array( |
| 276 | 'name' => ts('Edit'), |
| 277 | 'url' => 'civicrm/contact/add', |
| 278 | 'class' => 'no-popup', |
| 279 | 'qs' => "reset=1&action=update&cid=%%id%%{$searchContext}{$extraParams}", |
| 280 | 'title' => ts('Edit Contact Details'), |
| 281 | 'ref' => 'edit-contact', |
| 282 | ), |
| 283 | ); |
| 284 | |
| 285 | $config = CRM_Core_Config::singleton(); |
| 286 | //CRM-16552: mapAPIKey is not mandatory as google no longer requires an API Key |
| 287 | if ($config->mapProvider && ($config->mapAPIKey || $config->mapProvider == 'Google')) { |
| 288 | self::$_links[CRM_Core_Action::MAP] = array( |
| 289 | 'name' => ts('Map'), |
| 290 | 'url' => 'civicrm/contact/map', |
| 291 | 'qs' => "reset=1&cid=%%id%%{$searchContext}{$extraParams}", |
| 292 | 'title' => ts('Map Contact'), |
| 293 | ); |
| 294 | } |
| 295 | |
| 296 | // Adding Context Menu Links in more action |
| 297 | if ($contextMenu) { |
| 298 | $counter = 7000; |
| 299 | foreach ($contextMenu as $key => $value) { |
| 300 | $contextVal = '&context=' . $value['key']; |
| 301 | if ($value['key'] == 'delete') { |
| 302 | $contextVal = $searchContext; |
| 303 | } |
| 304 | $url = "civicrm/contact/view/{$value['key']}"; |
| 305 | $qs = "reset=1&action=add&cid=%%id%%{$contextVal}{$extraParams}"; |
| 306 | if ($value['key'] == 'activity') { |
| 307 | $qs = "action=browse&selectedChild=activity&reset=1&cid=%%id%%{$extraParams}"; |
| 308 | } |
| 309 | elseif ($value['key'] == 'email') { |
| 310 | $url = "civicrm/contact/view/activity"; |
| 311 | $qs = "atype=3&action=add&reset=1&cid=%%id%%{$extraParams}"; |
| 312 | } |
| 313 | |
| 314 | self::$_links[$counter++] = array( |
| 315 | 'name' => $value['title'], |
| 316 | 'url' => $url, |
| 317 | 'qs' => $qs, |
| 318 | 'title' => $value['title'], |
| 319 | 'ref' => $value['ref'], |
| 320 | 'class' => CRM_Utils_Array::value('class', $value), |
| 321 | ); |
| 322 | } |
| 323 | } |
| 324 | } |
| 325 | return self::$_links; |
| 326 | } |
| 327 | |
| 328 | /** |
| 329 | * Getter for array of the parameters required for creating pager. |
| 330 | * |
| 331 | * @param $action |
| 332 | * @param array $params |
| 333 | */ |
| 334 | public function getPagerParams($action, &$params) { |
| 335 | $params['status'] = ts('Contact %%StatusMessage%%'); |
| 336 | $params['csvString'] = NULL; |
| 337 | $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT; |
| 338 | |
| 339 | $params['buttonTop'] = 'PagerTopButton'; |
| 340 | $params['buttonBottom'] = 'PagerBottomButton'; |
| 341 | } |
| 342 | |
| 343 | /** |
| 344 | * @param null $action |
| 345 | * @param null $output |
| 346 | * |
| 347 | * @return array |
| 348 | */ |
| 349 | public function &getColHeads($action = NULL, $output = NULL) { |
| 350 | $colHeads = self::_getColumnHeaders(); |
| 351 | $colHeads[] = array('desc' => ts('Actions'), 'name' => ts('Action')); |
| 352 | return $colHeads; |
| 353 | } |
| 354 | |
| 355 | /** |
| 356 | * Returns the column headers as an array of tuples: |
| 357 | * (name, sortName (key to the sort array)) |
| 358 | * |
| 359 | * @param string $action |
| 360 | * The action being performed. |
| 361 | * @param string $output |
| 362 | * What should the result set include (web/email/csv). |
| 363 | * |
| 364 | * @return array |
| 365 | * the column headers that need to be displayed |
| 366 | */ |
| 367 | public function &getColumnHeaders($action = NULL, $output = NULL) { |
| 368 | $headers = NULL; |
| 369 | |
| 370 | // unset return property elements that we don't care |
| 371 | if (!empty($this->_returnProperties)) { |
| 372 | $doNotCareElements = array( |
| 373 | 'contact_type', |
| 374 | 'contact_sub_type', |
| 375 | 'sort_name', |
| 376 | ); |
| 377 | foreach ($doNotCareElements as $value) { |
| 378 | unset($this->_returnProperties[$value]); |
| 379 | } |
| 380 | } |
| 381 | |
| 382 | if ($output == CRM_Core_Selector_Controller::EXPORT) { |
| 383 | $csvHeaders = array(ts('Contact ID'), ts('Contact Type')); |
| 384 | foreach ($this->getColHeads($action, $output) as $column) { |
| 385 | if (array_key_exists('name', $column)) { |
| 386 | $csvHeaders[] = $column['name']; |
| 387 | } |
| 388 | } |
| 389 | $headers = $csvHeaders; |
| 390 | } |
| 391 | elseif ($output == CRM_Core_Selector_Controller::SCREEN) { |
| 392 | $csvHeaders = array(ts('Name')); |
| 393 | foreach ($this->getColHeads($action, $output) as $key => $column) { |
| 394 | if (array_key_exists('name', $column) && |
| 395 | $column['name'] && |
| 396 | $column['name'] != ts('Name') |
| 397 | ) { |
| 398 | $csvHeaders[$key] = $column['name']; |
| 399 | } |
| 400 | } |
| 401 | $headers = $csvHeaders; |
| 402 | } |
| 403 | elseif ($this->_ufGroupID) { |
| 404 | // we dont use the cached value of column headers |
| 405 | // since it potentially changed because of the profile selected |
| 406 | static $skipFields = array('group', 'tag'); |
| 407 | $direction = CRM_Utils_Sort::ASCENDING; |
| 408 | $empty = TRUE; |
| 409 | if (!self::$_columnHeaders) { |
| 410 | self::$_columnHeaders = array( |
| 411 | array('name' => ''), |
| 412 | array( |
| 413 | 'name' => ts('Name'), |
| 414 | 'sort' => 'sort_name', |
| 415 | 'direction' => CRM_Utils_Sort::ASCENDING, |
| 416 | ), |
| 417 | ); |
| 418 | |
| 419 | $locationTypes = CRM_Core_DAO_Address::buildOptions('location_type_id', 'validate'); |
| 420 | |
| 421 | foreach ($this->_fields as $name => $field) { |
| 422 | if (!empty($field['in_selector']) && |
| 423 | !in_array($name, $skipFields) |
| 424 | ) { |
| 425 | if (strpos($name, '-') !== FALSE) { |
| 426 | list($fieldName, $lType, $type) = CRM_Utils_System::explode('-', $name, 3); |
| 427 | |
| 428 | if ($lType == 'Primary') { |
| 429 | $locationTypeName = 1; |
| 430 | } |
| 431 | else { |
| 432 | $locationTypeName = $locationTypes[$lType]; |
| 433 | } |
| 434 | |
| 435 | if (in_array($fieldName, array( |
| 436 | 'phone', |
| 437 | 'im', |
| 438 | 'email', |
| 439 | ))) { |
| 440 | if ($type) { |
| 441 | $name = "`$locationTypeName-$fieldName-$type`"; |
| 442 | } |
| 443 | else { |
| 444 | $name = "`$locationTypeName-$fieldName`"; |
| 445 | } |
| 446 | } |
| 447 | else { |
| 448 | $name = "`$locationTypeName-$fieldName`"; |
| 449 | } |
| 450 | } |
| 451 | //to handle sort key for Internal contactId.CRM-2289 |
| 452 | if ($name == 'id') { |
| 453 | $name = 'contact_id'; |
| 454 | } |
| 455 | |
| 456 | self::$_columnHeaders[] = array( |
| 457 | 'name' => $field['title'], |
| 458 | 'sort' => $name, |
| 459 | 'direction' => $direction, |
| 460 | ); |
| 461 | $direction = CRM_Utils_Sort::DONTCARE; |
| 462 | $empty = FALSE; |
| 463 | } |
| 464 | } |
| 465 | |
| 466 | // if we dont have any valid columns, dont add the implicit ones |
| 467 | // this allows the template to check on emptiness of column headers |
| 468 | if ($empty) { |
| 469 | self::$_columnHeaders = array(); |
| 470 | } |
| 471 | else { |
| 472 | self::$_columnHeaders[] = array('desc' => ts('Actions'), 'name' => ts('Action')); |
| 473 | } |
| 474 | } |
| 475 | $headers = self::$_columnHeaders; |
| 476 | } |
| 477 | elseif (!empty($this->_returnProperties)) { |
| 478 | self::$_columnHeaders = array( |
| 479 | array('name' => ''), |
| 480 | array( |
| 481 | 'name' => ts('Name'), |
| 482 | 'sort' => 'sort_name', |
| 483 | 'direction' => CRM_Utils_Sort::ASCENDING, |
| 484 | ), |
| 485 | ); |
| 486 | $properties = self::makeProperties($this->_returnProperties); |
| 487 | |
| 488 | foreach ($properties as $prop) { |
| 489 | if (strpos($prop, '-')) { |
| 490 | list($loc, $fld, $phoneType) = CRM_Utils_System::explode('-', $prop, 3); |
| 491 | $title = $this->_query->_fields[$fld]['title']; |
| 492 | if (trim($phoneType) && !is_numeric($phoneType) && strtolower($phoneType) != $fld) { |
| 493 | $title .= "-{$phoneType}"; |
| 494 | } |
| 495 | // fetch Location type label from name as $loc, which will be later used in column header |
| 496 | $title .= sprintf(" (%s)", |
| 497 | CRM_Core_PseudoConstant::getLabel( |
| 498 | 'CRM_Core_DAO_Address', |
| 499 | 'location_type_id', |
| 500 | CRM_Core_PseudoConstant::getKey('CRM_Core_DAO_Address', 'location_type_id', $loc) |
| 501 | ) |
| 502 | ); |
| 503 | |
| 504 | } |
| 505 | elseif (isset($this->_query->_fields[$prop]) && isset($this->_query->_fields[$prop]['title'])) { |
| 506 | $title = $this->_query->_fields[$prop]['title']; |
| 507 | } |
| 508 | elseif (isset($this->_query->_pseudoConstantsSelect[$prop]) && isset($this->_query->_pseudoConstantsSelect[$prop]['pseudoconstant']['optionGroupName'])) { |
| 509 | $title = CRM_Core_BAO_OptionGroup::getTitleByName($this->_query->_pseudoConstantsSelect[$prop]['pseudoconstant']['optionGroupName']); |
| 510 | } |
| 511 | else { |
| 512 | $title = ''; |
| 513 | } |
| 514 | |
| 515 | self::$_columnHeaders[] = array('name' => $title, 'sort' => $prop); |
| 516 | } |
| 517 | self::$_columnHeaders[] = array('name' => ts('Actions')); |
| 518 | $headers = self::$_columnHeaders; |
| 519 | } |
| 520 | else { |
| 521 | $headers = $this->getColHeads($action, $output); |
| 522 | } |
| 523 | |
| 524 | return $headers; |
| 525 | } |
| 526 | |
| 527 | /** |
| 528 | * Returns total number of rows for the query. |
| 529 | * |
| 530 | * @param int $action |
| 531 | * |
| 532 | * @return int |
| 533 | * Total number of rows |
| 534 | */ |
| 535 | public function getTotalCount($action) { |
| 536 | // Use count from cache during paging/sorting |
| 537 | if (!empty($_GET['crmPID']) || !empty($_GET['crmSID'])) { |
| 538 | $count = Civi::cache('long')->get("Search Results Count $this->_key"); |
| 539 | } |
| 540 | if (empty($count)) { |
| 541 | $count = $this->_query->searchQuery(0, 0, NULL, TRUE); |
| 542 | Civi::cache('long')->set("Search Results Count $this->_key", $count); |
| 543 | } |
| 544 | return $count; |
| 545 | } |
| 546 | |
| 547 | /** |
| 548 | * Returns all the rows in the given offset and rowCount. |
| 549 | * |
| 550 | * @param string $action |
| 551 | * The action being performed. |
| 552 | * @param int $offset |
| 553 | * The row number to start from. |
| 554 | * @param int $rowCount |
| 555 | * The number of rows to return. |
| 556 | * @param string $sort |
| 557 | * The sql string that describes the sort order. |
| 558 | * @param string $output |
| 559 | * What should the result set include (web/email/csv). |
| 560 | * |
| 561 | * @return int |
| 562 | * the total number of rows for this action |
| 563 | */ |
| 564 | public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { |
| 565 | if (($output == CRM_Core_Selector_Controller::EXPORT || |
| 566 | $output == CRM_Core_Selector_Controller::SCREEN |
| 567 | ) && |
| 568 | $this->_formValues['radio_ts'] == 'ts_sel' |
| 569 | ) { |
| 570 | $includeContactIds = TRUE; |
| 571 | } |
| 572 | else { |
| 573 | $includeContactIds = FALSE; |
| 574 | } |
| 575 | |
| 576 | // note the formvalues were given by CRM_Contact_Form_Search to us |
| 577 | // and contain the search criteria (parameters) |
| 578 | // note that the default action is basic |
| 579 | if ($rowCount) { |
| 580 | /** @var CRM_Core_PrevNextCache_Interface $prevNext */ |
| 581 | $prevNext = Civi::service('prevnext'); |
| 582 | $cacheKey = $this->buildPrevNextCache($sort); |
| 583 | $cids = $prevNext->fetch($cacheKey, $offset, $rowCount); |
| 584 | $resultSet = empty($cids) ? [] : $this->_query->getCachedContacts($cids, $includeContactIds)->fetchGenerator(); |
| 585 | } |
| 586 | else { |
| 587 | $resultSet = $this->_query->searchQuery($offset, $rowCount, $sort, FALSE, $includeContactIds)->fetchGenerator(); |
| 588 | } |
| 589 | |
| 590 | // process the result of the query |
| 591 | $rows = array(); |
| 592 | $permissions = array(CRM_Core_Permission::getPermission()); |
| 593 | if (CRM_Core_Permission::check('delete contacts')) { |
| 594 | $permissions[] = CRM_Core_Permission::DELETE; |
| 595 | } |
| 596 | $mask = CRM_Core_Action::mask($permissions); |
| 597 | |
| 598 | // mask value to hide map link if there are not lat/long |
| 599 | $mapMask = $mask & 4095; |
| 600 | |
| 601 | if ($this->_searchContext == 'smog') { |
| 602 | $gc = CRM_Core_SelectValues::groupContactStatus(); |
| 603 | } |
| 604 | |
| 605 | if ($this->_ufGroupID) { |
| 606 | $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id'); |
| 607 | |
| 608 | $names = array(); |
| 609 | static $skipFields = array('group', 'tag'); |
| 610 | foreach ($this->_fields as $key => $field) { |
| 611 | if (!empty($field['in_selector']) && |
| 612 | !in_array($key, $skipFields) |
| 613 | ) { |
| 614 | if (strpos($key, '-') !== FALSE) { |
| 615 | list($fieldName, $id, $type) = CRM_Utils_System::explode('-', $key, 3); |
| 616 | |
| 617 | if ($id == 'Primary') { |
| 618 | $locationTypeName = 1; |
| 619 | } |
| 620 | elseif ($fieldName == 'url') { |
| 621 | $locationTypeName = "website-{$id}"; |
| 622 | } |
| 623 | else { |
| 624 | $locationTypeName = CRM_Utils_Array::value($id, $locationTypes); |
| 625 | if (!$locationTypeName) { |
| 626 | continue; |
| 627 | } |
| 628 | } |
| 629 | |
| 630 | $locationTypeName = str_replace(' ', '_', $locationTypeName); |
| 631 | if (in_array($fieldName, array( |
| 632 | 'phone', |
| 633 | 'im', |
| 634 | 'email', |
| 635 | ))) { |
| 636 | if ($type) { |
| 637 | $names[] = "{$locationTypeName}-{$fieldName}-{$type}"; |
| 638 | } |
| 639 | else { |
| 640 | $names[] = "{$locationTypeName}-{$fieldName}"; |
| 641 | } |
| 642 | } |
| 643 | else { |
| 644 | $names[] = "{$locationTypeName}-{$fieldName}"; |
| 645 | } |
| 646 | } |
| 647 | else { |
| 648 | $names[] = $field['name']; |
| 649 | } |
| 650 | } |
| 651 | } |
| 652 | |
| 653 | $names[] = "status"; |
| 654 | } |
| 655 | elseif (!empty($this->_returnProperties)) { |
| 656 | $names = self::makeProperties($this->_returnProperties); |
| 657 | } |
| 658 | else { |
| 659 | $names = self::$_properties; |
| 660 | } |
| 661 | |
| 662 | $links = self::links($this->_context, $this->_contextMenu, $this->_key); |
| 663 | |
| 664 | //check explicitly added contact to a Smart Group. |
| 665 | $groupID = CRM_Utils_Array::value('group', $this->_formValues); |
| 666 | |
| 667 | $pseudoconstants = array(); |
| 668 | // for CRM-3157 purposes |
| 669 | if (in_array('world_region', $names)) { |
| 670 | $pseudoconstants['world_region'] = array( |
| 671 | 'dbName' => 'worldregion_id', |
| 672 | 'values' => CRM_Core_PseudoConstant::worldRegion(), |
| 673 | ); |
| 674 | } |
| 675 | |
| 676 | foreach ($resultSet as $result) { |
| 677 | $row = array(); |
| 678 | $this->_query->convertToPseudoNames($result); |
| 679 | // the columns we are interested in |
| 680 | foreach ($names as $property) { |
| 681 | if ($property == 'status') { |
| 682 | continue; |
| 683 | } |
| 684 | if ($cfID = CRM_Core_BAO_CustomField::getKeyID($property)) { |
| 685 | $row[$property] = CRM_Core_BAO_CustomField::displayValue( |
| 686 | $result->$property, |
| 687 | $cfID, |
| 688 | $result->contact_id |
| 689 | ); |
| 690 | } |
| 691 | elseif (strpos($property, '-im')) { |
| 692 | $row[$property] = $result->$property; |
| 693 | if (!empty($result->$property)) { |
| 694 | $imProviders = CRM_Core_PseudoConstant::get('CRM_Core_DAO_IM', 'provider_id'); |
| 695 | $providerId = $property . "-provider_id"; |
| 696 | $providerName = $imProviders[$result->$providerId]; |
| 697 | $row[$property] = $result->$property . " ({$providerName})"; |
| 698 | } |
| 699 | } |
| 700 | elseif (in_array($property, array( |
| 701 | 'addressee', |
| 702 | 'email_greeting', |
| 703 | 'postal_greeting', |
| 704 | ))) { |
| 705 | $greeting = $property . '_display'; |
| 706 | $row[$property] = $result->$greeting; |
| 707 | } |
| 708 | elseif (isset($pseudoconstants[$property])) { |
| 709 | $row[$property] = CRM_Utils_Array::value( |
| 710 | $result->{$pseudoconstants[$property]['dbName']}, |
| 711 | $pseudoconstants[$property]['values'] |
| 712 | ); |
| 713 | } |
| 714 | elseif (strpos($property, '-url') !== FALSE) { |
| 715 | $websiteUrl = ''; |
| 716 | $websiteKey = str_replace('-url', '', $property); |
| 717 | $propertyArray = explode('-', $property); |
| 718 | $websiteFld = $websiteKey . '-' . array_pop($propertyArray); |
| 719 | if (!empty($result->$websiteFld)) { |
| 720 | $websiteTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Website', 'website_type_id'); |
| 721 | $websiteType = $websiteTypes[$result->{"$websiteKey-website_type_id"}]; |
| 722 | $websiteValue = $result->$websiteFld; |
| 723 | $websiteUrl = "<a href=\"{$websiteValue}\">{$websiteValue} ({$websiteType})</a>"; |
| 724 | } |
| 725 | $row[$property] = $websiteUrl; |
| 726 | } |
| 727 | else { |
| 728 | $row[$property] = isset($result->$property) ? $result->$property : NULL; |
| 729 | } |
| 730 | } |
| 731 | |
| 732 | if (!empty($result->postal_code_suffix)) { |
| 733 | $row['postal_code'] .= "-" . $result->postal_code_suffix; |
| 734 | } |
| 735 | |
| 736 | if ($output != CRM_Core_Selector_Controller::EXPORT && |
| 737 | $this->_searchContext == 'smog' |
| 738 | ) { |
| 739 | if (empty($result->status) && |
| 740 | $groupID |
| 741 | ) { |
| 742 | $contactID = $result->contact_id; |
| 743 | if ($contactID) { |
| 744 | $gcParams = array( |
| 745 | 'contact_id' => $contactID, |
| 746 | 'group_id' => $groupID, |
| 747 | ); |
| 748 | |
| 749 | $gcDefaults = array(); |
| 750 | CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_GroupContact', $gcParams, $gcDefaults); |
| 751 | |
| 752 | if (empty($gcDefaults)) { |
| 753 | $row['status'] = ts('Smart'); |
| 754 | } |
| 755 | else { |
| 756 | $row['status'] = $gc[$gcDefaults['status']]; |
| 757 | } |
| 758 | } |
| 759 | else { |
| 760 | $row['status'] = NULL; |
| 761 | } |
| 762 | } |
| 763 | else { |
| 764 | $row['status'] = $gc[$result->status]; |
| 765 | } |
| 766 | } |
| 767 | |
| 768 | if ($output != CRM_Core_Selector_Controller::EXPORT) { |
| 769 | $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->contact_id; |
| 770 | |
| 771 | if (!empty($this->_formValues['deleted_contacts']) && CRM_Core_Permission::check('access deleted contacts') |
| 772 | ) { |
| 773 | $links = array( |
| 774 | array( |
| 775 | 'name' => ts('View'), |
| 776 | 'url' => 'civicrm/contact/view', |
| 777 | 'qs' => 'reset=1&cid=%%id%%', |
| 778 | 'class' => 'no-popup', |
| 779 | 'title' => ts('View Contact Details'), |
| 780 | ), |
| 781 | array( |
| 782 | 'name' => ts('Restore'), |
| 783 | 'url' => 'civicrm/contact/view/delete', |
| 784 | 'qs' => 'reset=1&cid=%%id%%&restore=1', |
| 785 | 'title' => ts('Restore Contact'), |
| 786 | ), |
| 787 | ); |
| 788 | if (CRM_Core_Permission::check('delete contacts')) { |
| 789 | $links[] = array( |
| 790 | 'name' => ts('Delete Permanently'), |
| 791 | 'url' => 'civicrm/contact/view/delete', |
| 792 | 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1', |
| 793 | 'title' => ts('Permanently Delete Contact'), |
| 794 | ); |
| 795 | } |
| 796 | $row['action'] = CRM_Core_Action::formLink( |
| 797 | $links, |
| 798 | NULL, |
| 799 | array('id' => $result->contact_id), |
| 800 | ts('more'), |
| 801 | FALSE, |
| 802 | 'contact.selector.row', |
| 803 | 'Contact', |
| 804 | $result->contact_id |
| 805 | ); |
| 806 | } |
| 807 | elseif ((is_numeric(CRM_Utils_Array::value('geo_code_1', $row))) || |
| 808 | (!empty($row['city']) && |
| 809 | CRM_Utils_Array::value('state_province', $row) |
| 810 | ) |
| 811 | ) { |
| 812 | $row['action'] = CRM_Core_Action::formLink( |
| 813 | $links, |
| 814 | $mask, |
| 815 | array('id' => $result->contact_id), |
| 816 | ts('more'), |
| 817 | FALSE, |
| 818 | 'contact.selector.row', |
| 819 | 'Contact', |
| 820 | $result->contact_id |
| 821 | ); |
| 822 | } |
| 823 | else { |
| 824 | $row['action'] = CRM_Core_Action::formLink( |
| 825 | $links, |
| 826 | $mapMask, |
| 827 | array('id' => $result->contact_id), |
| 828 | ts('more'), |
| 829 | FALSE, |
| 830 | 'contact.selector.row', |
| 831 | 'Contact', |
| 832 | $result->contact_id |
| 833 | ); |
| 834 | } |
| 835 | |
| 836 | // allow components to add more actions |
| 837 | CRM_Core_Component::searchAction($row, $result->contact_id); |
| 838 | |
| 839 | $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type, |
| 840 | FALSE, |
| 841 | $result->contact_id |
| 842 | ); |
| 843 | |
| 844 | $row['contact_type_orig'] = $result->contact_sub_type ? $result->contact_sub_type : $result->contact_type; |
| 845 | $row['contact_sub_type'] = $result->contact_sub_type ? CRM_Contact_BAO_ContactType::contactTypePairs(FALSE, $result->contact_sub_type, ', ') : $result->contact_sub_type; |
| 846 | $row['contact_id'] = $result->contact_id; |
| 847 | $row['sort_name'] = $result->sort_name; |
| 848 | // Surely this if should be if NOT - otherwise it's just wierd. |
| 849 | if (array_key_exists('id', $row)) { |
| 850 | $row['id'] = $result->contact_id; |
| 851 | } |
| 852 | } |
| 853 | |
| 854 | $rows[$row['contact_id']] = $row; |
| 855 | } |
| 856 | |
| 857 | return $rows; |
| 858 | } |
| 859 | |
| 860 | /** |
| 861 | * @param CRM_Utils_Sort $sort |
| 862 | * |
| 863 | * @return string |
| 864 | */ |
| 865 | public function buildPrevNextCache($sort) { |
| 866 | $cacheKey = 'civicrm search ' . $this->_key; |
| 867 | |
| 868 | // We should clear the cache in following conditions: |
| 869 | // 1. when starting from scratch, i.e new search |
| 870 | // 2. if records are sorted |
| 871 | |
| 872 | // get current page requested |
| 873 | $pageNum = CRM_Utils_Request::retrieve('crmPID', 'Integer'); |
| 874 | |
| 875 | // get the current sort order |
| 876 | $currentSortID = CRM_Utils_Request::retrieve('crmSID', 'String'); |
| 877 | |
| 878 | $session = CRM_Core_Session::singleton(); |
| 879 | |
| 880 | // get previous sort id |
| 881 | $previousSortID = $session->get('previousSortID'); |
| 882 | |
| 883 | // check for current != previous to ensure cache is not reset if paging is done without changing |
| 884 | // sort criteria |
| 885 | if (!$pageNum || (!empty($currentSortID) && $currentSortID != $previousSortID)) { |
| 886 | Civi::service('prevnext')->deleteItem(NULL, $cacheKey, 'civicrm_contact'); |
| 887 | // this means it's fresh search, so set pageNum=1 |
| 888 | if (!$pageNum) { |
| 889 | $pageNum = 1; |
| 890 | } |
| 891 | } |
| 892 | |
| 893 | // set the current sort as previous sort |
| 894 | if (!empty($currentSortID)) { |
| 895 | $session->set('previousSortID', $currentSortID); |
| 896 | } |
| 897 | |
| 898 | $pageSize = CRM_Utils_Request::retrieve('crmRowCount', 'Integer', CRM_Core_DAO::$_nullObject, FALSE, 50); |
| 899 | $firstRecord = ($pageNum - 1) * $pageSize; |
| 900 | |
| 901 | //for alphabetic pagination selection save |
| 902 | $sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter', 'String'); |
| 903 | |
| 904 | //for text field pagination selection save |
| 905 | $countRow = Civi::service('prevnext')->getCount($cacheKey); |
| 906 | // $sortByCharacter triggers a refresh in the prevNext cache |
| 907 | if ($sortByCharacter && $sortByCharacter != 'all') { |
| 908 | $this->fillupPrevNextCache($sort, $cacheKey, 0, max(self::CACHE_SIZE, $pageSize)); |
| 909 | } |
| 910 | elseif (($firstRecord + $pageSize) >= $countRow) { |
| 911 | $this->fillupPrevNextCache($sort, $cacheKey, $countRow, max(self::CACHE_SIZE, $pageSize) + $firstRecord - $countRow); |
| 912 | } |
| 913 | return $cacheKey; |
| 914 | } |
| 915 | |
| 916 | /** |
| 917 | * @param $rows |
| 918 | */ |
| 919 | public function addActions(&$rows) { |
| 920 | |
| 921 | $basicPermissions = CRM_Core_Permission::check('delete contacts') ? array(CRM_Core_Permission::DELETE) : array(); |
| 922 | |
| 923 | // get permissions on an individual level (CRM-12645) |
| 924 | // @todo look at storing this to the session as this is called twice during search results render. |
| 925 | $can_edit_list = CRM_Contact_BAO_Contact_Permission::allowList(array_keys($rows), CRM_Core_Permission::EDIT); |
| 926 | |
| 927 | $links_template = self::links($this->_context, $this->_contextMenu, $this->_key); |
| 928 | |
| 929 | foreach ($rows as $id => & $row) { |
| 930 | $links = $links_template; |
| 931 | if (in_array($id, $can_edit_list)) { |
| 932 | $mask = CRM_Core_Action::mask(array_merge(array(CRM_Core_Permission::EDIT), $basicPermissions)); |
| 933 | } |
| 934 | else { |
| 935 | $mask = CRM_Core_Action::mask(array_merge(array(CRM_Core_Permission::VIEW), $basicPermissions)); |
| 936 | } |
| 937 | |
| 938 | if ((!is_numeric(CRM_Utils_Array::value('geo_code_1', $row))) && |
| 939 | (empty($row['city']) || |
| 940 | !CRM_Utils_Array::value('state_province', $row) |
| 941 | ) |
| 942 | ) { |
| 943 | $mask = $mask & 4095; |
| 944 | } |
| 945 | |
| 946 | if (!empty($this->_formValues['deleted_contacts']) && CRM_Core_Permission::check('access deleted contacts') |
| 947 | ) { |
| 948 | $links = array( |
| 949 | array( |
| 950 | 'name' => ts('View'), |
| 951 | 'url' => 'civicrm/contact/view', |
| 952 | 'qs' => 'reset=1&cid=%%id%%', |
| 953 | 'class' => 'no-popup', |
| 954 | 'title' => ts('View Contact Details'), |
| 955 | ), |
| 956 | array( |
| 957 | 'name' => ts('Restore'), |
| 958 | 'url' => 'civicrm/contact/view/delete', |
| 959 | 'qs' => 'reset=1&cid=%%id%%&restore=1', |
| 960 | 'title' => ts('Restore Contact'), |
| 961 | ), |
| 962 | ); |
| 963 | if (CRM_Core_Permission::check('delete contacts')) { |
| 964 | $links[] = array( |
| 965 | 'name' => ts('Delete Permanently'), |
| 966 | 'url' => 'civicrm/contact/view/delete', |
| 967 | 'qs' => 'reset=1&cid=%%id%%&skip_undelete=1', |
| 968 | 'title' => ts('Permanently Delete Contact'), |
| 969 | ); |
| 970 | } |
| 971 | $row['action'] = CRM_Core_Action::formLink( |
| 972 | $links, |
| 973 | NULL, |
| 974 | array('id' => $row['contact_id']), |
| 975 | ts('more'), |
| 976 | FALSE, |
| 977 | 'contact.selector.actions', |
| 978 | 'Contact', |
| 979 | $row['contact_id'] |
| 980 | ); |
| 981 | } |
| 982 | else { |
| 983 | $row['action'] = CRM_Core_Action::formLink( |
| 984 | $links, |
| 985 | $mask, |
| 986 | array('id' => $row['contact_id']), |
| 987 | ts('more'), |
| 988 | FALSE, |
| 989 | 'contact.selector.actions', |
| 990 | 'Contact', |
| 991 | $row['contact_id'] |
| 992 | ); |
| 993 | } |
| 994 | |
| 995 | // allow components to add more actions |
| 996 | CRM_Core_Component::searchAction($row, $row['contact_id']); |
| 997 | |
| 998 | if (!empty($row['contact_type_orig'])) { |
| 999 | $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($row['contact_type_orig'], |
| 1000 | FALSE, $row['contact_id']); |
| 1001 | } |
| 1002 | } |
| 1003 | } |
| 1004 | |
| 1005 | /** |
| 1006 | * @param $rows |
| 1007 | */ |
| 1008 | public function removeActions(&$rows) { |
| 1009 | foreach ($rows as $rid => & $rValue) { |
| 1010 | unset($rValue['contact_type']); |
| 1011 | unset($rValue['action']); |
| 1012 | } |
| 1013 | } |
| 1014 | |
| 1015 | /** |
| 1016 | * @param CRM_Utils_Sort $sort |
| 1017 | * @param string $cacheKey |
| 1018 | * @param int $start |
| 1019 | * @param int $end |
| 1020 | */ |
| 1021 | public function fillupPrevNextCache($sort, $cacheKey, $start = 0, $end = self::CACHE_SIZE) { |
| 1022 | $coreSearch = TRUE; |
| 1023 | // For custom searches, use the contactIDs method |
| 1024 | if (is_a($this, 'CRM_Contact_Selector_Custom')) { |
| 1025 | $sql = $this->_search->contactIDs($start, $end, $sort, TRUE); |
| 1026 | $coreSearch = FALSE; |
| 1027 | } |
| 1028 | // For core searches use the searchQuery method |
| 1029 | else { |
| 1030 | $sql = $this->_query->getSearchSQL($start, $end, $sort, FALSE, $this->_query->_includeContactIds, |
| 1031 | FALSE, TRUE); |
| 1032 | } |
| 1033 | |
| 1034 | // CRM-9096 |
| 1035 | // due to limitations in our search query writer, the above query does not work |
| 1036 | // in cases where the query is being sorted on a non-contact table |
| 1037 | // this results in a fatal error :( |
| 1038 | // see below for the gross hack of trapping the error and not filling |
| 1039 | // the prev next cache in this situation |
| 1040 | // the other alternative of running the FULL query will just be incredibly inefficient |
| 1041 | // and slow things down way too much on large data sets / complex queries |
| 1042 | |
| 1043 | $selectSQL = "SELECT DISTINCT %1, contact_a.id, contact_a.sort_name"; |
| 1044 | |
| 1045 | $sql = str_ireplace(array("SELECT contact_a.id as contact_id", "SELECT contact_a.id as id"), $selectSQL, $sql); |
| 1046 | try { |
| 1047 | Civi::service('prevnext')->fillWithSql($cacheKey, $sql, [1 => [$cacheKey, 'String']]); |
| 1048 | } |
| 1049 | catch (CRM_Core_Exception $e) { |
| 1050 | if ($coreSearch) { |
| 1051 | // in the case of error, try rebuilding cache using full sql which is used for search selector display |
| 1052 | // this fixes the bugs reported in CRM-13996 & CRM-14438 |
| 1053 | $this->rebuildPreNextCache($start, $end, $sort, $cacheKey); |
| 1054 | } |
| 1055 | else { |
| 1056 | // This will always show for CiviRules :-( as a) it orders by 'rule_label' |
| 1057 | // which is not available in the query & b) it uses contact not contact_a |
| 1058 | // as an alias. |
| 1059 | // CRM_Core_Session::setStatus(ts('Query Failed')); |
| 1060 | return; |
| 1061 | } |
| 1062 | } |
| 1063 | |
| 1064 | if (Civi::service('prevnext') instanceof CRM_Core_PrevNextCache_Sql) { |
| 1065 | // SQL-backed prevnext cache uses an extra record for pruning the cache. |
| 1066 | CRM_Core_BAO_Cache::setItem($cacheKey, 'CiviCRM Search PrevNextCache', $cacheKey); |
| 1067 | } |
| 1068 | } |
| 1069 | |
| 1070 | /** |
| 1071 | * called to rebuild prev next cache using full sql in case of core search ( excluding custom search) |
| 1072 | * |
| 1073 | * @param int $start |
| 1074 | * Start for limit clause. |
| 1075 | * @param int $end |
| 1076 | * End for limit clause. |
| 1077 | * @param CRM_Utils_Sort $sort |
| 1078 | * @param string $cacheKey |
| 1079 | * Cache key. |
| 1080 | */ |
| 1081 | public function rebuildPreNextCache($start, $end, $sort, $cacheKey) { |
| 1082 | // generate full SQL |
| 1083 | $sql = $this->_query->searchQuery($start, $end, $sort, FALSE, $this->_query->_includeContactIds, |
| 1084 | FALSE, FALSE, TRUE); |
| 1085 | |
| 1086 | $dao = CRM_Core_DAO::executeQuery($sql); |
| 1087 | |
| 1088 | // build insert query, note that currently we build cache for 500 (self::CACHE_SIZE) contact records at a time, hence below approach |
| 1089 | $rows = []; |
| 1090 | while ($dao->fetch()) { |
| 1091 | $rows[] = [ |
| 1092 | 'entity_table' => 'civicrm_contact', |
| 1093 | 'entity_id1' => $dao->contact_id, |
| 1094 | 'entity_id2' => $dao->contact_id, |
| 1095 | 'data' => $dao->sort_name, |
| 1096 | ]; |
| 1097 | } |
| 1098 | |
| 1099 | Civi::service('prevnext')->fillWithArray($cacheKey, $rows); |
| 1100 | } |
| 1101 | |
| 1102 | /** |
| 1103 | * @inheritDoc |
| 1104 | */ |
| 1105 | public function getQILL() { |
| 1106 | return $this->_query->qill(); |
| 1107 | } |
| 1108 | |
| 1109 | /** |
| 1110 | * Name of export file. |
| 1111 | * |
| 1112 | * @param string $output |
| 1113 | * Type of output. |
| 1114 | * |
| 1115 | * @return string |
| 1116 | * name of the file |
| 1117 | */ |
| 1118 | public function getExportFileName($output = 'csv') { |
| 1119 | return ts('CiviCRM Contact Search'); |
| 1120 | } |
| 1121 | |
| 1122 | /** |
| 1123 | * Get colunmn headers for search selector. |
| 1124 | * |
| 1125 | * @return array |
| 1126 | */ |
| 1127 | private static function &_getColumnHeaders() { |
| 1128 | if (!isset(self::$_columnHeaders)) { |
| 1129 | $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, |
| 1130 | 'address_options', TRUE, NULL, TRUE |
| 1131 | ); |
| 1132 | |
| 1133 | self::$_columnHeaders = array( |
| 1134 | 'contact_type' => array('desc' => ts('Contact Type')), |
| 1135 | 'sort_name' => array( |
| 1136 | 'name' => ts('Name'), |
| 1137 | 'sort' => 'sort_name', |
| 1138 | 'direction' => CRM_Utils_Sort::ASCENDING, |
| 1139 | ), |
| 1140 | ); |
| 1141 | |
| 1142 | $defaultAddress = array( |
| 1143 | 'street_address' => array('name' => ts('Address')), |
| 1144 | 'city' => array( |
| 1145 | 'name' => ts('City'), |
| 1146 | 'sort' => 'city', |
| 1147 | 'direction' => CRM_Utils_Sort::DONTCARE, |
| 1148 | ), |
| 1149 | 'state_province' => array( |
| 1150 | 'name' => ts('State'), |
| 1151 | 'sort' => 'state_province', |
| 1152 | 'direction' => CRM_Utils_Sort::DONTCARE, |
| 1153 | ), |
| 1154 | 'postal_code' => array( |
| 1155 | 'name' => ts('Postal'), |
| 1156 | 'sort' => 'postal_code', |
| 1157 | 'direction' => CRM_Utils_Sort::DONTCARE, |
| 1158 | ), |
| 1159 | 'country' => array( |
| 1160 | 'name' => ts('Country'), |
| 1161 | 'sort' => 'country', |
| 1162 | 'direction' => CRM_Utils_Sort::DONTCARE, |
| 1163 | ), |
| 1164 | ); |
| 1165 | |
| 1166 | foreach ($defaultAddress as $columnName => $column) { |
| 1167 | if (!empty($addressOptions[$columnName])) { |
| 1168 | self::$_columnHeaders[$columnName] = $column; |
| 1169 | } |
| 1170 | } |
| 1171 | |
| 1172 | self::$_columnHeaders['email'] = array( |
| 1173 | 'name' => ts('Email'), |
| 1174 | 'sort' => 'email', |
| 1175 | 'direction' => CRM_Utils_Sort::DONTCARE, |
| 1176 | ); |
| 1177 | |
| 1178 | self::$_columnHeaders['phone'] = array('name' => ts('Phone')); |
| 1179 | } |
| 1180 | return self::$_columnHeaders; |
| 1181 | } |
| 1182 | |
| 1183 | /** |
| 1184 | * @return CRM_Contact_BAO_Query |
| 1185 | */ |
| 1186 | public function getQuery() { |
| 1187 | return $this->_query; |
| 1188 | } |
| 1189 | |
| 1190 | /** |
| 1191 | * @return CRM_Contact_DAO_Contact |
| 1192 | */ |
| 1193 | public function alphabetQuery() { |
| 1194 | return $this->_query->alphabetQuery(); |
| 1195 | } |
| 1196 | |
| 1197 | /** |
| 1198 | * @param array $params |
| 1199 | * @param int $sortID |
| 1200 | * @param null $displayRelationshipType |
| 1201 | * @param string $queryOperator |
| 1202 | * |
| 1203 | * @return CRM_Contact_DAO_Contact |
| 1204 | */ |
| 1205 | public function contactIDQuery($params, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') { |
| 1206 | $sortOrder = &$this->getSortOrder($this->_action); |
| 1207 | $sort = new CRM_Utils_Sort($sortOrder, $sortID); |
| 1208 | |
| 1209 | // rectify params to what proximity search expects if there is a value for prox_distance |
| 1210 | // CRM-7021 CRM-7905 |
| 1211 | if (!empty($params)) { |
| 1212 | CRM_Contact_BAO_ProximityQuery::fixInputParams($params); |
| 1213 | } |
| 1214 | |
| 1215 | if (!$displayRelationshipType) { |
| 1216 | $query = new CRM_Contact_BAO_Query($params, |
| 1217 | CRM_Contact_BAO_Query::NO_RETURN_PROPERTIES, |
| 1218 | NULL, FALSE, FALSE, 1, |
| 1219 | FALSE, TRUE, TRUE, NULL, |
| 1220 | $queryOperator |
| 1221 | ); |
| 1222 | } |
| 1223 | else { |
| 1224 | $query = new CRM_Contact_BAO_Query($params, |
| 1225 | CRM_Contact_BAO_Query::NO_RETURN_PROPERTIES, |
| 1226 | NULL, FALSE, FALSE, 1, |
| 1227 | FALSE, TRUE, TRUE, $displayRelationshipType, |
| 1228 | $queryOperator |
| 1229 | ); |
| 1230 | } |
| 1231 | $value = $query->searchQuery(0, 0, $sort, |
| 1232 | FALSE, FALSE, FALSE, |
| 1233 | FALSE, FALSE |
| 1234 | ); |
| 1235 | return $value; |
| 1236 | } |
| 1237 | |
| 1238 | /** |
| 1239 | * @param $returnProperties |
| 1240 | * |
| 1241 | * @return array |
| 1242 | */ |
| 1243 | public function &makeProperties(&$returnProperties) { |
| 1244 | $properties = array(); |
| 1245 | foreach ($returnProperties as $name => $value) { |
| 1246 | if ($name != 'location') { |
| 1247 | // special handling for group and tag |
| 1248 | if (in_array($name, array('group', 'tag'))) { |
| 1249 | $name = "{$name}s"; |
| 1250 | } |
| 1251 | |
| 1252 | // special handling for notes |
| 1253 | if (in_array($name, array('note', 'note_subject', 'note_body'))) { |
| 1254 | $name = "notes"; |
| 1255 | } |
| 1256 | |
| 1257 | $properties[] = $name; |
| 1258 | } |
| 1259 | else { |
| 1260 | // extract all the location stuff |
| 1261 | foreach ($value as $n => $v) { |
| 1262 | foreach ($v as $n1 => $v1) { |
| 1263 | if (!strpos('_id', $n1) && $n1 != 'location_type') { |
| 1264 | $n = str_replace(' ', '_', $n); |
| 1265 | $properties[] = "{$n}-{$n1}"; |
| 1266 | } |
| 1267 | } |
| 1268 | } |
| 1269 | } |
| 1270 | } |
| 1271 | return $properties; |
| 1272 | } |
| 1273 | |
| 1274 | } |