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   public function preProcess() {
  77     $this->set('searchFormName', 'Search');
  78
  79     $this->_searchButtonName = $this->getButtonName('refresh');
  80     $this->_actionButtonName = $this->getButtonName('next', 'action');
  81
  82     $this->_done = FALSE;
  83
  84     $this->loadStandardSearchOptionsFromUrl();
  85
  86     // get user submitted values
  87     // get it from controller only if form has been submitted, else preProcess has set this
  88     if (!empty($_POST)) {
  89       $this->_formValues = $this->controller->exportValues($this->_name);
  90     }
  91     else {
  92       $this->_formValues = $this->get('formValues');
  93     }
  94
  95     //membership ID
  96     $memberShipId = CRM_Utils_Request::retrieve('memberId', 'Positive', $this);
  97     if (isset($memberShipId)) {
  98       $this->_formValues['contribution_membership_id'] = $memberShipId;
  99     }
 100     $participantId = CRM_Utils_Request::retrieve('participantId', 'Positive', $this);
 101     if (isset($participantId)) {
 102       $this->_formValues['contribution_participant_id'] = $participantId;
 103     }
 104
 105     if ($this->_force) {
 106       $this->postProcess();
 107       $this->set('force', 0);
 108     }
 109
 110     $sortID = NULL;
 111     if ($this->get(CRM_Utils_Sort::SORT_ID)) {
 112       $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID),
 113         $this->get(CRM_Utils_Sort::SORT_DIRECTION)
 114       );
 115     }
 116
 117     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 118     $selector = new CRM_Contribute_Selector_Search($this->_queryParams,
 119       $this->_action,
 120       NULL,
 121       $this->_single,
 122       $this->_limit,
 123       $this->_context
 124     );
 125     $prefix = NULL;
 126     if ($this->_context == 'user') {
 127       $prefix = $this->_prefix;
 128     }
 129
 130     $this->assign("{$prefix}limit", $this->_limit);
 131     $this->assign("{$prefix}single", $this->_single);
 132
 133     $controller = new CRM_Core_Selector_Controller($selector,
 134       $this->get(CRM_Utils_Pager::PAGE_ID),
 135       $sortID,
 136       CRM_Core_Action::VIEW,
 137       $this,
 138       CRM_Core_Selector_Controller::TRANSFER,
 139       $prefix
 140     );
 141
 142     $controller->setEmbedded(TRUE);
 143     $controller->moveFromSessionToTemplate();
 144
 145     $this->assign('contributionSummary', $this->get('summary'));
 146   }
 147
 148   /**
 149    * Set defaults.
 150    *
 151    * @return array
 152    */
 153   public function setDefaultValues() {
 154     if (empty($this->_defaults['contribution_status'])) {
 155       $this->_defaults['contribution_status'][1] = 1;
 156     }
 157     return $this->_defaults;
 158   }
 159
 160   /**
 161    * Build the form object.
 162    *
 163    * @throws \CRM_Core_Exception
 164    * @throws \CiviCRM_API3_Exception
 165    */
 166   public function buildQuickForm() {
 167     if ($this->isFormInViewOrEditMode()) {
 168       parent::buildQuickForm();
 169       $this->addContactSearchFields();
 170
 171       CRM_Contribute_BAO_Query::buildSearchForm($this);
 172     }
 173
 174     $rows = $this->get('rows');
 175     if (is_array($rows)) {
 176       if (!$this->_single) {
 177         $this->addRowSelectors($rows);
 178       }
 179
 180       $permission = CRM_Core_Permission::getPermission();
 181
 182       $queryParams = $this->get('queryParams');
 183       $taskParams['softCreditFiltering'] = FALSE;
 184       if (!empty($queryParams)) {
 185         $taskParams['softCreditFiltering'] = CRM_Contribute_BAO_Query::isSoftCreditOptionEnabled($queryParams);
 186       }
 187       $tasks = CRM_Contribute_Task::permissionedTaskTitles($permission, $taskParams);
 188       $this->addTaskMenu($tasks);
 189     }
 190
 191   }
 192
 193   /**
 194    * Get the label for the sortName field if email searching is on.
 195    *
 196    * (email searching is a setting under search preferences).
 197    *
 198    * @return string
 199    */
 200   protected function getSortNameLabelWithEmail() {
 201     return ts('Contributor Name or Email');
 202   }
 203
 204   /**
 205    * Get the label for the sortName field if email searching is off.
 206    *
 207    * (email searching is a setting under search preferences).
 208    *
 209    * @return string
 210    */
 211   protected function getSortNameLabelWithOutEmail() {
 212     return ts('Contributor Name');
 213   }
 214
 215   /**
 216    * Get the label for the tag field.
 217    *
 218    * We do this in a function so the 'ts' wraps the whole string to allow
 219    * better translation.
 220    *
 221    * @return string
 222    */
 223   protected function getTagLabel() {
 224     return ts('Contributor Tag(s)');
 225   }
 226
 227   /**
 228    * Get the label for the group field.
 229    *
 230    * @return string
 231    */
 232   protected function getGroupLabel() {
 233     return ts('Contributor Group(s)');
 234   }
 235
 236   /**
 237    * Get the label for the group field.
 238    *
 239    * @return string
 240    */
 241   protected function getContactTypeLabel() {
 242     return ts('Contributor Contact Type');
 243   }
 244
 245   /**
 246    * The post processing of the form gets done here.
 247    *
 248    * Key things done during post processing are
 249    *      - check for reset or next request. if present, skip post processing.
 250    *      - now check if user requested running a saved search, if so, then
 251    *        the form values associated with the saved search are used for searching.
 252    *      - if user has done a submit with new values the regular post submission is
 253    *        done.
 254    * The processing consists of using a Selector / Controller framework for getting the
 255    * search results.
 256    */
 257   public function postProcess() {
 258     if ($this->_done) {
 259       return;
 260     }
 261
 262     $this->_done = TRUE;
 263
 264     if (!empty($_POST) && !$this->_force) {
 265       $this->_formValues = $this->controller->exportValues($this->_name);
 266     }
 267     $this->convertTextStringsToUseLikeOperator();
 268     $this->fixFormValues();
 269
 270     // We don't show test records in summaries or dashboards
 271     if (empty($this->_formValues['contribution_test']) && $this->_force && !empty($this->_context) && $this->_context == 'dashboard') {
 272       $this->_formValues["contribution_test"] = 0;
 273     }
 274
 275     foreach ([
 276       'contribution_amount_low',
 277       'contribution_amount_high',
 278     ] as $f) {
 279       if (isset($this->_formValues[$f])) {
 280         $this->_formValues[$f] = CRM_Utils_Rule::cleanMoney($this->_formValues[$f]);
 281       }
 282     }
 283
 284     $config = CRM_Core_Config::singleton();
 285     if (!empty($_POST)) {
 286       $specialParams = [
 287         'financial_type_id',
 288         'contribution_soft_credit_type_id',
 289         'contribution_status_id',
 290         'contribution_trxn_id',
 291         'contribution_page_id',
 292         'contribution_product_id',
 293         'invoice_id',
 294         'payment_instrument_id',
 295         'contribution_batch_id',
 296       ];
 297       CRM_Contact_BAO_Query::processSpecialFormValue($this->_formValues, $specialParams);
 298
 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       }
 304
 305       if ($tags && is_array($tags)) {
 306         unset($this->_formValues['contact_tags']);
 307         foreach ($tags as $notImportant => $tagID) {
 308           $this->_formValues['contact_tags'][$tagID] = 1;
 309         }
 310       }
 311
 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       }
 317
 318       if ($group && is_array($group)) {
 319         unset($this->_formValues['group']);
 320         foreach ($group as $groupID) {
 321           $this->_formValues['group'][$groupID] = 1;
 322         }
 323       }
 324     }
 325
 326     CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues);
 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();
 334     if ($buttonName == $this->_actionButtonName) {
 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
 338       $stateMachine = $this->controller->getStateMachine();
 339       $formName = $stateMachine->getTaskFormName();
 340       $this->controller->resetPage($formName);
 341       return;
 342     }
 343
 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     }
 380
 381     $controller->run();
 382   }
 383
 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    */
 389   public function fixFormValues() {
 390     if (!$this->_force) {
 391       return;
 392     }
 393
 394     $status = CRM_Utils_Request::retrieve('status', 'String');
 395     if ($status) {
 396       $this->_formValues['contribution_status_id'] = [$status => 1];
 397       $this->_defaults['contribution_status_id'] = [$status => 1];
 398     }
 399
 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
 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;
 416         // @todo - why do we retrieve these when they are not used?
 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
 426     $lowDate = CRM_Utils_Request::retrieve('start', 'Timestamp');
 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
 433     $highDate = CRM_Utils_Request::retrieve('end', 'Timestamp');
 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
 449     $test = CRM_Utils_Request::retrieve('test', 'Boolean');
 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   /**
 472    * Return a descriptive name for the page, used in wizard header.
 473    *
 474    * @return string
 475    */
 476   public function getTitle() {
 477     return ts('Find Contributions');
 478   }
 479
 480 }