CRM/Contribute/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * Advanced search, extends basic search.
  36  */
  37 class CRM_Contribute_Form_Search extends CRM_Core_Form_Search {
  38
  39   /**
  40    * The params that are sent to the query.
  41    *
  42    * @var array
  43    */
  44   protected $_queryParams;
  45
  46   /**
  47    * Are we restricting ourselves to a single contact.
  48    *
  49    * @var bool
  50    */
  51   protected $_single = FALSE;
  52
  53   /**
  54    * Are we restricting ourselves to a single contact.
  55    *
  56    * @var bool
  57    */
  58   protected $_limit = NULL;
  59
  60   /**
  61    * Prefix for the controller.
  62    * @var string
  63    */
  64   protected $_prefix = "contribute_";
  65
  66   /**
  67    * Explicitly declare the entity api name.
  68    */
  69   public function getDefaultEntity() {
  70     return 'Contribution';
  71   }
  72
  73   /**
  74    * Processing needed for buildForm and later.
  75    *
  76    * @throws \CiviCRM_API3_Exception
  77    * @throws \CRM_Core_Exception
  78    */
  79   public function preProcess() {
  80     $this->set('searchFormName', 'Search');
  81
  82     $this->_searchButtonName = $this->getButtonName('refresh');
  83     $this->_actionButtonName = $this->getButtonName('next', 'action');
  84
  85     $this->_done = FALSE;
  86
  87     $this->loadStandardSearchOptionsFromUrl();
  88
  89     // get user submitted values
  90     // get it from controller only if form has been submitted, else preProcess has set this
  91     if (!empty($_POST)) {
  92       $this->_formValues = $this->controller->exportValues($this->_name);
  93     }
  94     else {
  95       $this->_formValues = $this->get('formValues');
  96     }
  97
  98     //membership ID
  99     $memberShipId = CRM_Utils_Request::retrieve('memberId', 'Positive', $this);
 100     if (isset($memberShipId)) {
 101       $this->_formValues['contribution_membership_id'] = $memberShipId;
 102     }
 103     $participantId = CRM_Utils_Request::retrieve('participantId', 'Positive', $this);
 104     if (isset($participantId)) {
 105       $this->_formValues['contribution_participant_id'] = $participantId;
 106     }
 107
 108     if ($this->_force) {
 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);
 115     }
 116
 117     $sortID = NULL;
 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)
 121       );
 122     }
 123
 124     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 125     $selector = new CRM_Contribute_Selector_Search($this->_queryParams,
 126       $this->_action,
 127       NULL,
 128       $this->_single,
 129       $this->_limit,
 130       $this->_context
 131     );
 132     $prefix = NULL;
 133     if ($this->_context == 'user') {
 134       $prefix = $this->_prefix;
 135     }
 136
 137     $this->assign("{$prefix}limit", $this->_limit);
 138     $this->assign("{$prefix}single", $this->_single);
 139
 140     $controller = new CRM_Core_Selector_Controller($selector,
 141       $this->get(CRM_Utils_Pager::PAGE_ID),
 142       $sortID,
 143       CRM_Core_Action::VIEW,
 144       $this,
 145       CRM_Core_Selector_Controller::TRANSFER,
 146       $prefix
 147     );
 148
 149     $controller->setEmbedded(TRUE);
 150     $controller->moveFromSessionToTemplate();
 151
 152     $this->assign('contributionSummary', $this->get('summary'));
 153   }
 154
 155   /**
 156    * Set defaults.
 157    *
 158    * @return array
 159    * @throws \Exception
 160    */
 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');
 166     }
 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');
 171     }
 172     $this->_defaults = parent::setDefaultValues();
 173
 174     $this->_defaults = array_merge($this->getEntityDefaults('ContributionRecur'), $this->_defaults);
 175
 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',
 181         'Completed'
 182       );
 183     }
 184     return $this->_defaults;
 185   }
 186
 187   /**
 188    * Build the form object.
 189    *
 190    * @throws \CRM_Core_Exception
 191    * @throws \CiviCRM_API3_Exception
 192    */
 193   public function buildQuickForm() {
 194     if ($this->isFormInViewOrEditMode()) {
 195       parent::buildQuickForm();
 196       $this->addContactSearchFields();
 197
 198       CRM_Contribute_BAO_Query::buildSearchForm($this);
 199     }
 200
 201     $rows = $this->get('rows');
 202     if (is_array($rows)) {
 203       if (!$this->_single) {
 204         $this->addRowSelectors($rows);
 205       }
 206
 207       $permission = CRM_Core_Permission::getPermission();
 208
 209       $queryParams = $this->get('queryParams');
 210       $taskParams['softCreditFiltering'] = FALSE;
 211       if (!empty($queryParams)) {
 212         $taskParams['softCreditFiltering'] = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams);
 213       }
 214       $tasks = CRM_Contribute_Task::permissionedTaskTitles($permission, $taskParams);
 215       $this->addTaskMenu($tasks);
 216     }
 217
 218   }
 219
 220   /**
 221    * Get the label for the sortName field if email searching is on.
 222    *
 223    * (email searching is a setting under search preferences).
 224    *
 225    * @return string
 226    */
 227   protected function getSortNameLabelWithEmail() {
 228     return ts('Contributor Name or Email');
 229   }
 230
 231   /**
 232    * Get the label for the sortName field if email searching is off.
 233    *
 234    * (email searching is a setting under search preferences).
 235    *
 236    * @return string
 237    */
 238   protected function getSortNameLabelWithOutEmail() {
 239     return ts('Contributor Name');
 240   }
 241
 242   /**
 243    * Get the label for the tag field.
 244    *
 245    * We do this in a function so the 'ts' wraps the whole string to allow
 246    * better translation.
 247    *
 248    * @return string
 249    */
 250   protected function getTagLabel() {
 251     return ts('Contributor Tag(s)');
 252   }
 253
 254   /**
 255    * Get the label for the group field.
 256    *
 257    * @return string
 258    */
 259   protected function getGroupLabel() {
 260     return ts('Contributor Group(s)');
 261   }
 262
 263   /**
 264    * Get the label for the group field.
 265    *
 266    * @return string
 267    */
 268   protected function getContactTypeLabel() {
 269     return ts('Contributor Contact Type');
 270   }
 271
 272   /**
 273    * The post processing of the form gets done here.
 274    *
 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
 280    *        done.
 281    * The processing consists of using a Selector / Controller framework for getting the
 282    * search results.
 283    */
 284   public function postProcess() {
 285     if ($this->_done) {
 286       return;
 287     }
 288
 289     $this->_done = TRUE;
 290
 291     $this->setFormValues();
 292     $this->fixFormValues();
 293
 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;
 297     }
 298
 299     foreach ([
 300       'contribution_amount_low',
 301       'contribution_amount_high',
 302     ] as $f) {
 303       if (isset($this->_formValues[$f])) {
 304         $this->_formValues[$f] = CRM_Utils_Rule::cleanMoney($this->_formValues[$f]);
 305       }
 306     }
 307
 308     $config = CRM_Core_Config::singleton();
 309     if (!empty($_POST)) {
 310       $specialParams = [
 311         'financial_type_id',
 312         'contribution_soft_credit_type_id',
 313         'contribution_status_id',
 314         'contribution_trxn_id',
 315         'contribution_page_id',
 316         'contribution_product_id',
 317         'invoice_id',
 318         'payment_instrument_id',
 319         'contribution_batch_id',
 320       ];
 321       CRM_Contact_BAO_Query::processSpecialFormValue($this->_formValues, $specialParams);
 322
 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;
 327       }
 328
 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;
 333         }
 334       }
 335
 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;
 340       }
 341
 342       if ($group && is_array($group)) {
 343         unset($this->_formValues['group']);
 344         foreach ($group as $groupID) {
 345           $this->_formValues['group'][$groupID] = 1;
 346         }
 347       }
 348     }
 349
 350     CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues);
 351
 352     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 353
 354     $this->set('formValues', $this->_formValues);
 355     $this->set('queryParams', $this->_queryParams);
 356
 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
 360
 361       // hack, make sure we reset the task values
 362       $stateMachine = $this->controller->getStateMachine();
 363       $formName = $stateMachine->getTaskFormName();
 364       $this->controller->resetPage($formName);
 365       return;
 366     }
 367
 368     $sortID = NULL;
 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)
 372       );
 373     }
 374
 375     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 376     $selector = new CRM_Contribute_Selector_Search($this->_queryParams,
 377       $this->_action,
 378       NULL,
 379       $this->_single,
 380       $this->_limit,
 381       $this->_context
 382     );
 383     $selector->setKey($this->controller->_key);
 384
 385     $prefix = NULL;
 386     if ($this->_context == 'basic' || $this->_context == 'user') {
 387       $prefix = $this->_prefix;
 388     }
 389
 390     $controller = new CRM_Core_Selector_Controller($selector,
 391       $this->get(CRM_Utils_Pager::PAGE_ID),
 392       $sortID,
 393       CRM_Core_Action::VIEW,
 394       $this,
 395       CRM_Core_Selector_Controller::SESSION,
 396       $prefix
 397     );
 398     $controller->setEmbedded(TRUE);
 399
 400     $query = &$selector->getQuery();
 401     if ($this->_context == 'user') {
 402       $query->setSkipPermission(TRUE);
 403     }
 404
 405     $controller->run();
 406   }
 407
 408   /**
 409    * Use values from $_GET if force is set to TRUE.
 410    *
 411    * Note that this means that GET over-rides POST. This was a historical decision & the reasoning is not explained.
 412    */
 413   public function fixFormValues() {
 414     if (!$this->_force) {
 415       return;
 416     }
 417
 418     $status = CRM_Utils_Request::retrieve('status', 'String');
 419     if ($status) {
 420       $this->_formValues['contribution_status_id'] = [$status => 1];
 421       $this->_defaults['contribution_status_id'] = [$status => 1];
 422     }
 423
 424     $pcpid = (array) CRM_Utils_Request::retrieve('pcpid', 'String', $this);
 425     if ($pcpid) {
 426       // Add new pcpid to the tail of the array...
 427       foreach ($pcpid as $pcpIdList) {
 428         $this->_formValues['contribution_pcp_made_through_id'][] = $pcpIdList;
 429       }
 430       // and avoid any duplicate
 431       $this->_formValues['contribution_pcp_made_through_id'] = array_unique($this->_formValues['contribution_pcp_made_through_id']);
 432     }
 433
 434     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 435
 436     if ($cid) {
 437       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 438       if ($cid > 0) {
 439         $this->_formValues['contact_id'] = $cid;
 440         // @todo - why do we retrieve these when they are not used?
 441         list($display, $image) = CRM_Contact_BAO_Contact::getDisplayAndImage($cid);
 442         $this->_defaults['sort_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid,
 443           'sort_name'
 444         );
 445         // also assign individual mode to the template
 446         $this->_single = TRUE;
 447       }
 448     }
 449
 450     $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive',
 451       $this
 452     );
 453
 454     $test = CRM_Utils_Request::retrieve('test', 'Boolean');
 455     if (isset($test)) {
 456       $test = CRM_Utils_Type::escape($test, 'Boolean');
 457       $this->_formValues['contribution_test'] = $test;
 458     }
 459     //Recurring id
 460     $recur = CRM_Utils_Request::retrieve('recur', 'Positive', $this, FALSE);
 461     if ($recur) {
 462       $this->_formValues['contribution_recur_id'] = $recur;
 463       $this->_formValues['contribution_recurring'] = 1;
 464     }
 465
 466     //check for contribution page id.
 467     $contribPageId = CRM_Utils_Request::retrieve('pid', 'Positive', $this);
 468     if ($contribPageId) {
 469       $this->_formValues['contribution_page_id'] = $contribPageId;
 470     }
 471
 472     //give values to default.
 473     $this->_defaults = $this->_formValues;
 474   }
 475
 476   /**
 477    * Return a descriptive name for the page, used in wizard header.
 478    *
 479    * @return string
 480    */
 481   public function getTitle() {
 482     return ts('Find Contributions');
 483   }
 484
 485 }