Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
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 | |
8c9251b3 | 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
35 | * Base Search / View form for *all* listing of multiple | |
36 | * contacts | |
37 | */ | |
3efb5b86 | 38 | class CRM_Contact_Form_Search extends CRM_Core_Form_Search { |
6a488035 | 39 | |
d424ffde | 40 | /** |
fe482240 | 41 | * list of valid contexts. |
6a488035 TO |
42 | * |
43 | * @var array | |
6a488035 TO |
44 | */ |
45 | static $_validContext = NULL; | |
46 | ||
47 | /** | |
fe482240 | 48 | * List of values used when we want to display other objects. |
6a488035 TO |
49 | * |
50 | * @var array | |
6a488035 TO |
51 | */ |
52 | static $_modeValues = NULL; | |
53 | ||
6a488035 | 54 | /** |
fe482240 | 55 | * The contextMenu. |
6a488035 TO |
56 | * |
57 | * @var array | |
6a488035 TO |
58 | */ |
59 | protected $_contextMenu; | |
60 | ||
61 | /** | |
fe482240 | 62 | * The groupId retrieved from the GET vars. |
6a488035 TO |
63 | * |
64 | * @var int | |
6a488035 TO |
65 | */ |
66 | public $_groupID; | |
67 | ||
68 | /** | |
fe482240 | 69 | * The Group ID belonging to Add Member to group ID. |
6a488035 TO |
70 | * retrieved from the GET vars |
71 | * | |
72 | * @var int | |
6a488035 TO |
73 | */ |
74 | protected $_amtgID; | |
75 | ||
76 | /** | |
fe482240 | 77 | * The saved search ID retrieved from the GET vars. |
6a488035 TO |
78 | * |
79 | * @var int | |
6a488035 TO |
80 | */ |
81 | protected $_ssID; | |
82 | ||
6a488035 | 83 | /** |
fe482240 | 84 | * The group elements. |
6a488035 TO |
85 | * |
86 | * @var array | |
6a488035 TO |
87 | */ |
88 | public $_group; | |
89 | public $_groupElement; | |
6a488035 TO |
90 | |
91 | /** | |
fe482240 | 92 | * The tag elements. |
6a488035 TO |
93 | * |
94 | * @var array | |
6a488035 TO |
95 | */ |
96 | public $_tag; | |
97 | public $_tagElement; | |
98 | ||
6a488035 | 99 | /** |
fe482240 | 100 | * The params used for search. |
6a488035 TO |
101 | * |
102 | * @var array | |
6a488035 TO |
103 | */ |
104 | protected $_params; | |
105 | ||
106 | /** | |
fe482240 | 107 | * The return properties used for search. |
6a488035 TO |
108 | * |
109 | * @var array | |
6a488035 TO |
110 | */ |
111 | protected $_returnProperties; | |
112 | ||
113 | /** | |
fe482240 | 114 | * The sort by character. |
6a488035 TO |
115 | * |
116 | * @var string | |
6a488035 TO |
117 | */ |
118 | protected $_sortByCharacter; | |
119 | ||
120 | /** | |
fe482240 | 121 | * The profile group id used for display. |
6a488035 TO |
122 | * |
123 | * @var integer | |
6a488035 TO |
124 | */ |
125 | protected $_ufGroupID; | |
126 | ||
c490a46a | 127 | /** |
100fef9d | 128 | * Csv - common search values |
c490a46a CW |
129 | * |
130 | * @var array | |
c490a46a | 131 | */ |
6a488035 TO |
132 | static $csv = array('contact_type', 'group', 'tag'); |
133 | ||
134 | /** | |
135 | * @var string how to display the results. Should we display as | |
136 | * contributons, members, cases etc | |
137 | */ | |
138 | protected $_componentMode; | |
139 | ||
140 | /** | |
141 | * @var string what operator should we use, AND or OR | |
142 | */ | |
143 | protected $_operator; | |
144 | ||
145 | protected $_modeValue; | |
146 | ||
90c13aa2 SL |
147 | /** |
148 | * Declare entity reference fields as they will need to be converted to using 'IN'. | |
149 | * | |
150 | * @var array | |
151 | */ | |
f179424e | 152 | protected $entityReferenceFields = array('event_id', 'membership_type_id'); |
90c13aa2 | 153 | |
6a488035 | 154 | /** |
fe482240 | 155 | * Name of the selector to use. |
6a488035 TO |
156 | */ |
157 | static $_selectorName = 'CRM_Contact_Selector'; | |
158 | protected $_customSearchID = NULL; | |
159 | protected $_customSearchClass = NULL; | |
160 | ||
161 | protected $_openedPanes = array(); | |
d5965a37 | 162 | |
6e62b28c TM |
163 | /** |
164 | * Explicitly declare the entity api name. | |
165 | */ | |
166 | public function getDefaultEntity() { | |
167 | return 'Contact'; | |
168 | } | |
6a488035 TO |
169 | |
170 | /** | |
fe482240 | 171 | * Define the set of valid contexts that the search form operates on. |
6a488035 | 172 | * |
a6c01b45 CW |
173 | * @return array |
174 | * the valid context set and the titles | |
6a488035 | 175 | */ |
00be9182 | 176 | public static function &validContext() { |
6a488035 TO |
177 | if (!(self::$_validContext)) { |
178 | self::$_validContext = array( | |
179 | 'smog' => 'Show members of group', | |
180 | 'amtg' => 'Add members to group', | |
181 | 'basic' => 'Basic Search', | |
182 | 'search' => 'Search', | |
183 | 'builder' => 'Search Builder', | |
184 | 'advanced' => 'Advanced Search', | |
185 | 'custom' => 'Custom Search', | |
186 | ); | |
187 | } | |
188 | return self::$_validContext; | |
189 | } | |
190 | ||
86538308 EM |
191 | /** |
192 | * @param $context | |
193 | * | |
194 | * @return bool | |
195 | */ | |
00be9182 | 196 | public static function isSearchContext($context) { |
6a488035 TO |
197 | $searchContext = CRM_Utils_Array::value($context, self::validContext()); |
198 | return $searchContext ? TRUE : FALSE; | |
199 | } | |
200 | ||
00be9182 | 201 | public static function setModeValues() { |
a6c6c64f JP |
202 | self::$_modeValues = array( |
203 | CRM_Contact_BAO_Query::MODE_CONTACTS => array( | |
204 | 'selectorName' => self::$_selectorName, | |
205 | 'selectorLabel' => ts('Contacts'), | |
206 | 'taskFile' => 'CRM/Contact/Form/Search/ResultTasks.tpl', | |
207 | 'taskContext' => NULL, | |
208 | 'resultFile' => 'CRM/Contact/Form/Selector.tpl', | |
209 | 'resultContext' => NULL, | |
210 | 'taskClassName' => 'CRM_Contact_Task', | |
211 | 'component' => '', | |
212 | ), | |
213 | CRM_Contact_BAO_Query::MODE_CONTRIBUTE => array( | |
214 | 'selectorName' => 'CRM_Contribute_Selector_Search', | |
215 | 'selectorLabel' => ts('Contributions'), | |
216 | 'taskFile' => 'CRM/common/searchResultTasks.tpl', | |
217 | 'taskContext' => 'Contribution', | |
218 | 'resultFile' => 'CRM/Contribute/Form/Selector.tpl', | |
219 | 'resultContext' => 'Search', | |
220 | 'taskClassName' => 'CRM_Contribute_Task', | |
221 | 'component' => 'CiviContribute', | |
222 | ), | |
223 | CRM_Contact_BAO_Query::MODE_EVENT => array( | |
224 | 'selectorName' => 'CRM_Event_Selector_Search', | |
225 | 'selectorLabel' => ts('Event Participants'), | |
226 | 'taskFile' => 'CRM/common/searchResultTasks.tpl', | |
227 | 'taskContext' => NULL, | |
228 | 'resultFile' => 'CRM/Event/Form/Selector.tpl', | |
229 | 'resultContext' => 'Search', | |
230 | 'taskClassName' => 'CRM_Event_Task', | |
231 | 'component' => 'CiviEvent', | |
232 | ), | |
233 | CRM_Contact_BAO_Query::MODE_ACTIVITY => array( | |
234 | 'selectorName' => 'CRM_Activity_Selector_Search', | |
235 | 'selectorLabel' => ts('Activities'), | |
236 | 'taskFile' => 'CRM/common/searchResultTasks.tpl', | |
237 | 'taskContext' => NULL, | |
238 | 'resultFile' => 'CRM/Activity/Form/Selector.tpl', | |
239 | 'resultContext' => 'Search', | |
240 | 'taskClassName' => 'CRM_Activity_Task', | |
241 | 'component' => 'activity', | |
242 | ), | |
243 | CRM_Contact_BAO_Query::MODE_MEMBER => array( | |
244 | 'selectorName' => 'CRM_Member_Selector_Search', | |
245 | 'selectorLabel' => ts('Memberships'), | |
246 | 'taskFile' => "CRM/common/searchResultTasks.tpl", | |
247 | 'taskContext' => NULL, | |
248 | 'resultFile' => 'CRM/Member/Form/Selector.tpl', | |
249 | 'resultContext' => 'Search', | |
250 | 'taskClassName' => 'CRM_Member_Task', | |
251 | 'component' => 'CiviMember', | |
252 | ), | |
253 | CRM_Contact_BAO_Query::MODE_CASE => array( | |
254 | 'selectorName' => 'CRM_Case_Selector_Search', | |
255 | 'selectorLabel' => ts('Cases'), | |
256 | 'taskFile' => "CRM/common/searchResultTasks.tpl", | |
257 | 'taskContext' => NULL, | |
258 | 'resultFile' => 'CRM/Case/Form/Selector.tpl', | |
259 | 'resultContext' => 'Search', | |
260 | 'taskClassName' => 'CRM_Case_Task', | |
261 | 'component' => 'CiviCase', | |
262 | ), | |
263 | CRM_Contact_BAO_Query::MODE_CONTACTSRELATED => array( | |
264 | 'selectorName' => self::$_selectorName, | |
265 | 'selectorLabel' => ts('Related Contacts'), | |
266 | 'taskFile' => 'CRM/Contact/Form/Search/ResultTasks.tpl', | |
267 | 'taskContext' => NULL, | |
268 | 'resultFile' => 'CRM/Contact/Form/Selector.tpl', | |
269 | 'resultContext' => NULL, | |
270 | 'taskClassName' => 'CRM_Contact_Task', | |
271 | 'component' => 'related_contact', | |
272 | ), | |
273 | CRM_Contact_BAO_Query::MODE_MAILING => array( | |
274 | 'selectorName' => 'CRM_Mailing_Selector_Search', | |
275 | 'selectorLabel' => ts('Mailings'), | |
276 | 'taskFile' => "CRM/common/searchResultTasks.tpl", | |
277 | 'taskContext' => NULL, | |
278 | 'resultFile' => 'CRM/Mailing/Form/Selector.tpl', | |
279 | 'resultContext' => 'Search', | |
280 | 'taskClassName' => 'CRM_Mailing_Task', | |
281 | 'component' => 'CiviMail', | |
282 | ), | |
283 | ); | |
6a488035 TO |
284 | } |
285 | ||
86538308 | 286 | /** |
a6c6c64f JP |
287 | * Get the metadata for the query mode (this includes task class names) |
288 | * | |
86538308 EM |
289 | * @param int $mode |
290 | * | |
a6c6c64f JP |
291 | * @return array |
292 | * @throws \CRM_Core_Exception | |
86538308 | 293 | */ |
eda34f9b | 294 | public static function getModeValue($mode = CRM_Contact_BAO_Query::MODE_CONTACTS) { |
a6c6c64f JP |
295 | $searchPane = CRM_Utils_Request::retrieve('searchPane', 'String'); |
296 | if (!empty($searchPane)) { | |
297 | $mode = array_search($searchPane, self::getModeToComponentMapping()); | |
298 | } | |
6a488035 | 299 | |
a6c6c64f | 300 | self::setModeValues(); |
6a488035 | 301 | if (!array_key_exists($mode, self::$_modeValues)) { |
eda34f9b | 302 | $mode = CRM_Contact_BAO_Query::MODE_CONTACTS; |
6a488035 TO |
303 | } |
304 | ||
305 | return self::$_modeValues[$mode]; | |
306 | } | |
307 | ||
e30af20d | 308 | /** |
309 | * Get a mapping of modes to components. | |
310 | * | |
311 | * This will map the integers to the components. Contact has an empty component | |
312 | * an pseudo-components exist for activity & related_contact. | |
313 | * | |
314 | * @return array | |
315 | */ | |
316 | public static function getModeToComponentMapping() { | |
317 | $mapping = []; | |
318 | self::setModeValues(); | |
319 | ||
320 | foreach (self::$_modeValues as $id => $metadata) { | |
321 | $mapping[$id] = $metadata['component']; | |
322 | } | |
323 | return $mapping; | |
324 | } | |
325 | ||
86538308 EM |
326 | /** |
327 | * @return array | |
328 | */ | |
00be9182 | 329 | public static function getModeSelect() { |
6a488035 TO |
330 | self::setModeValues(); |
331 | ||
eda34f9b | 332 | $componentModes = array(); |
6a488035 | 333 | foreach (self::$_modeValues as $id => & $value) { |
eda34f9b | 334 | $componentModes[$id] = $value['selectorLabel']; |
6a488035 TO |
335 | } |
336 | ||
eda34f9b MW |
337 | $enabledComponents = CRM_Core_Component::getEnabledComponents(); |
338 | ||
339 | // unset disabled components | |
340 | if (!array_key_exists('CiviMail', $enabledComponents)) { | |
341 | unset($componentModes[CRM_Contact_BAO_Query::MODE_MAILING]); | |
342 | } | |
343 | ||
344 | // unset contributions or participants if user does not have permission on them | |
6a488035 | 345 | if (!CRM_Core_Permission::access('CiviContribute')) { |
eda34f9b | 346 | unset($componentModes[CRM_Contact_BAO_Query::MODE_CONTRIBUTE]); |
6a488035 TO |
347 | } |
348 | ||
349 | if (!CRM_Core_Permission::access('CiviEvent')) { | |
eda34f9b MW |
350 | unset($componentModes[CRM_Contact_BAO_Query::MODE_EVENT]); |
351 | } | |
352 | ||
353 | if (!CRM_Core_Permission::access('CiviMember')) { | |
354 | unset($componentModes[CRM_Contact_BAO_Query::MODE_MEMBER]); | |
6a488035 TO |
355 | } |
356 | ||
357 | if (!CRM_Core_Permission::check('view all activities')) { | |
eda34f9b | 358 | unset($componentModes[CRM_Contact_BAO_Query::MODE_ACTIVITY]); |
6a488035 | 359 | } |
eda34f9b MW |
360 | |
361 | return $componentModes; | |
6a488035 TO |
362 | } |
363 | ||
364 | /** | |
32795e82 | 365 | * Builds the list of tasks or actions that a searcher can perform on a result set. |
6a488035 | 366 | * |
32795e82 | 367 | * @return array |
6a488035 | 368 | */ |
e98a9804 | 369 | public function buildTaskList() { |
eda34f9b | 370 | // amtg = 'Add members to group' |
7a3978aa | 371 | if ($this->_context !== 'amtg') { |
eda34f9b MW |
372 | $taskParams['deletedContacts'] = FALSE; |
373 | if ($this->_componentMode == CRM_Contact_BAO_Query::MODE_CONTACTS || $this->_componentMode == CRM_Contact_BAO_Query::MODE_CONTACTSRELATED) { | |
374 | $taskParams['deletedContacts'] = CRM_Utils_Array::value('deleted_contacts', $this->_formValues); | |
7a3978aa | 375 | } |
eda34f9b MW |
376 | $className = $this->_modeValue['taskClassName']; |
377 | $taskParams['ssID'] = isset($this->_ssID) ? $this->_ssID : NULL; | |
378 | $this->_taskList += $className::permissionedTaskTitles(CRM_Core_Permission::getPermission(), $taskParams); | |
32795e82 FG |
379 | } |
380 | ||
7a3978aa | 381 | return $this->_taskList; |
32795e82 | 382 | } |
6a488035 | 383 | |
32795e82 FG |
384 | /** |
385 | * Build the common elements between the search/advanced form. | |
6a488035 | 386 | */ |
00be9182 | 387 | public function buildQuickForm() { |
3efb5b86 | 388 | parent::buildQuickForm(); |
8e4ec1f5 | 389 | CRM_Core_Resources::singleton() |
8e4ec1f5 CW |
390 | // jsTree is needed for tags popup |
391 | ->addScriptFile('civicrm', 'packages/jquery/plugins/jstree/jquery.jstree.js', 0, 'html-header', FALSE) | |
392 | ->addStyleFile('civicrm', 'packages/jquery/plugins/jstree/themes/default/style.css', 0, 'html-header'); | |
eda34f9b | 393 | |
6a488035 | 394 | // some tasks.. what do we want to do with the selected contacts ? |
eda34f9b | 395 | $this->_taskList = $this->buildTaskList(); |
6a488035 TO |
396 | |
397 | if (isset($this->_ssID)) { | |
79d7553f | 398 | $search_custom_id |
399 | = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $this->_ssID, 'search_custom_id'); | |
6a488035 TO |
400 | |
401 | $savedSearchValues = array( | |
402 | 'id' => $this->_ssID, | |
403 | 'name' => CRM_Contact_BAO_SavedSearch::getName($this->_ssID, 'title'), | |
404 | 'search_custom_id' => $search_custom_id, | |
405 | ); | |
406 | $this->assign_by_ref('savedSearch', $savedSearchValues); | |
407 | $this->assign('ssID', $this->_ssID); | |
408 | } | |
409 | ||
410 | if ($this->_context === 'smog') { | |
411 | // CRM-11788, we might want to do this for all of search where force=1 | |
412 | $formQFKey = CRM_Utils_Array::value('qfKey', $this->_formValues); | |
413 | $getQFKey = CRM_Utils_Array::value('qfKey', $_GET); | |
414 | $postQFKey = CRM_Utils_Array::value('qfKey', $_POST); | |
415 | if ($formQFKey && empty($getQFKey) && empty($postQFKey)) { | |
416 | $url = CRM_Utils_System::makeURL('qfKey') . $formQFKey; | |
417 | CRM_Utils_System::redirect($url); | |
418 | } | |
838d0ff6 | 419 | $permissionForGroup = FALSE; |
6a488035 TO |
420 | |
421 | if (!empty($this->_groupID)) { | |
6a488035 TO |
422 | // check if user has permission to edit members of this group |
423 | $permission = CRM_Contact_BAO_Group::checkPermission($this->_groupID); | |
424 | if ($permission && in_array(CRM_Core_Permission::EDIT, $permission)) { | |
425 | $permissionForGroup = TRUE; | |
426 | } | |
427 | ||
428 | // check if _groupID exists, it might not if | |
429 | // we are displaying a hidden group | |
430 | if (!isset($this->_group[$this->_groupID])) { | |
79d7553f | 431 | $this->_group[$this->_groupID] |
432 | = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $this->_groupID, 'title'); | |
6a488035 TO |
433 | } |
434 | ||
6a488035 TO |
435 | // set the group title |
436 | $groupValues = array('id' => $this->_groupID, 'title' => $this->_group[$this->_groupID]); | |
437 | $this->assign_by_ref('group', $groupValues); | |
438 | ||
439 | // also set ssID if this is a saved search | |
440 | $ssID = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $this->_groupID, 'saved_search_id'); | |
441 | $this->assign('ssID', $ssID); | |
442 | ||
443 | //get the saved search mapping id | |
444 | if ($ssID) { | |
445 | $this->_ssID = $ssID; | |
446 | $ssMappingId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $ssID, 'mapping_id'); | |
447 | $this->assign('ssMappingID', $ssMappingId); | |
448 | } | |
449 | ||
450 | // Set dynamic page title for 'Show Members of Group' | |
451 | CRM_Utils_System::setTitle(ts('Contacts in Group: %1', array(1 => $this->_group[$this->_groupID]))); | |
452 | } | |
453 | ||
454 | $group_contact_status = array(); | |
455 | foreach (CRM_Core_SelectValues::groupContactStatus() as $k => $v) { | |
456 | if (!empty($k)) { | |
457 | $group_contact_status[] = $this->createElement('checkbox', $k, NULL, $v); | |
458 | } | |
459 | } | |
460 | $this->addGroup($group_contact_status, | |
461 | 'group_contact_status', ts('Group Status') | |
462 | ); | |
463 | ||
838d0ff6 | 464 | $this->assign('permissionedForGroup', $permissionForGroup); |
6a488035 TO |
465 | } |
466 | ||
467 | // add the go button for the action form, note it is of type 'next' rather than of type 'submit' | |
468 | if ($this->_context === 'amtg') { | |
353ffa53 TO |
469 | // check if _groupID exists, it might not if |
470 | // we are displaying a hidden group | |
6a488035 TO |
471 | if (!isset($this->_group[$this->_amtgID])) { |
472 | $this->assign('permissionedForGroup', FALSE); | |
79d7553f | 473 | $this->_group[$this->_amtgID] |
474 | = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $this->_amtgID, 'title'); | |
6a488035 TO |
475 | } |
476 | ||
477 | // Set dynamic page title for 'Add Members Group' | |
478 | CRM_Utils_System::setTitle(ts('Add to Group: %1', array(1 => $this->_group[$this->_amtgID]))); | |
479 | // also set the group title and freeze the action task with Add Members to Group | |
480 | $groupValues = array('id' => $this->_amtgID, 'title' => $this->_group[$this->_amtgID]); | |
481 | $this->assign_by_ref('group', $groupValues); | |
482 | $this->add('submit', $this->_actionButtonName, ts('Add Contacts to %1', array(1 => $this->_group[$this->_amtgID])), | |
483 | array( | |
97e557d7 | 484 | 'class' => 'crm-form-submit', |
6a488035 TO |
485 | ) |
486 | ); | |
eda34f9b | 487 | $this->add('hidden', 'task', CRM_Contact_Task::GROUP_ADD); |
c2d91642 | 488 | $selectedRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked')); |
489 | $allRowsRadio = $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all'); | |
490 | $this->assign('ts_sel_id', $selectedRowsRadio->_attributes['id']); | |
491 | $this->assign('ts_all_id', $allRowsRadio->_attributes['id']); | |
6a488035 | 492 | } |
6a488035 | 493 | |
2ebb21f0 CW |
494 | $selectedContactIds = array(); |
495 | $qfKeyParam = CRM_Utils_Array::value('qfKey', $this->_formValues); | |
496 | // We use ajax to handle selections only if the search results component_mode is set to "contacts" | |
eda34f9b | 497 | if ($qfKeyParam && ($this->get('component_mode') <= CRM_Contact_BAO_Query::MODE_CONTACTS || $this->get('component_mode') == CRM_Contact_BAO_Query::MODE_CONTACTSRELATED)) { |
2ebb21f0 | 498 | $this->addClass('crm-ajax-selection-form'); |
6a488035 TO |
499 | $qfKeyParam = "civicrm search {$qfKeyParam}"; |
500 | $selectedContactIdsArr = CRM_Core_BAO_PrevNextCache::getSelection($qfKeyParam); | |
501 | $selectedContactIds = array_keys($selectedContactIdsArr[$qfKeyParam]); | |
502 | } | |
503 | ||
504 | $this->assign_by_ref('selectedContactIds', $selectedContactIds); | |
505 | ||
6a488035 TO |
506 | $rows = $this->get('rows'); |
507 | ||
508 | if (is_array($rows)) { | |
6e8d1c11 | 509 | $this->addRowSelectors($rows); |
6a488035 TO |
510 | } |
511 | ||
6a488035 TO |
512 | } |
513 | ||
514 | /** | |
fe482240 | 515 | * Processing needed for buildForm and later. |
6a488035 | 516 | */ |
00be9182 | 517 | public function preProcess() { |
6a488035 TO |
518 | // set the various class variables |
519 | ||
520 | $this->_group = CRM_Core_PseudoConstant::group(); | |
521 | ||
6a488035 TO |
522 | $this->_tag = CRM_Core_BAO_Tag::getTags(); |
523 | $this->_done = FALSE; | |
524 | ||
525 | /* | |
deb50ba3 CW |
526 | * we allow the controller to set force/reset externally, useful when we are being |
527 | * driven by the wizard framework | |
528 | */ | |
6a488035 | 529 | |
e8a0f9e0 | 530 | $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean'); |
6a488035 | 531 | |
e8a0f9e0 | 532 | $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean'); |
6a488035 TO |
533 | $this->_groupID = CRM_Utils_Request::retrieve('gid', 'Positive', $this); |
534 | $this->_amtgID = CRM_Utils_Request::retrieve('amtgID', 'Positive', $this); | |
535 | $this->_ssID = CRM_Utils_Request::retrieve('ssID', 'Positive', $this); | |
536 | $this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter', 'String', $this); | |
537 | $this->_ufGroupID = CRM_Utils_Request::retrieve('id', 'Positive', $this); | |
eda34f9b MW |
538 | $this->_componentMode = CRM_Utils_Request::retrieve('component_mode', 'Positive', $this, FALSE, CRM_Contact_BAO_Query::MODE_CONTACTS, $_REQUEST); |
539 | $this->_operator = CRM_Utils_Request::retrieve('operator', 'String', $this, FALSE, CRM_Contact_BAO_Query::SEARCH_OPERATOR_AND, 'REQUEST'); | |
6a488035 TO |
540 | |
541 | /** | |
542 | * set the button names | |
543 | */ | |
544 | $this->_searchButtonName = $this->getButtonName('refresh'); | |
6a488035 TO |
545 | $this->_actionButtonName = $this->getButtonName('next', 'action'); |
546 | ||
6a488035 TO |
547 | $this->assign('actionButtonName', $this->_actionButtonName); |
548 | ||
6a488035 TO |
549 | // if we dont get this from the url, use default if one exsts |
550 | $config = CRM_Core_Config::singleton(); | |
551 | if ($this->_ufGroupID == NULL && | |
552 | $config->defaultSearchProfileID != NULL | |
553 | ) { | |
554 | $this->_ufGroupID = $config->defaultSearchProfileID; | |
555 | } | |
556 | ||
557 | // assign context to drive the template display, make sure context is valid | |
558 | $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search'); | |
559 | if (!CRM_Utils_Array::value($this->_context, self::validContext())) { | |
560 | $this->_context = 'search'; | |
561 | } | |
562 | $this->set('context', $this->_context); | |
563 | $this->assign('context', $this->_context); | |
564 | ||
565 | $this->_modeValue = self::getModeValue($this->_componentMode); | |
566 | $this->assign($this->_modeValue); | |
567 | ||
568 | $this->set('selectorName', self::$_selectorName); | |
569 | ||
570 | // get user submitted values | |
571 | // get it from controller only if form has been submitted, else preProcess has set this | |
4eeb9a5b TO |
572 | // $this->controller->isModal( ) returns TRUE if page is |
573 | // valid, i.e all the validations are TRUE | |
6a488035 TO |
574 | |
575 | if (!empty($_POST) && !$this->controller->isModal()) { | |
576 | $this->_formValues = $this->controller->exportValues($this->_name); | |
577 | ||
578 | $this->normalizeFormValues(); | |
90c13aa2 | 579 | $this->_params = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields); |
6a488035 TO |
580 | $this->_returnProperties = &$this->returnProperties(); |
581 | ||
582 | // also get the uf group id directly from the post value | |
583 | $this->_ufGroupID = CRM_Utils_Array::value('uf_group_id', $_POST, $this->_ufGroupID); | |
584 | $this->_formValues['uf_group_id'] = $this->_ufGroupID; | |
585 | $this->set('id', $this->_ufGroupID); | |
586 | ||
587 | // also get the object mode directly from the post value | |
588 | $this->_componentMode = CRM_Utils_Array::value('component_mode', $_POST, $this->_componentMode); | |
589 | ||
590 | // also get the operator from the post value if set | |
591 | $this->_operator = CRM_Utils_Array::value('operator', $_POST, $this->_operator); | |
592 | $this->_formValues['operator'] = $this->_operator; | |
593 | $this->set('operator', $this->_operator); | |
594 | } | |
595 | else { | |
596 | $this->_formValues = $this->get('formValues'); | |
90c13aa2 | 597 | $this->_params = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, $this->entityReferenceFields); |
6a488035 TO |
598 | $this->_returnProperties = &$this->returnProperties(); |
599 | if (!empty($this->_ufGroupID)) { | |
600 | $this->set('id', $this->_ufGroupID); | |
601 | } | |
602 | } | |
603 | ||
604 | if (empty($this->_formValues)) { | |
605 | //check if group is a smart group (fix for CRM-1255) | |
606 | if ($this->_groupID) { | |
607 | if ($ssId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group', $this->_groupID, 'saved_search_id')) { | |
608 | $this->_ssID = $ssId; | |
609 | } | |
610 | } | |
611 | ||
612 | // fix for CRM-1907 | |
613 | if (isset($this->_ssID) && $this->_context != 'smog') { | |
614 | // we only retrieve the saved search values if out current values are null | |
615 | $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID); | |
616 | ||
617 | //fix for CRM-1505 | |
618 | if (CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $this->_ssID, 'mapping_id')) { | |
619 | $this->_params = CRM_Contact_BAO_SavedSearch::getSearchParams($this->_ssID); | |
620 | } | |
621 | else { | |
622 | $this->_params = CRM_Contact_BAO_Query::convertFormValues($this->_formValues); | |
623 | } | |
624 | $this->_returnProperties = &$this->returnProperties(); | |
625 | } | |
626 | else { | |
627 | if (isset($this->_ufGroupID)) { | |
628 | // also set the uf group id if not already present | |
629 | $this->_formValues['uf_group_id'] = $this->_ufGroupID; | |
630 | } | |
631 | if (isset($this->_componentMode)) { | |
632 | $this->_formValues['component_mode'] = $this->_componentMode; | |
633 | } | |
634 | if (isset($this->_operator)) { | |
635 | $this->_formValues['operator'] = $this->_operator; | |
636 | } | |
637 | ||
638 | // FIXME: we should generalise in a way that components could inject url-filters | |
639 | // just like they build their own form elements | |
640 | foreach (array( | |
353ffa53 TO |
641 | 'mailing_id', |
642 | 'mailing_delivery_status', | |
643 | 'mailing_open_status', | |
644 | 'mailing_click_status', | |
645 | 'mailing_reply_status', | |
646 | 'mailing_optout', | |
647 | 'mailing_forward', | |
648 | 'mailing_unsubscribe', | |
649 | 'mailing_date_low', | |
650 | 'mailing_date_high', | |
651 | ) as $mailingFilter) { | |
6a488035 TO |
652 | $type = 'String'; |
653 | if ($mailingFilter == 'mailing_id' && | |
654 | $filterVal = CRM_Utils_Request::retrieve('mailing_id', 'Positive', $this) | |
655 | ) { | |
656 | $this->_formValues[$mailingFilter] = array($filterVal); | |
657 | } | |
658 | elseif ($filterVal = CRM_Utils_Request::retrieve($mailingFilter, $type, $this)) { | |
659 | $this->_formValues[$mailingFilter] = $filterVal; | |
660 | } | |
661 | if ($filterVal) { | |
662 | $this->_openedPanes['Mailings'] = 1; | |
663 | $this->_formValues['hidden_CiviMail'] = 1; | |
664 | } | |
665 | } | |
666 | } | |
667 | } | |
668 | $this->assign('id', | |
669 | CRM_Utils_Array::value('uf_group_id', $this->_formValues) | |
670 | ); | |
eda34f9b | 671 | $operator = CRM_Utils_Array::value('operator', $this->_formValues, CRM_Contact_BAO_Query::SEARCH_OPERATOR_AND); |
6a488035 | 672 | $this->set('queryOperator', $operator); |
eda34f9b | 673 | if ($operator == CRM_Contact_BAO_Query::SEARCH_OPERATOR_OR) { |
6a488035 TO |
674 | $this->assign('operator', ts('OR')); |
675 | } | |
676 | else { | |
677 | $this->assign('operator', ts('AND')); | |
678 | } | |
679 | ||
680 | // show the context menu only when we’re not searching for deleted contacts; CRM-5673 | |
a7488080 | 681 | if (empty($this->_formValues['deleted_contacts'])) { |
6a488035 TO |
682 | $menuItems = CRM_Contact_BAO_Contact::contextMenu(); |
683 | $primaryActions = CRM_Utils_Array::value('primaryActions', $menuItems, array()); | |
684 | $this->_contextMenu = CRM_Utils_Array::value('moreActions', $menuItems, array()); | |
685 | $this->assign('contextMenu', $primaryActions + $this->_contextMenu); | |
686 | } | |
687 | ||
688 | if (!isset($this->_componentMode)) { | |
689 | $this->_componentMode = CRM_Contact_BAO_Query::MODE_CONTACTS; | |
690 | } | |
6a488035 | 691 | self::$_selectorName = $this->_modeValue['selectorName']; |
a6c6c64f | 692 | self::setModeValues(); |
6a488035 TO |
693 | |
694 | $setDynamic = FALSE; | |
695 | if (strpos(self::$_selectorName, 'CRM_Contact_Selector') !== FALSE) { | |
696 | $selector = new self::$_selectorName( | |
697 | $this->_customSearchClass, | |
698 | $this->_formValues, | |
699 | $this->_params, | |
700 | $this->_returnProperties, | |
701 | $this->_action, | |
ab8a593e | 702 | FALSE, TRUE, |
6a488035 TO |
703 | $this->_context, |
704 | $this->_contextMenu | |
705 | ); | |
706 | $setDynamic = TRUE; | |
707 | } | |
708 | else { | |
709 | $selector = new self::$_selectorName( | |
710 | $this->_params, | |
711 | $this->_action, | |
ab8a593e | 712 | NULL, FALSE, NULL, |
6a488035 TO |
713 | "search", "advanced" |
714 | ); | |
715 | } | |
716 | ||
717 | $selector->setKey($this->controller->_key); | |
718 | ||
719 | $controller = new CRM_Contact_Selector_Controller($selector, | |
720 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
721 | $this->get(CRM_Utils_Sort::SORT_ID), | |
722 | CRM_Core_Action::VIEW, | |
723 | $this, | |
724 | CRM_Core_Selector_Controller::TRANSFER | |
725 | ); | |
726 | $controller->setEmbedded(TRUE); | |
727 | $controller->setDynamicAction($setDynamic); | |
728 | ||
729 | if ($this->_force) { | |
730 | ||
731 | $this->postProcess(); | |
732 | ||
733 | /* | |
deb50ba3 CW |
734 | * Note that we repeat this, since the search creates and stores |
735 | * values that potentially change the controller behavior. i.e. things | |
736 | * like totalCount etc | |
737 | */ | |
6a488035 TO |
738 | $sortID = NULL; |
739 | if ($this->get(CRM_Utils_Sort::SORT_ID)) { | |
740 | $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID), | |
741 | $this->get(CRM_Utils_Sort::SORT_DIRECTION) | |
742 | ); | |
743 | } | |
744 | $controller = new CRM_Contact_Selector_Controller($selector, | |
745 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
746 | $sortID, | |
747 | CRM_Core_Action::VIEW, $this, CRM_Core_Selector_Controller::TRANSFER | |
748 | ); | |
749 | $controller->setEmbedded(TRUE); | |
750 | $controller->setDynamicAction($setDynamic); | |
751 | } | |
752 | ||
753 | $controller->moveFromSessionToTemplate(); | |
754 | } | |
755 | ||
86538308 EM |
756 | /** |
757 | * @return array | |
758 | */ | |
00be9182 | 759 | public function &getFormValues() { |
6a488035 TO |
760 | return $this->_formValues; |
761 | } | |
762 | ||
763 | /** | |
fe482240 | 764 | * Common post processing. |
6a488035 | 765 | */ |
00be9182 | 766 | public function postProcess() { |
6a488035 TO |
767 | /* |
768 | * sometime we do a postProcess early on, so we dont need to repeat it | |
769 | * this will most likely introduce some more bugs :( | |
770 | */ | |
771 | ||
772 | if ($this->_done) { | |
773 | return; | |
774 | } | |
775 | $this->_done = TRUE; | |
776 | ||
777 | //for prev/next pagination | |
a3d827a7 | 778 | $crmPID = CRM_Utils_Request::retrieve('crmPID', 'Integer'); |
6a488035 TO |
779 | |
780 | if (array_key_exists($this->_searchButtonName, $_POST) || | |
353ffa53 TO |
781 | ($this->_force && !$crmPID) |
782 | ) { | |
6a488035 TO |
783 | //reset the cache table for new search |
784 | $cacheKey = "civicrm search {$this->controller->_key}"; | |
785 | CRM_Core_BAO_PrevNextCache::deleteItem(NULL, $cacheKey); | |
786 | } | |
787 | ||
788 | //get the button name | |
789 | $buttonName = $this->controller->getButtonName(); | |
790 | ||
8cc574cf | 791 | if (isset($this->_ufGroupID) && empty($this->_formValues['uf_group_id'])) { |
6a488035 TO |
792 | $this->_formValues['uf_group_id'] = $this->_ufGroupID; |
793 | } | |
794 | ||
8cc574cf | 795 | if (isset($this->_componentMode) && empty($this->_formValues['component_mode'])) { |
6a488035 TO |
796 | $this->_formValues['component_mode'] = $this->_componentMode; |
797 | } | |
798 | ||
8cc574cf | 799 | if (isset($this->_operator) && empty($this->_formValues['operator'])) { |
6a488035 TO |
800 | $this->_formValues['operator'] = $this->_operator; |
801 | } | |
802 | ||
a7488080 | 803 | if (empty($this->_formValues['qfKey'])) { |
6a488035 TO |
804 | $this->_formValues['qfKey'] = $this->controller->_key; |
805 | } | |
806 | ||
807 | if (!CRM_Core_Permission::check('access deleted contacts')) { | |
808 | unset($this->_formValues['deleted_contacts']); | |
809 | } | |
810 | ||
811 | $this->set('type', $this->_action); | |
812 | $this->set('formValues', $this->_formValues); | |
813 | $this->set('queryParams', $this->_params); | |
814 | $this->set('returnProperties', $this->_returnProperties); | |
815 | ||
e341bbee | 816 | if ($buttonName == $this->_actionButtonName) { |
6a488035 TO |
817 | // check actionName and if next, then do not repeat a search, since we are going to the next page |
818 | // hack, make sure we reset the task values | |
819 | $stateMachine = $this->controller->getStateMachine(); | |
820 | $formName = $stateMachine->getTaskFormName(); | |
821 | $this->controller->resetPage($formName); | |
822 | return; | |
823 | } | |
824 | else { | |
825 | $output = CRM_Core_Selector_Controller::SESSION; | |
826 | ||
827 | // create the selector, controller and run - store results in session | |
828 | $searchChildGroups = TRUE; | |
829 | if ($this->get('isAdvanced')) { | |
830 | $searchChildGroups = FALSE; | |
831 | } | |
832 | ||
833 | $setDynamic = FALSE; | |
834 | ||
835 | if (strpos(self::$_selectorName, 'CRM_Contact_Selector') !== FALSE) { | |
79d7553f | 836 | $selector = new self::$_selectorName( |
6a488035 TO |
837 | $this->_customSearchClass, |
838 | $this->_formValues, | |
839 | $this->_params, | |
840 | $this->_returnProperties, | |
841 | $this->_action, | |
ab8a593e | 842 | FALSE, |
6a488035 TO |
843 | $searchChildGroups, |
844 | $this->_context, | |
845 | $this->_contextMenu | |
846 | ); | |
847 | $setDynamic = TRUE; | |
848 | } | |
849 | else { | |
d3e86119 | 850 | $selector = new self::$_selectorName( |
6a488035 TO |
851 | $this->_params, |
852 | $this->_action, | |
e60f24eb | 853 | NULL, |
ab8a593e | 854 | FALSE, |
e60f24eb | 855 | NULL, |
6a488035 TO |
856 | "search", |
857 | "advanced" | |
858 | ); | |
859 | } | |
860 | ||
861 | $selector->setKey($this->controller->_key); | |
862 | ||
863 | // added the sorting character to the form array | |
6a488035 TO |
864 | $config = CRM_Core_Config::singleton(); |
865 | // do this only for contact search | |
866 | if ($setDynamic && $config->includeAlphabeticalPager) { | |
e166ff79 CW |
867 | // Don't recompute if we are just paging/sorting |
868 | if ($this->_reset || (empty($_GET['crmPID']) && empty($_GET['crmSID']) && !$this->_sortByCharacter)) { | |
6a488035 TO |
869 | $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($selector, $this->_sortByCharacter); |
870 | $this->set('AToZBar', $aToZBar); | |
871 | } | |
872 | } | |
873 | ||
874 | $sortID = NULL; | |
875 | if ($this->get(CRM_Utils_Sort::SORT_ID)) { | |
876 | $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID), | |
877 | $this->get(CRM_Utils_Sort::SORT_DIRECTION) | |
878 | ); | |
879 | } | |
880 | $controller = new CRM_Contact_Selector_Controller($selector, | |
881 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
882 | $sortID, | |
883 | CRM_Core_Action::VIEW, | |
884 | $this, | |
885 | $output | |
886 | ); | |
887 | $controller->setEmbedded(TRUE); | |
888 | $controller->setDynamicAction($setDynamic); | |
889 | $controller->run(); | |
890 | } | |
891 | } | |
892 | ||
86538308 | 893 | /** |
e60f24eb | 894 | * @return NULL |
86538308 | 895 | */ |
00be9182 | 896 | public function &returnProperties() { |
6a488035 TO |
897 | return CRM_Core_DAO::$_nullObject; |
898 | } | |
899 | ||
900 | /** | |
901 | * Return a descriptive name for the page, used in wizard header | |
902 | * | |
903 | * @return string | |
6a488035 | 904 | */ |
00be9182 | 905 | public function getTitle() { |
6a488035 TO |
906 | return ts('Search'); |
907 | } | |
96025800 | 908 | |
6a488035 | 909 | } |