Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | ||
6a488035 TO |
18 | /** |
19 | * This file is for civievent search | |
20 | */ | |
3efb5b86 | 21 | class CRM_Event_Form_Search extends CRM_Core_Form_Search { |
6a488035 | 22 | |
6a488035 | 23 | /** |
66f9e52b | 24 | * The params that are sent to the query. |
6a488035 TO |
25 | * |
26 | * @var array | |
6a488035 TO |
27 | */ |
28 | protected $_queryParams; | |
29 | ||
6a488035 | 30 | /** |
66f9e52b | 31 | * Are we restricting ourselves to a single contact. |
6a488035 | 32 | * |
d51c6add | 33 | * @var bool |
6a488035 TO |
34 | */ |
35 | protected $_single = FALSE; | |
36 | ||
37 | /** | |
66f9e52b | 38 | * Are we restricting ourselves to a single contact. |
6a488035 | 39 | * |
d51c6add | 40 | * @var bool |
6a488035 TO |
41 | */ |
42 | protected $_limit = NULL; | |
43 | ||
6a488035 | 44 | /** |
66f9e52b | 45 | * Prefix for the controller. |
90b461f1 | 46 | * @var string |
6a488035 TO |
47 | */ |
48 | protected $_prefix = "event_"; | |
49 | ||
6a488035 | 50 | /** |
66f9e52b | 51 | * The saved search ID retrieved from the GET vars. |
6a488035 TO |
52 | * |
53 | * @var int | |
6a488035 TO |
54 | */ |
55 | protected $_ssID; | |
56 | ||
61b4d091 | 57 | /** |
58 | * Metadata of all fields to include on the form. | |
59 | * | |
60 | * @var array | |
61 | */ | |
62 | protected $searchFieldMetadata = []; | |
63 | ||
61b4d091 | 64 | /** |
8a6fde27 | 65 | * Get the default entity for the form. |
66 | * | |
61b4d091 | 67 | * @return string |
68 | */ | |
69 | public function getDefaultEntity() { | |
70 | return 'Participant'; | |
71 | } | |
72 | ||
6a488035 | 73 | /** |
66f9e52b | 74 | * Processing needed for buildForm and later. |
6a488035 TO |
75 | * |
76 | * @return void | |
1d81be90 | 77 | * |
78 | * @throws \CRM_Core_Exception | |
79 | * @throws \CiviCRM_API3_Exception | |
6a488035 | 80 | */ |
00be9182 | 81 | public function preProcess() { |
6a488035 TO |
82 | $this->set('searchFormName', 'Search'); |
83 | ||
84 | /** | |
85 | * set the button names | |
86 | */ | |
6a488035 TO |
87 | $this->_actionButtonName = $this->getButtonName('next', 'action'); |
88 | ||
89 | $this->_done = FALSE; | |
6a488035 | 90 | |
1d81be90 | 91 | parent::preProcess(); |
6a488035 | 92 | |
be2fb01f | 93 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, ['event_id']); |
6a488035 TO |
94 | $selector = new CRM_Event_Selector_Search($this->_queryParams, |
95 | $this->_action, | |
96 | NULL, | |
97 | $this->_single, | |
98 | $this->_limit, | |
99 | $this->_context | |
100 | ); | |
101 | $prefix = NULL; | |
86f20cc1 | 102 | if ($this->_context === 'user') { |
6a488035 TO |
103 | $prefix = $this->_prefix; |
104 | } | |
105 | ||
106 | $this->assign("{$prefix}limit", $this->_limit); | |
107 | $this->assign("{$prefix}single", $this->_single); | |
108 | ||
109 | $controller = new CRM_Core_Selector_Controller($selector, | |
110 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
b5c63125 | 111 | $this->getSortID(), |
6a488035 TO |
112 | CRM_Core_Action::VIEW, |
113 | $this, | |
114 | CRM_Core_Selector_Controller::TRANSFER, | |
115 | $prefix | |
116 | ); | |
117 | $controller->setEmbedded(TRUE); | |
118 | $controller->moveFromSessionToTemplate(); | |
119 | ||
120 | $this->assign('summary', $this->get('summary')); | |
121 | } | |
122 | ||
123 | /** | |
66f9e52b | 124 | * Build the form object. |
6a488035 | 125 | * |
6a488035 | 126 | * @return void |
61b4d091 | 127 | * |
128 | * @throws \CRM_Core_Exception | |
86f20cc1 | 129 | * @throws \CiviCRM_API3_Exception |
6a488035 | 130 | */ |
00be9182 | 131 | public function buildQuickForm() { |
3efb5b86 | 132 | parent::buildQuickForm(); |
0573fd28 | 133 | $this->addContactSearchFields(); |
48242ab6 | 134 | |
6a488035 TO |
135 | CRM_Event_BAO_Query::buildSearchForm($this); |
136 | ||
6a488035 TO |
137 | $rows = $this->get('rows'); |
138 | if (is_array($rows)) { | |
be2fb01f | 139 | $lineItems = $eventIds = []; |
6a488035 | 140 | if (!$this->_single) { |
8d36b801 | 141 | $this->addRowSelectors($rows); |
6a488035 TO |
142 | } |
143 | foreach ($rows as $row) { | |
144 | $eventIds[$row['event_id']] = $row['event_id']; | |
6a488035 TO |
145 | if (CRM_Event_BAO_Event::usesPriceSet($row['event_id'])) { |
146 | // add line item details if applicable | |
147 | $lineItems[$row['participant_id']] = CRM_Price_BAO_LineItem::getLineItems($row['participant_id']); | |
148 | } | |
149 | } | |
150 | ||
151 | //get actual count only when we are dealing w/ single event. | |
152 | $participantCount = 0; | |
153 | if (count($eventIds) == 1) { | |
154 | //convert form values to clause. | |
be2fb01f | 155 | $seatClause = []; |
884fdc63 | 156 | if (CRM_Utils_Array::value('participant_test', $this->_formValues) == '1' || CRM_Utils_Array::value('participant_test', $this->_formValues) == '0') { |
157 | $seatClause[] = "( participant.is_test = {$this->_formValues['participant_test']} )"; | |
158 | } | |
159 | if (!empty($this->_formValues['participant_status_id'])) { | |
f14010f5 | 160 | $seatClause[] = CRM_Contact_BAO_Query::buildClause("participant.status_id", 'IN', $this->_formValues['participant_status_id'], 'Int'); |
ef36db8b | 161 | if ($status = CRM_Utils_Array::value('IN', $this->_formValues['participant_status_id'])) { |
162 | $this->_formValues['participant_status_id'] = $status; | |
163 | } | |
884fdc63 | 164 | } |
165 | if (!empty($this->_formValues['participant_role_id'])) { | |
be2fb01f | 166 | $escapedRoles = []; |
0906de17 MM |
167 | foreach ((array) $this->_formValues['participant_role_id'] as $participantRole) { |
168 | $escapedRoles[] = CRM_Utils_Type::escape($participantRole, 'String'); | |
169 | } | |
aba574d4 | 170 | $seatClause[] = "( participant.role_id IN ( '" . implode("' , '", $escapedRoles) . "' ) )"; |
884fdc63 | 171 | } |
172 | ||
7c75c017 | 173 | // CRM-15379 |
174 | if (!empty($this->_formValues['participant_fee_id'])) { | |
175 | $participant_fee_id = $this->_formValues['participant_fee_id']; | |
6bc9b1f6 | 176 | $val_regexp = []; |
f179424e | 177 | foreach ($participant_fee_id as $k => &$val) { |
178 | $val = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $val, 'label'); | |
6bc9b1f6 | 179 | $val_regexp[$k] = CRM_Core_DAO::escapeString(preg_quote(trim($val))); |
f179424e | 180 | $val = CRM_Core_DAO::escapeString(trim($val)); |
181 | } | |
6bc9b1f6 | 182 | $feeLabel = implode('|', $val_regexp); |
f179424e | 183 | $seatClause[] = "( participant.fee_level REGEXP '{$feeLabel}' )"; |
6a488035 | 184 | } |
59adcdd9 | 185 | |
884fdc63 | 186 | $seatClause = implode(' AND ', $seatClause); |
187 | $participantCount = CRM_Event_BAO_Event::eventTotalSeats(array_pop($eventIds), $seatClause); | |
6a488035 TO |
188 | } |
189 | $this->assign('participantCount', $participantCount); | |
190 | $this->assign('lineItems', $lineItems); | |
191 | ||
2e1f50d6 | 192 | $taskParams['ssID'] = $this->_ssID ?? NULL; |
8fd26836 | 193 | $tasks = CRM_Event_Task::permissionedTaskTitles(CRM_Core_Permission::getPermission(), $taskParams); |
6a488035 | 194 | |
6a488035 | 195 | if (isset($this->_ssID)) { |
be2fb01f | 196 | $savedSearchValues = [ |
6a488035 TO |
197 | 'id' => $this->_ssID, |
198 | 'name' => CRM_Contact_BAO_SavedSearch::getName($this->_ssID, 'title'), | |
be2fb01f | 199 | ]; |
6a488035 TO |
200 | $this->assign_by_ref('savedSearch', $savedSearchValues); |
201 | $this->assign('ssID', $this->_ssID); | |
202 | } | |
203 | ||
34197a55 | 204 | $this->addTaskMenu($tasks); |
6a488035 TO |
205 | } |
206 | ||
6a488035 TO |
207 | } |
208 | ||
e597fc33 DG |
209 | /** |
210 | * Get the label for the sortName field if email searching is on. | |
211 | * | |
212 | * (email searching is a setting under search preferences). | |
213 | * | |
214 | * @return string | |
215 | */ | |
216 | protected function getSortNameLabelWithEmail() { | |
217 | return ts('Participant Name or Email'); | |
218 | } | |
219 | ||
220 | /** | |
221 | * Get the label for the sortName field if email searching is off. | |
222 | * | |
223 | * (email searching is a setting under search preferences). | |
224 | * | |
225 | * @return string | |
226 | */ | |
227 | protected function getSortNameLabelWithOutEmail() { | |
228 | return ts('Participant Name'); | |
229 | } | |
230 | ||
0573fd28 | 231 | /** |
232 | * Get the label for the tag field. | |
233 | * | |
234 | * We do this in a function so the 'ts' wraps the whole string to allow | |
235 | * better translation. | |
236 | * | |
237 | * @return string | |
238 | */ | |
239 | protected function getTagLabel() { | |
240 | return ts('Participant Tag(s)'); | |
241 | } | |
242 | ||
243 | /** | |
244 | * Get the label for the group field. | |
245 | * | |
246 | * @return string | |
247 | */ | |
248 | protected function getGroupLabel() { | |
249 | return ts('Participant Group(s)'); | |
250 | } | |
251 | ||
252 | /** | |
253 | * Get the label for the group field. | |
254 | * | |
255 | * @return string | |
256 | */ | |
257 | protected function getContactTypeLabel() { | |
258 | return ts('Participant Contact Type'); | |
259 | } | |
260 | ||
6a488035 | 261 | /** |
12cda498 AP |
262 | * Test submit the form. |
263 | * @param $formValues | |
6a488035 | 264 | */ |
12cda498 AP |
265 | public function testSubmit($formValues) { |
266 | $this->submit($formValues); | |
267 | } | |
6a488035 | 268 | |
12cda498 AP |
269 | /** |
270 | * Submit the search form with given values. | |
271 | * @param $formValues | |
272 | */ | |
273 | private function submit($formValues) { | |
274 | $this->_formValues = $formValues; | |
6a488035 TO |
275 | |
276 | $this->fixFormValues(); | |
277 | ||
278 | if (isset($this->_ssID) && empty($_POST)) { | |
279 | // if we are editing / running a saved search and the form has not been posted | |
280 | $this->_formValues = CRM_Contact_BAO_SavedSearch::getFormValues($this->_ssID); | |
281 | } | |
282 | ||
d43b88cc CW |
283 | // We don't show test records in summaries or dashboards |
284 | if (empty($this->_formValues['participant_test']) && $this->_force) { | |
6a488035 TO |
285 | $this->_formValues["participant_test"] = 0; |
286 | } | |
287 | ||
c94d39fd | 288 | CRM_Core_BAO_CustomValue::fixCustomFieldValue($this->_formValues); |
6a488035 | 289 | |
be2fb01f | 290 | $this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues, 0, FALSE, NULL, ['event_id']); |
6a488035 | 291 | |
6a488035 TO |
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 | ||
6a488035 TO |
305 | $selector = new CRM_Event_Selector_Search($this->_queryParams, |
306 | $this->_action, | |
307 | NULL, | |
308 | $this->_single, | |
309 | $this->_limit, | |
310 | $this->_context | |
311 | ); | |
312 | ||
313 | $selector->setKey($this->controller->_key); | |
314 | ||
315 | $prefix = NULL; | |
316 | if ($this->_context == 'user') { | |
317 | $prefix = $this->_prefix; | |
318 | } | |
319 | ||
320 | $this->assign("{$prefix}limit", $this->_limit); | |
321 | $this->assign("{$prefix}single", $this->_single); | |
322 | ||
323 | $controller = new CRM_Core_Selector_Controller($selector, | |
324 | $this->get(CRM_Utils_Pager::PAGE_ID), | |
b5c63125 | 325 | $this->getSortID(), |
6a488035 TO |
326 | CRM_Core_Action::VIEW, |
327 | $this, | |
328 | CRM_Core_Selector_Controller::SESSION, | |
329 | $prefix | |
330 | ); | |
331 | $controller->setEmbedded(TRUE); | |
332 | ||
a5611c8e | 333 | $query = $selector->getQuery(); |
6a488035 TO |
334 | if ($this->_context == 'user') { |
335 | $query->setSkipPermission(TRUE); | |
336 | } | |
337 | $controller->run(); | |
338 | } | |
339 | ||
12cda498 AP |
340 | /** |
341 | * The post processing of the form gets done here. | |
342 | * | |
343 | * Key things done during post processing are | |
344 | * - check for reset or next request. if present, skip post procesing. | |
345 | * - now check if user requested running a saved search, if so, then | |
346 | * the form values associated with the saved search are used for searching. | |
347 | * - if user has done a submit with new values the regular post submissing is | |
348 | * done. | |
349 | * The processing consists of using a Selector / Controller framework for getting the | |
350 | * search results. | |
351 | * | |
352 | * @param | |
353 | * | |
354 | * @return void | |
1d81be90 | 355 | * @throws \CRM_Core_Exception |
12cda498 AP |
356 | */ |
357 | public function postProcess() { | |
358 | if ($this->_done) { | |
359 | return; | |
360 | } | |
361 | ||
362 | $this->_done = TRUE; | |
56d513f2 | 363 | $this->setFormValues(); |
12cda498 | 364 | |
56d513f2 | 365 | $this->submit($this->_formValues); |
12cda498 AP |
366 | } |
367 | ||
6a488035 | 368 | /** |
dc195289 | 369 | * add the rules (mainly global rules) for form. |
6a488035 TO |
370 | * All local rules are added near the element |
371 | * | |
355ba699 | 372 | * @return void |
6a488035 TO |
373 | * @see valid_date |
374 | */ | |
6ea503d4 TO |
375 | public function addRules() { |
376 | } | |
6a488035 | 377 | |
00be9182 | 378 | public function fixFormValues() { |
6a488035 TO |
379 | // if this search has been forced |
380 | // then see if there are any get values, and if so over-ride the post values | |
381 | // note that this means that GET over-rides POST :) | |
6a488035 | 382 | |
1273d77c | 383 | $role = CRM_Utils_Request::retrieve('role', 'String'); |
6a488035 TO |
384 | |
385 | if (isset($role)) { | |
386 | if ($role === 'true') { | |
4b191b48 | 387 | $roleTypes = CRM_Event_PseudoConstant::participantRole(NULL, "filter = 1"); |
6a488035 TO |
388 | } |
389 | elseif ($role === 'false') { | |
4b191b48 | 390 | $roleTypes = CRM_Event_PseudoConstant::participantRole(NULL, "filter = 0"); |
6a488035 TO |
391 | } |
392 | elseif (is_numeric($role)) { | |
53133bb0 | 393 | $roleTypes = (int) $role; |
6a488035 | 394 | } |
d5bd1f7e | 395 | $this->_formValues['participant_role_id'] = is_array($roleTypes) ? array_keys($roleTypes) : $roleTypes; |
53133bb0 | 396 | } |
397 | ||
1273d77c | 398 | $type = CRM_Utils_Request::retrieve('type', 'Positive'); |
6a488035 TO |
399 | if ($type) { |
400 | $this->_formValues['event_type'] = $type; | |
401 | } | |
402 | ||
403 | $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this); | |
404 | ||
405 | if ($cid) { | |
406 | $cid = CRM_Utils_Type::escape($cid, 'Integer'); | |
407 | if ($cid > 0) { | |
408 | $this->_formValues['contact_id'] = $cid; | |
409 | ||
410 | // also assign individual mode to the template | |
411 | $this->_single = TRUE; | |
412 | } | |
413 | } | |
414 | } | |
415 | ||
6a488035 TO |
416 | /** |
417 | * Return a descriptive name for the page, used in wizard header | |
418 | * | |
419 | * @return string | |
6a488035 TO |
420 | */ |
421 | public function getTitle() { | |
422 | return ts('Find Participants'); | |
423 | } | |
96025800 | 424 | |
18db97df | 425 | /** |
426 | * Set the metadata for the form. | |
427 | * | |
428 | * @throws \CiviCRM_API3_Exception | |
429 | */ | |
430 | protected function setSearchMetadata() { | |
431 | $this->addSearchFieldMetadata(['Participant' => CRM_Event_BAO_Query::getSearchFieldMetadata()]); | |
432 | } | |
433 | ||
1126bdc5 SL |
434 | /** |
435 | * Set the default form values. | |
436 | * | |
437 | * | |
438 | * @return array | |
439 | * the default array reference | |
86f20cc1 | 440 | * @throws \CRM_Core_Exception |
1126bdc5 SL |
441 | */ |
442 | public function setDefaultValues() { | |
56d513f2 | 443 | $this->_defaults = array_merge(parent::setDefaultValues(), (array) $this->_formValues); |
5f3ff0ef SL |
444 | $event = CRM_Utils_Request::retrieve('event', 'Positive'); |
445 | if ($event) { | |
446 | $this->_defaults['event_id'] = $event; | |
447 | $this->_defaults['event_name'] = CRM_Event_PseudoConstant::event($event, TRUE); | |
448 | } | |
449 | ||
450 | $status = CRM_Utils_Request::retrieve('status', 'String'); | |
451 | if (isset($status)) { | |
452 | if ($status === 'true') { | |
453 | $statusTypes = CRM_Event_PseudoConstant::participantStatus(NULL, "is_counted = 1"); | |
454 | } | |
455 | elseif ($status === 'false') { | |
456 | $statusTypes = CRM_Event_PseudoConstant::participantStatus(NULL, "is_counted = 0"); | |
457 | } | |
458 | elseif (is_numeric($status)) { | |
459 | $statusTypes = (int) $status; | |
460 | } | |
461 | elseif (is_array($status) && !array_key_exists('IN', $status)) { | |
462 | $statusTypes = array_keys($status); | |
463 | } | |
464 | $this->_defaults['participant_status_id'] = is_array($statusTypes) ? array_keys($statusTypes) : $statusTypes; | |
465 | } | |
466 | return $this->_defaults; | |
1126bdc5 SL |
467 | } |
468 | ||
6a488035 | 469 | } |