3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2020
35 * Advanced search, extends basic search.
37 class CRM_Contribute_Form_Search
extends CRM_Core_Form_Search
{
40 * The params that are sent to the query.
44 protected $_queryParams;
47 * Are we restricting ourselves to a single contact.
51 protected $_single = FALSE;
54 * Are we restricting ourselves to a single contact.
58 protected $_limit = NULL;
61 * Prefix for the controller.
64 protected $_prefix = "contribute_";
67 * Explicitly declare the entity api name.
69 public function getDefaultEntity() {
70 return 'Contribution';
74 * Processing needed for buildForm and later.
76 * @throws \CiviCRM_API3_Exception
77 * @throws \CRM_Core_Exception
79 public function preProcess() {
80 $this->set('searchFormName', 'Search');
82 $this->_searchButtonName
= $this->getButtonName('refresh');
83 $this->_actionButtonName
= $this->getButtonName('next', 'action');
90 $memberShipId = CRM_Utils_Request
::retrieve('memberId', 'Positive', $this);
91 if (isset($memberShipId)) {
92 $this->_formValues
['contribution_membership_id'] = $memberShipId;
94 $participantId = CRM_Utils_Request
::retrieve('participantId', 'Positive', $this);
95 if (isset($participantId)) {
96 $this->_formValues
['contribution_participant_id'] = $participantId;
99 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
100 $selector = new CRM_Contribute_Selector_Search($this->_queryParams
,
108 if ($this->_context
== 'user') {
109 $prefix = $this->_prefix
;
112 $this->assign("{$prefix}limit", $this->_limit
);
113 $this->assign("{$prefix}single", $this->_single
);
115 $controller = new CRM_Core_Selector_Controller($selector,
116 $this->get(CRM_Utils_Pager
::PAGE_ID
),
118 CRM_Core_Action
::VIEW
,
120 CRM_Core_Selector_Controller
::TRANSFER
,
124 $controller->setEmbedded(TRUE);
125 $controller->moveFromSessionToTemplate();
127 $this->assign('contributionSummary', $this->get('summary'));
136 public function setDefaultValues() {
137 $this->setDeprecatedDefaults();
138 $this->_defaults
= parent
::setDefaultValues();
140 $this->_defaults
= array_merge($this->getEntityDefaults('ContributionRecur'), $this->_defaults
);
142 if (empty($this->_defaults
['contribution_status_id']) && !$this->_force
) {
143 // In force mode only parameters from the url will be used. When visible/ explicit this is a useful default.
144 $this->_defaults
['contribution_status_id'][1] = CRM_Core_PseudoConstant
::getKey(
145 'CRM_Contribute_BAO_Contribution',
146 'contribution_status_id',
150 return $this->_defaults
;
154 * Build the form object.
156 * @throws \CRM_Core_Exception
157 * @throws \CiviCRM_API3_Exception
159 public function buildQuickForm() {
160 if ($this->isFormInViewOrEditMode()) {
161 parent
::buildQuickForm();
162 $this->addContactSearchFields();
164 CRM_Contribute_BAO_Query
::buildSearchForm($this);
167 $rows = $this->get('rows');
168 if (is_array($rows)) {
169 if (!$this->_single
) {
170 $this->addRowSelectors($rows);
173 $permission = CRM_Core_Permission
::getPermission();
175 $queryParams = $this->get('queryParams');
176 $taskParams['softCreditFiltering'] = FALSE;
177 if (!empty($queryParams)) {
178 $taskParams['softCreditFiltering'] = CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled($queryParams);
180 $tasks = CRM_Contribute_Task
::permissionedTaskTitles($permission, $taskParams);
181 $this->addTaskMenu($tasks);
187 * Get the label for the sortName field if email searching is on.
189 * (email searching is a setting under search preferences).
193 protected function getSortNameLabelWithEmail() {
194 return ts('Contributor Name or Email');
198 * Get the label for the sortName field if email searching is off.
200 * (email searching is a setting under search preferences).
204 protected function getSortNameLabelWithOutEmail() {
205 return ts('Contributor Name');
209 * Get the label for the tag field.
211 * We do this in a function so the 'ts' wraps the whole string to allow
212 * better translation.
216 protected function getTagLabel() {
217 return ts('Contributor Tag(s)');
221 * Get the label for the group field.
225 protected function getGroupLabel() {
226 return ts('Contributor Group(s)');
230 * Get the label for the group field.
234 protected function getContactTypeLabel() {
235 return ts('Contributor Contact Type');
239 * The post processing of the form gets done here.
241 * Key things done during post processing are
242 * - check for reset or next request. if present, skip post processing.
243 * - now check if user requested running a saved search, if so, then
244 * the form values associated with the saved search are used for searching.
245 * - if user has done a submit with new values the regular post submission is
247 * The processing consists of using a Selector / Controller framework for getting the
250 public function postProcess() {
257 $this->setFormValues();
258 // @todo - stop changing formValues - respect submitted form values, change a working array.
259 $this->fixFormValues();
261 // We don't show test records in summaries or dashboards
262 if (empty($this->_formValues
['contribution_test']) && $this->_force
&& !empty($this->_context
) && $this->_context
== 'dashboard') {
263 // @todo - stop changing formValues - respect submitted form values, change a working array.
264 $this->_formValues
["contribution_test"] = 0;
268 'contribution_amount_low',
269 'contribution_amount_high',
271 if (isset($this->_formValues
[$f])) {
272 // @todo - stop changing formValues - respect submitted form values, change a working array.
273 $this->_formValues
[$f] = CRM_Utils_Rule
::cleanMoney($this->_formValues
[$f]);
277 if (!empty($_POST)) {
280 'contribution_soft_credit_type_id',
281 'contribution_status_id',
282 'contribution_trxn_id',
283 'contribution_page_id',
284 'contribution_product_id',
286 'payment_instrument_id',
287 'contribution_batch_id',
289 // @todo - stop changing formValues - respect submitted form values, change a working array.
290 CRM_Contact_BAO_Query
::processSpecialFormValue($this->_formValues
, $specialParams);
292 // @todo - stop changing formValues - respect submitted form values, change a working array.
293 $tags = CRM_Utils_Array
::value('contact_tags', $this->_formValues
);
294 if ($tags && !is_array($tags)) {
295 // @todo - stop changing formValues - respect submitted form values, change a working array.
296 unset($this->_formValues
['contact_tags']);
297 $this->_formValues
['contact_tags'][$tags] = 1;
300 if ($tags && is_array($tags)) {
301 unset($this->_formValues
['contact_tags']);
302 foreach ($tags as $notImportant => $tagID) {
303 // @todo - stop changing formValues - respect submitted form values, change a working array.
304 $this->_formValues
['contact_tags'][$tagID] = 1;
308 $group = CRM_Utils_Array
::value('group', $this->_formValues
);
309 if ($group && !is_array($group)) {
310 // @todo - stop changing formValues - respect submitted form values, change a working array.
311 unset($this->_formValues
['group']);
312 $this->_formValues
['group'][$group] = 1;
315 if ($group && is_array($group)) {
316 unset($this->_formValues
['group']);
317 foreach ($group as $groupID) {
318 // @todo - stop changing formValues - respect submitted form values, change a working array.
319 $this->_formValues
['group'][$groupID] = 1;
324 // @todo - stop changing formValues - respect submitted form values, change a working array.
325 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
327 // @todo - stop changing formValues - respect submitted form values, change a working array.
328 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
330 $this->set('queryParams', $this->_queryParams
);
332 $buttonName = $this->controller
->getButtonName();
333 if ($buttonName == $this->_actionButtonName
) {
334 // check actionName and if next, then do not repeat a search, since we are going to the next page
336 // hack, make sure we reset the task values
337 $stateMachine = $this->controller
->getStateMachine();
338 $formName = $stateMachine->getTaskFormName();
339 $this->controller
->resetPage($formName);
343 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
344 $selector = new CRM_Contribute_Selector_Search($this->_queryParams
,
351 $selector->setKey($this->controller
->_key
);
354 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
355 $prefix = $this->_prefix
;
358 $controller = new CRM_Core_Selector_Controller($selector,
359 $this->get(CRM_Utils_Pager
::PAGE_ID
),
361 CRM_Core_Action
::VIEW
,
363 CRM_Core_Selector_Controller
::SESSION
,
366 $controller->setEmbedded(TRUE);
368 $query = &$selector->getQuery();
369 if ($this->_context
== 'user') {
370 $query->setSkipPermission(TRUE);
377 * Use values from $_GET if force is set to TRUE.
379 * Note that this means that GET over-rides POST. This was a historical decision & the reasoning is not explained.
381 public function fixFormValues() {
382 if (!$this->_force
) {
386 $status = CRM_Utils_Request
::retrieve('status', 'String');
388 $this->_formValues
['contribution_status_id'] = [$status => 1];
389 $this->_defaults
['contribution_status_id'] = [$status => 1];
392 $pcpid = (array) CRM_Utils_Request
::retrieve('pcpid', 'String', $this);
394 // Add new pcpid to the tail of the array...
395 foreach ($pcpid as $pcpIdList) {
396 $this->_formValues
['contribution_pcp_made_through_id'][] = $pcpIdList;
398 // and avoid any duplicate
399 $this->_formValues
['contribution_pcp_made_through_id'] = array_unique($this->_formValues
['contribution_pcp_made_through_id']);
402 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
405 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
407 $this->_formValues
['contact_id'] = $cid;
408 // @todo - why do we retrieve these when they are not used?
409 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
410 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
413 // also assign individual mode to the template
414 $this->_single
= TRUE;
418 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive',
422 $test = CRM_Utils_Request
::retrieve('test', 'Boolean');
424 $test = CRM_Utils_Type
::escape($test, 'Boolean');
425 $this->_formValues
['contribution_test'] = $test;
428 $recur = CRM_Utils_Request
::retrieve('recur', 'Positive', $this, FALSE);
430 $this->_formValues
['contribution_recur_id'] = $recur;
431 $this->_formValues
['contribution_recurring'] = 1;
434 //check for contribution page id.
435 $contribPageId = CRM_Utils_Request
::retrieve('pid', 'Positive', $this);
436 if ($contribPageId) {
437 $this->_formValues
['contribution_page_id'] = $contribPageId;
442 * Return a descriptive name for the page, used in wizard header.
446 public function getTitle() {
447 return ts('Find Contributions');
451 * Set the metadata for the form.
453 * @throws \CiviCRM_API3_Exception
455 protected function setSearchMetadata() {
456 $this->addSearchFieldMetadata(['Contribution' => CRM_Contribute_BAO_Query
::getSearchFieldMetadata()]);
457 $this->addSearchFieldMetadata(['ContributionRecur' => CRM_Contribute_BAO_ContributionRecur
::getContributionRecurSearchFieldMetadata()]);
461 * Handling for url params that are deprecated.
463 * @throws \CRM_Core_Exception
465 protected function setDeprecatedDefaults() {
466 $lowReceiveDate = CRM_Utils_Request
::retrieve('start', 'Timestamp');
467 if (!empty($lowReceiveDate)) {
468 $this->_formValues
['receive_date_low'] = date('Y-m-d H:i:s', strtotime($lowReceiveDate));
469 CRM_Core_Error
::deprecatedFunctionWarning('pass receive_date_low not start');
471 $highReceiveDate = CRM_Utils_Request
::retrieve('end', 'Timestamp');
472 if (!empty($highReceiveDate)) {
473 $this->_formValues
['receive_date_high'] = date('Y-m-d H:i:s', strtotime($highReceiveDate));
474 CRM_Core_Error
::deprecatedFunctionWarning('pass receive_date_high not end');