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