3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
41 * This file is for civigrant search
43 class CRM_Grant_Form_Search
extends CRM_Core_Form
{
46 * Are we forced to run a search
54 * name of search button
59 protected $_searchButtonName;
62 * name of action button
67 protected $_actionButtonName;
70 * form values that we will be using
75 protected $_formValues;
78 * the params that are sent to the query
83 protected $_queryParams;
86 * have we already done this search
94 * are we restricting ourselves to a single contact
99 protected $_single = FALSE;
102 * are we restricting ourselves to a single contact
107 protected $_limit = NULL;
110 * what context are we being invoked from
115 protected $_context = NULL;
118 * prefix for the controller
121 protected $_prefix = "grant_";
123 protected $_defaults;
126 * processing needed for buildForm and later
130 */ function preProcess() {
133 * set the button names
136 $this->_searchButtonName
= $this->getButtonName('refresh');
137 $this->_actionButtonName
= $this->getButtonName('next', 'action');
139 $this->_done
= FALSE;
140 $this->defaults
= array();
143 * we allow the controller to set force/reset externally, useful when we are being
144 * driven by the wizard framework
147 $this->_reset
= CRM_Utils_Request
::retrieve('reset', 'Boolean', CRM_Core_DAO
::$_nullObject);
148 $this->_force
= CRM_Utils_Request
::retrieve('force', 'Boolean', $this, FALSE);
149 $this->_limit
= CRM_Utils_Request
::retrieve('limit', 'Positive', $this);
150 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'search');
152 $this->assign("context", $this->_context
);
154 // get user submitted values
155 // get it from controller only if form has been submitted, else preProcess has set this
156 if (!empty($_POST)) {
157 $this->_formValues
= $this->controller
->exportValues($this->_name
);
160 $this->_formValues
= $this->get('formValues');
163 if (empty($this->_formValues
)) {
164 if (isset($this->_ssID
)) {
165 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
170 $this->postProcess();
171 $this->set('force', 0);
175 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
176 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
177 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
181 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
182 $selector = new CRM_Grant_Selector_Search($this->_queryParams
,
190 if ($this->_context
== 'user') {
191 $prefix = $this->_prefix
;
194 $this->assign("{$prefix}limit", $this->_limit
);
195 $this->assign("{$prefix}single", $this->_single
);
197 $controller = new CRM_Core_Selector_Controller($selector,
198 $this->get(CRM_Utils_Pager
::PAGE_ID
),
200 CRM_Core_Action
::VIEW
,
202 CRM_Core_Selector_Controller
::TRANSFER
,
205 $controller->setEmbedded(TRUE);
206 $controller->moveFromSessionToTemplate();
208 $this->assign('summary', $this->get('summary'));
218 function buildQuickForm() {
219 $this->addElement('text', 'sort_name', ts('Name or Email'), CRM_Core_DAO
::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
221 CRM_Grant_BAO_Query
::buildSearchForm($this);
224 * add form checkboxes for each row. This is needed out here to conform to QF protocol
225 * of all elements being declared in builQuickForm
229 $rows = $this->get('rows');
230 if (is_array($rows)) {
231 CRM_Core_Resources
::singleton()->addScriptFile('civicrm', 'js/crm.livePage.js');
232 if (!$this->_single
) {
233 $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('onchange' => "toggleTaskAction( true ); return toggleCheckboxVals('mark_x_',this);"));
234 foreach ($rows as $row) {
235 $this->addElement('checkbox', CRM_Utils_Array
::value('checkbox', $row),
237 array('onclick' => " toggleTaskAction( true ); return checkSelectedBox('" . CRM_Utils_Array
::value('checkbox', $row) . "');")
239 $grant_id = $row['grant_id'];
243 $total = $cancel = 0;
245 $permission = CRM_Core_Permission
::getPermission();
247 $tasks = array('' => ts('- actions -'));
248 $permissionedTask = CRM_Grant_Task
::permissionedTaskTitles($permission);
249 if (is_array($permissionedTask) && !CRM_Utils_System
::isNull($permissionedTask)) {
250 $tasks +
= $permissionedTask;
253 $this->add('select', 'task', ts('Actions:') . ' ', $tasks);
254 $this->add('submit', $this->_actionButtonName
, ts('Go'),
256 'class' => 'form-submit',
257 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);",
261 // need to perform tasks on all or selected items ? using radio_ts(task selection) for it
262 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked'));
263 $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all', array('onchange' => $this->getName() . ".toggleSelect.checked = false; toggleCheckboxVals('mark_x_',this); toggleTaskAction( true );"));
267 $this->addButtons(array(
270 'name' => ts('Search'),
277 * The post processing of the form gets done here.
279 * Key things done during post processing are
280 * - check for reset or next request. if present, skip post procesing.
281 * - now check if user requested running a saved search, if so, then
282 * the form values associated with the saved search are used for searching.
283 * - if user has done a submit with new values the regular post submissing is
285 * The processing consists of using a Selector / Controller framework for getting the
293 function postProcess() {
300 $this->_formValues
= $this->controller
->exportValues($this->_name
);
301 $this->fixFormValues();
303 if (isset($this->_ssID
) && empty($_POST)) {
304 // if we are editing / running a saved search and the form has not been posted
305 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
308 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
);
310 $this->set('formValues', $this->_formValues
);
311 $this->set('queryParams', $this->_queryParams
);
313 $buttonName = $this->controller
->getButtonName();
314 if ($buttonName == $this->_actionButtonName
) {
315 // check actionName and if next, then do not repeat a search, since we are going to the next page
317 // hack, make sure we reset the task values
318 $stateMachine = $this->controller
->getStateMachine();
319 $formName = $stateMachine->getTaskFormName();
320 $this->controller
->resetPage($formName);
325 if ($this->get(CRM_Utils_Sort
::SORT_ID
)) {
326 $sortID = CRM_Utils_Sort
::sortIDValue($this->get(CRM_Utils_Sort
::SORT_ID
),
327 $this->get(CRM_Utils_Sort
::SORT_DIRECTION
)
332 $selector = new CRM_Grant_Selector_Search($this->_queryParams
,
339 $selector->setKey($this->controller
->_key
);
342 if ($this->_context
== 'basic' ||
$this->_context
== 'user') {
343 $prefix = $this->_prefix
;
346 $controller = new CRM_Core_Selector_Controller($selector,
347 $this->get(CRM_Utils_Pager
::PAGE_ID
),
349 CRM_Core_Action
::VIEW
,
351 CRM_Core_Selector_Controller
::SESSION
,
354 $controller->setEmbedded(TRUE);
356 $query = &$selector->getQuery();
357 if ($this->_context
== 'user') {
358 $query->setSkipPermission(TRUE);
364 * Set the default form values
368 * @return array the default array reference
370 function &setDefaultValues() {
371 return $this->_formValues
;
374 function fixFormValues() {
375 // if this search has been forced
376 // then see if there are any get values, and if so over-ride the post values
377 // note that this means that GET over-rides POST :)
379 if (!$this->_force
) {
383 $status = CRM_Utils_Request
::retrieve('status', 'String',
384 CRM_Core_DAO
::$_nullObject
387 $this->_formValues
['grant_status_id'] = $status;
388 $this->_defaults
['grant_status_id'] = $status;
391 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
394 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
396 $this->_formValues
['contact_id'] = $cid;
398 // also assign individual mode to the template
399 $this->_single
= TRUE;
404 function getFormValues() {
409 * Return a descriptive name for the page, used in wizard header
414 public function getTitle() {
415 return ts('Find Grants');