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