CRM/Contribute/Form/Search.php

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