Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
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, | | |
a5611c8e | 24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
6a488035 | 25 | +--------------------------------------------------------------------+ |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Files required | |
38 | */ | |
39 | ||
40 | /** | |
41 | * This file is for civievent search | |
42 | */ | |
3efb5b86 | 43 | class CRM_Event_Form_Search extends CRM_Core_Form_Search { |
6a488035 | 44 | |
6a488035 | 45 | /** |
66f9e52b | 46 | * The params that are sent to the query. |
6a488035 TO |
47 | * |
48 | * @var array | |
6a488035 TO |
49 | */ |
50 | protected $_queryParams; | |
51 | ||
6a488035 | 52 | /** |
66f9e52b | 53 | * Are we restricting ourselves to a single contact. |
6a488035 | 54 | * |
6a488035 TO |
55 | * @var boolean |
56 | */ | |
57 | protected $_single = FALSE; | |
58 | ||
59 | /** | |
66f9e52b | 60 | * Are we restricting ourselves to a single contact. |
6a488035 | 61 | * |
6a488035 TO |
62 | * @var boolean |
63 | */ | |
64 | protected $_limit = NULL; | |
65 | ||
6a488035 | 66 | /** |
66f9e52b | 67 | * Prefix for the controller. |
6a488035 TO |
68 | */ |
69 | protected $_prefix = "event_"; | |
70 | ||
71 | protected $_defaults; | |
72 | ||
73 | /** | |
66f9e52b | 74 | * The saved search ID retrieved from the GET vars. |
6a488035 TO |
75 | * |
76 | * @var int | |
6a488035 TO |
77 | */ |
78 | protected $_ssID; | |
79 | ||
80 | /** | |
66f9e52b | 81 | * Processing needed for buildForm and later. |
6a488035 TO |
82 | * |
83 | * @return void | |
6a488035 | 84 | */ |
00be9182 | 85 | public function preProcess() { |
6a488035 TO |
86 | $this->set('searchFormName', 'Search'); |
87 | ||
88 | /** | |
89 | * set the button names | |
90 | */ | |
91 | $this->_searchButtonName = $this->getButtonName('refresh'); | |
6a488035 TO |
92 | $this->_actionButtonName = $this->getButtonName('next', 'action'); |
93 | ||
94 | $this->_done = FALSE; | |
95 | $this->defaults = array(); | |
96 | ||
a5611c8e DL |
97 | /* |
98 | * we allow the controller to set force/reset externally, useful when we are being | |
99 | * driven by the wizard framework | |
6a488035 | 100 | */ |
353ffa53 TO |
101 | $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject); |
102 | $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE); | |
103 | $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this); | |
6a488035 | 104 | $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search'); |
353ffa53 | 105 | $this->_ssID = CRM_Utils_Request::retrieve('ssID', 'Positive', $this); |
6a488035 TO |
106 | $this->assign("context", $this->_context); |
107 | ||
108 | // get user submitted values | |
109 | // get it from controller only if form has been submitted, else preProcess has set this | |
110 | if (!empty($_POST) && !$this->controller->isModal()) { | |
111 | $this->_formValues = $this->controller->exportValues($this->_name); | |
112 | } | |
113 | else { | |
114 | $this->_formValues = $this->get('formValues'); | |
115 | } | |
116 | ||
117 | if (empty($this->_formValues)) { | |
118 | if (isset($this->_ssID)) { | |
119 | $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID); | |
120 | } | |
121 | } | |
122 | ||
123 | if ($this->_force) { | |
124 | $this->postProcess(); | |
125 | $this->set('force', 0); | |
126 | } | |
127 | ||
128 | $sortID = NULL; | |
129 | if ($this->get(CRM_Utils_Sort::SORT_ID)) { | |
130 | $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID), | |
131 | $this->get(CRM_Utils_Sort::SORT_DIRECTION) | |
132 | ); | |
133 | } | |
134 | ||
135 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues); | |
136 | $selector = new CRM_Event_Selector_Search($this->_queryParams, | |
137 | $this->_action, | |
138 | NULL, | |
139 | $this->_single, | |
140 | $this->_limit, | |
141 | $this->_context | |
142 | ); | |
143 | $prefix = NULL; | |
144 | if ($this->_context == 'user') { | |
145 | $prefix = $this->_prefix; | |
146 | } | |
147 | ||
148 | $this->assign("{$prefix}limit", $this->_limit); | |
149 | $this->assign("{$prefix}single", $this->_single); | |
150 | ||
151 | $controller = new CRM_Core_Selector_Controller($selector, | |
152 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
153 | $sortID, | |
154 | CRM_Core_Action::VIEW, | |
155 | $this, | |
156 | CRM_Core_Selector_Controller::TRANSFER, | |
157 | $prefix | |
158 | ); | |
159 | $controller->setEmbedded(TRUE); | |
160 | $controller->moveFromSessionToTemplate(); | |
161 | ||
162 | $this->assign('summary', $this->get('summary')); | |
163 | } | |
164 | ||
165 | /** | |
66f9e52b | 166 | * Build the form object. |
6a488035 | 167 | * |
6a488035 TO |
168 | * |
169 | * @return void | |
170 | */ | |
00be9182 | 171 | public function buildQuickForm() { |
3efb5b86 | 172 | parent::buildQuickForm(); |
6a488035 TO |
173 | $this->addElement('text', 'sort_name', ts('Participant Name or Email'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name')); |
174 | ||
175 | CRM_Event_BAO_Query::buildSearchForm($this); | |
176 | ||
6a488035 TO |
177 | $rows = $this->get('rows'); |
178 | if (is_array($rows)) { | |
179 | $lineItems = $eventIds = array(); | |
180 | if (!$this->_single) { | |
8d36b801 | 181 | $this->addRowSelectors($rows); |
6a488035 TO |
182 | } |
183 | foreach ($rows as $row) { | |
184 | $eventIds[$row['event_id']] = $row['event_id']; | |
6a488035 TO |
185 | if (CRM_Event_BAO_Event::usesPriceSet($row['event_id'])) { |
186 | // add line item details if applicable | |
187 | $lineItems[$row['participant_id']] = CRM_Price_BAO_LineItem::getLineItems($row['participant_id']); | |
188 | } | |
189 | } | |
190 | ||
191 | //get actual count only when we are dealing w/ single event. | |
192 | $participantCount = 0; | |
193 | if (count($eventIds) == 1) { | |
194 | //convert form values to clause. | |
195 | $seatClause = array(); | |
884fdc63 | 196 | if (CRM_Utils_Array::value('participant_test', $this->_formValues) == '1' || CRM_Utils_Array::value('participant_test', $this->_formValues) == '0') { |
197 | $seatClause[] = "( participant.is_test = {$this->_formValues['participant_test']} )"; | |
198 | } | |
199 | if (!empty($this->_formValues['participant_status_id'])) { | |
ef36db8b | 200 | $seatClause[] = CRM_Contact_BAO_Query::buildClause("participant.status_id", '=', $this->_formValues['participant_status_id'], 'Int'); |
201 | if ($status = CRM_Utils_Array::value('IN', $this->_formValues['participant_status_id'])) { | |
202 | $this->_formValues['participant_status_id'] = $status; | |
203 | } | |
884fdc63 | 204 | } |
205 | if (!empty($this->_formValues['participant_role_id'])) { | |
d5bd1f7e | 206 | $seatClause[] = '( participant.role_id IN ( ' . implode(' , ', (array) $this->_formValues['participant_role_id']) . ' ) )'; |
884fdc63 | 207 | } |
208 | ||
7c75c017 | 209 | // CRM-15379 |
210 | if (!empty($this->_formValues['participant_fee_id'])) { | |
211 | $participant_fee_id = $this->_formValues['participant_fee_id']; | |
212 | $feeLabel = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $participant_fee_id, 'label'); | |
213 | $feeLabel = CRM_Core_DAO::escapeString(trim($feeLabel)); | |
884fdc63 | 214 | $seatClause[] = "( participant.fee_level LIKE '%$feeLabel%' )"; |
6a488035 | 215 | } |
59adcdd9 | 216 | |
884fdc63 | 217 | $seatClause = implode(' AND ', $seatClause); |
218 | $participantCount = CRM_Event_BAO_Event::eventTotalSeats(array_pop($eventIds), $seatClause); | |
6a488035 TO |
219 | } |
220 | $this->assign('participantCount', $participantCount); | |
221 | $this->assign('lineItems', $lineItems); | |
222 | ||
6a488035 TO |
223 | $permission = CRM_Core_Permission::getPermission(); |
224 | ||
34197a55 | 225 | $tasks = CRM_Event_Task::permissionedTaskTitles($permission); |
6a488035 TO |
226 | if (isset($this->_ssID)) { |
227 | if ($permission == CRM_Core_Permission::EDIT) { | |
228 | $tasks = $tasks + CRM_Event_Task::optionalTaskTitle(); | |
229 | } | |
230 | ||
231 | $savedSearchValues = array( | |
232 | 'id' => $this->_ssID, | |
233 | 'name' => CRM_Contact_BAO_SavedSearch::getName($this->_ssID, 'title'), | |
234 | ); | |
235 | $this->assign_by_ref('savedSearch', $savedSearchValues); | |
236 | $this->assign('ssID', $this->_ssID); | |
237 | } | |
238 | ||
34197a55 | 239 | $this->addTaskMenu($tasks); |
6a488035 TO |
240 | } |
241 | ||
6a488035 TO |
242 | } |
243 | ||
244 | /** | |
245 | * The post processing of the form gets done here. | |
246 | * | |
247 | * Key things done during post processing are | |
248 | * - check for reset or next request. if present, skip post procesing. | |
249 | * - now check if user requested running a saved search, if so, then | |
250 | * the form values associated with the saved search are used for searching. | |
251 | * - if user has done a submit with new values the regular post submissing is | |
252 | * done. | |
253 | * The processing consists of using a Selector / Controller framework for getting the | |
254 | * search results. | |
255 | * | |
256 | * @param | |
257 | * | |
258 | * @return void | |
6a488035 | 259 | */ |
00be9182 | 260 | public function postProcess() { |
6a488035 TO |
261 | if ($this->_done) { |
262 | return; | |
263 | } | |
264 | ||
265 | $this->_done = TRUE; | |
266 | ||
267 | if (!empty($_POST)) { | |
268 | $this->_formValues = $this->controller->exportValues($this->_name); | |
269 | } | |
270 | ||
271 | if (empty($this->_formValues)) { | |
272 | $this->_formValues = $this->controller->exportValues($this->_name); | |
273 | } | |
274 | ||
275 | $this->fixFormValues(); | |
276 | ||
277 | if (isset($this->_ssID) && empty($_POST)) { | |
278 | // if we are editing / running a saved search and the form has not been posted | |
279 | $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID); | |
280 | } | |
281 | ||
d43b88cc CW |
282 | // We don't show test records in summaries or dashboards |
283 | if (empty($this->_formValues['participant_test']) && $this->_force) { | |
6a488035 TO |
284 | $this->_formValues["participant_test"] = 0; |
285 | } | |
286 | ||
c94d39fd | 287 | CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues); |
6a488035 TO |
288 | |
289 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues); | |
290 | ||
291 | $this->set('formValues', $this->_formValues); | |
292 | $this->set('queryParams', $this->_queryParams); | |
293 | ||
294 | $buttonName = $this->controller->getButtonName(); | |
e341bbee | 295 | if ($buttonName == $this->_actionButtonName) { |
6a488035 TO |
296 | // check actionName and if next, then do not repeat a search, since we are going to the next page |
297 | ||
298 | // hack, make sure we reset the task values | |
a5611c8e | 299 | $stateMachine = $this->controller->getStateMachine(); |
6a488035 TO |
300 | $formName = $stateMachine->getTaskFormName(); |
301 | $this->controller->resetPage($formName); | |
302 | return; | |
303 | } | |
304 | ||
305 | $sortID = NULL; | |
306 | if ($this->get(CRM_Utils_Sort::SORT_ID)) { | |
307 | $sortID = CRM_Utils_Sort::sortIDValue($this->get(CRM_Utils_Sort::SORT_ID), | |
308 | $this->get(CRM_Utils_Sort::SORT_DIRECTION) | |
309 | ); | |
310 | } | |
311 | ||
312 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues); | |
313 | ||
314 | $selector = new CRM_Event_Selector_Search($this->_queryParams, | |
315 | $this->_action, | |
316 | NULL, | |
317 | $this->_single, | |
318 | $this->_limit, | |
319 | $this->_context | |
320 | ); | |
321 | ||
322 | $selector->setKey($this->controller->_key); | |
323 | ||
324 | $prefix = NULL; | |
325 | if ($this->_context == 'user') { | |
326 | $prefix = $this->_prefix; | |
327 | } | |
328 | ||
329 | $this->assign("{$prefix}limit", $this->_limit); | |
330 | $this->assign("{$prefix}single", $this->_single); | |
331 | ||
332 | $controller = new CRM_Core_Selector_Controller($selector, | |
333 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
334 | $sortID, | |
335 | CRM_Core_Action::VIEW, | |
336 | $this, | |
337 | CRM_Core_Selector_Controller::SESSION, | |
338 | $prefix | |
339 | ); | |
340 | $controller->setEmbedded(TRUE); | |
341 | ||
a5611c8e | 342 | $query = $selector->getQuery(); |
6a488035 TO |
343 | if ($this->_context == 'user') { |
344 | $query->setSkipPermission(TRUE); | |
345 | } | |
346 | $controller->run(); | |
347 | } | |
348 | ||
349 | /** | |
dc195289 | 350 | * add the rules (mainly global rules) for form. |
6a488035 TO |
351 | * All local rules are added near the element |
352 | * | |
355ba699 | 353 | * @return void |
6a488035 TO |
354 | * @see valid_date |
355 | */ | |
6ea503d4 TO |
356 | public function addRules() { |
357 | } | |
6a488035 TO |
358 | |
359 | /** | |
66f9e52b | 360 | * Set the default form values. |
6a488035 | 361 | * |
6a488035 | 362 | * |
a6c01b45 CW |
363 | * @return array |
364 | * the default array reference | |
6a488035 | 365 | */ |
00be9182 | 366 | public function setDefaultValues() { |
6a488035 TO |
367 | $defaults = array(); |
368 | $defaults = $this->_formValues; | |
369 | return $defaults; | |
370 | } | |
371 | ||
00be9182 | 372 | public function fixFormValues() { |
6a488035 TO |
373 | // if this search has been forced |
374 | // then see if there are any get values, and if so over-ride the post values | |
375 | // note that this means that GET over-rides POST :) | |
376 | $event = CRM_Utils_Request::retrieve('event', 'Positive', | |
377 | CRM_Core_DAO::$_nullObject | |
378 | ); | |
379 | if ($event) { | |
380 | $this->_formValues['event_id'] = $event; | |
381 | $this->_formValues['event_name'] = CRM_Event_PseudoConstant::event($event, TRUE); | |
382 | } | |
383 | ||
384 | $status = CRM_Utils_Request::retrieve('status', 'String', | |
385 | CRM_Core_DAO::$_nullObject | |
386 | ); | |
387 | ||
388 | if (isset($status)) { | |
389 | if ($status === 'true') { | |
d5bd1f7e | 390 | $statusTypes = CRM_Event_PseudoConstant::participantStatus(NULL, "is_counted = 1"); |
6a488035 TO |
391 | } |
392 | elseif ($status === 'false') { | |
d5bd1f7e | 393 | $statusTypes = CRM_Event_PseudoConstant::participantStatus(NULL, "is_counted = 0"); |
6a488035 TO |
394 | } |
395 | elseif (is_numeric($status)) { | |
53133bb0 | 396 | $statusTypes = (int) $status; |
6a488035 | 397 | } |
ef36db8b | 398 | |
399 | $this->_formValues['participant_status_id'] = is_array($statusTypes) ? array('IN' => array_keys($statusTypes)) : $statusTypes; | |
400 | } | |
401 | elseif ($statusTypes = CRM_Utils_Array::value('participant_status_id', $this->_formValues)) { | |
402 | $this->_formValues['participant_status_id'] = is_array($statusTypes) ? array('IN' => $statusTypes) : $statusTypes; | |
6a488035 TO |
403 | } |
404 | ||
405 | $role = CRM_Utils_Request::retrieve('role', 'String', | |
406 | CRM_Core_DAO::$_nullObject | |
407 | ); | |
408 | ||
409 | if (isset($role)) { | |
410 | if ($role === 'true') { | |
4b191b48 | 411 | $roleTypes = CRM_Event_PseudoConstant::participantRole(NULL, "filter = 1"); |
6a488035 TO |
412 | } |
413 | elseif ($role === 'false') { | |
4b191b48 | 414 | $roleTypes = CRM_Event_PseudoConstant::participantRole(NULL, "filter = 0"); |
6a488035 TO |
415 | } |
416 | elseif (is_numeric($role)) { | |
53133bb0 | 417 | $roleTypes = (int) $role; |
6a488035 | 418 | } |
d5bd1f7e | 419 | $this->_formValues['participant_role_id'] = is_array($roleTypes) ? array_keys($roleTypes) : $roleTypes; |
53133bb0 | 420 | } |
421 | ||
6a488035 TO |
422 | $type = CRM_Utils_Request::retrieve('type', 'Positive', |
423 | CRM_Core_DAO::$_nullObject | |
424 | ); | |
425 | if ($type) { | |
426 | $this->_formValues['event_type'] = $type; | |
427 | } | |
428 | ||
429 | $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this); | |
430 | ||
431 | if ($cid) { | |
432 | $cid = CRM_Utils_Type::escape($cid, 'Integer'); | |
433 | if ($cid > 0) { | |
434 | $this->_formValues['contact_id'] = $cid; | |
435 | ||
436 | // also assign individual mode to the template | |
437 | $this->_single = TRUE; | |
438 | } | |
439 | } | |
440 | } | |
441 | ||
0cf587a7 EM |
442 | /** |
443 | * @return null | |
444 | */ | |
00be9182 | 445 | public function getFormValues() { |
6a488035 TO |
446 | return NULL; |
447 | } | |
448 | ||
449 | /** | |
450 | * Return a descriptive name for the page, used in wizard header | |
451 | * | |
452 | * @return string | |
6a488035 TO |
453 | */ |
454 | public function getTitle() { | |
455 | return ts('Find Participants'); | |
456 | } | |
96025800 | 457 | |
6a488035 | 458 | } |