3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This file is for CiviGrant search
21 class CRM_Grant_Form_Search
extends CRM_Core_Form_Search
{
24 * The params that are sent to the query.
28 protected $_queryParams;
31 * Are we restricting ourselves to a single contact.
35 protected $_single = FALSE;
42 protected $_limit = NULL;
45 * Prefix for the controller.
48 protected $_prefix = "grant_";
51 * Metadata of all fields to include on the form.
55 protected $searchFieldMetadata = [];
60 public function getDefaultEntity() {
65 * Processing needed for buildForm and later.
69 public function preProcess() {
71 * set the button names
73 $this->_searchButtonName
= $this->getButtonName('refresh');
74 $this->_actionButtonName
= $this->getButtonName('next', 'action');
78 $this->loadStandardSearchOptionsFromUrl();
79 $this->loadFormValues();
83 $this->set('force', 0);
86 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
87 $selector = new CRM_Grant_Selector_Search($this->_queryParams
,
95 if ($this->_context
== 'user') {
96 $prefix = $this->_prefix
;
99 $this->assign("{$prefix}limit", $this->_limit
);
100 $this->assign("{$prefix}single", $this->_single
);
102 $controller = new CRM_Core_Selector_Controller($selector,
103 $this->get(CRM_Utils_Pager
::PAGE_ID
),
105 CRM_Core_Action
::VIEW
,
107 CRM_Core_Selector_Controller
::TRANSFER
,
110 $controller->setEmbedded(TRUE);
111 $controller->moveFromSessionToTemplate();
113 $this->assign('summary', $this->get('summary'));
117 * Build the form object.
119 public function buildQuickForm() {
120 parent
::buildQuickForm();
121 $this->addSortNameField();
123 CRM_Grant_BAO_Query
::buildSearchForm($this);
125 $rows = $this->get('rows');
126 if (is_array($rows)) {
127 if (!$this->_single
) {
128 $this->addRowSelectors($rows);
131 $this->addTaskMenu(CRM_Grant_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission()));
137 * The post processing of the form gets done here.
139 * Key things done during post processing are
140 * - check for reset or next request. if present, skip post procesing.
141 * - now check if user requested running a saved search, if so, then
142 * the form values associated with the saved search are used for searching.
143 * - if user has done a submit with new values the regular post submissing is
145 * The processing consists of using a Selector / Controller framework for getting the
152 public function postProcess() {
159 $this->_formValues
= $this->controller
->exportValues($this->_name
);
160 $this->fixFormValues();
162 if (isset($this->_ssID
) && empty($_POST)) {
163 // if we are editing / running a saved search and the form has not been posted
164 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
167 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
169 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
171 $this->set('formValues', $this->_formValues
);
172 $this->set('queryParams', $this->_queryParams
);
174 $buttonName = $this->controller
->getButtonName();
175 if ($buttonName == $this->_actionButtonName
) {
176 // check actionName and if next, then do not repeat a search, since we are going to the next page
178 // hack, make sure we reset the task values
179 $stateMachine = $this->controller
->getStateMachine();
180 $formName = $stateMachine->getTaskFormName();
181 $this->controller
->resetPage($formName);
185 $selector = new CRM_Grant_Selector_Search($this->_queryParams
,
192 $selector->setKey($this->controller
->_key
);
195 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
196 $prefix = $this->_prefix
;
199 $controller = new CRM_Core_Selector_Controller($selector,
200 $this->get(CRM_Utils_Pager
::PAGE_ID
),
202 CRM_Core_Action
::VIEW
,
204 CRM_Core_Selector_Controller
::SESSION
,
207 $controller->setEmbedded(TRUE);
209 $query = &$selector->getQuery();
210 if ($this->_context
== 'user') {
211 $query->setSkipPermission(TRUE);
217 * Set the default form values.
221 * the default array reference
223 public function &setDefaultValues() {
224 return $this->_formValues
;
227 public function fixFormValues() {
228 // if this search has been forced
229 // then see if there are any get values, and if so over-ride the post values
230 // note that this means that GET over-rides POST :)
232 if (!$this->_force
) {
236 $status = CRM_Utils_Request
::retrieve('status', 'String');
238 $this->_formValues
['grant_status_id'] = $status;
239 $this->_defaults
['grant_status_id'] = $status;
242 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
245 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
247 $this->_formValues
['contact_id'] = $cid;
249 // also assign individual mode to the template
250 $this->_single
= TRUE;
258 public function getFormValues() {
263 * Return a descriptive name for the page, used in wizard header
267 public function getTitle() {
268 return ts('Find Grants');
272 * Get metadata for fields being assigned by metadata.
276 protected function getEntityMetadata() {
277 return CRM_Grant_BAO_Query
::getSearchFieldMetadata();
281 * Set the metadata for the form.
283 * @throws \CiviCRM_API3_Exception
285 protected function setSearchMetadata() {
286 $this->addSearchFieldMetadata(['Grant' => $this->getEntityMetadata()]);