CRM/Contribute/Form/Search.php

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