Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
c94d39fd | 11 | | under the terms of the GNU Affero General Public License | |
6a488035 TO |
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 | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Files required | |
38 | */ | |
39 | ||
40 | /** | |
41 | * advanced search, extends basic search | |
42 | */ | |
43 | class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search { | |
44 | ||
45 | /** | |
fe482240 | 46 | * Processing needed for buildForm and later. |
6a488035 TO |
47 | * |
48 | * @return void | |
6a488035 | 49 | */ |
00be9182 | 50 | public function preProcess() { |
6a488035 TO |
51 | $this->set('searchFormName', 'Advanced'); |
52 | ||
53 | parent::preProcess(); | |
54 | $openedPanes = CRM_Contact_BAO_Query::$_openedPanes; | |
55 | $openedPanes = array_merge($openedPanes, $this->_openedPanes); | |
56 | $this->assign('openedPanes', $openedPanes); | |
57 | } | |
58 | ||
59 | /** | |
fe482240 | 60 | * Build the form object. |
6a488035 | 61 | * |
6a488035 TO |
62 | * |
63 | * @return void | |
64 | */ | |
00be9182 | 65 | public function buildQuickForm() { |
6a488035 TO |
66 | $this->set('context', 'advanced'); |
67 | ||
68 | $this->_searchPane = CRM_Utils_Array::value('searchPane', $_GET); | |
69 | ||
70 | $this->_searchOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, | |
71 | 'advanced_search_options' | |
72 | ); | |
73 | ||
74 | if (!$this->_searchPane || $this->_searchPane == 'basic') { | |
75 | CRM_Contact_Form_Search_Criteria::basic($this); | |
76 | } | |
77 | ||
78 | $allPanes = array(); | |
79 | $paneNames = array( | |
80 | ts('Address Fields') => 'location', | |
81 | ts('Custom Fields') => 'custom', | |
82 | ts('Activities') => 'activity', | |
83 | ts('Relationships') => 'relationship', | |
84 | ts('Demographics') => 'demographics', | |
85 | ts('Notes') => 'notes', | |
86 | ts('Change Log') => 'changeLog', | |
87 | ); | |
88 | ||
89 | //check if there are any custom data searchable fields | |
90 | $groupDetails = array(); | |
91 | $extends = array_merge(array('Contact', 'Individual', 'Household', 'Organization'), | |
92 | CRM_Contact_BAO_ContactType::subTypes() | |
93 | ); | |
94 | $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, | |
95 | $extends | |
96 | ); | |
97 | // if no searchable fields unset panel | |
98 | if (empty($groupDetails)) { | |
99 | unset($paneNames[ts('Custom Fields')]); | |
100 | } | |
101 | ||
102 | foreach ($paneNames as $name => $type) { | |
103 | if (!$this->_searchOptions[$type]) { | |
104 | unset($paneNames[$name]); | |
105 | } | |
106 | } | |
107 | ||
108 | $components = CRM_Core_Component::getEnabledComponents(); | |
109 | ||
110 | $componentPanes = array(); | |
111 | foreach ($components as $name => $component) { | |
112 | if (in_array($name, array_keys($this->_searchOptions)) && | |
113 | $this->_searchOptions[$name] && | |
114 | CRM_Core_Permission::access($component->name) | |
115 | ) { | |
116 | $componentPanes[$name] = $component->registerAdvancedSearchPane(); | |
117 | $componentPanes[$name]['name'] = $name; | |
118 | } | |
119 | } | |
120 | ||
121 | usort($componentPanes, array('CRM_Utils_Sort', 'cmpFunc')); | |
122 | foreach ($componentPanes as $name => $pane) { | |
123 | // FIXME: we should change the use of $name here to keyword | |
124 | $paneNames[$pane['title']] = $pane['name']; | |
125 | } | |
126 | ||
efa3a566 DS |
127 | $hookPanes = array(); |
128 | CRM_Contact_BAO_Query_Hook::singleton()->registerAdvancedSearchPane($hookPanes); | |
129 | $paneNames = array_merge($paneNames, $hookPanes); | |
6a488035 | 130 | |
efa3a566 | 131 | $this->_paneTemplatePath = array(); |
6a488035 | 132 | foreach ($paneNames as $name => $type) { |
efa3a566 | 133 | if (!array_key_exists($type, $this->_searchOptions) && !in_array($type, $hookPanes)) { |
6a488035 TO |
134 | continue; |
135 | } | |
136 | ||
137 | $allPanes[$name] = array( | |
138 | 'url' => CRM_Utils_System::url('civicrm/contact/search/advanced', | |
139 | "snippet=1&searchPane=$type&qfKey={$this->controller->_key}" | |
140 | ), | |
141 | 'open' => 'false', | |
142 | 'id' => $type, | |
143 | ); | |
144 | ||
145 | // see if we need to include this paneName in the current form | |
8cc574cf | 146 | if ($this->_searchPane == $type || !empty($_POST["hidden_{$type}"]) || |
6a488035 TO |
147 | CRM_Utils_Array::value("hidden_{$type}", $this->_formValues) |
148 | ) { | |
149 | $allPanes[$name]['open'] = 'true'; | |
150 | ||
a7488080 | 151 | if (!empty($components[$type])) { |
6a488035 TO |
152 | $c = $components[$type]; |
153 | $this->add('hidden', "hidden_$type", 1); | |
154 | $c->buildAdvancedSearchPaneForm($this); | |
155 | $this->_paneTemplatePath[$type] = $c->getAdvancedSearchPaneTemplatePath(); | |
156 | } | |
4c9b6178 | 157 | elseif (in_array($type, $hookPanes)) { |
efa3a566 DS |
158 | CRM_Contact_BAO_Query_Hook::singleton()->buildAdvancedSearchPaneForm($this, $type); |
159 | CRM_Contact_BAO_Query_Hook::singleton()->setAdvancedSearchPaneTemplatePath($this->_paneTemplatePath, $type); | |
160 | } | |
6a488035 | 161 | else { |
0e6e8724 | 162 | CRM_Contact_Form_Search_Criteria::$type($this); |
6a488035 TO |
163 | $template = ucfirst($type); |
164 | $this->_paneTemplatePath[$type] = "CRM/Contact/Form/Search/Criteria/{$template}.tpl"; | |
165 | } | |
166 | } | |
167 | } | |
168 | ||
169 | $this->assign('allPanes', $allPanes); | |
170 | if (!$this->_searchPane) { | |
171 | parent::buildQuickForm(); | |
172 | } | |
173 | else { | |
174 | $this->assign('suppressForm', TRUE); | |
175 | } | |
176 | } | |
177 | ||
86538308 | 178 | /** |
fe482240 | 179 | * Use the form name to create the tpl file name. |
86538308 EM |
180 | * |
181 | * @return string | |
86538308 EM |
182 | */ |
183 | /** | |
184 | * @return string | |
185 | */ | |
00be9182 | 186 | public function getTemplateFileName() { |
6a488035 TO |
187 | if (!$this->_searchPane) { |
188 | return parent::getTemplateFileName(); | |
189 | } | |
190 | else { | |
191 | if (isset($this->_paneTemplatePath[$this->_searchPane])) { | |
192 | return $this->_paneTemplatePath[$this->_searchPane]; | |
193 | } | |
194 | else { | |
195 | $name = ucfirst($this->_searchPane); | |
196 | return "CRM/Contact/Form/Search/Criteria/{$name}.tpl"; | |
197 | } | |
198 | } | |
199 | } | |
200 | ||
201 | /** | |
fe482240 | 202 | * Set the default form values. |
6a488035 | 203 | * |
6a488035 | 204 | * |
a6c01b45 CW |
205 | * @return array |
206 | * the default array reference | |
6a488035 | 207 | */ |
00be9182 | 208 | public function setDefaultValues() { |
6a488035 TO |
209 | $defaults = $this->_formValues; |
210 | $this->normalizeDefaultValues($defaults); | |
211 | ||
212 | if ($this->_context === 'amtg') { | |
213 | $defaults['task'] = CRM_Contact_Task::GROUP_CONTACTS; | |
214 | } | |
6a488035 TO |
215 | |
216 | $defaults['privacy_toggle'] = 1; | |
6a3ff72a | 217 | $defaults['operator'] = 'AND'; |
6a488035 TO |
218 | |
219 | return $defaults; | |
220 | } | |
221 | ||
222 | /** | |
223 | * The post processing of the form gets done here. | |
224 | * | |
225 | * Key things done during post processing are | |
226 | * - check for reset or next request. if present, skip post procesing. | |
227 | * - now check if user requested running a saved search, if so, then | |
228 | * the form values associated with the saved search are used for searching. | |
229 | * - if user has done a submit with new values the regular post submissing is | |
230 | * done. | |
231 | * The processing consists of using a Selector / Controller framework for getting the | |
232 | * search results. | |
233 | * | |
234 | * @param | |
235 | * | |
236 | * @return void | |
6a488035 | 237 | */ |
00be9182 | 238 | public function postProcess() { |
6a488035 TO |
239 | $this->set('isAdvanced', '1'); |
240 | ||
241 | // get user submitted values | |
242 | // get it from controller only if form has been submitted, else preProcess has set this | |
243 | if (!empty($_POST)) { | |
244 | $this->_formValues = $this->controller->exportValues($this->_name); | |
245 | $this->normalizeFormValues(); | |
246 | // FIXME: couldn't figure out a good place to do this, | |
247 | // FIXME: so leaving this as a dependency for now | |
248 | if (array_key_exists('contribution_amount_low', $this->_formValues)) { | |
249 | foreach (array( | |
353ffa53 | 250 | 'contribution_amount_low', |
af9b09df | 251 | 'contribution_amount_high', |
353ffa53 | 252 | ) as $f) { |
6a488035 TO |
253 | $this->_formValues[$f] = CRM_Utils_Rule::cleanMoney($this->_formValues[$f]); |
254 | } | |
255 | } | |
256 | ||
257 | // set the group if group is submitted | |
81aa6678 | 258 | if (!empty($this->_formValues['uf_group_id'])) { |
6a488035 TO |
259 | $this->set('id', $this->_formValues['uf_group_id']); |
260 | } | |
261 | else { | |
262 | $this->set('id', ''); | |
263 | } | |
264 | } | |
265 | ||
266 | // retrieve ssID values only if formValues is null, i.e. form has never been posted | |
267 | if (empty($this->_formValues) && isset($this->_ssID)) { | |
268 | $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID); | |
269 | } | |
270 | ||
8cc574cf | 271 | if (isset($this->_groupID) && empty($this->_formValues['group'])) { |
6a488035 TO |
272 | $this->_formValues['group'] = array($this->_groupID => 1); |
273 | } | |
274 | ||
6a488035 TO |
275 | //search for civicase |
276 | if (is_array($this->_formValues)) { | |
277 | $allCases = FALSE; | |
278 | if (array_key_exists('case_owner', $this->_formValues) && | |
279 | !$this->_formValues['case_owner'] && | |
280 | !$this->_force | |
281 | ) { | |
282 | foreach (array( | |
353ffa53 TO |
283 | 'case_type_id', |
284 | 'case_status_id', | |
285 | 'case_deleted', | |
af9b09df | 286 | 'case_tags', |
353ffa53 | 287 | ) as $caseCriteria) { |
a7488080 | 288 | if (!empty($this->_formValues[$caseCriteria])) { |
6a488035 TO |
289 | $allCases = TRUE; |
290 | $this->_formValues['case_owner'] = 1; | |
291 | continue; | |
292 | } | |
293 | } | |
294 | if ($allCases) { | |
295 | if (CRM_Core_Permission::check('access all cases and activities')) { | |
296 | $this->_formValues['case_owner'] = 1; | |
297 | } | |
298 | else { | |
299 | $this->_formValues['case_owner'] = 2; | |
300 | } | |
301 | } | |
302 | else { | |
303 | $this->_formValues['case_owner'] = 0; | |
304 | } | |
305 | } | |
d8f7f92c RK |
306 | if (array_key_exists('case_owner', $this->_formValues) && empty($this->_formValues['case_deleted'])) { |
307 | $this->_formValues['case_deleted'] = 0; | |
308 | } | |
6a488035 TO |
309 | } |
310 | ||
311 | // we dont want to store the sortByCharacter in the formValue, it is more like | |
312 | // a filter on the result set | |
313 | // this filter is reset if we click on the search button | |
e166ff79 | 314 | if ($this->_sortByCharacter !== NULL && empty($_POST)) { |
6a488035 TO |
315 | if (strtolower($this->_sortByCharacter) == 'all') { |
316 | $this->_formValues['sortByCharacter'] = NULL; | |
317 | } | |
318 | else { | |
319 | $this->_formValues['sortByCharacter'] = $this->_sortByCharacter; | |
320 | } | |
321 | } | |
e166ff79 CW |
322 | else { |
323 | $this->_sortByCharacter = NULL; | |
324 | } | |
6a488035 | 325 | |
c94d39fd | 326 | CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues); |
6a488035 TO |
327 | |
328 | $this->_params = CRM_Contact_BAO_Query::convertFormValues($this->_formValues); | |
329 | $this->_returnProperties = &$this->returnProperties(); | |
330 | parent::postProcess(); | |
331 | } | |
332 | ||
333 | /** | |
100fef9d | 334 | * Normalize the form values to make it look similar to the advanced form values |
6a488035 TO |
335 | * this prevents a ton of work downstream and allows us to use the same code for |
336 | * multiple purposes (queries, save/edit etc) | |
337 | * | |
338 | * @return void | |
6a488035 | 339 | */ |
00be9182 | 340 | public function normalizeFormValues() { |
6a488035 TO |
341 | $contactType = CRM_Utils_Array::value('contact_type', $this->_formValues); |
342 | ||
343 | if ($contactType && is_array($contactType)) { | |
344 | unset($this->_formValues['contact_type']); | |
345 | foreach ($contactType as $key => $value) { | |
346 | $this->_formValues['contact_type'][$value] = 1; | |
347 | } | |
348 | } | |
349 | ||
350 | $config = CRM_Core_Config::singleton(); | |
351 | $group = CRM_Utils_Array::value('group', $this->_formValues); | |
352 | if ($group && is_array($group)) { | |
353 | unset($this->_formValues['group']); | |
354 | foreach ($group as $key => $value) { | |
355 | $this->_formValues['group'][$value] = 1; | |
356 | } | |
357 | } | |
358 | ||
359 | $tag = CRM_Utils_Array::value('contact_tags', $this->_formValues); | |
360 | if ($tag && is_array($tag)) { | |
361 | unset($this->_formValues['contact_tags']); | |
362 | foreach ($tag as $key => $value) { | |
363 | $this->_formValues['contact_tags'][$value] = 1; | |
364 | } | |
365 | } | |
86538308 | 366 | |
afa0b07c | 367 | $specialParams = array( |
368 | 'financial_type_id', | |
369 | 'contribution_soft_credit_type_id', | |
370 | 'contribution_status', | |
fb11d707 | 371 | 'contribution_status_id', |
afa0b07c | 372 | 'contribution_source', |
994bde4e SB |
373 | 'membership_type_id', |
374 | 'membership_status_id', | |
375 | 'participant_status_id', | |
afa0b07c | 376 | 'contribution_trxn_id', |
377 | 'activity_type_id', | |
378 | 'status_id', | |
379 | 'activity_subject', | |
afa0b07c | 380 | ); |
381 | foreach ($specialParams as $element) { | |
3c151c70 | 382 | $value = CRM_Utils_Array::value($element, $this->_formValues); |
9ab34172 | 383 | if ($value) { |
384 | if (is_array($value)) { | |
385 | if ($element == 'status_id') { | |
386 | unset($this->_formValues[$element]); | |
387 | $element = 'activity_' . $element; | |
388 | } | |
389 | $this->_formValues[$element] = array('IN' => $value); | |
390 | } | |
391 | else { | |
392 | $this->_formValues[$element] = array('LIKE' => "%$value%"); | |
393 | } | |
1f0d8c92 PN |
394 | } |
395 | } | |
86538308 | 396 | |
6a488035 TO |
397 | $taglist = CRM_Utils_Array::value('contact_taglist', $this->_formValues); |
398 | ||
399 | if ($taglist && is_array($taglist)) { | |
400 | unset($this->_formValues['contact_taglist']); | |
401 | foreach ($taglist as $value) { | |
402 | if ($value) { | |
403 | $value = explode(',', $value); | |
404 | foreach ($value as $tId) { | |
405 | if (is_numeric($tId)) { | |
406 | $this->_formValues['contact_tags'][$tId] = 1; | |
407 | } | |
408 | } | |
409 | } | |
410 | } | |
411 | } | |
6a488035 TO |
412 | } |
413 | ||
414 | /** | |
fe482240 | 415 | * Normalize default values for multiselect plugins. |
6a488035 | 416 | * |
5a4f6742 | 417 | * @param array $defaults |
f4bff68a | 418 | * @return array |
6a488035 | 419 | */ |
00be9182 | 420 | public function normalizeDefaultValues(&$defaults) { |
6a488035 TO |
421 | if (!is_array($defaults)) { |
422 | $defaults = array(); | |
423 | } | |
424 | ||
425 | if ($this->_ssID && empty($_POST)) { | |
c94d39fd | 426 | $specialFields = array('contact_type', 'group', 'contact_tags'); |
6a488035 | 427 | |
c94d39fd | 428 | foreach ($defaults as $element => $value) { |
429 | if (!empty($value) && is_array($value)) { | |
430 | if (in_array($element, $specialFields)) { | |
431 | $defaults[$element] = array_keys($value); | |
432 | } | |
433 | // As per the OK (Operator as Key) value format, value array may contain key | |
434 | // as an operator so to ensure the default is always set actual value | |
435 | elseif (in_array(key($value), CRM_Core_DAO::acceptedSQLOperators(), TRUE)) { | |
436 | $defaults[$element] = CRM_Utils_Array::value(key($value), $value); | |
437 | if (is_string($defaults[$element])) { | |
438 | $defaults[$element] = str_replace("%", '', $defaults[$element]); | |
439 | } | |
440 | } | |
6a488035 TO |
441 | } |
442 | } | |
443 | } | |
444 | return $defaults; | |
445 | } | |
96025800 | 446 | |
6a488035 | 447 | } |