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