3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This file is for civievent search
21 class CRM_Event_Form_Search
extends CRM_Core_Form_Search
{
24 * The params that are sent to the query.
28 protected $_queryParams;
31 * Are we restricting ourselves to a single contact.
35 protected $_single = FALSE;
38 * Are we restricting ourselves to a single contact.
42 protected $_limit = NULL;
45 * Prefix for the controller.
48 protected $_prefix = "event_";
51 * The saved search ID retrieved from the GET vars.
58 * Metadata of all fields to include on the form.
62 protected $searchFieldMetadata = [];
65 * Get the default entity for the form.
69 public function getDefaultEntity() {
74 * Processing needed for buildForm and later.
78 * @throws \CRM_Core_Exception
79 * @throws \CiviCRM_API3_Exception
81 public function preProcess() {
82 // SearchFormName is deprecated & to be removed - the replacement is for the task to
83 // call $this->form->getSearchFormValues()
84 // A couple of extensions use it.
85 $this->set('searchFormName', 'Search');
88 * set the button names
90 $this->_actionButtonName
= $this->getButtonName('next', 'action');
96 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, ['event_id']);
97 $selector = new CRM_Event_Selector_Search($this->_queryParams
,
105 if ($this->_context
=== 'user') {
106 $prefix = $this->_prefix
;
109 $this->assign("{$prefix}limit", $this->_limit
);
110 $this->assign("{$prefix}single", $this->_single
);
112 $controller = new CRM_Core_Selector_Controller($selector,
113 $this->get(CRM_Utils_Pager
::PAGE_ID
),
115 CRM_Core_Action
::VIEW
,
117 CRM_Core_Selector_Controller
::TRANSFER
,
120 $controller->setEmbedded(TRUE);
121 $controller->moveFromSessionToTemplate();
123 $this->assign('summary', $this->get('summary'));
127 * Build the form object.
131 * @throws \CRM_Core_Exception
132 * @throws \CiviCRM_API3_Exception
134 public function buildQuickForm() {
135 parent
::buildQuickForm();
136 $this->addContactSearchFields();
138 CRM_Event_BAO_Query
::buildSearchForm($this);
140 $rows = $this->get('rows');
141 if (is_array($rows)) {
142 $lineItems = $eventIds = [];
143 if (!$this->_single
) {
144 $this->addRowSelectors($rows);
146 foreach ($rows as $row) {
147 $eventIds[$row['event_id']] = $row['event_id'];
148 if (CRM_Event_BAO_Event
::usesPriceSet($row['event_id'])) {
149 // add line item details if applicable
150 $lineItems[$row['participant_id']] = CRM_Price_BAO_LineItem
::getLineItems($row['participant_id']);
154 //get actual count only when we are dealing w/ single event.
155 $participantCount = 0;
156 if (count($eventIds) == 1) {
157 //convert form values to clause.
159 if (CRM_Utils_Array
::value('participant_test', $this->_formValues
) == '1' || CRM_Utils_Array
::value('participant_test', $this->_formValues
) == '0') {
160 $seatClause[] = "( participant.is_test = {$this->_formValues['participant_test']} )";
162 if (!empty($this->_formValues
['participant_status_id'])) {
163 $seatClause[] = CRM_Contact_BAO_Query
::buildClause("participant.status_id", 'IN', $this->_formValues
['participant_status_id'], 'Int');
164 if ($status = CRM_Utils_Array
::value('IN', $this->_formValues
['participant_status_id'])) {
165 $this->_formValues
['participant_status_id'] = $status;
168 if (!empty($this->_formValues
['participant_role_id'])) {
170 foreach ((array) $this->_formValues
['participant_role_id'] as $participantRole) {
171 $escapedRoles[] = CRM_Utils_Type
::escape($participantRole, 'String');
173 $seatClause[] = "( participant.role_id IN ( '" . implode("' , '", $escapedRoles) . "' ) )";
177 if (!empty($this->_formValues
['participant_fee_id'])) {
178 $participant_fee_id = $this->_formValues
['participant_fee_id'];
180 foreach ($participant_fee_id as $k => &$val) {
181 $val = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $val, 'label');
182 $val_regexp[$k] = CRM_Core_DAO
::escapeString(preg_quote(trim($val)));
183 $val = CRM_Core_DAO
::escapeString(trim($val));
185 $feeLabel = implode('|', $val_regexp);
186 $seatClause[] = "( participant.fee_level REGEXP '{$feeLabel}' )";
189 $seatClause = implode(' AND ', $seatClause);
190 $participantCount = CRM_Event_BAO_Event
::eventTotalSeats(array_pop($eventIds), $seatClause);
192 $this->assign('participantCount', $participantCount);
193 $this->assign('lineItems', $lineItems);
195 $taskParams['ssID'] = $this->_ssID ??
NULL;
196 $tasks = CRM_Event_Task
::permissionedTaskTitles(CRM_Core_Permission
::getPermission(), $taskParams);
198 if (isset($this->_ssID
)) {
199 $savedSearchValues = [
200 'id' => $this->_ssID
,
201 'name' => CRM_Contact_BAO_SavedSearch
::getName($this->_ssID
, 'title'),
204 $this->assign('savedSearch', $savedSearchValues ??
NULL);
205 $this->assign('ssID', $this->_ssID
);
207 $this->addTaskMenu($tasks);
213 * Get the label for the sortName field if email searching is on.
215 * (email searching is a setting under search preferences).
219 protected function getSortNameLabelWithEmail() {
220 return ts('Participant Name or Email');
224 * Get the label for the sortName field if email searching is off.
226 * (email searching is a setting under search preferences).
230 protected function getSortNameLabelWithOutEmail() {
231 return ts('Participant Name');
235 * Get the label for the tag field.
237 * We do this in a function so the 'ts' wraps the whole string to allow
238 * better translation.
242 protected function getTagLabel() {
243 return ts('Participant Tag(s)');
247 * Get the label for the group field.
251 protected function getGroupLabel() {
252 return ts('Participant Group(s)');
256 * Get the label for the group field.
260 protected function getContactTypeLabel() {
261 return ts('Participant Contact Type');
265 * Test submit the form.
268 public function testSubmit($formValues) {
269 $this->submit($formValues);
273 * Submit the search form with given values.
276 private function submit($formValues) {
277 $this->_formValues
= $formValues;
279 $this->fixFormValues();
281 if (isset($this->_ssID
) && empty($_POST)) {
282 // if we are editing / running a saved search and the form has not been posted
283 $this->_formValues
= CRM_Contact_BAO_SavedSearch
::getFormValues($this->_ssID
);
286 // We don't show test records in summaries or dashboards
287 if (empty($this->_formValues
['participant_test']) && $this->_force
) {
288 $this->_formValues
["participant_test"] = 0;
291 $this->_queryParams
= CRM_Contact_BAO_Query
::convertFormValues($this->_formValues
, 0, FALSE, NULL, ['event_id']);
293 $this->set('queryParams', $this->_queryParams
);
295 $buttonName = $this->controller
->getButtonName();
296 if ($buttonName == $this->_actionButtonName
) {
297 // check actionName and if next, then do not repeat a search, since we are going to the next page
299 // hack, make sure we reset the task values
300 $stateMachine = $this->controller
->getStateMachine();
301 $formName = $stateMachine->getTaskFormName();
302 $this->controller
->resetPage($formName);
306 $selector = new CRM_Event_Selector_Search($this->_queryParams
,
314 $selector->setKey($this->controller
->_key
);
317 if ($this->_context
== 'user') {
318 $prefix = $this->_prefix
;
321 $this->assign("{$prefix}limit", $this->_limit
);
322 $this->assign("{$prefix}single", $this->_single
);
324 $controller = new CRM_Core_Selector_Controller($selector,
325 $this->get(CRM_Utils_Pager
::PAGE_ID
),
327 CRM_Core_Action
::VIEW
,
329 CRM_Core_Selector_Controller
::SESSION
,
332 $controller->setEmbedded(TRUE);
334 $query = $selector->getQuery();
335 if ($this->_context
== 'user') {
336 $query->setSkipPermission(TRUE);
342 * The post processing of the form gets done here.
344 * Key things done during post processing are
345 * - check for reset or next request. if present, skip post procesing.
346 * - now check if user requested running a saved search, if so, then
347 * the form values associated with the saved search are used for searching.
348 * - if user has done a submit with new values the regular post submissing is
350 * The processing consists of using a Selector / Controller framework for getting the
356 * @throws \CRM_Core_Exception
358 public function postProcess() {
364 $this->setFormValues();
366 $this->submit($this->_formValues
);
370 * add the rules (mainly global rules) for form.
371 * All local rules are added near the element
376 public function addRules() {
379 public function fixFormValues() {
380 // if this search has been forced
381 // then see if there are any get values, and if so over-ride the post values
382 // note that this means that GET over-rides POST :)
384 $role = CRM_Utils_Request
::retrieve('role', 'String');
387 if ($role === 'true') {
388 $roleTypes = CRM_Event_PseudoConstant
::participantRole(NULL, "filter = 1");
390 elseif ($role === 'false') {
391 $roleTypes = CRM_Event_PseudoConstant
::participantRole(NULL, "filter = 0");
393 elseif (is_numeric($role)) {
394 $roleTypes = (int) $role;
396 $this->_formValues
['participant_role_id'] = is_array($roleTypes) ?
array_keys($roleTypes) : $roleTypes;
399 $type = CRM_Utils_Request
::retrieve('type', 'Positive');
401 $this->_formValues
['event_type'] = $type;
404 $cid = CRM_Utils_Request
::retrieve('cid', 'Positive', $this);
407 $cid = CRM_Utils_Type
::escape($cid, 'Integer');
409 $this->_formValues
['contact_id'] = $cid;
411 // also assign individual mode to the template
412 $this->_single
= TRUE;
418 * Return a descriptive name for the page, used in wizard header
422 public function getTitle() {
423 return ts('Find Participants');
427 * Set the metadata for the form.
429 * @throws \CiviCRM_API3_Exception
431 protected function setSearchMetadata() {
432 $this->addSearchFieldMetadata(['Participant' => CRM_Event_BAO_Query
::getSearchFieldMetadata()]);
436 * Set the default form values.
440 * the default array reference
441 * @throws \CRM_Core_Exception
443 public function setDefaultValues() {
444 $this->_defaults
= array_merge(parent
::setDefaultValues(), (array) $this->_formValues
);
445 $event = CRM_Utils_Request
::retrieve('event', 'Positive');
447 $this->_defaults
['event_id'] = $event;
448 $this->_defaults
['event_name'] = CRM_Event_PseudoConstant
::event($event, TRUE);
451 $status = CRM_Utils_Request
::retrieve('status', 'String');
452 if (isset($status)) {
453 if ($status === 'true') {
454 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, "is_counted = 1");
456 elseif ($status === 'false') {
457 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, "is_counted = 0");
459 elseif (is_numeric($status)) {
460 $statusTypes = (int) $status;
462 elseif (is_array($status) && !array_key_exists('IN', $status)) {
463 $statusTypes = array_keys($status);
465 $this->_defaults
['participant_status_id'] = is_array($statusTypes) ?
array_keys($statusTypes) : $statusTypes;
467 return $this->_defaults
;