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