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