3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * This file is for CiviGrant search
37 class CRM_Grant_Form_Search
extends CRM_Core_Form_Search
{
40 * The params that are sent to the query.
44 protected $_queryParams;
47 * Are we restricting ourselves to a single contact.
51 protected $_single = FALSE;
58 protected $_limit = NULL;
61 * Prefix for the controller.
64 protected $_prefix = "grant_";
67 * Metadata of all fields to include on the form.
71 protected $searchFieldMetadata = [];
76 public function getDefaultEntity() {
81 * Processing needed for buildForm and later.
85 public function preProcess() {
87 * set the button names
89 $this->_searchButtonName
= $this->getButtonName('refresh');
90 $this->_actionButtonName
= $this->getButtonName('next', 'action');
94 $this->loadStandardSearchOptionsFromUrl();
95 $this->loadFormValues();
99 $this->set('force', 0);
103 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
104 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
105 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
109 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
110 $selector = new CRM_Grant_Selector_Search($this->_queryParams
,
118 if ($this->_context
== 'user') {
119 $prefix = $this->_prefix
;
122 $this->assign("{$prefix}limit", $this->_limit
);
123 $this->assign("{$prefix}single", $this->_single
);
125 $controller = new CRM_Core_Selector_Controller($selector,
126 $this->get(CRM_Utils_Pager
::PAGE_ID
),
128 CRM_Core_Action
::VIEW
,
130 CRM_Core_Selector_Controller
::TRANSFER
,
133 $controller->setEmbedded(TRUE);
134 $controller->moveFromSessionToTemplate();
136 $this->assign('summary', $this->get('summary'));
140 * Build the form object.
142 public function buildQuickForm() {
143 parent
::buildQuickForm();
144 $this->addSortNameField();
146 CRM_Grant_BAO_Query
::buildSearchForm($this);
148 $rows = $this->get('rows');
149 if (is_array($rows)) {
150 if (!$this->_single
) {
151 $this->addRowSelectors($rows);
154 $this->addTaskMenu(CRM_Grant_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission()));
160 * The post processing of the form gets done here.
162 * Key things done during post processing are
163 * - check for reset or next request. if present, skip post procesing.
164 * - now check if user requested running a saved search, if so, then
165 * the form values associated with the saved search are used for searching.
166 * - if user has done a submit with new values the regular post submissing is
168 * The processing consists of using a Selector / Controller framework for getting the
175 public function postProcess() {
182 $this->_formValues
= $this->controller
->exportValues($this->_name
);
183 $this->fixFormValues();
185 if (isset($this->_ssID
) && empty($_POST)) {
186 // if we are editing / running a saved search and the form has not been posted
187 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
190 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
192 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
194 $this->set('formValues', $this->_formValues
);
195 $this->set('queryParams', $this->_queryParams
);
197 $buttonName = $this->controller
->getButtonName();
198 if ($buttonName == $this->_actionButtonName
) {
199 // check actionName and if next, then do not repeat a search, since we are going to the next page
201 // hack, make sure we reset the task values
202 $stateMachine = $this->controller
->getStateMachine();
203 $formName = $stateMachine->getTaskFormName();
204 $this->controller
->resetPage($formName);
209 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
210 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
211 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
215 $selector = new CRM_Grant_Selector_Search($this->_queryParams
,
222 $selector->setKey($this->controller
->_key
);
225 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
226 $prefix = $this->_prefix
;
229 $controller = new CRM_Core_Selector_Controller($selector,
230 $this->get(CRM_Utils_Pager
::PAGE_ID
),
232 CRM_Core_Action
::VIEW
,
234 CRM_Core_Selector_Controller
::SESSION
,
237 $controller->setEmbedded(TRUE);
239 $query = &$selector->getQuery();
240 if ($this->_context
== 'user') {
241 $query->setSkipPermission(TRUE);
247 * Set the default form values.
251 * the default array reference
253 public function &setDefaultValues() {
254 return $this->_formValues
;
257 public function fixFormValues() {
258 // if this search has been forced
259 // then see if there are any get values, and if so over-ride the post values
260 // note that this means that GET over-rides POST :)
262 if (!$this->_force
) {
266 $status = CRM_Utils_Request
::retrieve('status', 'String');
268 $this->_formValues
['grant_status_id'] = $status;
269 $this->_defaults
['grant_status_id'] = $status;
272 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
275 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
277 $this->_formValues
['contact_id'] = $cid;
279 // also assign individual mode to the template
280 $this->_single
= TRUE;
288 public function getFormValues() {
293 * Return a descriptive name for the page, used in wizard header
297 public function getTitle() {
298 return ts('Find Grants');
302 * Get metadata for fields being assigned by metadata.
306 protected function getEntityMetadata() {
307 return CRM_Grant_BAO_Query
::getSearchFieldMetadata();