Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id: Selector.php 11510 2007-09-18 09:21:34Z lobo $ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class is used to retrieve and display a range of | |
38 | * contacts that match the given criteria (specifically for | |
39 | * results of advanced search options. | |
40 | * | |
41 | */ | |
42 | class CRM_Contact_Selector_Custom extends CRM_Contact_Selector { | |
43 | ||
44 | /** | |
45 | * This defines two actions- View and Edit. | |
46 | * | |
47 | * @var array | |
6a488035 TO |
48 | */ |
49 | static $_links = NULL; | |
50 | ||
51 | /** | |
100fef9d | 52 | * We use desc to remind us what that column is, name is used in the tpl |
6a488035 TO |
53 | * |
54 | * @var array | |
6a488035 TO |
55 | */ |
56 | static $_columnHeaders; | |
57 | ||
58 | /** | |
59 | * Properties of contact we're interested in displaying | |
60 | * @var array | |
6a488035 TO |
61 | */ |
62 | static $_properties = array('contact_id', 'contact_type', 'display_name'); | |
63 | ||
64 | /** | |
100fef9d | 65 | * FormValues is the array returned by exportValues called on |
6a488035 TO |
66 | * the HTML_QuickForm_Controller for that page. |
67 | * | |
68 | * @var array | |
6a488035 TO |
69 | */ |
70 | public $_formValues; | |
71 | ||
72 | /** | |
100fef9d | 73 | * Params is the array in a value used by the search query creator |
6a488035 TO |
74 | * |
75 | * @var array | |
6a488035 TO |
76 | */ |
77 | public $_params; | |
78 | ||
79 | /** | |
100fef9d | 80 | * Represent the type of selector |
6a488035 TO |
81 | * |
82 | * @var int | |
6a488035 TO |
83 | */ |
84 | protected $_action; | |
85 | ||
86 | protected $_query; | |
87 | ||
88 | /** | |
100fef9d | 89 | * The public visible fields to be shown to the user |
6a488035 TO |
90 | * |
91 | * @var array | |
6a488035 TO |
92 | */ |
93 | protected $_fields; | |
94 | ||
95 | /** | |
96 | * The object that implements the search interface | |
97 | */ | |
98 | protected $_search; | |
99 | ||
100 | protected $_customSearchClass; | |
101 | ||
102 | /** | |
103 | * Class constructor | |
104 | * | |
6c8f6e67 | 105 | * @param $customSearchClass |
77c5b619 TO |
106 | * @param array $formValues |
107 | * Array of form values imported. | |
108 | * @param array $params | |
109 | * Array of parameters for query. | |
6c8f6e67 EM |
110 | * @param null $returnProperties |
111 | * @param \const|int $action - action of search basic or advanced. | |
6a488035 | 112 | * |
6c8f6e67 EM |
113 | * @param bool $includeContactIds |
114 | * @param bool $searchChildGroups | |
115 | * @param string $searchContext | |
116 | * @param null $contextMenu | |
117 | * | |
118 | * @return \CRM_Contact_Selector_Custom | |
6a488035 TO |
119 | */ |
120 | function __construct( | |
121 | $customSearchClass, | |
ce80b209 TO |
122 | $formValues = NULL, |
123 | $params = NULL, | |
124 | $returnProperties = NULL, | |
125 | $action = CRM_Core_Action::NONE, | |
6a488035 TO |
126 | $includeContactIds = FALSE, |
127 | $searchChildGroups = TRUE, | |
ce80b209 TO |
128 | $searchContext = 'search', |
129 | $contextMenu = NULL | |
6a488035 TO |
130 | ) { |
131 | $this->_customSearchClass = $customSearchClass; | |
132 | $this->_formValues = $formValues; | |
133 | $this->_includeContactIds = $includeContactIds; | |
134 | ||
135 | $ext = CRM_Extension_System::singleton()->getMapper(); | |
136 | ||
137 | if (!$ext->isExtensionKey($customSearchClass)) { | |
138 | if ($ext->isExtensionClass($customSearchClass)) { | |
139 | $customSearchFile = $ext->classToPath($customSearchClass); | |
ce80b209 | 140 | require_once $customSearchFile; |
6a488035 TO |
141 | } |
142 | else { | |
ce80b209 | 143 | require_once str_replace('_', DIRECTORY_SEPARATOR, $customSearchClass) . '.php'; |
6a488035 | 144 | } |
481a74f4 | 145 | $this->_search = new $customSearchClass($formValues); |
6a488035 TO |
146 | } |
147 | else { | |
c7b8b4e4 DL |
148 | $fnName = $ext->keyToPath; |
149 | $customSearchFile = $fnName($customSearchClass, 'search'); | |
150 | $className = $ext->keyToClass($customSearchClass, 'search'); | |
151 | $this->_search = new $className($formValues); | |
6a488035 TO |
152 | } |
153 | } | |
6a488035 TO |
154 | |
155 | /** | |
156 | * This method returns the links that are given for each search row. | |
157 | * currently the links added for each row are | |
158 | * | |
159 | * - View | |
160 | * - Edit | |
161 | * | |
162 | * @return array | |
6a488035 | 163 | */ |
00be9182 | 164 | public static function &links() { |
7c34ab11 | 165 | list($key) = func_get_args(); |
119c08a8 | 166 | $searchContext = "&context=custom"; |
7c34ab11 | 167 | $extraParams = ($key) ? "&key={$key}" : NULL; |
168 | ||
6a488035 TO |
169 | if (!(self::$_links)) { |
170 | self::$_links = array( | |
171 | CRM_Core_Action::VIEW => array( | |
172 | 'name' => ts('View'), | |
173 | 'url' => 'civicrm/contact/view', | |
119c08a8 | 174 | 'qs' => "reset=1&cid=%%id%%{$extraParams}{$searchContext}", |
d3fcd52f | 175 | 'class' => 'no-popup', |
6a488035 TO |
176 | 'title' => ts('View Contact Details'), |
177 | ), | |
178 | CRM_Core_Action::UPDATE => array( | |
179 | 'name' => ts('Edit'), | |
180 | 'url' => 'civicrm/contact/add', | |
181 | 'qs' => 'reset=1&action=update&cid=%%id%%', | |
d3fcd52f | 182 | 'class' => 'no-popup', |
6a488035 TO |
183 | 'title' => ts('Edit Contact Details'), |
184 | ), | |
185 | ); | |
186 | ||
187 | $config = CRM_Core_Config::singleton(); | |
188 | if ($config->mapAPIKey && $config->mapProvider) { | |
189 | self::$_links[CRM_Core_Action::MAP] = array( | |
190 | 'name' => ts('Map'), | |
191 | 'url' => 'civicrm/contact/map', | |
192 | 'qs' => 'reset=1&cid=%%id%%&searchType=custom', | |
d3fcd52f | 193 | 'class' => 'no-popup', |
6a488035 TO |
194 | 'title' => ts('Map Contact'), |
195 | ); | |
196 | } | |
197 | } | |
198 | return self::$_links; | |
199 | } | |
6a488035 TO |
200 | |
201 | /** | |
100fef9d | 202 | * Getter for array of the parameters required for creating pager. |
6a488035 | 203 | * |
da6b46f4 | 204 | * @param $action |
c490a46a | 205 | * @param array $params |
6a488035 | 206 | */ |
00be9182 | 207 | public function getPagerParams($action, &$params) { |
353ffa53 | 208 | $params['status'] = ts('Contact %%StatusMessage%%'); |
6a488035 | 209 | $params['csvString'] = NULL; |
353ffa53 | 210 | $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT; |
6a488035 TO |
211 | |
212 | $params['buttonTop'] = 'PagerTopButton'; | |
213 | $params['buttonBottom'] = 'PagerBottomButton'; | |
214 | } | |
6a488035 TO |
215 | |
216 | /** | |
100fef9d | 217 | * Returns the column headers as an array of tuples: |
6a488035 TO |
218 | * (name, sortName (key to the sort array)) |
219 | * | |
77c5b619 TO |
220 | * @param string $action |
221 | * The action being performed. | |
3f8d2862 | 222 | * @param string $output |
77c5b619 | 223 | * What should the result set include (web/email/csv). |
6a488035 | 224 | * |
a6c01b45 CW |
225 | * @return array |
226 | * the column headers that need to be displayed | |
6a488035 | 227 | */ |
00be9182 | 228 | public function &getColumnHeaders($action = NULL, $output = NULL) { |
6a488035 TO |
229 | $columns = $this->_search->columns(); |
230 | if ($output == CRM_Core_Selector_Controller::EXPORT) { | |
231 | return array_keys($columns); | |
232 | } | |
233 | else { | |
234 | $headers = array(); | |
235 | foreach ($columns as $name => $key) { | |
236 | if (!empty($name)) { | |
237 | $headers[] = array( | |
238 | 'name' => $name, | |
239 | 'sort' => $key, | |
240 | 'direction' => CRM_Utils_Sort::ASCENDING, | |
241 | ); | |
242 | } | |
243 | else { | |
244 | $headers[] = array(); | |
245 | } | |
246 | } | |
247 | return $headers; | |
248 | } | |
249 | } | |
250 | ||
251 | /** | |
252 | * Returns total number of rows for the query. | |
253 | * | |
254 | * @param | |
255 | * | |
a6c01b45 CW |
256 | * @return int |
257 | * Total number of rows | |
6a488035 | 258 | */ |
00be9182 | 259 | public function getTotalCount($action) { |
6a488035 TO |
260 | return $this->_search->count(); |
261 | } | |
262 | ||
263 | /** | |
100fef9d | 264 | * Returns all the rows in the given offset and rowCount |
6a488035 | 265 | * |
3f8d2862 | 266 | * @param string $action |
77c5b619 TO |
267 | * The action being performed. |
268 | * @param int $offset | |
269 | * The row number to start from. | |
270 | * @param int $rowCount | |
271 | * The number of rows to return. | |
272 | * @param string $sort | |
273 | * The sql string that describes the sort order. | |
3f8d2862 | 274 | * @param string $output |
77c5b619 | 275 | * What should the result set include (web/email/csv). |
6a488035 | 276 | * |
a6c01b45 CW |
277 | * @return int |
278 | * the total number of rows for this action | |
6a488035 | 279 | */ |
00be9182 | 280 | public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) { |
6a488035 TO |
281 | |
282 | $includeContactIDs = FALSE; | |
283 | if (($output == CRM_Core_Selector_Controller::EXPORT || | |
284 | $output == CRM_Core_Selector_Controller::SCREEN | |
285 | ) && | |
286 | $this->_formValues['radio_ts'] == 'ts_sel' | |
287 | ) { | |
288 | $includeContactIDs = TRUE; | |
289 | } | |
290 | ||
291 | $sql = $this->_search->all($offset, $rowCount, $sort, $includeContactIDs); | |
d9ab802d PJ |
292 | // contact query object used for creating $sql |
293 | $contactQueryObj = NULL; | |
294 | if (method_exists($this->_search, 'getQueryObj') && | |
353ffa53 TO |
295 | is_a($this->_search->getQueryObj(), 'CRM_Contact_BAO_Query') |
296 | ) { | |
d9ab802d PJ |
297 | $contactQueryObj = $this->_search->getQueryObj(); |
298 | } | |
6a488035 TO |
299 | |
300 | $dao = CRM_Core_DAO::executeQuery($sql, CRM_Core_DAO::$_nullArray); | |
301 | ||
353ffa53 | 302 | $columns = $this->_search->columns(); |
6a488035 | 303 | $columnNames = array_values($columns); |
353ffa53 | 304 | $links = self::links($this->_key); |
6a488035 TO |
305 | |
306 | $permissions = array(CRM_Core_Permission::getPermission()); | |
307 | if (CRM_Core_Permission::check('delete contacts')) { | |
308 | $permissions[] = CRM_Core_Permission::DELETE; | |
309 | } | |
310 | $mask = CRM_Core_Action::mask($permissions); | |
311 | ||
312 | $alterRow = FALSE; | |
313 | if (method_exists($this->_customSearchClass, | |
353ffa53 TO |
314 | 'alterRow' |
315 | )) { | |
6a488035 TO |
316 | $alterRow = TRUE; |
317 | } | |
318 | $image = FALSE; | |
319 | if (is_a($this->_search, 'CRM_Contact_Form_Search_Custom_Basic')) { | |
320 | $image = TRUE; | |
321 | } | |
322 | // process the result of the query | |
323 | $rows = array(); | |
324 | while ($dao->fetch()) { | |
325 | $row = array(); | |
326 | $empty = TRUE; | |
327 | ||
d9ab802d PJ |
328 | // if contact query object present |
329 | // process pseudo constants | |
330 | if ($contactQueryObj) { | |
331 | $contactQueryObj->convertToPseudoNames($dao); | |
332 | } | |
333 | ||
6a488035 TO |
334 | // the columns we are interested in |
335 | foreach ($columnNames as $property) { | |
336 | $row[$property] = $dao->$property; | |
337 | if (!empty($dao->$property)) { | |
338 | $empty = FALSE; | |
339 | } | |
340 | } | |
341 | if (!$empty) { | |
342 | $contactID = isset($dao->contact_id) ? $dao->contact_id : NULL; | |
343 | ||
344 | $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $contactID; | |
345 | $row['action'] = CRM_Core_Action::formLink($links, | |
346 | $mask, | |
87dab4a4 AH |
347 | array('id' => $contactID), |
348 | ts('more'), | |
349 | FALSE, | |
350 | 'contact.custom.actions', | |
351 | 'Contact', | |
352 | $contactID | |
6a488035 TO |
353 | ); |
354 | $row['contact_id'] = $contactID; | |
355 | ||
356 | if ($alterRow) { | |
357 | $this->_search->alterRow($row); | |
358 | } | |
359 | ||
360 | if ($image) { | |
ce80b209 | 361 | $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($dao->contact_sub_type ? $dao->contact_sub_type : $dao->contact_type, FALSE, $contactID |
6a488035 TO |
362 | ); |
363 | } | |
364 | $rows[] = $row; | |
365 | } | |
366 | } | |
367 | ||
368 | $this->buildPrevNextCache($sort); | |
369 | ||
370 | return $rows; | |
371 | } | |
372 | ||
373 | /** | |
374 | * Given the current formValues, gets the query in local | |
375 | * language | |
376 | * | |
353ffa53 TO |
377 | * @param array ( |
378 | * reference) $formValues submitted formValues | |
6a488035 | 379 | * |
a6c01b45 CW |
380 | * @return array |
381 | * which contains an array of strings | |
6a488035 TO |
382 | */ |
383 | public function getQILL() { | |
384 | return NULL; | |
385 | } | |
386 | ||
86538308 EM |
387 | /** |
388 | * @return mixed | |
389 | */ | |
6a488035 TO |
390 | public function getSummary() { |
391 | return $this->_search->summary(); | |
392 | } | |
393 | ||
394 | /** | |
100fef9d | 395 | * Name of export file. |
6a488035 | 396 | * |
77c5b619 TO |
397 | * @param string $output |
398 | * Type of output. | |
6a488035 | 399 | * |
a6c01b45 CW |
400 | * @return string |
401 | * name of the file | |
6a488035 | 402 | */ |
00be9182 | 403 | public function getExportFileName($output = 'csv') { |
6a488035 TO |
404 | return ts('CiviCRM Custom Search'); |
405 | } | |
406 | ||
86538308 EM |
407 | /** |
408 | * @return null | |
409 | */ | |
00be9182 | 410 | public function alphabetQuery() { |
6a488035 TO |
411 | return NULL; |
412 | } | |
413 | ||
86538308 | 414 | /** |
c490a46a | 415 | * @param array $params |
86538308 | 416 | * @param $action |
100fef9d | 417 | * @param int $sortID |
86538308 EM |
418 | * @param null $displayRelationshipType |
419 | * @param string $queryOperator | |
420 | * | |
421 | * @return Object | |
422 | */ | |
00be9182 | 423 | public function &contactIDQuery($params, $action, $sortID, $displayRelationshipType = NULL, $queryOperator = 'AND') { |
6a488035 TO |
424 | $params = array(); |
425 | $sql = $this->_search->contactIDs($params); | |
426 | ||
427 | return CRM_Core_DAO::executeQuery($sql, $params); | |
428 | } | |
429 | ||
86538308 EM |
430 | /** |
431 | * @param $rows | |
432 | */ | |
00be9182 | 433 | public function addActions(&$rows) { |
7c34ab11 | 434 | $links = self::links($this->_key); |
6a488035 TO |
435 | |
436 | $permissions = array(CRM_Core_Permission::getPermission()); | |
437 | if (CRM_Core_Permission::check('delete contacts')) { | |
438 | $permissions[] = CRM_Core_Permission::DELETE; | |
439 | } | |
440 | $mask = CRM_Core_Action::mask($permissions); | |
441 | ||
442 | foreach ($rows as $id => & $row) { | |
443 | $row['action'] = CRM_Core_Action::formLink($links, | |
444 | $mask, | |
87dab4a4 AH |
445 | array('id' => $row['contact_id']), |
446 | ts('more'), | |
447 | FALSE, | |
448 | 'contact.custom.actions', | |
449 | 'Contact', | |
450 | $row['contact_id'] | |
6a488035 TO |
451 | ); |
452 | } | |
453 | } | |
454 | ||
86538308 EM |
455 | /** |
456 | * @param $rows | |
457 | */ | |
00be9182 | 458 | public function removeActions(&$rows) { |
6a488035 TO |
459 | foreach ($rows as $rid => & $rValue) { |
460 | unset($rValue['action']); | |
461 | } | |
462 | } | |
463 | } |