3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
41 * This file is for civigrant search
43 class CRM_Grant_Form_Search
extends CRM_Core_Form_Search
{
46 * The params that are sent to the query.
50 protected $_queryParams;
53 * Are we restricting ourselves to a single contact.
57 protected $_single = FALSE;
60 * Are we restricting ourselves to a single contact.
64 protected $_limit = NULL;
67 * Prefix for the controller.
69 protected $_prefix = "grant_";
72 * Processing needed for buildForm and later.
76 public function preProcess() {
78 * set the button names
80 $this->_searchButtonName
= $this->getButtonName('refresh');
81 $this->_actionButtonName
= $this->getButtonName('next', 'action');
84 $this->defaults
= array();
87 * we allow the controller to set force/reset externally, useful when we are being
88 * driven by the wizard framework
91 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean');
92 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
93 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
94 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
96 $this->assign("context", $this->_context
);
98 // get user submitted values
99 // get it from controller only if form has been submitted, else preProcess has set this
100 if (!empty($_POST)) {
101 $this->_formValues
= $this->controller
->exportValues($this->_name
);
104 $this->_formValues
= $this->get('formValues');
107 if (empty($this->_formValues
)) {
108 if (isset($this->_ssID
)) {
109 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
114 $this->postProcess();
115 $this->set('force', 0);
119 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
120 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
121 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
125 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
126 $selector = new CRM_Grant_Selector_Search($this->_queryParams
,
134 if ($this->_context
== 'user') {
135 $prefix = $this->_prefix
;
138 $this->assign("{$prefix}limit", $this->_limit
);
139 $this->assign("{$prefix}single", $this->_single
);
141 $controller = new CRM_Core_Selector_Controller($selector,
142 $this->get(CRM_Utils_Pager
::PAGE_ID
),
144 CRM_Core_Action
::VIEW
,
146 CRM_Core_Selector_Controller
::TRANSFER
,
149 $controller->setEmbedded(TRUE);
150 $controller->moveFromSessionToTemplate();
152 $this->assign('summary', $this->get('summary'));
156 * Build the form object.
161 public function buildQuickForm() {
162 parent
::buildQuickForm();
163 $this->addSortNameField();
165 CRM_Grant_BAO_Query
::buildSearchForm($this);
167 $rows = $this->get('rows');
168 if (is_array($rows)) {
169 if (!$this->_single
) {
170 $this->addRowSelectors($rows);
173 $this->addTaskMenu(CRM_Grant_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission()));
179 * The post processing of the form gets done here.
181 * Key things done during post processing are
182 * - check for reset or next request. if present, skip post procesing.
183 * - now check if user requested running a saved search, if so, then
184 * the form values associated with the saved search are used for searching.
185 * - if user has done a submit with new values the regular post submissing is
187 * The processing consists of using a Selector / Controller framework for getting the
194 public function postProcess() {
201 $this->_formValues
= $this->controller
->exportValues($this->_name
);
202 $this->fixFormValues();
204 if (isset($this->_ssID
) && empty($_POST)) {
205 // if we are editing / running a saved search and the form has not been posted
206 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
209 CRM_Core_BAO_CustomValue
::fixCustomFieldValue($this->_formValues
);
211 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
213 $this->set('formValues', $this->_formValues
);
214 $this->set('queryParams', $this->_queryParams
);
216 $buttonName = $this->controller
->getButtonName();
217 if ($buttonName == $this->_actionButtonName
) {
218 // check actionName and if next, then do not repeat a search, since we are going to the next page
220 // hack, make sure we reset the task values
221 $stateMachine = $this->controller
->getStateMachine();
222 $formName = $stateMachine->getTaskFormName();
223 $this->controller
->resetPage($formName);
228 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
229 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
230 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
234 $selector = new CRM_Grant_Selector_Search($this->_queryParams
,
241 $selector->setKey($this->controller
->_key
);
244 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
245 $prefix = $this->_prefix
;
248 $controller = new CRM_Core_Selector_Controller($selector,
249 $this->get(CRM_Utils_Pager
::PAGE_ID
),
251 CRM_Core_Action
::VIEW
,
253 CRM_Core_Selector_Controller
::SESSION
,
256 $controller->setEmbedded(TRUE);
258 $query = &$selector->getQuery();
259 if ($this->_context
== 'user') {
260 $query->setSkipPermission(TRUE);
266 * Set the default form values.
270 * the default array reference
272 public function &setDefaultValues() {
273 return $this->_formValues
;
276 public function fixFormValues() {
277 // if this search has been forced
278 // then see if there are any get values, and if so over-ride the post values
279 // note that this means that GET over-rides POST :)
281 if (!$this->_force
) {
285 $status = CRM_Utils_Request
::retrieve('status', 'String');
287 $this->_formValues
['grant_status_id'] = $status;
288 $this->_defaults
['grant_status_id'] = $status;
291 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
294 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
296 $this->_formValues
['contact_id'] = $cid;
298 // also assign individual mode to the template
299 $this->_single
= TRUE;
307 public function getFormValues() {
312 * Return a descriptive name for the page, used in wizard header
316 public function getTitle() {
317 return ts('Find Grants');