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$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Files required | |
38 | */ | |
39 | ||
40 | /** | |
41 | * advanced search, extends basic search | |
42 | */ | |
3efb5b86 | 43 | class CRM_Contribute_Form_Search extends CRM_Core_Form_Search { |
6a488035 | 44 | |
6a488035 | 45 | /** |
100fef9d | 46 | * The params that are sent to the query |
6a488035 TO |
47 | * |
48 | * @var array | |
6a488035 TO |
49 | */ |
50 | protected $_queryParams; | |
51 | ||
6a488035 | 52 | /** |
100fef9d | 53 | * Are we restricting ourselves to a single contact |
6a488035 | 54 | * |
6a488035 TO |
55 | * @var boolean |
56 | */ | |
57 | protected $_single = FALSE; | |
58 | ||
59 | /** | |
100fef9d | 60 | * Are we restricting ourselves to a single contact |
6a488035 | 61 | * |
6a488035 TO |
62 | * @var boolean |
63 | */ | |
64 | protected $_limit = NULL; | |
65 | ||
6a488035 TO |
66 | protected $_defaults; |
67 | ||
68 | /** | |
100fef9d | 69 | * Prefix for the controller |
6a488035 TO |
70 | */ |
71 | protected $_prefix = "contribute_"; | |
72 | ||
73 | /** | |
100fef9d | 74 | * Processing needed for buildForm and later |
6a488035 TO |
75 | * |
76 | * @return void | |
95ea96be EM |
77 | */ |
78 | function preProcess() { | |
6a488035 TO |
79 | $this->set('searchFormName', 'Search'); |
80 | ||
81 | /** | |
82 | * set the button names | |
83 | */ | |
84 | $this->_searchButtonName = $this->getButtonName('refresh'); | |
6a488035 TO |
85 | $this->_actionButtonName = $this->getButtonName('next', 'action'); |
86 | ||
87 | $this->_done = FALSE; | |
88 | $this->defaults = array(); | |
89 | ||
90 | /* | |
91 | * we allow the controller to set force/reset externally, useful when we are being | |
92 | * driven by the wizard framework | |
93 | */ | |
ed106721 | 94 | |
353ffa53 TO |
95 | $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject); |
96 | $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE); | |
97 | $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this); | |
6a488035 TO |
98 | $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search'); |
99 | ||
100 | $this->assign("context", $this->_context); | |
101 | ||
102 | // get user submitted values | |
103 | // get it from controller only if form has been submitted, else preProcess has set this | |
104 | if (!empty($_POST)) { | |
105 | $this->_formValues = $this->controller->exportValues($this->_name); | |
106 | } | |
107 | else { | |
108 | $this->_formValues = $this->get('formValues'); | |
109 | } | |
110 | ||
111 | //membership ID | |
112 | $memberShipId = CRM_Utils_Request::retrieve('memberId', 'Positive', $this); | |
113 | if (isset($memberShipId)) { | |
114 | $this->_formValues['contribution_membership_id'] = $memberShipId; | |
115 | } | |
116 | $participantId = CRM_Utils_Request::retrieve('participantId', 'Positive', $this); | |
117 | if (isset($participantId)) { | |
118 | $this->_formValues['contribution_participant_id'] = $participantId; | |
119 | } | |
120 | ||
121 | if ($this->_force) { | |
122 | $this->postProcess(); | |
123 | $this->set('force', 0); | |
124 | } | |
125 | ||
126 | $sortID = NULL; | |
127 | if ($this->get(CRM_Utils_Sort::SORT_ID)) { | |
128 | $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID), | |
129 | $this->get(CRM_Utils_Sort::SORT_DIRECTION) | |
130 | ); | |
131 | } | |
132 | ||
3c151c70 | 133 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 1); |
6a488035 TO |
134 | $selector = new CRM_Contribute_Selector_Search($this->_queryParams, |
135 | $this->_action, | |
136 | NULL, | |
137 | $this->_single, | |
138 | $this->_limit, | |
139 | $this->_context | |
140 | ); | |
141 | $prefix = NULL; | |
142 | if ($this->_context == 'user') { | |
143 | $prefix = $this->_prefix; | |
144 | } | |
145 | ||
146 | $this->assign("{$prefix}limit", $this->_limit); | |
147 | $this->assign("{$prefix}single", $this->_single); | |
148 | ||
149 | $controller = new CRM_Core_Selector_Controller($selector, | |
150 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
151 | $sortID, | |
152 | CRM_Core_Action::VIEW, | |
153 | $this, | |
154 | CRM_Core_Selector_Controller::TRANSFER, | |
155 | $prefix | |
156 | ); | |
157 | ||
158 | $controller->setEmbedded(TRUE); | |
159 | $controller->moveFromSessionToTemplate(); | |
160 | ||
161 | $this->assign('contributionSummary', $this->get('summary')); | |
162 | } | |
163 | ||
00be9182 | 164 | public function setDefaultValues() { |
874c9be7 | 165 | if (empty($this->_defaults['contribution_status'])) { |
6a488035 TO |
166 | $this->_defaults['contribution_status'][1] = 1; |
167 | } | |
168 | return $this->_defaults; | |
169 | } | |
170 | ||
171 | /** | |
c490a46a | 172 | * Build the form object |
6a488035 | 173 | * |
6a488035 TO |
174 | * |
175 | * @return void | |
176 | */ | |
00be9182 | 177 | public function buildQuickForm() { |
3efb5b86 | 178 | parent::buildQuickForm(); |
6a488035 TO |
179 | // text for sort_name |
180 | $this->addElement('text', | |
181 | 'sort_name', | |
182 | ts('Contributor Name or Email'), | |
183 | CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', | |
184 | 'sort_name' | |
185 | ) | |
186 | ); | |
187 | ||
24431f7b | 188 | $this->_group = CRM_Core_PseudoConstant::nestedGroup(); |
6a488035 TO |
189 | |
190 | // multiselect for groups | |
191 | if ($this->_group) { | |
192 | $this->add('select', 'group', ts('Groups'), $this->_group, FALSE, | |
ab345ca5 | 193 | array('id' => 'group', 'multiple' => 'multiple', 'class' => 'crm-select2') |
6a488035 TO |
194 | ); |
195 | } | |
196 | ||
197 | // multiselect for tags | |
6a488035 TO |
198 | $contactTags = CRM_Core_BAO_Tag::getTags(); |
199 | ||
200 | if ($contactTags) { | |
201 | $this->add('select', 'contact_tags', ts('Tags'), $contactTags, FALSE, | |
ab345ca5 | 202 | array('id' => 'contact_tags', 'multiple' => 'multiple', 'class' => 'crm-select2') |
6a488035 TO |
203 | ); |
204 | } | |
205 | ||
206 | CRM_Contribute_BAO_Query::buildSearchForm($this); | |
207 | ||
6a488035 TO |
208 | $rows = $this->get('rows'); |
209 | if (is_array($rows)) { | |
210 | if (!$this->_single) { | |
8d36b801 | 211 | $this->addRowSelectors($rows); |
6a488035 TO |
212 | } |
213 | ||
6a488035 TO |
214 | $permission = CRM_Core_Permission::getPermission(); |
215 | ||
c410490a DS |
216 | $queryParams = $this->get('queryParams'); |
217 | $softCreditFiltering = FALSE; | |
218 | if (!empty($queryParams)) { | |
219 | $softCreditFiltering = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams); | |
220 | } | |
34197a55 CW |
221 | $tasks = CRM_Contribute_Task::permissionedTaskTitles($permission, $softCreditFiltering); |
222 | $this->addTaskMenu($tasks); | |
6a488035 TO |
223 | } |
224 | ||
6a488035 TO |
225 | } |
226 | ||
227 | /** | |
228 | * The post processing of the form gets done here. | |
229 | * | |
230 | * Key things done during post processing are | |
231 | * - check for reset or next request. if present, skip post procesing. | |
232 | * - now check if user requested running a saved search, if so, then | |
233 | * the form values associated with the saved search are used for searching. | |
234 | * - if user has done a submit with new values the regular post submissing is | |
235 | * done. | |
236 | * The processing consists of using a Selector / Controller framework for getting the | |
237 | * search results. | |
238 | * | |
239 | * @param | |
240 | * | |
241 | * @return void | |
6a488035 | 242 | */ |
00be9182 | 243 | public function postProcess() { |
6a488035 TO |
244 | if ($this->_done) { |
245 | return; | |
246 | } | |
247 | ||
248 | $this->_done = TRUE; | |
249 | ||
250 | if (!empty($_POST)) { | |
251 | $this->_formValues = $this->controller->exportValues($this->_name); | |
252 | } | |
253 | ||
254 | $this->fixFormValues(); | |
255 | ||
d43b88cc | 256 | // We don't show test records in summaries or dashboards |
b899db8f | 257 | if (empty($this->_formValues['contribution_test']) && $this->_force && !empty($this->_context) && $this->_context == 'dashboard') { |
6a488035 TO |
258 | $this->_formValues["contribution_test"] = 0; |
259 | } | |
260 | ||
261 | foreach (array( | |
353ffa53 TO |
262 | 'contribution_amount_low', |
263 | 'contribution_amount_high' | |
264 | ) as $f) { | |
6a488035 TO |
265 | if (isset($this->_formValues[$f])) { |
266 | $this->_formValues[$f] = CRM_Utils_Rule::cleanMoney($this->_formValues[$f]); | |
267 | } | |
268 | } | |
ed106721 | 269 | |
6a488035 | 270 | $config = CRM_Core_Config::singleton(); |
a2be2b19 | 271 | if (!empty($_POST)) { |
afa0b07c | 272 | $specialParams = array( |
273 | 'financial_type_id', | |
274 | 'contribution_soft_credit_type_id', | |
275 | 'contribution_status_id', | |
276 | 'contribution_source', | |
277 | 'contribution_trxn_id' | |
278 | ); | |
279 | foreach ($specialParams as $element) { | |
3c151c70 | 280 | $value = CRM_Utils_Array::value($element, $this->_formValues); |
281 | if ($value) { | |
9ab34172 | 282 | if (is_array($value)) { |
283 | $this->_formValues[$element] = array('IN' => $value); | |
284 | } | |
e51b7372 | 285 | else { |
286 | $this->_formValues[$element] = array('LIKE' => "%$value%"); | |
287 | } | |
a2be2b19 | 288 | } |
1f0d8c92 | 289 | } |
1f0d8c92 | 290 | |
a2be2b19 PN |
291 | $tags = CRM_Utils_Array::value('contact_tags', $this->_formValues); |
292 | if ($tags && !is_array($tags)) { | |
293 | unset($this->_formValues['contact_tags']); | |
294 | $this->_formValues['contact_tags'][$tags] = 1; | |
295 | } | |
ed106721 | 296 | |
a2be2b19 PN |
297 | if ($tags && is_array($tags)) { |
298 | unset($this->_formValues['contact_tags']); | |
22e263ad | 299 | foreach ($tags as $notImportant => $tagID) { |
a2be2b19 PN |
300 | $this->_formValues['contact_tags'][$tagID] = 1; |
301 | } | |
6a488035 | 302 | } |
ed106721 | 303 | |
a2be2b19 PN |
304 | if (!$config->groupTree) { |
305 | $group = CRM_Utils_Array::value('group', $this->_formValues); | |
306 | if ($group && !is_array($group)) { | |
307 | unset($this->_formValues['group']); | |
308 | $this->_formValues['group'][$group] = 1; | |
309 | } | |
ed106721 | 310 | |
a2be2b19 PN |
311 | if ($group && is_array($group)) { |
312 | unset($this->_formValues['group']); | |
22e263ad | 313 | foreach ($group as $notImportant => $groupID) { |
a2be2b19 PN |
314 | $this->_formValues['group'][$groupID] = 1; |
315 | } | |
6a488035 TO |
316 | } |
317 | } | |
6a488035 TO |
318 | } |
319 | ||
320 | CRM_Core_BAO_CustomValue::fixFieldValueOfTypeMemo($this->_formValues); | |
321 | ||
322 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues); | |
323 | ||
324 | $this->set('formValues', $this->_formValues); | |
325 | $this->set('queryParams', $this->_queryParams); | |
326 | ||
327 | $buttonName = $this->controller->getButtonName(); | |
e341bbee | 328 | if ($buttonName == $this->_actionButtonName) { |
6a488035 TO |
329 | // check actionName and if next, then do not repeat a search, since we are going to the next page |
330 | ||
331 | // hack, make sure we reset the task values | |
ed106721 | 332 | $stateMachine = $this->controller->getStateMachine(); |
6a488035 TO |
333 | $formName = $stateMachine->getTaskFormName(); |
334 | $this->controller->resetPage($formName); | |
335 | return; | |
336 | } | |
337 | ||
6a488035 TO |
338 | $sortID = NULL; |
339 | if ($this->get(CRM_Utils_Sort::SORT_ID)) { | |
340 | $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID), | |
341 | $this->get(CRM_Utils_Sort::SORT_DIRECTION) | |
342 | ); | |
343 | } | |
344 | ||
345 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues); | |
346 | $selector = new CRM_Contribute_Selector_Search($this->_queryParams, | |
347 | $this->_action, | |
348 | NULL, | |
349 | $this->_single, | |
350 | $this->_limit, | |
351 | $this->_context | |
352 | ); | |
353 | $selector->setKey($this->controller->_key); | |
354 | ||
355 | $prefix = NULL; | |
356 | if ($this->_context == 'basic' || $this->_context == 'user') { | |
357 | $prefix = $this->_prefix; | |
358 | } | |
359 | ||
360 | $controller = new CRM_Core_Selector_Controller($selector, | |
361 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
362 | $sortID, | |
363 | CRM_Core_Action::VIEW, | |
364 | $this, | |
365 | CRM_Core_Selector_Controller::SESSION, | |
366 | $prefix | |
367 | ); | |
368 | $controller->setEmbedded(TRUE); | |
369 | ||
370 | $query = &$selector->getQuery(); | |
371 | if ($this->_context == 'user') { | |
372 | $query->setSkipPermission(TRUE); | |
373 | } | |
374 | $summary = &$query->summaryContribution($this->_context); | |
375 | $this->set('summary', $summary); | |
376 | $this->assign('contributionSummary', $summary); | |
377 | $controller->run(); | |
378 | } | |
379 | ||
00be9182 | 380 | public function fixFormValues() { |
6a488035 TO |
381 | // if this search has been forced |
382 | // then see if there are any get values, and if so over-ride the post values | |
383 | // note that this means that GET over-rides POST :) | |
6a488035 TO |
384 | if (!$this->_force) { |
385 | return; | |
386 | } | |
387 | ||
388 | $status = CRM_Utils_Request::retrieve('status', 'String', | |
389 | CRM_Core_DAO::$_nullObject | |
390 | ); | |
391 | if ($status) { | |
392 | $this->_formValues['contribution_status_id'] = array($status => 1); | |
393 | $this->_defaults['contribution_status_id'] = array($status => 1); | |
394 | } | |
395 | ||
396 | $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this); | |
397 | ||
398 | if ($cid) { | |
399 | $cid = CRM_Utils_Type::escape($cid, 'Integer'); | |
400 | if ($cid > 0) { | |
401 | $this->_formValues['contact_id'] = $cid; | |
402 | list($display, $image) = CRM_Contact_BAO_Contact::getDisplayAndImage($cid); | |
403 | $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, | |
404 | 'sort_name' | |
405 | ); | |
406 | // also assign individual mode to the template | |
407 | $this->_single = TRUE; | |
408 | } | |
409 | } | |
410 | ||
411 | $lowDate = CRM_Utils_Request::retrieve('start', 'Timestamp', | |
412 | CRM_Core_DAO::$_nullObject | |
413 | ); | |
414 | if ($lowDate) { | |
415 | $lowDate = CRM_Utils_Type::escape($lowDate, 'Timestamp'); | |
416 | $date = CRM_Utils_Date::setDateDefaults($lowDate); | |
417 | $this->_formValues['contribution_date_low'] = $this->_defaults['contribution_date_low'] = $date[0]; | |
418 | } | |
419 | ||
420 | $highDate = CRM_Utils_Request::retrieve('end', 'Timestamp', | |
421 | CRM_Core_DAO::$_nullObject | |
422 | ); | |
423 | if ($highDate) { | |
424 | $highDate = CRM_Utils_Type::escape($highDate, 'Timestamp'); | |
425 | $date = CRM_Utils_Date::setDateDefaults($highDate); | |
426 | $this->_formValues['contribution_date_high'] = $this->_defaults['contribution_date_high'] = $date[0]; | |
427 | } | |
428 | ||
429 | if ($highDate || $lowDate) { | |
430 | //set the Choose Date Range value | |
431 | $this->_formValues['contribution_date_relative'] = 0; | |
432 | } | |
433 | ||
434 | $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', | |
435 | $this | |
436 | ); | |
437 | ||
438 | $test = CRM_Utils_Request::retrieve('test', 'Boolean', | |
439 | CRM_Core_DAO::$_nullObject | |
440 | ); | |
441 | if (isset($test)) { | |
442 | $test = CRM_Utils_Type::escape($test, 'Boolean'); | |
443 | $this->_formValues['contribution_test'] = $test; | |
444 | } | |
445 | //Recurring id | |
446 | $recur = CRM_Utils_Request::retrieve('recur', 'Positive', $this, FALSE); | |
447 | if ($recur) { | |
448 | $this->_formValues['contribution_recur_id'] = $recur; | |
449 | $this->_formValues['contribution_recurring'] = 1; | |
450 | } | |
451 | ||
452 | //check for contribution page id. | |
453 | $contribPageId = CRM_Utils_Request::retrieve('pid', 'Positive', $this); | |
454 | if ($contribPageId) { | |
455 | $this->_formValues['contribution_page_id'] = $contribPageId; | |
456 | } | |
457 | ||
458 | //give values to default. | |
459 | $this->_defaults = $this->_formValues; | |
460 | } | |
461 | ||
462 | /** | |
463 | * Return a descriptive name for the page, used in wizard header | |
464 | * | |
465 | * @return string | |
6a488035 TO |
466 | */ |
467 | public function getTitle() { | |
468 | return ts('Find Contributions'); | |
469 | } | |
470 | } |