Merge pull request #18140 from mattwire/removetimeoutpermlocation
[civicrm-core.git] / CRM / Event / Form / Registration / Register.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
5 | |
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 +--------------------------------------------------------------------+
10 */
11
12 /**
13 * @package CRM
14 * @copyright CiviCRM LLC https://civicrm.org/licensing
15 */
16
17 /**
18 * This class generates form components for processing Event.
19 */
20 class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration {
21
22 /**
23 * The fields involved in this page.
24 *
25 * @var array
26 */
27 public $_fields;
28
29 /**
30 * The status message that user view.
31 *
32 * @var string
33 */
34 protected $_waitlistMsg;
35 protected $_requireApprovalMsg;
36
37 /**
38 * Deprecated parameter that we hope to remove.
39 *
40 * @var bool
41 */
42 public $_quickConfig;
43
44 /**
45 * Skip duplicate check.
46 *
47 * This can be set using hook_civicrm_buildForm() to override the registration dupe check.
48 *
49 * @var bool
50 * @see https://issues.civicrm.org/jira/browse/CRM-7604
51 */
52 public $_skipDupeRegistrationCheck = FALSE;
53
54 public $_paymentProcessorID;
55
56 /**
57 * Show fee block or not.
58 *
59 * @var bool
60 */
61 public $_noFees;
62
63 /**
64 * Fee Block.
65 *
66 * @var array
67 */
68 public $_feeBlock;
69
70 /**
71 * Array of payment related fields to potentially display on this form (generally credit card or debit card fields).
72 *
73 * This is rendered via billingBlock.tpl.
74 *
75 * @var array
76 */
77 public $_paymentFields = [];
78
79 /**
80 * Is this submission incurring no costs.
81 *
82 * @param array $fields
83 * @param \CRM_Event_Form_Registration_Register $form
84 *
85 * @return bool
86 */
87 protected static function isZeroAmount($fields, $form): bool {
88 $isZeroAmount = FALSE;
89 if (!empty($fields['priceSetId'])) {
90 if (empty($fields['amount'])) {
91 $isZeroAmount = TRUE;
92 }
93 }
94 elseif (!empty($fields['amount']) &&
95 (isset($form->_values['discount'][$fields['amount']])
96 && CRM_Utils_Array::value('value', $form->_values['discount'][$fields['amount']]) == 0
97 )
98 ) {
99 $isZeroAmount = TRUE;
100 }
101 elseif (!empty($fields['amount']) &&
102 (isset($form->_values['fee'][$fields['amount']])
103 && CRM_Utils_Array::value('value', $form->_values['fee'][$fields['amount']]) == 0
104 )
105 ) {
106 $isZeroAmount = TRUE;
107 }
108 return $isZeroAmount;
109 }
110
111 /**
112 * Get the contact id for the registration.
113 *
114 * @param array $fields
115 * @param CRM_Event_Form_Registration $form
116 * @param bool $isAdditional
117 *
118 * @return int|null
119 */
120 public static function getRegistrationContactID($fields, $form, $isAdditional) {
121 $contactID = NULL;
122 if (!$isAdditional) {
123 $contactID = $form->getContactID();
124 }
125 if (!$contactID && is_array($fields) && $fields) {
126 $contactID = CRM_Contact_BAO_Contact::getFirstDuplicateContact($fields, 'Individual', 'Unsupervised', [], FALSE, CRM_Utils_Array::value('dedupe_rule_group_id', $form->_values['event']), ['event_id' => CRM_Utils_Array::value('id', $form->_values['event'])]);
127 }
128 return $contactID;
129 }
130
131 /**
132 * Set variables up before form is built.
133 *
134 * @throws \CRM_Core_Exception
135 */
136 public function preProcess() {
137 parent::preProcess();
138
139 //CRM-4320.
140 //here we can't use parent $this->_allowWaitlist as user might
141 //walk back and we might set this value in this postProcess.
142 //(we set when spaces < group count and want to allow become part of waiting )
143 $eventFull = CRM_Event_BAO_Participant::eventFull($this->_eventId, FALSE, CRM_Utils_Array::value('has_waitlist', $this->_values['event']));
144
145 // Get payment processors if appropriate for this event
146 // We hide the payment fields if the event is full or requires approval,
147 // and the current user has not yet been approved CRM-12279
148 $this->_noFees = (($eventFull || $this->_requireApproval) && !$this->_allowConfirmation);
149 $this->_paymentProcessors = $this->_noFees ? [] : $this->get('paymentProcessors');
150 $this->preProcessPaymentOptions();
151
152 $this->_allowWaitlist = FALSE;
153 if ($eventFull && !$this->_allowConfirmation && !empty($this->_values['event']['has_waitlist'])) {
154 $this->_allowWaitlist = TRUE;
155 $this->_waitlistMsg = $this->_values['event']['waitlist_text'] ?? NULL;
156 if (!$this->_waitlistMsg) {
157 $this->_waitlistMsg = ts('This event is currently full. However you can register now and get added to a waiting list. You will be notified if spaces become available.');
158 }
159 }
160 $this->set('allowWaitlist', $this->_allowWaitlist);
161
162 //To check if the user is already registered for the event(CRM-2426)
163 if (!$this->_skipDupeRegistrationCheck) {
164 self::checkRegistration(NULL, $this);
165 }
166
167 $this->assign('availableRegistrations', $this->_availableRegistrations);
168
169 // get the participant values from EventFees.php, CRM-4320
170 if ($this->_allowConfirmation) {
171 CRM_Event_Form_EventFees::preProcess($this);
172 }
173 }
174
175 /**
176 * Set default values for the form.
177 *
178 * @return array
179 *
180 * @throws \CRM_Core_Exception
181 * @throws \CiviCRM_API3_Exception
182 */
183 public function setDefaultValues() {
184 $this->_defaults = [];
185 if (!$this->_allowConfirmation && $this->_requireApproval) {
186 $this->_defaults['bypass_payment'] = 1;
187 }
188 $contactID = $this->getContactID();
189 CRM_Core_Payment_Form::setDefaultValues($this, $contactID);
190
191 CRM_Event_BAO_Participant::formatFieldsAndSetProfileDefaults($contactID, $this);
192
193 // Set default payment processor as default payment_processor radio button value
194 if (!empty($this->_paymentProcessors)) {
195 foreach ($this->_paymentProcessors as $pid => $value) {
196 if (!empty($value['is_default'])) {
197 $this->_defaults['payment_processor_id'] = $pid;
198 }
199 }
200 }
201
202 //if event is monetary and pay later is enabled and payment
203 //processor is not available then freeze the pay later checkbox with
204 //default check
205 if (!empty($this->_values['event']['is_pay_later']) &&
206 !is_array($this->_paymentProcessor)
207 ) {
208 $this->_defaults['is_pay_later'] = 1;
209 }
210
211 //set custom field defaults
212 if (!empty($this->_fields)) {
213 //load default campaign from page.
214 if (array_key_exists('participant_campaign_id', $this->_fields)) {
215 $this->_defaults['participant_campaign_id'] = CRM_Utils_Array::value('campaign_id',
216 $this->_values['event']
217 );
218 }
219
220 foreach ($this->_fields as $name => $field) {
221 if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) {
222 // fix for CRM-1743
223 if (!isset($this->_defaults[$name])) {
224 CRM_Core_BAO_CustomField::setProfileDefaults($customFieldID, $name, $this->_defaults,
225 NULL, CRM_Profile_Form::MODE_REGISTER
226 );
227 }
228 }
229 }
230 }
231
232 //fix for CRM-3088, default value for discount set.
233 $discountId = NULL;
234 if (!empty($this->_values['discount'])) {
235 $discountId = CRM_Core_BAO_Discount::findSet($this->_eventId, 'civicrm_event');
236 if ($discountId) {
237 if (isset($this->_values['event']['default_discount_fee_id'])) {
238 $discountKey = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue',
239 $this->_values['event']['default_discount_fee_id'],
240 'weight', 'id'
241 );
242
243 $this->_defaults['amount'] = key(array_slice($this->_values['discount'][$discountId],
244 $discountKey - 1, $discountKey, TRUE
245 ));
246 }
247 }
248 }
249
250 // add this event's default participant role to defaults array
251 // (for cases where participant_role field is included in form via profile)
252 if ($this->_values['event']['default_role_id']) {
253 $this->_defaults['participant_role']
254 = $this->_defaults['participant_role_id'] = $this->_values['event']['default_role_id'];
255 }
256 if ($this->_priceSetId && !empty($this->_feeBlock)) {
257 foreach ($this->_feeBlock as $key => $val) {
258 if (empty($val['options'])) {
259 continue;
260 }
261 $optionFullIds = CRM_Utils_Array::value('option_full_ids', $val, []);
262 foreach ($val['options'] as $keys => $values) {
263 if ($values['is_default'] && empty($values['is_full'])) {
264
265 if ($val['html_type'] == 'CheckBox') {
266 $this->_defaults["price_{$key}"][$keys] = 1;
267 }
268 else {
269 $this->_defaults["price_{$key}"] = $keys;
270 }
271 }
272 }
273 $unsetSubmittedOptions[$val['id']] = $optionFullIds;
274 }
275 //reset values for all options those are full.
276 CRM_Event_Form_Registration::resetElementValue($unsetSubmittedOptions, $this);
277 }
278
279 //set default participant fields, CRM-4320.
280 $hasAdditionalParticipants = FALSE;
281 if ($this->_allowConfirmation) {
282 $this->_contactId = $contactID;
283 $this->_discountId = $discountId;
284 $forcePayLater = CRM_Utils_Array::value('is_pay_later', $this->_defaults, FALSE);
285 $this->_defaults = array_merge($this->_defaults, CRM_Event_Form_EventFees::setDefaultValues($this));
286 $this->_defaults['is_pay_later'] = $forcePayLater;
287
288 if ($this->_additionalParticipantIds) {
289 $hasAdditionalParticipants = TRUE;
290 $this->_defaults['additional_participants'] = count($this->_additionalParticipantIds);
291 }
292 }
293 $this->assign('hasAdditionalParticipants', $hasAdditionalParticipants);
294
295 // //hack to simplify credit card entry for testing
296 // $this->_defaults['credit_card_type'] = 'Visa';
297 // $this->_defaults['credit_card_number'] = '4807731747657838';
298 // $this->_defaults['cvv2'] = '000';
299 // $this->_defaults['credit_card_exp_date'] = array( 'Y' => '2010', 'M' => '05' );
300
301 // to process Custom data that are appended to URL
302 $getDefaults = CRM_Core_BAO_CustomGroup::extractGetParams($this, "'Contact', 'Individual', 'Contribution', 'Participant'");
303 if (!empty($getDefaults)) {
304 $this->_defaults = array_merge($this->_defaults, $getDefaults);
305 }
306
307 return $this->_defaults;
308 }
309
310 /**
311 * Build the form object.
312 */
313 public function buildQuickForm() {
314 // build profiles first so that we can determine address fields etc
315 // and then show copy address checkbox
316 $this->buildCustom($this->_values['custom_pre_id'], 'customPre');
317 $this->buildCustom($this->_values['custom_post_id'], 'customPost');
318
319 // CRM-18399: used by template to pass pre profile id as a url arg
320 $this->assign('custom_pre_id', $this->_values['custom_pre_id']);
321
322 CRM_Core_Payment_ProcessorForm::buildQuickForm($this);
323
324 $contactID = $this->getContactID();
325 if ($contactID) {
326 $this->assign('contact_id', $contactID);
327 $this->assign('display_name', CRM_Contact_BAO_Contact::displayName($contactID));
328 }
329
330 $bypassPayment = $allowGroupOnWaitlist = $isAdditionalParticipants = FALSE;
331 if ($this->_values['event']['is_multiple_registrations']) {
332 // don't allow to add additional during confirmation if not preregistered.
333 if (!$this->_allowConfirmation || $this->_additionalParticipantIds) {
334 // CRM-17745: Make maximum additional participants configurable
335 // Label is value + 1, since the code sees this is ADDITIONAL participants (in addition to "self")
336 $additionalOptions = [];
337 $additionalOptions[''] = 1;
338 for ($i = 1; $i <= $this->_values['event']['max_additional_participants']; $i++) {
339 $additionalOptions[$i] = $i + 1;
340 }
341 $this->add('select', 'additional_participants',
342 ts('How many people are you registering?'),
343 $additionalOptions,
344 NULL,
345 ['onChange' => "allowParticipant()"]
346 );
347 $isAdditionalParticipants = TRUE;
348 }
349 }
350
351 if (!$this->_allowConfirmation) {
352 $bypassPayment = TRUE;
353 }
354
355 //hack to allow group to register w/ waiting
356 if ((!empty($this->_values['event']['is_multiple_registrations']) ||
357 $this->_priceSetId
358 ) &&
359 !$this->_allowConfirmation &&
360 is_numeric($this->_availableRegistrations) && !empty($this->_values['event']['has_waitlist'])
361 ) {
362 $bypassPayment = TRUE;
363 //case might be group become as a part of waitlist.
364 //If not waitlist then they require admin approve.
365 $allowGroupOnWaitlist = TRUE;
366 $this->_waitlistMsg = ts("This event has only %1 space(s) left. If you continue and register more than %1 people (including yourself ), the whole group will be wait listed. Or, you can reduce the number of people you are registering to %1 to avoid being put on the waiting list.", [1 => $this->_availableRegistrations]);
367
368 if ($this->_requireApproval) {
369 $this->_requireApprovalMsg = CRM_Utils_Array::value('approval_req_text', $this->_values['event'],
370 ts('Registration for this event requires approval. Once your registration(s) have been reviewed, you will receive an email with a link to a web page where you can complete the registration process.')
371 );
372 }
373 }
374
375 //case where only approval needed - no waitlist.
376 if ($this->_requireApproval &&
377 !$this->_allowWaitlist && !$bypassPayment
378 ) {
379 $this->_requireApprovalMsg = CRM_Utils_Array::value('approval_req_text', $this->_values['event'],
380 ts('Registration for this event requires approval. Once your registration has been reviewed, you will receive an email with a link to a web page where you can complete the registration process.')
381 );
382 }
383
384 //lets display status to primary page only.
385 $this->assign('waitlistMsg', $this->_waitlistMsg);
386 $this->assign('requireApprovalMsg', $this->_requireApprovalMsg);
387 $this->assign('allowGroupOnWaitlist', $allowGroupOnWaitlist);
388 $this->assign('isAdditionalParticipants', $isAdditionalParticipants);
389
390 if ($this->_values['event']['is_monetary']) {
391 self::buildAmount($this);
392 }
393
394 if ($contactID === 0 && !$this->_values['event']['is_multiple_registrations']) {
395 //@todo we are blocking for multiple registrations because we haven't tested
396 $this->addCIDZeroOptions();
397 }
398
399 if ($this->_values['event']['is_monetary']) {
400 $this->addPaymentProcessorFieldsToForm();
401 }
402
403 $this->addElement('hidden', 'bypass_payment', NULL, ['id' => 'bypass_payment']);
404
405 $this->assign('bypassPayment', $bypassPayment);
406
407 if (!$contactID) {
408 $createCMSUser = FALSE;
409
410 if ($this->_values['custom_pre_id']) {
411 $profileID = $this->_values['custom_pre_id'];
412 $createCMSUser = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_cms_user');
413 }
414
415 if (!$createCMSUser &&
416 $this->_values['custom_post_id']
417 ) {
418 if (!is_array($this->_values['custom_post_id'])) {
419 $profileIDs = [$this->_values['custom_post_id']];
420 }
421 else {
422 $profileIDs = $this->_values['custom_post_id'];
423 }
424 foreach ($profileIDs as $pid) {
425 if (CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $pid, 'is_cms_user')) {
426 $profileID = $pid;
427 $createCMSUser = TRUE;
428 break;
429 }
430 }
431 }
432
433 if ($createCMSUser) {
434 CRM_Core_BAO_CMSUser::buildForm($this, $profileID, TRUE);
435 }
436 }
437
438 //we have to load confirm contribution button in template
439 //when multiple payment processor as the user
440 //can toggle with payment processor selection
441 $billingModePaymentProcessors = 0;
442 if (!CRM_Utils_System::isNull($this->_paymentProcessors)) {
443 foreach ($this->_paymentProcessors as $key => $values) {
444 if ($values['billing_mode'] == CRM_Core_Payment::BILLING_MODE_BUTTON) {
445 $billingModePaymentProcessors++;
446 }
447 }
448 }
449
450 if ($billingModePaymentProcessors && count($this->_paymentProcessors) == $billingModePaymentProcessors) {
451 $allAreBillingModeProcessors = TRUE;
452 }
453 else {
454 $allAreBillingModeProcessors = FALSE;
455 }
456
457 if (!$allAreBillingModeProcessors || !empty($this->_values['event']['is_pay_later']) || $bypassPayment
458 ) {
459
460 //freeze button to avoid multiple calls.
461 if (empty($this->_values['event']['is_monetary'])) {
462 $this->submitOnce = TRUE;
463 }
464
465 // CRM-11182 - Optional confirmation screen
466 // Change button label depending on whether the next action is confirm or register
467 $buttonParams = [
468 'type' => 'upload',
469 'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
470 'isDefault' => TRUE,
471 ];
472 if (
473 !$this->_values['event']['is_multiple_registrations']
474 && !$this->_values['event']['is_monetary']
475 && !$this->_values['event']['is_confirm_enabled']
476 ) {
477 $buttonParams['name'] = ts('Register');
478 }
479 else {
480 $buttonParams['name'] = ts('Review your registration');
481 $buttonParams['icon'] = 'fa-chevron-right';
482 }
483
484 $this->addButtons([$buttonParams]);
485 }
486
487 $this->addFormRule(['CRM_Event_Form_Registration_Register', 'formRule'], $this);
488 $this->unsavedChangesWarn = TRUE;
489
490 // add pcp fields
491 if ($this->_pcpId) {
492 CRM_PCP_BAO_PCP::buildPcp($this->_pcpId, $this);
493 }
494 }
495
496 /**
497 * Build the radio/text form elements for the amount field
498 *
499 * @param CRM_Event_Form_Registration_Register $form
500 * Form object.
501 * @param bool $required
502 * True if you want to add formRule.
503 * @param int $discountId
504 * Discount id for the event.
505 *
506 * @throws \CRM_Core_Exception
507 */
508 public static function buildAmount(&$form, $required = TRUE, $discountId = NULL) {
509 // build amount only when needed, skip incase of event full and waitlisting is enabled
510 // and few other conditions check preProcess()
511 if (property_exists($form, '_noFees') && $form->_noFees) {
512 return;
513 }
514
515 //if payment done, no need to build the fee block.
516 if (!empty($form->_paymentId)) {
517 //fix to display line item in update mode.
518 $form->assign('priceSet', $form->_priceSet ?? NULL);
519 return;
520 }
521
522 $feeFields = $form->_values['fee'] ?? NULL;
523
524 if (is_array($feeFields)) {
525 $form->_feeBlock = &$form->_values['fee'];
526 }
527
528 //check for discount.
529 $discountedFee = $form->_values['discount'] ?? NULL;
530 if (is_array($discountedFee) && !empty($discountedFee)) {
531 if (!$discountId) {
532 $form->_discountId = $discountId = CRM_Core_BAO_Discount::findSet($form->_eventId, 'civicrm_event');
533 }
534 if ($discountId) {
535 $form->_feeBlock = &$form->_values['discount'][$discountId];
536 }
537 }
538 if (!is_array($form->_feeBlock)) {
539 $form->_feeBlock = [];
540 }
541
542 //its time to call the hook.
543 CRM_Utils_Hook::buildAmount('event', $form, $form->_feeBlock);
544
545 //reset required if participant is skipped.
546 $button = substr($form->controller->getButtonName(), -4);
547 if ($required && $button == 'skip') {
548 $required = FALSE;
549 }
550
551 $className = CRM_Utils_System::getClassName($form);
552
553 //build the priceset fields.
554 if (isset($form->_priceSetId) && $form->_priceSetId) {
555
556 //format price set fields across option full.
557 self::formatFieldsForOptionFull($form);
558
559 if (!empty($form->_priceSet['is_quick_config'])) {
560 $form->_quickConfig = $form->_priceSet['is_quick_config'];
561 }
562 $form->add('hidden', 'priceSetId', $form->_priceSetId);
563
564 // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
565 $adminFieldVisible = FALSE;
566 if (CRM_Core_Permission::check('administer CiviCRM data')) {
567 $adminFieldVisible = TRUE;
568 }
569
570 $hideAdminValues = TRUE;
571 if (CRM_Core_Permission::check('edit event participants')) {
572 $hideAdminValues = FALSE;
573 }
574
575 foreach ($form->_feeBlock as $field) {
576 // public AND admin visibility fields are included for back-office registration and back-office change selections
577 if (CRM_Utils_Array::value('visibility', $field) == 'public' ||
578 (CRM_Utils_Array::value('visibility', $field) == 'admin' && $adminFieldVisible == TRUE) ||
579 $className == 'CRM_Event_Form_Participant' ||
580 $className === 'CRM_Event_Form_Task_Register' ||
581 $className == 'CRM_Event_Form_ParticipantFeeSelection'
582 ) {
583 $fieldId = $field['id'];
584 $elementName = 'price_' . $fieldId;
585
586 $isRequire = $field['is_required'] ?? NULL;
587 if ($button == 'skip') {
588 $isRequire = FALSE;
589 }
590
591 //user might modified w/ hook.
592 $options = $field['options'] ?? NULL;
593 $formClasses = ['CRM_Event_Form_Participant', 'CRM_Event_Form_Task_Register', 'CRM_Event_Form_ParticipantFeeSelection'];
594
595 if (!is_array($options)) {
596 continue;
597 }
598 elseif ($hideAdminValues && !in_array($className, $formClasses)) {
599 $publicVisibilityID = CRM_Price_BAO_PriceField::getVisibilityOptionID('public');
600 $adminVisibilityID = CRM_Price_BAO_PriceField::getVisibilityOptionID('admin');
601
602 foreach ($options as $key => $currentOption) {
603 $optionVisibility = CRM_Utils_Array::value('visibility_id', $currentOption, $publicVisibilityID);
604 if ($optionVisibility == $adminVisibilityID) {
605 unset($options[$key]);
606 }
607 }
608 }
609
610 $optionFullIds = CRM_Utils_Array::value('option_full_ids', $field, []);
611
612 //soft suppress required rule when option is full.
613 if (!empty($optionFullIds) && (count($options) == count($optionFullIds))) {
614 $isRequire = FALSE;
615 }
616 if (!empty($options)) {
617 //build the element.
618 CRM_Price_BAO_PriceField::addQuickFormElement($form,
619 $elementName,
620 $fieldId,
621 FALSE,
622 $isRequire,
623 NULL,
624 $options,
625 $optionFullIds
626 );
627 }
628 }
629 }
630 $form->_priceSet['id'] = $form->_priceSet['id'] ?? $form->_priceSetId;
631 $form->assign('priceSet', $form->_priceSet);
632 }
633 else {
634 $eventFeeBlockValues = [];
635 foreach ($form->_feeBlock as $fee) {
636 if (is_array($fee)) {
637
638 //CRM-7632, CRM-6201
639 $totalAmountJs = NULL;
640 if ($className == 'CRM_Event_Form_Participant' || $className === 'CRM_Event_Form_Task_Register') {
641 $totalAmountJs = ['onClick' => "fillTotalAmount(" . $fee['value'] . ")"];
642 }
643
644 $eventFeeBlockValues['amount_id_' . $fee['amount_id']] = $fee['value'];
645 $elements[] = &$form->createElement('radio', NULL, '',
646 CRM_Utils_Money::format($fee['value']) . ' ' .
647 $fee['label'],
648 $fee['amount_id'],
649 $totalAmountJs
650 );
651 }
652 }
653 $form->assign('eventFeeBlockValues', json_encode($eventFeeBlockValues));
654
655 $form->_defaults['amount'] = $form->_values['event']['default_fee_id'] ?? NULL;
656 $element = &$form->addGroup($elements, 'amount', ts('Event Fee(s)'), '<br />');
657 if (isset($form->_online) && $form->_online) {
658 $element->freeze();
659 }
660 if ($required) {
661 $form->addRule('amount', ts('Fee Level is a required field.'), 'required');
662 }
663 }
664 }
665
666 /**
667 * @param CRM_Event_Form_Registration $form
668 */
669 public static function formatFieldsForOptionFull(&$form) {
670 $priceSet = $form->get('priceSet');
671 $priceSetId = $form->get('priceSetId');
672 $defaultPricefieldIds = [];
673 if (!empty($form->_values['line_items'])) {
674 foreach ($form->_values['line_items'] as $lineItem) {
675 $defaultPricefieldIds[] = $lineItem['price_field_value_id'];
676 }
677 }
678 if (!$priceSetId ||
679 !is_array($priceSet) ||
680 empty($priceSet) || empty($priceSet['optionsMaxValueTotal'])
681 ) {
682 return;
683 }
684
685 $skipParticipants = $formattedPriceSetDefaults = [];
686 if (!empty($form->_allowConfirmation) && (isset($form->_pId) || isset($form->_additionalParticipantId))) {
687 $participantId = $form->_pId ?? $form->_additionalParticipantId;
688 $pricesetDefaults = CRM_Event_Form_EventFees::setDefaultPriceSet($participantId,
689 $form->_eventId
690 );
691 // modify options full to respect the selected fields
692 // options on confirmation.
693 $formattedPriceSetDefaults = self::formatPriceSetParams($form, $pricesetDefaults);
694
695 // to skip current registered participants fields option count on confirmation.
696 $skipParticipants[] = $form->_participantId;
697 if (!empty($form->_additionalParticipantIds)) {
698 $skipParticipants = array_merge($skipParticipants, $form->_additionalParticipantIds);
699 }
700 }
701
702 $className = CRM_Utils_System::getClassName($form);
703
704 //get the current price event price set options count.
705 $currentOptionsCount = self::getPriceSetOptionCount($form);
706 $recordedOptionsCount = CRM_Event_BAO_Participant::priceSetOptionsCount($form->_eventId, $skipParticipants);
707 $optionFullTotalAmount = 0;
708 $currentParticipantNo = (int) substr($form->_name, 12);
709 foreach ($form->_feeBlock as & $field) {
710 $optionFullIds = [];
711 $fieldId = $field['id'];
712 if (!is_array($field['options'])) {
713 continue;
714 }
715 foreach ($field['options'] as & $option) {
716 $optId = $option['id'];
717 $count = CRM_Utils_Array::value('count', $option, 0);
718 $maxValue = CRM_Utils_Array::value('max_value', $option, 0);
719 $dbTotalCount = CRM_Utils_Array::value($optId, $recordedOptionsCount, 0);
720 $currentTotalCount = CRM_Utils_Array::value($optId, $currentOptionsCount, 0);
721
722 $totalCount = $currentTotalCount + $dbTotalCount;
723 $isFull = FALSE;
724 if ($maxValue &&
725 (($totalCount >= $maxValue) &&
726 (empty($form->_lineItem[$currentParticipantNo][$optId]['price_field_id']) || $dbTotalCount >= $maxValue))
727 ) {
728 $isFull = TRUE;
729 $optionFullIds[$optId] = $optId;
730 if ($field['html_type'] != 'Select') {
731 if (in_array($optId, $defaultPricefieldIds)) {
732 $optionFullTotalAmount += CRM_Utils_Array::value('amount', $option);
733 }
734 }
735 else {
736 if (!empty($defaultPricefieldIds) && in_array($optId, $defaultPricefieldIds)) {
737 unset($optionFullIds[$optId]);
738 }
739 }
740 }
741 //here option is not full,
742 //but we don't want to allow participant to increase
743 //seats at the time of re-walking registration.
744 if ($count &&
745 !empty($form->_allowConfirmation) &&
746 !empty($formattedPriceSetDefaults)
747 ) {
748 if (empty($formattedPriceSetDefaults["price_{$field}"]) || empty($formattedPriceSetDefaults["price_{$fieldId}"][$optId])) {
749 $optionFullIds[$optId] = $optId;
750 $isFull = TRUE;
751 }
752 }
753 $option['is_full'] = $isFull;
754 $option['db_total_count'] = $dbTotalCount;
755 $option['total_option_count'] = $dbTotalCount + $currentTotalCount;
756 }
757
758 //ignore option full for offline registration.
759 if ($className == 'CRM_Event_Form_Participant' || $className === 'CRM_Event_Form_Task_Register') {
760 $optionFullIds = [];
761 }
762
763 //finally get option ids in.
764 $field['option_full_ids'] = $optionFullIds;
765 }
766 $form->assign('optionFullTotalAmount', $optionFullTotalAmount);
767 }
768
769 /**
770 * Global form rule.
771 *
772 * @param array $fields
773 * The input form values.
774 * @param array $files
775 * The uploaded files if any.
776 * @param \CRM_Event_Form_Registration_Register $form
777 *
778 * @return bool|array
779 * true if no errors, else array of errors
780 *
781 * @throws \CRM_Core_Exception
782 */
783 public static function formRule($fields, $files, $form) {
784 $errors = [];
785 //check that either an email or firstname+lastname is included in the form(CRM-9587)
786 self::checkProfileComplete($fields, $errors, $form->_eventId);
787 //To check if the user is already registered for the event(CRM-2426)
788 if (!$form->_skipDupeRegistrationCheck) {
789 self::checkRegistration($fields, $form);
790 }
791 //check for availability of registrations.
792 if (!$form->_allowConfirmation && empty($fields['bypass_payment']) &&
793 is_numeric($form->_availableRegistrations) &&
794 CRM_Utils_Array::value('additional_participants', $fields) >= $form->_availableRegistrations
795 ) {
796 $errors['additional_participants'] = ts("There is only enough space left on this event for %1 participant(s).", [1 => $form->_availableRegistrations]);
797 }
798
799 $numberAdditionalParticipants = $fields['additional_participants'] ?? 0;
800
801 if ($numberAdditionalParticipants && !CRM_Utils_Rule::positiveInteger($fields['additional_participants'])) {
802 $errors['additional_participants'] = ts('Please enter a whole number for Number of additional people.');
803 }
804
805 // during confirmation don't allow to increase additional participants, CRM-4320
806 if ($form->_allowConfirmation && $numberAdditionalParticipants &&
807 is_array($form->_additionalParticipantIds) &&
808 $numberAdditionalParticipants > count($form->_additionalParticipantIds)
809 ) {
810 $errors['additional_participants'] = ts("Oops. It looks like you are trying to increase the number of additional people you are registering for. You can confirm registration for a maximum of %1 additional people.", [1 => count($form->_additionalParticipantIds)]);
811 }
812
813 //don't allow to register w/ waiting if enough spaces available.
814 if (!empty($fields['bypass_payment']) && $form->_allowConfirmation) {
815 if (!is_numeric($form->_availableRegistrations) ||
816 (empty($fields['priceSetId']) && CRM_Utils_Array::value('additional_participants', $fields) < $form->_availableRegistrations)
817 ) {
818 $errors['bypass_payment'] = ts("Oops. There are enough available spaces in this event. You can not add yourself to the waiting list.");
819 }
820 }
821
822 // priceset validations
823 if (!empty($fields['priceSetId']) &&
824 !$form->_requireApproval && !$form->_allowWaitlist
825 ) {
826 //format params.
827 $formatted = self::formatPriceSetParams($form, $fields);
828 $ppParams = [$formatted];
829 $priceSetErrors = self::validatePriceSet($form, $ppParams);
830 $primaryParticipantCount = self::getParticipantCount($form, $ppParams);
831
832 //get price set fields errors in.
833 $errors = array_merge($errors, CRM_Utils_Array::value(0, $priceSetErrors, []));
834
835 $totalParticipants = $primaryParticipantCount;
836 if ($numberAdditionalParticipants) {
837 $totalParticipants += $numberAdditionalParticipants;
838 }
839
840 if (empty($fields['bypass_payment']) &&
841 !$form->_allowConfirmation &&
842 is_numeric($form->_availableRegistrations) &&
843 $form->_availableRegistrations < $totalParticipants
844 ) {
845 $errors['_qf_default'] = ts("Only %1 Registrations available.", [1 => $form->_availableRegistrations]);
846 }
847
848 $lineItem = [];
849 CRM_Price_BAO_PriceSet::processAmount($form->_values['fee'], $fields, $lineItem);
850
851 $minAmt = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $fields['priceSetId'], 'min_amount');
852 if ($fields['amount'] < 0) {
853 $errors['_qf_default'] = ts('Event Fee(s) can not be less than zero. Please select the options accordingly');
854 }
855 elseif (!empty($minAmt) && $fields['amount'] < $minAmt) {
856 $errors['_qf_default'] = ts('A minimum amount of %1 should be selected from Event Fee(s).', [
857 1 => CRM_Utils_Money::format($minAmt),
858 ]);
859 }
860 }
861 foreach (CRM_Contact_BAO_Contact::$_greetingTypes as $greeting) {
862 if ($greetingType = CRM_Utils_Array::value($greeting, $fields)) {
863 $customizedValue = CRM_Core_PseudoConstant::getKey('CRM_Contact_BAO_Contact', $greeting . '_id', 'Customized');
864 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
865 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
866 [1 => ucwords(str_replace('_', ' ', $greeting))]
867 );
868 }
869 }
870 }
871
872 // @todo - can we remove the 'is_monetary' concept?
873 if ($form->_values['event']['is_monetary']) {
874 if (empty($form->_requireApproval) && !empty($fields['amount']) && $fields['amount'] > 0 &&
875 !isset($fields['payment_processor_id'])) {
876 $errors['payment_processor_id'] = ts('Please select a Payment Method');
877 }
878
879 if (self::isZeroAmount($fields, $form)) {
880 return empty($errors) ? TRUE : $errors;
881 }
882
883 // also return if zero fees for valid members
884 if (!empty($fields['bypass_payment']) ||
885 (!$form->_allowConfirmation && ($form->_requireApproval || $form->_allowWaitlist))
886 ) {
887 return empty($errors) ? TRUE : $errors;
888 }
889 CRM_Core_Payment_Form::validatePaymentInstrument(
890 $fields['payment_processor_id'],
891 $fields,
892 $errors,
893 (!$form->_isBillingAddressRequiredForPayLater ? NULL : 'billing')
894 );
895 }
896
897 return empty($errors) ? TRUE : $errors;
898 }
899
900 /**
901 * Check if profiles are complete when event registration occurs(CRM-9587).
902 *
903 * @param array $fields
904 * @param array $errors
905 * @param int $eventId
906 */
907 public static function checkProfileComplete($fields, &$errors, $eventId) {
908 $email = '';
909 foreach ($fields as $fieldname => $fieldvalue) {
910 if (substr($fieldname, 0, 6) == 'email-' && $fieldvalue) {
911 $email = $fieldvalue;
912 }
913 }
914
915 if (!$email && !(!empty($fields['first_name']) && !empty($fields['last_name']))) {
916 $defaults = $params = ['id' => $eventId];
917 CRM_Event_BAO_Event::retrieve($params, $defaults);
918 $message = ts("Mandatory fields (first name and last name, OR email address) are missing from this form.");
919 $errors['_qf_default'] = $message;
920 }
921 }
922
923 /**
924 * Process the form submission.
925 */
926 public function postProcess() {
927 // get the submitted form values.
928 $params = $this->controller->exportValues($this->_name);
929
930 //set as Primary participant
931 $params['is_primary'] = 1;
932
933 if ($this->_values['event']['is_pay_later']
934 && (!array_key_exists('hidden_processor', $params) || $params['payment_processor_id'] == 0)
935 ) {
936 $params['is_pay_later'] = 1;
937 }
938 else {
939 $params['is_pay_later'] = 0;
940 }
941
942 $this->set('is_pay_later', $params['is_pay_later']);
943
944 // assign pay later stuff
945 $this->_params['is_pay_later'] = CRM_Utils_Array::value('is_pay_later', $params, FALSE);
946 $this->assign('is_pay_later', $params['is_pay_later']);
947 if ($params['is_pay_later']) {
948 $this->assign('pay_later_text', $this->_values['event']['pay_later_text']);
949 $this->assign('pay_later_receipt', $this->_values['event']['pay_later_receipt']);
950 }
951
952 if (!$this->_allowConfirmation) {
953 // check if the participant is already registered
954 if (!$this->_skipDupeRegistrationCheck) {
955 $params['contact_id'] = self::getRegistrationContactID($params, $this, FALSE);
956 }
957 }
958
959 if (!empty($params['image_URL'])) {
960 CRM_Contact_BAO_Contact::processImageParams($params);
961 }
962
963 //carry campaign to partcipants.
964 if (array_key_exists('participant_campaign_id', $params)) {
965 $params['campaign_id'] = $params['participant_campaign_id'];
966 }
967 else {
968 $params['campaign_id'] = $this->_values['event']['campaign_id'] ?? NULL;
969 }
970
971 //hack to allow group to register w/ waiting
972 $primaryParticipantCount = self::getParticipantCount($this, $params);
973
974 $totalParticipants = $primaryParticipantCount;
975 if (!empty($params['additional_participants'])) {
976 $totalParticipants += $params['additional_participants'];
977 }
978 if (!$this->_allowConfirmation && !empty($params['bypass_payment']) &&
979 is_numeric($this->_availableRegistrations) &&
980 $totalParticipants > $this->_availableRegistrations
981 ) {
982 $this->_allowWaitlist = TRUE;
983 $this->set('allowWaitlist', TRUE);
984 }
985
986 //carry participant id if pre-registered.
987 if ($this->_allowConfirmation && $this->_participantId) {
988 $params['participant_id'] = $this->_participantId;
989 }
990
991 $params['defaultRole'] = 1;
992 if (array_key_exists('participant_role', $params)) {
993 $params['participant_role_id'] = $params['participant_role'];
994 }
995
996 if (array_key_exists('participant_role_id', $params)) {
997 $params['defaultRole'] = 0;
998 }
999 if (empty($params['participant_role_id']) &&
1000 $this->_values['event']['default_role_id']
1001 ) {
1002 $params['participant_role_id'] = $this->_values['event']['default_role_id'];
1003 }
1004
1005 $config = CRM_Core_Config::singleton();
1006 $params['currencyID'] = $config->defaultCurrency;
1007
1008 if ($this->_values['event']['is_monetary']) {
1009 // we first reset the confirm page so it accepts new values
1010 $this->controller->resetPage('Confirm');
1011
1012 //added for discount
1013 $discountId = CRM_Core_BAO_Discount::findSet($this->_eventId, 'civicrm_event');
1014 $params['amount_level'] = $this->getAmountLevel($params, $discountId);
1015 if (!empty($this->_values['discount'][$discountId])) {
1016 $params['discount_id'] = $discountId;
1017 $params['amount'] = $this->_values['discount'][$discountId][$params['amount']]['value'];
1018 }
1019 elseif (empty($params['priceSetId'])) {
1020 if (!empty($params['amount'])) {
1021 $params['amount'] = $this->_values['fee'][$params['amount']]['value'];
1022 }
1023 else {
1024 $params['amount'] = '';
1025 }
1026 }
1027 else {
1028 $lineItem = [];
1029 CRM_Price_BAO_PriceSet::processAmount($this->_values['fee'], $params, $lineItem);
1030 if ($params['tax_amount']) {
1031 $this->set('tax_amount', $params['tax_amount']);
1032 }
1033 $submittedLineItems = $this->get('lineItem');
1034 if (!empty($submittedLineItems) && is_array($submittedLineItems)) {
1035 $submittedLineItems[0] = $lineItem;
1036 }
1037 else {
1038 $submittedLineItems = [$lineItem];
1039 }
1040 $submittedLineItems = array_filter($submittedLineItems);
1041 $this->set('lineItem', $submittedLineItems);
1042 $this->set('lineItemParticipantsCount', [$primaryParticipantCount]);
1043 }
1044
1045 $this->set('amount', $params['amount']);
1046 $this->set('amount_level', $params['amount_level']);
1047
1048 // generate and set an invoiceID for this transaction
1049 $invoiceID = md5(uniqid(rand(), TRUE));
1050 $this->set('invoiceID', $invoiceID);
1051
1052 if ($this->_paymentProcessor) {
1053 $payment = $this->_paymentProcessor['object'];
1054 $payment->setBaseReturnUrl('civicrm/event/register');
1055 }
1056
1057 // ContributeMode is a deprecated concept. It is short-hand for a bunch of
1058 // assumptions we are working to remove.
1059 $this->set('contributeMode', 'direct');
1060
1061 if ($this->_values['event']['is_monetary']) {
1062 $params['currencyID'] = $config->defaultCurrency;
1063 $params['invoiceID'] = $invoiceID;
1064 }
1065 $this->_params = $this->get('params');
1066 // Set the button so we know what
1067 $params['button'] = $this->controller->getButtonName();
1068 if (!empty($this->_params) && is_array($this->_params)) {
1069 $this->_params[0] = $params;
1070 }
1071 else {
1072 $this->_params = [];
1073 $this->_params[] = $params;
1074 }
1075 $this->set('params', $this->_params);
1076 if ($this->_paymentProcessor &&
1077 // Actually we don't really need to check if it supports pre-approval - we could just call
1078 // it regardless as the function we call re-acts tot the rests of the preApproval call.
1079 $this->_paymentProcessor['object']->supports('preApproval')
1080 && !$this->_allowWaitlist &&
1081 !$this->_requireApproval
1082 ) {
1083
1084 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1085 $this->set('contributeMode', 'express');
1086
1087 // Send Event Name & Id in Params
1088 $params['eventName'] = $this->_values['event']['title'];
1089 $params['eventId'] = $this->_values['event']['id'];
1090
1091 $params['cancelURL'] = CRM_Utils_System::url('civicrm/event/register',
1092 "_qf_Register_display=1&qfKey={$this->controller->_key}",
1093 TRUE, NULL, FALSE
1094 );
1095 if (!empty($params['additional_participants'])) {
1096 $urlArgs = "_qf_Participant_1_display=1&rfp=1&qfKey={$this->controller->_key}";
1097 }
1098 else {
1099 $urlArgs = "_qf_Confirm_display=1&rfp=1&qfKey={$this->controller->_key}";
1100 }
1101 $params['returnURL'] = CRM_Utils_System::url('civicrm/event/register',
1102 $urlArgs,
1103 TRUE, NULL, FALSE
1104 );
1105 $params['invoiceID'] = $invoiceID;
1106
1107 $params['component'] = 'event';
1108 // This code is duplicated multiple places and should be consolidated.
1109 $params = $this->prepareParamsForPaymentProcessor($params);
1110 $this->handlePreApproval($params);
1111 }
1112 elseif ($this->_paymentProcessor &&
1113 (int) $this->_paymentProcessor['billing_mode'] & CRM_Core_Payment::BILLING_MODE_NOTIFY
1114 ) {
1115 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1116 $this->set('contributeMode', 'notify');
1117 }
1118 }
1119 else {
1120 $params['description'] = ts('Online Event Registration') . ' ' . $this->_values['event']['title'];
1121
1122 $this->_params = [];
1123 $this->_params[] = $params;
1124 $this->set('params', $this->_params);
1125
1126 if (
1127 empty($params['additional_participants'])
1128 // CRM-11182 - Optional confirmation screen
1129 && !$this->_values['event']['is_confirm_enabled']
1130 ) {
1131 $this->processRegistration($this->_params);
1132 }
1133 }
1134
1135 // If registering > 1 participant, give status message
1136 if (!empty($params['additional_participants'])) {
1137 $statusMsg = ts('Registration information for participant 1 has been saved.');
1138 CRM_Core_Session::setStatus($statusMsg, ts('Saved'), 'success');
1139 }
1140 }
1141
1142 /**
1143 * Method to check if the user is already registered for the event.
1144 * and if result found redirect to the event info page
1145 *
1146 * @param array $fields
1147 * The input form values(anonymous user).
1148 * @param CRM_Event_Form_Registration_Register $form
1149 * Event data.
1150 * @param bool $isAdditional
1151 * Treat isAdditional participants a bit differently.
1152 *
1153 * @return int
1154 */
1155 public static function checkRegistration($fields, $form, $isAdditional = FALSE) {
1156 // CRM-3907, skip check for preview registrations
1157 // CRM-4320 participant need to walk wizard
1158 if (
1159 ($form->getPaymentMode() === 'test' || $form->_allowConfirmation)
1160 ) {
1161 return FALSE;
1162 }
1163
1164 $contactID = self::getRegistrationContactID($fields, $form, $isAdditional);
1165
1166 if ($contactID) {
1167 $participant = new CRM_Event_BAO_Participant();
1168 $participant->contact_id = $contactID;
1169 $participant->event_id = $form->_values['event']['id'];
1170 if (!empty($fields['participant_role']) && is_numeric($fields['participant_role'])) {
1171 $participant->role_id = $fields['participant_role'];
1172 }
1173 else {
1174 $participant->role_id = $form->_values['event']['default_role_id'];
1175 }
1176 $participant->is_test = 0;
1177 $participant->find();
1178 // Event#30 - Anyone whose status type has `is_counted` OR is on the waitlist should be considered as registered.
1179 $statusTypes = CRM_Event_PseudoConstant::participantStatus(NULL, 'is_counted = 1') + CRM_Event_PseudoConstant::participantStatus(NULL, "name = 'On waitlist'");
1180 while ($participant->fetch()) {
1181 if (array_key_exists($participant->status_id, $statusTypes)) {
1182 if (!$isAdditional && !$form->_values['event']['allow_same_participant_emails']) {
1183 $registerUrl = CRM_Utils_System::url('civicrm/event/register',
1184 "reset=1&id={$form->_values['event']['id']}&cid=0"
1185 );
1186 if ($form->_pcpId) {
1187 $registerUrl .= '&pcpId=' . $form->_pcpId;
1188 }
1189 $registrationType = (CRM_Event_PseudoConstant::getKey('CRM_Event_BAO_Participant', 'participant_status_id', 'On waitlist') == $participant->status_id) ? 'waitlisted' : 'registered';
1190 $status = ts("It looks like you are already %1 for this event. If you want to change your registration, or you feel that you've received this message in error, please contact the site administrator.", [1 => $registrationType]);
1191 $status .= ' ' . ts('You can also <a href="%1">register another participant</a>.', [1 => $registerUrl]);
1192 CRM_Core_Session::singleton()->setStatus($status, ts('Oops.'), 'alert');
1193 $url = CRM_Utils_System::url('civicrm/event/info',
1194 "reset=1&id={$form->_values['event']['id']}&noFullMsg=true"
1195 );
1196 if ($form->_action & CRM_Core_Action::PREVIEW) {
1197 $url .= '&action=preview';
1198 }
1199
1200 if ($form->_pcpId) {
1201 $url .= '&pcpId=' . $form->_pcpId;
1202 }
1203
1204 CRM_Utils_System::redirect($url);
1205 }
1206
1207 if ($isAdditional) {
1208 $status = ts("It looks like this participant is already registered for this event. If you want to change your registration, or you feel that you've received this message in error, please contact the site administrator.");
1209 CRM_Core_Session::singleton()->setStatus($status, ts('Oops.'), 'alert');
1210 return $participant->id;
1211 }
1212 }
1213 }
1214 }
1215 }
1216
1217 }