3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
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');
87 $this->loadStandardSearchOptionsFromUrl();
89 // get user submitted values
90 // get it from controller only if form has been submitted, else preProcess has set this
92 $this->_formValues
= $this->controller
->exportValues($this->_name
);
95 $this->_formValues
= $this->get('formValues');
99 $memberShipId = CRM_Utils_Request
::retrieve('memberId', 'Positive', $this);
100 if (isset($memberShipId)) {
101 $this->_formValues
['contribution_membership_id'] = $memberShipId;
103 $participantId = CRM_Utils_Request
::retrieve('participantId', 'Positive', $this);
104 if (isset($participantId)) {
105 $this->_formValues
['contribution_participant_id'] = $participantId;
109 // Search field metadata is normally added in buildForm but we are bypassing that in this flow
110 // (I've always found the flow kinda confusing & perhaps that is the problem but this mitigates)
111 $this->addSearchFieldMetadata(['Contribution' => CRM_Contribute_BAO_Query
::getSearchFieldMetadata()]);
112 $this->addSearchFieldMetadata(['ContributionRecur' => CRM_Contribute_BAO_ContributionRecur
::getContributionRecurSearchFieldMetadata()]);
113 $this->postProcess();
114 $this->set('force', 0);
118 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
119 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
120 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
124 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
125 $selector = new CRM_Contribute_Selector_Search($this->_queryParams
,
133 if ($this->_context
== 'user') {
134 $prefix = $this->_prefix
;
137 $this->assign("{$prefix}limit", $this->_limit
);
138 $this->assign("{$prefix}single", $this->_single
);
140 $controller = new CRM_Core_Selector_Controller($selector,
141 $this->get(CRM_Utils_Pager
::PAGE_ID
),
143 CRM_Core_Action
::VIEW
,
145 CRM_Core_Selector_Controller
::TRANSFER
,
149 $controller->setEmbedded(TRUE);
150 $controller->moveFromSessionToTemplate();
152 $this->assign('contributionSummary', $this->get('summary'));
161 public function setDefaultValues() {
162 $lowReceiveDate = CRM_Utils_Request
::retrieve('start', 'Timestamp');
163 if (!empty($lowReceiveDate)) {
164 $this->_formValues
['receive_date_low'] = date('Y-m-d H:i:s', strtotime($lowReceiveDate));
165 CRM_Core_Error
::deprecatedFunctionWarning('pass receive_date_low not start');
167 $highReceiveDate = CRM_Utils_Request
::retrieve('end', 'Timestamp');
168 if (!empty($highReceiveDate)) {
169 $this->_formValues
['receive_date_high'] = date('Y-m-d H:i:s', strtotime($highReceiveDate));
170 CRM_Core_Error
::deprecatedFunctionWarning('pass receive_date_high not end');
172 $this->_defaults
= parent
::setDefaultValues();
174 $this->_defaults
= array_merge($this->getEntityDefaults('ContributionRecur'), $this->_defaults
);
176 if (empty($this->_defaults
['contribution_status_id']) && !$this->_force
) {
177 // In force mode only parameters from the url will be used. When visible/ explicit this is a useful default.
178 $this->_defaults
['contribution_status_id'][1] = CRM_Core_PseudoConstant
::getKey(
179 'CRM_Contribute_BAO_Contribution',
180 'contribution_status_id',
184 return $this->_defaults
;
188 * Build the form object.
190 * @throws \CRM_Core_Exception
191 * @throws \CiviCRM_API3_Exception
193 public function buildQuickForm() {
194 if ($this->isFormInViewOrEditMode()) {
195 parent
::buildQuickForm();
196 $this->addContactSearchFields();
198 CRM_Contribute_BAO_Query
::buildSearchForm($this);
201 $rows = $this->get('rows');
202 if (is_array($rows)) {
203 if (!$this->_single
) {
204 $this->addRowSelectors($rows);
207 $permission = CRM_Core_Permission
::getPermission();
209 $queryParams = $this->get('queryParams');
210 $taskParams['softCreditFiltering'] = FALSE;
211 if (!empty($queryParams)) {
212 $taskParams['softCreditFiltering'] = CRM_Contribute_BAO_Query
::isSoftCreditOptionEnabled($queryParams);
214 $tasks = CRM_Contribute_Task
::permissionedTaskTitles($permission, $taskParams);
215 $this->addTaskMenu($tasks);
221 * Get the label for the sortName field if email searching is on.
223 * (email searching is a setting under search preferences).
227 protected function getSortNameLabelWithEmail() {
228 return ts('Contributor Name or Email');
232 * Get the label for the sortName field if email searching is off.
234 * (email searching is a setting under search preferences).
238 protected function getSortNameLabelWithOutEmail() {
239 return ts('Contributor Name');
243 * Get the label for the tag field.
245 * We do this in a function so the 'ts' wraps the whole string to allow
246 * better translation.
250 protected function getTagLabel() {
251 return ts('Contributor Tag(s)');
255 * Get the label for the group field.
259 protected function getGroupLabel() {
260 return ts('Contributor Group(s)');
264 * Get the label for the group field.
268 protected function getContactTypeLabel() {
269 return ts('Contributor Contact Type');
273 * The post processing of the form gets done here.
275 * Key things done during post processing are
276 * - check for reset or next request. if present, skip post processing.
277 * - now check if user requested running a saved search, if so, then
278 * the form values associated with the saved search are used for searching.
279 * - if user has done a submit with new values the regular post submission is
281 * The processing consists of using a Selector / Controller framework for getting the
284 public function postProcess() {
291 $this->setFormValues();
292 $this->fixFormValues();
294 // We don't show test records in summaries or dashboards
295 if (empty($this->_formValues
['contribution_test']) && $this->_force
&& !empty($this->_context
) && $this->_context
== 'dashboard') {
296 $this->_formValues
["contribution_test"] = 0;
300 'contribution_amount_low',
301 'contribution_amount_high',
303 if (isset($this->_formValues
[$f])) {
304 $this->_formValues
[$f] = CRM_Utils_Rule
::cleanMoney($this->_formValues
[$f]);
308 $config = CRM_Core_Config
::singleton();
309 if (!empty($_POST)) {
312 'contribution_soft_credit_type_id',
313 'contribution_status_id',
314 'contribution_trxn_id',
315 'contribution_page_id',
316 'contribution_product_id',
318 'payment_instrument_id',
319 'contribution_batch_id',
321 CRM_Contact_BAO_Query
::processSpecialFormValue($this->_formValues
, $specialParams);
323 $tags = CRM_Utils_Array
::value('contact_tags', $this->_formValues
);
324 if ($tags && !is_array($tags)) {
325 unset($this->_formValues
['contact_tags']);
326 $this->_formValues
['contact_tags'][$tags] = 1;
329 if ($tags && is_array($tags)) {
330 unset($this->_formValues
['contact_tags']);
331 foreach ($tags as $notImportant => $tagID) {
332 $this->_formValues
['contact_tags'][$tagID] = 1;
336 $group = CRM_Utils_Array
::value('group', $this->_formValues
);
337 if ($group && !is_array($group)) {
338 unset($this->_formValues
['group']);
339 $this->_formValues
['group'][$group] = 1;
342 if ($group && is_array($group)) {
343 unset($this->_formValues
['group']);
344 foreach ($group as $groupID) {
345 $this->_formValues
['group'][$groupID] = 1;
350 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
352 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
354 $this->set('formValues', $this->_formValues
);
355 $this->set('queryParams', $this->_queryParams
);
357 $buttonName = $this->controller
->getButtonName();
358 if ($buttonName == $this->_actionButtonName
) {
359 // check actionName and if next, then do not repeat a search, since we are going to the next page
361 // hack, make sure we reset the task values
362 $stateMachine = $this->controller
->getStateMachine();
363 $formName = $stateMachine->getTaskFormName();
364 $this->controller
->resetPage($formName);
369 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
370 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
371 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
375 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
376 $selector = new CRM_Contribute_Selector_Search($this->_queryParams
,
383 $selector->setKey($this->controller
->_key
);
386 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
387 $prefix = $this->_prefix
;
390 $controller = new CRM_Core_Selector_Controller($selector,
391 $this->get(CRM_Utils_Pager
::PAGE_ID
),
393 CRM_Core_Action
::VIEW
,
395 CRM_Core_Selector_Controller
::SESSION
,
398 $controller->setEmbedded(TRUE);
400 $query = &$selector->getQuery();
401 if ($this->_context
== 'user') {
402 $query->setSkipPermission(TRUE);
409 * Use values from $_GET if force is set to TRUE.
411 * Note that this means that GET over-rides POST. This was a historical decision & the reasoning is not explained.
413 public function fixFormValues() {
414 if (!$this->_force
) {
417 // Start by loading url defaults.
418 $this->_formValues
= $this->setDefaultValues();
420 $status = CRM_Utils_Request
::retrieve('status', 'String');
422 $this->_formValues
['contribution_status_id'] = [$status => 1];
423 $this->_defaults
['contribution_status_id'] = [$status => 1];
426 $pcpid = (array) CRM_Utils_Request
::retrieve('pcpid', 'String', $this);
428 // Add new pcpid to the tail of the array...
429 foreach ($pcpid as $pcpIdList) {
430 $this->_formValues
['contribution_pcp_made_through_id'][] = $pcpIdList;
432 // and avoid any duplicate
433 $this->_formValues
['contribution_pcp_made_through_id'] = array_unique($this->_formValues
['contribution_pcp_made_through_id']);
436 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
439 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
441 $this->_formValues
['contact_id'] = $cid;
442 // @todo - why do we retrieve these when they are not used?
443 list($display, $image) = CRM_Contact_BAO_Contact
::getDisplayAndImage($cid);
444 $this->_defaults
['sort_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $cid,
447 // also assign individual mode to the template
448 $this->_single
= TRUE;
452 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive',
456 $test = CRM_Utils_Request
::retrieve('test', 'Boolean');
458 $test = CRM_Utils_Type
::escape($test, 'Boolean');
459 $this->_formValues
['contribution_test'] = $test;
462 $recur = CRM_Utils_Request
::retrieve('recur', 'Positive', $this, FALSE);
464 $this->_formValues
['contribution_recur_id'] = $recur;
465 $this->_formValues
['contribution_recurring'] = 1;
468 //check for contribution page id.
469 $contribPageId = CRM_Utils_Request
::retrieve('pid', 'Positive', $this);
470 if ($contribPageId) {
471 $this->_formValues
['contribution_page_id'] = $contribPageId;
474 //give values to default.
475 $this->_defaults
= $this->_formValues
;
479 * Return a descriptive name for the page, used in wizard header.
483 public function getTitle() {
484 return ts('Find Contributions');