CRM/Grant/Form/Search.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This file is for CiviGrant search
  20  */
  21 class CRM_Grant_Form_Search extends CRM_Core_Form_Search {
  22
  23   /**
  24    * The params that are sent to the query.
  25    *
  26    * @var array
  27    */
  28   protected $_queryParams;
  29
  30   /**
  31    * Are we restricting ourselves to a single contact.
  32    *
  33    * @var bool
  34    */
  35   protected $_single = FALSE;
  36
  37   /**
  38    * Return limit.
  39    *
  40    * @var int
  41    */
  42   protected $_limit;
  43
  44   /**
  45    * Prefix for the controller.
  46    *
  47    * @var string
  48    */
  49   protected $_prefix = 'grant_';
  50
  51   /**
  52    * Metadata of all fields to include on the form.
  53    *
  54    * @var array
  55    */
  56   protected $searchFieldMetadata = [];
  57
  58   /**
  59    * @return string
  60    */
  61   public function getDefaultEntity() {
  62     return 'Grant';
  63   }
  64
  65   /**
  66    * Processing needed for buildForm and later.
  67    *
  68    * @throws \CRM_Core_Exception
  69    * @throws \CiviCRM_API3_Exception
  70    */
  71   public function preProcess() {
  72     /**
  73      * set the button names
  74      */
  75     $this->_actionButtonName = $this->getButtonName('next', 'action');
  76
  77     $this->_done = FALSE;
  78     $this->sortNameOnly = TRUE;
  79
  80     parent::preProcess();
  81
  82     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
  83     $selector = new CRM_Grant_Selector_Search($this->_queryParams,
  84       $this->_action,
  85       NULL,
  86       $this->_single,
  87       $this->_limit,
  88       $this->_context
  89     );
  90     $prefix = NULL;
  91     if ($this->_context === 'user') {
  92       $prefix = $this->_prefix;
  93     }
  94
  95     $this->assign("{$prefix}limit", $this->_limit);
  96     $this->assign("{$prefix}single", $this->_single);
  97
  98     $controller = new CRM_Core_Selector_Controller($selector,
  99       $this->get(CRM_Utils_Pager::PAGE_ID),
 100       $this->getSortID(),
 101       CRM_Core_Action::VIEW,
 102       $this,
 103       CRM_Core_Selector_Controller::TRANSFER,
 104       $prefix
 105     );
 106     $controller->setEmbedded(TRUE);
 107     $controller->moveFromSessionToTemplate();
 108
 109     $this->assign('summary', $this->get('summary'));
 110   }
 111
 112   /**
 113    * Build the form object.
 114    *
 115    * @throws \CRM_Core_Exception
 116    * @throws \CiviCRM_API3_Exception
 117    */
 118   public function buildQuickForm() {
 119     parent::buildQuickForm();
 120     $this->addSortNameField();
 121
 122     CRM_Grant_BAO_Query::buildSearchForm($this);
 123
 124     $rows = $this->get('rows');
 125     if (is_array($rows)) {
 126       if (!$this->_single) {
 127         $this->addRowSelectors($rows);
 128       }
 129
 130       $this->addTaskMenu(CRM_Grant_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission()));
 131     }
 132
 133   }
 134
 135   /**
 136    * The post processing of the form gets done here.
 137    *
 138    * Key things done during post processing are
 139    *      - check for reset or next request. if present, skip post procesing.
 140    *      - now check if user requested running a saved search, if so, then
 141    *        the form values associated with the saved search are used for searching.
 142    *      - if user has done a submit with new values the regular post submissing is
 143    *        done.
 144    * The processing consists of using a Selector / Controller framework for getting the
 145    * search results.
 146    *
 147    * @return void
 148    * @throws \CRM_Core_Exception
 149    */
 150   public function postProcess() {
 151     if ($this->_done) {
 152       return;
 153     }
 154
 155     $this->_done = TRUE;
 156
 157     $this->setFormValues();
 158     $this->fixFormValues();
 159
 160     if (isset($this->_ssID) && empty($_POST)) {
 161       // if we are editing / running a saved search and the form has not been posted
 162       $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID);
 163     }
 164
 165     $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
 166
 167     $this->set('queryParams', $this->_queryParams);
 168
 169     $buttonName = $this->controller->getButtonName();
 170     if ($buttonName === $this->_actionButtonName) {
 171       // check actionName and if next, then do not repeat a search, since we are going to the next page
 172
 173       // hack, make sure we reset the task values
 174       $stateMachine = $this->controller->getStateMachine();
 175       $formName = $stateMachine->getTaskFormName();
 176       $this->controller->resetPage($formName);
 177       return;
 178     }
 179
 180     $selector = new CRM_Grant_Selector_Search($this->_queryParams,
 181       $this->_action,
 182       NULL,
 183       $this->_single,
 184       $this->_limit,
 185       $this->_context
 186     );
 187     $selector->setKey($this->controller->_key);
 188
 189     $prefix = NULL;
 190     if ($this->_context === 'basic' || $this->_context === 'user') {
 191       $prefix = $this->_prefix;
 192     }
 193
 194     $controller = new CRM_Core_Selector_Controller($selector,
 195       $this->get(CRM_Utils_Pager::PAGE_ID),
 196       $this->getSortID(),
 197       CRM_Core_Action::VIEW,
 198       $this,
 199       CRM_Core_Selector_Controller::SESSION,
 200       $prefix
 201     );
 202     $controller->setEmbedded(TRUE);
 203
 204     $query = &$selector->getQuery();
 205     if ($this->_context === 'user') {
 206       $query->setSkipPermission(TRUE);
 207     }
 208     $controller->run();
 209   }
 210
 211   /**
 212    * Hack form values :-(.
 213    *
 214    * @throws \CRM_Core_Exception
 215    */
 216   public function fixFormValues() {
 217     // if this search has been forced
 218     // then see if there are any get values, and if so over-ride the post values
 219     // note that this means that GET over-rides POST :)
 220
 221     if (!$this->_force) {
 222       return;
 223     }
 224
 225     $status = CRM_Utils_Request::retrieve('status', 'String');
 226     if ($status) {
 227       $this->_formValues['grant_status_id'] = $status;
 228       $this->_defaults['grant_status_id'] = $status;
 229     }
 230
 231     $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 232
 233     if ($cid) {
 234       $cid = CRM_Utils_Type::escape($cid, 'Integer');
 235       if ($cid > 0) {
 236         $this->_formValues['contact_id'] = $cid;
 237
 238         // also assign individual mode to the template
 239         $this->_single = TRUE;
 240       }
 241     }
 242   }
 243
 244   /**
 245    * Return a descriptive name for the page, used in wizard header
 246    *
 247    * @return string
 248    */
 249   public function getTitle() {
 250     return ts('Find Grants');
 251   }
 252
 253   /**
 254    * Get metadata for fields being assigned by metadata.
 255    *
 256    * @return array
 257    *
 258    * @throws \CiviCRM_API3_Exception
 259    */
 260   protected function getEntityMetadata() {
 261     return CRM_Grant_BAO_Query::getSearchFieldMetadata();
 262   }
 263
 264   /**
 265    * Set the metadata for the form.
 266    *
 267    * @throws \CiviCRM_API3_Exception
 268    */
 269   protected function setSearchMetadata() {
 270     $this->addSearchFieldMetadata(['Grant' => $this->getEntityMetadata()]);
 271   }
 272
 273 }