Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
31 | * @copyright CiviCRM LLC (c) 2004-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Files required | |
38 | */ | |
39 | ||
40 | /** | |
41 | * This file is for civigrant search | |
42 | */ | |
43 | class CRM_Grant_Form_Search extends CRM_Core_Form { | |
44 | ||
45 | /** | |
46 | * Are we forced to run a search | |
47 | * | |
48 | * @var int | |
49 | * @access protected | |
50 | */ | |
51 | protected $_force; | |
52 | ||
53 | /** | |
54 | * name of search button | |
55 | * | |
56 | * @var string | |
57 | * @access protected | |
58 | */ | |
59 | protected $_searchButtonName; | |
60 | ||
61 | /** | |
62 | * name of print button | |
63 | * | |
64 | * @var string | |
65 | * @access protected | |
66 | */ | |
67 | protected $_printButtonName; | |
68 | ||
69 | /** | |
70 | * name of action button | |
71 | * | |
72 | * @var string | |
73 | * @access protected | |
74 | */ | |
75 | protected $_actionButtonName; | |
76 | ||
77 | /** | |
78 | * form values that we will be using | |
79 | * | |
80 | * @var array | |
81 | * @access protected | |
82 | */ | |
83 | protected $_formValues; | |
84 | ||
85 | /** | |
86 | * the params that are sent to the query | |
87 | * | |
88 | * @var array | |
89 | * @access protected | |
90 | */ | |
91 | protected $_queryParams; | |
92 | ||
93 | /** | |
94 | * have we already done this search | |
95 | * | |
96 | * @access protected | |
97 | * @var boolean | |
98 | */ | |
99 | protected $_done; | |
100 | ||
101 | /** | |
102 | * are we restricting ourselves to a single contact | |
103 | * | |
104 | * @access protected | |
105 | * @var boolean | |
106 | */ | |
107 | protected $_single = FALSE; | |
108 | ||
109 | /** | |
110 | * are we restricting ourselves to a single contact | |
111 | * | |
112 | * @access protected | |
113 | * @var boolean | |
114 | */ | |
115 | protected $_limit = NULL; | |
116 | ||
117 | /** | |
118 | * what context are we being invoked from | |
119 | * | |
120 | * @access protected | |
121 | * @var string | |
122 | */ | |
123 | protected $_context = NULL; | |
124 | ||
125 | /** | |
126 | * prefix for the controller | |
127 | * | |
128 | */ | |
129 | protected $_prefix = "grant_"; | |
130 | ||
131 | protected $_defaults; | |
132 | ||
133 | /** | |
134 | * processing needed for buildForm and later | |
135 | * | |
136 | * @return void | |
137 | * @access public | |
138 | */ function preProcess() { | |
139 | ||
140 | /** | |
141 | * set the button names | |
142 | */ | |
143 | ||
144 | $this->_searchButtonName = $this->getButtonName('refresh'); | |
145 | $this->_printButtonName = $this->getButtonName('next', 'print'); | |
146 | $this->_actionButtonName = $this->getButtonName('next', 'action'); | |
147 | ||
148 | $this->_done = FALSE; | |
149 | $this->defaults = array(); | |
150 | ||
151 | /* | |
152 | * we allow the controller to set force/reset externally, useful when we are being | |
153 | * driven by the wizard framework | |
154 | */ | |
155 | ||
156 | $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject); | |
157 | $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE); | |
158 | $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this); | |
159 | $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search'); | |
160 | ||
161 | $this->assign("context", $this->_context); | |
162 | ||
163 | // get user submitted values | |
164 | // get it from controller only if form has been submitted, else preProcess has set this | |
165 | if (!empty($_POST)) { | |
166 | $this->_formValues = $this->controller->exportValues($this->_name); | |
167 | } | |
168 | else { | |
169 | $this->_formValues = $this->get('formValues'); | |
170 | } | |
171 | ||
172 | if (empty($this->_formValues)) { | |
173 | if (isset($this->_ssID)) { | |
174 | $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID); | |
175 | } | |
176 | } | |
177 | ||
178 | if ($this->_force) { | |
179 | $this->postProcess(); | |
180 | $this->set('force', 0); | |
181 | } | |
182 | ||
183 | $sortID = NULL; | |
184 | if ($this->get(CRM_Utils_Sort::SORT_ID)) { | |
185 | $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID), | |
186 | $this->get(CRM_Utils_Sort::SORT_DIRECTION) | |
187 | ); | |
188 | } | |
189 | ||
190 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues); | |
191 | $selector = new CRM_Grant_Selector_Search($this->_queryParams, | |
192 | $this->_action, | |
193 | NULL, | |
194 | $this->_single, | |
195 | $this->_limit, | |
196 | $this->_context | |
197 | ); | |
198 | $prefix = NULL; | |
199 | if ($this->_context == 'user') { | |
200 | $prefix = $this->_prefix; | |
201 | } | |
202 | ||
203 | $this->assign("{$prefix}limit", $this->_limit); | |
204 | $this->assign("{$prefix}single", $this->_single); | |
205 | ||
206 | $controller = new CRM_Core_Selector_Controller($selector, | |
207 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
208 | $sortID, | |
209 | CRM_Core_Action::VIEW, | |
210 | $this, | |
211 | CRM_Core_Selector_Controller::TRANSFER, | |
212 | $prefix | |
213 | ); | |
214 | $controller->setEmbedded(TRUE); | |
215 | $controller->moveFromSessionToTemplate(); | |
216 | ||
217 | $this->assign('summary', $this->get('summary')); | |
218 | } | |
219 | ||
220 | /** | |
221 | * Build the form | |
222 | * | |
223 | * @access public | |
224 | * | |
225 | * @return void | |
226 | */ | |
227 | function buildQuickForm() { | |
228 | $this->addElement('text', 'sort_name', ts('Name or Email'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name')); | |
229 | ||
230 | CRM_Grant_BAO_Query::buildSearchForm($this); | |
231 | ||
232 | /* | |
233 | * add form checkboxes for each row. This is needed out here to conform to QF protocol | |
234 | * of all elements being declared in builQuickForm | |
235 | */ | |
236 | ||
237 | ||
238 | $rows = $this->get('rows'); | |
239 | if (is_array($rows)) { | |
240 | if (!$this->_single) { | |
241 | $this->addElement('checkbox', 'toggleSelect', NULL, NULL, array('onchange' => "toggleTaskAction( true ); return toggleCheckboxVals('mark_x_',this);")); | |
242 | foreach ($rows as $row) { | |
243 | $this->addElement('checkbox', CRM_Utils_Array::value('checkbox', $row), | |
244 | NULL, NULL, | |
245 | array('onclick' => " toggleTaskAction( true ); return checkSelectedBox('" . CRM_Utils_Array::value('checkbox', $row) . "');") | |
246 | ); | |
247 | $grant_id = $row['grant_id']; | |
248 | } | |
249 | } | |
250 | ||
251 | $total = $cancel = 0; | |
252 | ||
253 | $permission = CRM_Core_Permission::getPermission(); | |
254 | ||
255 | $tasks = array('' => ts('- actions -')); | |
256 | $permissionedTask = CRM_Grant_Task::permissionedTaskTitles($permission); | |
257 | if (is_array($permissionedTask) && !CRM_Utils_System::isNull($permissionedTask)) { | |
258 | $tasks += $permissionedTask; | |
259 | } | |
260 | ||
261 | $this->add('select', 'task', ts('Actions:') . ' ', $tasks); | |
262 | $this->add('submit', $this->_actionButtonName, ts('Go'), | |
263 | array( | |
264 | 'class' => 'form-submit', | |
265 | 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 0);", | |
266 | ) | |
267 | ); | |
268 | ||
269 | $this->add('submit', $this->_printButtonName, ts('Print'), | |
270 | array( | |
271 | 'class' => 'form-submit', | |
272 | 'onclick' => "return checkPerformAction('mark_x', '" . $this->getName() . "', 1);", | |
273 | ) | |
274 | ); | |
275 | ||
276 | // need to perform tasks on all or selected items ? using radio_ts(task selection) for it | |
277 | $this->addElement('radio', 'radio_ts', NULL, '', 'ts_sel', array('checked' => 'checked')); | |
278 | $this->addElement('radio', 'radio_ts', NULL, '', 'ts_all', array('onchange' => $this->getName() . ".toggleSelect.checked = false; toggleCheckboxVals('mark_x_',this); toggleTaskAction( true );")); | |
279 | } | |
280 | ||
281 | // add buttons | |
282 | $this->addButtons(array( | |
283 | array( | |
284 | 'type' => 'refresh', | |
285 | 'name' => ts('Search'), | |
286 | 'isDefault' => TRUE, | |
287 | ), | |
288 | )); | |
289 | } | |
290 | ||
291 | /** | |
292 | * The post processing of the form gets done here. | |
293 | * | |
294 | * Key things done during post processing are | |
295 | * - check for reset or next request. if present, skip post procesing. | |
296 | * - now check if user requested running a saved search, if so, then | |
297 | * the form values associated with the saved search are used for searching. | |
298 | * - if user has done a submit with new values the regular post submissing is | |
299 | * done. | |
300 | * The processing consists of using a Selector / Controller framework for getting the | |
301 | * search results. | |
302 | * | |
303 | * @param | |
304 | * | |
305 | * @return void | |
306 | * @access public | |
307 | */ | |
308 | function postProcess() { | |
309 | if ($this->_done) { | |
310 | return; | |
311 | } | |
312 | ||
313 | $this->_done = TRUE; | |
314 | ||
315 | $this->_formValues = $this->controller->exportValues($this->_name); | |
316 | $this->fixFormValues(); | |
317 | ||
318 | if (isset($this->_ssID) && empty($_POST)) { | |
319 | // if we are editing / running a saved search and the form has not been posted | |
320 | $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID); | |
321 | } | |
322 | ||
323 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues); | |
324 | ||
325 | $this->set('formValues', $this->_formValues); | |
326 | $this->set('queryParams', $this->_queryParams); | |
327 | ||
328 | $buttonName = $this->controller->getButtonName(); | |
329 | if ($buttonName == $this->_actionButtonName || $buttonName == $this->_printButtonName) { | |
330 | // check actionName and if next, then do not repeat a search, since we are going to the next page | |
331 | ||
332 | // hack, make sure we reset the task values | |
333 | $stateMachine = &$this->controller->getStateMachine(); | |
334 | $formName = $stateMachine->getTaskFormName(); | |
335 | $this->controller->resetPage($formName); | |
336 | return; | |
337 | } | |
338 | ||
339 | $sortID = NULL; | |
340 | if ($this->get(CRM_Utils_Sort::SORT_ID)) { | |
341 | $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID), | |
342 | $this->get(CRM_Utils_Sort::SORT_DIRECTION) | |
343 | ); | |
344 | } | |
345 | ||
346 | ||
347 | $selector = new CRM_Grant_Selector_Search($this->_queryParams, | |
348 | $this->_action, | |
349 | NULL, | |
350 | $this->_single, | |
351 | $this->_limit, | |
352 | $this->_context | |
353 | ); | |
354 | $selector->setKey($this->controller->_key); | |
355 | ||
356 | $prefix = NULL; | |
357 | if ($this->_context == 'basic' || $this->_context == 'user') { | |
358 | $prefix = $this->_prefix; | |
359 | } | |
360 | ||
361 | $controller = new CRM_Core_Selector_Controller($selector, | |
362 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
363 | $sortID, | |
364 | CRM_Core_Action::VIEW, | |
365 | $this, | |
366 | CRM_Core_Selector_Controller::SESSION, | |
367 | $prefix | |
368 | ); | |
369 | $controller->setEmbedded(TRUE); | |
370 | ||
371 | $query = &$selector->getQuery(); | |
372 | if ($this->_context == 'user') { | |
373 | $query->setSkipPermission(TRUE); | |
374 | } | |
375 | $controller->run(); | |
376 | } | |
377 | ||
378 | /** | |
379 | * Set the default form values | |
380 | * | |
381 | * @access protected | |
382 | * | |
383 | * @return array the default array reference | |
384 | */ | |
385 | function &setDefaultValues() { | |
386 | return $this->_formValues; | |
387 | } | |
388 | ||
389 | function fixFormValues() { | |
390 | // if this search has been forced | |
391 | // then see if there are any get values, and if so over-ride the post values | |
392 | // note that this means that GET over-rides POST :) | |
393 | ||
394 | if (!$this->_force) { | |
395 | return; | |
396 | } | |
397 | ||
398 | $status = CRM_Utils_Request::retrieve('status', 'String', | |
399 | CRM_Core_DAO::$_nullObject | |
400 | ); | |
401 | if ($status) { | |
402 | $this->_formValues['grant_status_id'] = $status; | |
403 | $this->_defaults['grant_status_id'] = $status; | |
404 | } | |
405 | ||
406 | $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this); | |
407 | ||
408 | if ($cid) { | |
409 | $cid = CRM_Utils_Type::escape($cid, 'Integer'); | |
410 | if ($cid > 0) { | |
411 | $this->_formValues['contact_id'] = $cid; | |
412 | ||
413 | // also assign individual mode to the template | |
414 | $this->_single = TRUE; | |
415 | } | |
416 | } | |
417 | } | |
418 | ||
419 | function getFormValues() { | |
420 | return NULL; | |
421 | } | |
422 | ||
423 | /** | |
424 | * Return a descriptive name for the page, used in wizard header | |
425 | * | |
426 | * @return string | |
427 | * @access public | |
428 | */ | |
429 | public function getTitle() { | |
430 | return ts('Find Grants'); | |
431 | } | |
432 | } | |
433 |