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