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 +--------------------------------------------------------------------+
14 * @copyright CiviCRM LLC https://civicrm.org/licensing
18 * This class generates form components for processing Event.
20 class CRM_Event_Form_Registration_Register
extends CRM_Event_Form_Registration
{
23 * The fields involved in this page.
30 * The status message that user view.
34 protected $_waitlistMsg;
35 protected $_requireApprovalMsg;
38 * Deprecated parameter that we hope to remove.
45 * Skip duplicate check.
47 * This can be set using hook_civicrm_buildForm() to override the registration dupe check.
52 public $_skipDupeRegistrationCheck = FALSE;
54 public $_paymentProcessorID;
57 * Show fee block or not.
71 * Array of payment related fields to potentially display on this form (generally credit card or debit card fields).
73 * This is rendered via billingBlock.tpl.
77 public $_paymentFields = [];
80 * Is this submission incurring no costs.
82 * @param array $fields
83 * @param \CRM_Event_Form_Registration_Register $form
87 protected static function isZeroAmount($fields, $form): bool {
88 $isZeroAmount = FALSE;
89 if (!empty($fields['priceSetId'])) {
90 if (empty($fields['amount'])) {
94 elseif (!empty($fields['amount']) &&
95 (isset($form->_values
['discount'][$fields['amount']])
96 && CRM_Utils_Array
::value('value', $form->_values
['discount'][$fields['amount']]) == 0
101 elseif (!empty($fields['amount']) &&
102 (isset($form->_values
['fee'][$fields['amount']])
103 && CRM_Utils_Array
::value('value', $form->_values
['fee'][$fields['amount']]) == 0
106 $isZeroAmount = TRUE;
108 return $isZeroAmount;
112 * Get the contact id for the registration.
114 * @param array $fields
115 * @param CRM_Event_Form_Registration $form
116 * @param bool $isAdditional
120 public static function getRegistrationContactID($fields, $form, $isAdditional) {
122 if (!$isAdditional) {
123 $contactID = $form->getContactID();
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'])]);
132 * Set variables up before form is built.
134 * @throws \CRM_Core_Exception
136 public function preProcess() {
137 parent
::preProcess();
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']));
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();
152 $this->_allowWaitlist
= FALSE;
153 if ($eventFull && !$this->_allowConfirmation
&& !empty($this->_values
['event']['has_waitlist'])) {
154 $this->_allowWaitlist
= TRUE;
155 $this->_waitlistMsg
= CRM_Utils_Array
::value('waitlist_text', $this->_values
['event']);
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.');
160 $this->set('allowWaitlist', $this->_allowWaitlist
);
162 //To check if the user is already registered for the event(CRM-2426)
163 if (!$this->_skipDupeRegistrationCheck
) {
164 self
::checkRegistration(NULL, $this);
167 $this->assign('availableRegistrations', $this->_availableRegistrations
);
169 // get the participant values from EventFees.php, CRM-4320
170 if ($this->_allowConfirmation
) {
171 CRM_Event_Form_EventFees
::preProcess($this);
176 * Set default values for the form.
180 * @throws \CRM_Core_Exception
181 * @throws \CiviCRM_API3_Exception
183 public function setDefaultValues() {
184 $this->_defaults
= [];
185 if (!$this->_allowConfirmation
&& $this->_requireApproval
) {
186 $this->_defaults
['bypass_payment'] = 1;
188 $contactID = $this->getContactID();
189 CRM_Core_Payment_Form
::setDefaultValues($this, $contactID);
191 CRM_Event_BAO_Participant
::formatFieldsAndSetProfileDefaults($contactID, $this);
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;
202 //if event is monetary and pay later is enabled and payment
203 //processor is not available then freeze the pay later checkbox with
205 if (!empty($this->_values
['event']['is_pay_later']) &&
206 !is_array($this->_paymentProcessor
)
208 $this->_defaults
['is_pay_later'] = 1;
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']
220 foreach ($this->_fields
as $name => $field) {
221 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
223 if (!isset($this->_defaults
[$name])) {
224 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID, $name, $this->_defaults
,
225 NULL, CRM_Profile_Form
::MODE_REGISTER
232 //fix for CRM-3088, default value for discount set.
234 if (!empty($this->_values
['discount'])) {
235 $discountId = CRM_Core_BAO_Discount
::findSet($this->_eventId
, 'civicrm_event');
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'],
243 $this->_defaults
['amount'] = key(array_slice($this->_values
['discount'][$discountId],
244 $discountKey - 1, $discountKey, TRUE
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'];
256 if ($this->_priceSetId
&& !empty($this->_feeBlock
)) {
257 foreach ($this->_feeBlock
as $key => $val) {
258 if (empty($val['options'])) {
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'])) {
265 if ($val['html_type'] == 'CheckBox') {
266 $this->_defaults
["price_{$key}"][$keys] = 1;
269 $this->_defaults
["price_{$key}"] = $keys;
273 $unsetSubmittedOptions[$val['id']] = $optionFullIds;
275 //reset values for all options those are full.
276 CRM_Event_Form_Registration
::resetElementValue($unsetSubmittedOptions, $this);
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;
288 if ($this->_additionalParticipantIds
) {
289 $hasAdditionalParticipants = TRUE;
290 $this->_defaults
['additional_participants'] = count($this->_additionalParticipantIds
);
293 $this->assign('hasAdditionalParticipants', $hasAdditionalParticipants);
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' );
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);
307 return $this->_defaults
;
311 * Build the form object.
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');
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']);
322 CRM_Core_Payment_ProcessorForm
::buildQuickForm($this);
324 $contactID = $this->getContactID();
326 $this->assign('contact_id', $contactID);
327 $this->assign('display_name', CRM_Contact_BAO_Contact
::displayName($contactID));
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;
341 $this->add('select', 'additional_participants',
342 ts('How many people are you registering?'),
345 ['onChange' => "allowParticipant()"]
347 $isAdditionalParticipants = TRUE;
351 if (!$this->_allowConfirmation
) {
352 $bypassPayment = TRUE;
355 //hack to allow group to register w/ waiting
356 if ((!empty($this->_values
['event']['is_multiple_registrations']) ||
359 !$this->_allowConfirmation
&&
360 is_numeric($this->_availableRegistrations
) && !empty($this->_values
['event']['has_waitlist'])
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
]);
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.')
375 //case where only approval needed - no waitlist.
376 if ($this->_requireApproval
&&
377 !$this->_allowWaitlist
&& !$bypassPayment
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.')
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);
390 if ($this->_values
['event']['is_monetary']) {
391 self
::buildAmount($this);
394 $pps = $this->getProcessors();
395 if ($this->getContactID() === 0 && !$this->_values
['event']['is_multiple_registrations']) {
396 //@todo we are blocking for multiple registrations because we haven't tested
397 $this->addCIDZeroOptions();
400 if ($this->_values
['event']['is_monetary']) {
401 $this->addPaymentProcessorFieldsToForm();
404 $this->addElement('hidden', 'bypass_payment', NULL, ['id' => 'bypass_payment']);
406 $this->assign('bypassPayment', $bypassPayment);
408 $userID = $this->getContactID();
411 $createCMSUser = FALSE;
413 if ($this->_values
['custom_pre_id']) {
414 $profileID = $this->_values
['custom_pre_id'];
415 $createCMSUser = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_cms_user');
418 if (!$createCMSUser &&
419 $this->_values
['custom_post_id']
421 if (!is_array($this->_values
['custom_post_id'])) {
422 $profileIDs = [$this->_values
['custom_post_id']];
425 $profileIDs = $this->_values
['custom_post_id'];
427 foreach ($profileIDs as $pid) {
428 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $pid, 'is_cms_user')) {
430 $createCMSUser = TRUE;
436 if ($createCMSUser) {
437 CRM_Core_BAO_CMSUser
::buildForm($this, $profileID, TRUE);
441 //we have to load confirm contribution button in template
442 //when multiple payment processor as the user
443 //can toggle with payment processor selection
444 $billingModePaymentProcessors = 0;
445 if (!CRM_Utils_System
::isNull($this->_paymentProcessors
)) {
446 foreach ($this->_paymentProcessors
as $key => $values) {
447 if ($values['billing_mode'] == CRM_Core_Payment
::BILLING_MODE_BUTTON
) {
448 $billingModePaymentProcessors++
;
453 if ($billingModePaymentProcessors && count($this->_paymentProcessors
) == $billingModePaymentProcessors) {
454 $allAreBillingModeProcessors = TRUE;
457 $allAreBillingModeProcessors = FALSE;
460 if (!$allAreBillingModeProcessors ||
!empty($this->_values
['event']['is_pay_later']) ||
$bypassPayment
463 //freeze button to avoid multiple calls.
464 if (empty($this->_values
['event']['is_monetary'])) {
465 $this->submitOnce
= TRUE;
468 // CRM-11182 - Optional confirmation screen
469 // Change button label depending on whether the next action is confirm or register
471 !$this->_values
['event']['is_multiple_registrations']
472 && !$this->_values
['event']['is_monetary']
473 && !$this->_values
['event']['is_confirm_enabled']
475 $buttonLabel = ts('Register');
478 $buttonLabel = ts('Review your registration');
484 'name' => $buttonLabel,
485 'spacing' => ' ',
491 $this->addFormRule(['CRM_Event_Form_Registration_Register', 'formRule'], $this);
492 $this->unsavedChangesWarn
= TRUE;
496 CRM_PCP_BAO_PCP
::buildPcp($this->_pcpId
, $this);
501 * Build the radio/text form elements for the amount field
503 * @param CRM_Event_Form_Registration_Register $form
505 * @param bool $required
506 * True if you want to add formRule.
507 * @param int $discountId
508 * Discount id for the event.
510 * @throws \CRM_Core_Exception
512 public static function buildAmount(&$form, $required = TRUE, $discountId = NULL) {
513 // build amount only when needed, skip incase of event full and waitlisting is enabled
514 // and few other conditions check preProcess()
515 if (property_exists($form, '_noFees') && $form->_noFees
) {
519 //if payment done, no need to build the fee block.
520 if (!empty($form->_paymentId
)) {
521 //fix to display line item in update mode.
522 $form->assign('priceSet', isset($form->_priceSet
) ?
$form->_priceSet
: NULL);
526 $feeFields = CRM_Utils_Array
::value('fee', $form->_values
);
528 if (is_array($feeFields)) {
529 $form->_feeBlock
= &$form->_values
['fee'];
532 //check for discount.
533 $discountedFee = CRM_Utils_Array
::value('discount', $form->_values
);
534 if (is_array($discountedFee) && !empty($discountedFee)) {
536 $form->_discountId
= $discountId = CRM_Core_BAO_Discount
::findSet($form->_eventId
, 'civicrm_event');
539 $form->_feeBlock
= &$form->_values
['discount'][$discountId];
542 if (!is_array($form->_feeBlock
)) {
543 $form->_feeBlock
= [];
546 //its time to call the hook.
547 CRM_Utils_Hook
::buildAmount('event', $form, $form->_feeBlock
);
549 //reset required if participant is skipped.
550 $button = substr($form->controller
->getButtonName(), -4);
551 if ($required && $button == 'skip') {
555 $className = CRM_Utils_System
::getClassName($form);
557 //build the priceset fields.
558 if (isset($form->_priceSetId
) && $form->_priceSetId
) {
560 //format price set fields across option full.
561 self
::formatFieldsForOptionFull($form);
563 if (!empty($form->_priceSet
['is_quick_config'])) {
564 $form->_quickConfig
= $form->_priceSet
['is_quick_config'];
566 $form->add('hidden', 'priceSetId', $form->_priceSetId
);
568 // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
569 $adminFieldVisible = FALSE;
570 if (CRM_Core_Permission
::check('administer CiviCRM')) {
571 $adminFieldVisible = TRUE;
574 $hideAdminValues = TRUE;
575 if (CRM_Core_Permission
::check('edit event participants')) {
576 $hideAdminValues = FALSE;
579 foreach ($form->_feeBlock
as $field) {
580 // public AND admin visibility fields are included for back-office registration and back-office change selections
581 if (CRM_Utils_Array
::value('visibility', $field) == 'public' ||
582 (CRM_Utils_Array
::value('visibility', $field) == 'admin' && $adminFieldVisible == TRUE) ||
583 $className == 'CRM_Event_Form_Participant' ||
584 $className == 'CRM_Event_Form_ParticipantFeeSelection'
586 $fieldId = $field['id'];
587 $elementName = 'price_' . $fieldId;
589 $isRequire = CRM_Utils_Array
::value('is_required', $field);
590 if ($button == 'skip') {
594 //user might modified w/ hook.
595 $options = CRM_Utils_Array
::value('options', $field);
596 $formClasses = ['CRM_Event_Form_Participant', 'CRM_Event_Form_ParticipantFeeSelection'];
598 if (!is_array($options)) {
601 elseif ($hideAdminValues && !in_array($className, $formClasses)) {
602 $publicVisibilityID = CRM_Price_BAO_PriceField
::getVisibilityOptionID('public');
603 $adminVisibilityID = CRM_Price_BAO_PriceField
::getVisibilityOptionID('admin');
605 foreach ($options as $key => $currentOption) {
606 $optionVisibility = CRM_Utils_Array
::value('visibility_id', $currentOption, $publicVisibilityID);
607 if ($optionVisibility == $adminVisibilityID) {
608 unset($options[$key]);
613 $optionFullIds = CRM_Utils_Array
::value('option_full_ids', $field, []);
615 //soft suppress required rule when option is full.
616 if (!empty($optionFullIds) && (count($options) == count($optionFullIds))) {
619 if (!empty($options)) {
621 CRM_Price_BAO_PriceField
::addQuickFormElement($form,
633 $form->assign('priceSet', $form->_priceSet
);
636 $eventFeeBlockValues = [];
637 foreach ($form->_feeBlock
as $fee) {
638 if (is_array($fee)) {
641 $totalAmountJs = NULL;
642 if ($className == 'CRM_Event_Form_Participant') {
643 $totalAmountJs = ['onClick' => "fillTotalAmount(" . $fee['value'] . ")"];
646 $eventFeeBlockValues['amount_id_' . $fee['amount_id']] = $fee['value'];
647 $elements[] = &$form->createElement('radio', NULL, '',
648 CRM_Utils_Money
::format($fee['value']) . ' ' .
655 $form->assign('eventFeeBlockValues', json_encode($eventFeeBlockValues));
657 $form->_defaults
['amount'] = CRM_Utils_Array
::value('default_fee_id', $form->_values
['event']);
658 $element = &$form->addGroup($elements, 'amount', ts('Event Fee(s)'), '<br />');
659 if (isset($form->_online
) && $form->_online
) {
663 $form->addRule('amount', ts('Fee Level is a required field.'), 'required');
669 * @param CRM_Event_Form_Registration $form
671 public static function formatFieldsForOptionFull(&$form) {
672 $priceSet = $form->get('priceSet');
673 $priceSetId = $form->get('priceSetId');
674 $defaultPricefieldIds = [];
675 if (!empty($form->_values
['line_items'])) {
676 foreach ($form->_values
['line_items'] as $lineItem) {
677 $defaultPricefieldIds[] = $lineItem['price_field_value_id'];
681 !is_array($priceSet) ||
682 empty($priceSet) ||
empty($priceSet['optionsMaxValueTotal'])
687 $skipParticipants = $formattedPriceSetDefaults = [];
688 if (!empty($form->_allowConfirmation
) && (isset($form->_pId
) ||
isset($form->_additionalParticipantId
))) {
689 $participantId = isset($form->_pId
) ?
$form->_pId
: $form->_additionalParticipantId
;
690 $pricesetDefaults = CRM_Event_Form_EventFees
::setDefaultPriceSet($participantId,
693 // modify options full to respect the selected fields
694 // options on confirmation.
695 $formattedPriceSetDefaults = self
::formatPriceSetParams($form, $pricesetDefaults);
697 // to skip current registered participants fields option count on confirmation.
698 $skipParticipants[] = $form->_participantId
;
699 if (!empty($form->_additionalParticipantIds
)) {
700 $skipParticipants = array_merge($skipParticipants, $form->_additionalParticipantIds
);
704 $className = CRM_Utils_System
::getClassName($form);
706 //get the current price event price set options count.
707 $currentOptionsCount = self
::getPriceSetOptionCount($form);
708 $recordedOptionsCount = CRM_Event_BAO_Participant
::priceSetOptionsCount($form->_eventId
, $skipParticipants);
709 $optionFullTotalAmount = 0;
710 $currentParticipantNo = (int) substr($form->_name
, 12);
711 foreach ($form->_feeBlock
as & $field) {
713 $fieldId = $field['id'];
714 if (!is_array($field['options'])) {
717 foreach ($field['options'] as & $option) {
718 $optId = $option['id'];
719 $count = CRM_Utils_Array
::value('count', $option, 0);
720 $maxValue = CRM_Utils_Array
::value('max_value', $option, 0);
721 $dbTotalCount = CRM_Utils_Array
::value($optId, $recordedOptionsCount, 0);
722 $currentTotalCount = CRM_Utils_Array
::value($optId, $currentOptionsCount, 0);
724 $totalCount = $currentTotalCount +
$dbTotalCount;
727 (($totalCount >= $maxValue) &&
728 (empty($form->_lineItem
[$currentParticipantNo][$optId]['price_field_id']) ||
$dbTotalCount >= $maxValue))
731 $optionFullIds[$optId] = $optId;
732 if ($field['html_type'] != 'Select') {
733 if (in_array($optId, $defaultPricefieldIds)) {
734 $optionFullTotalAmount +
= CRM_Utils_Array
::value('amount', $option);
738 if (!empty($defaultPricefieldIds) && in_array($optId, $defaultPricefieldIds)) {
739 unset($optionFullIds[$optId]);
743 //here option is not full,
744 //but we don't want to allow participant to increase
745 //seats at the time of re-walking registration.
747 !empty($form->_allowConfirmation
) &&
748 !empty($formattedPriceSetDefaults)
750 if (empty($formattedPriceSetDefaults["price_{$field}"]) ||
empty($formattedPriceSetDefaults["price_{$fieldId}"][$optId])) {
751 $optionFullIds[$optId] = $optId;
755 $option['is_full'] = $isFull;
756 $option['db_total_count'] = $dbTotalCount;
757 $option['total_option_count'] = $dbTotalCount +
$currentTotalCount;
760 //ignore option full for offline registration.
761 if ($className == 'CRM_Event_Form_Participant') {
765 //finally get option ids in.
766 $field['option_full_ids'] = $optionFullIds;
768 $form->assign('optionFullTotalAmount', $optionFullTotalAmount);
774 * @param array $fields
775 * The input form values.
776 * @param array $files
777 * The uploaded files if any.
778 * @param \CRM_Event_Form_Registration_Register $form
781 * true if no errors, else array of errors
783 * @throws \CRM_Core_Exception
785 public static function formRule($fields, $files, $form) {
787 //check that either an email or firstname+lastname is included in the form(CRM-9587)
788 self
::checkProfileComplete($fields, $errors, $form->_eventId
);
789 //To check if the user is already registered for the event(CRM-2426)
790 if (!$form->_skipDupeRegistrationCheck
) {
791 self
::checkRegistration($fields, $form);
793 //check for availability of registrations.
794 if (!$form->_allowConfirmation
&& empty($fields['bypass_payment']) &&
795 is_numeric($form->_availableRegistrations
) &&
796 CRM_Utils_Array
::value('additional_participants', $fields) >= $form->_availableRegistrations
798 $errors['additional_participants'] = ts("There is only enough space left on this event for %1 participant(s).", [1 => $form->_availableRegistrations
]);
801 $numberAdditionalParticipants = $fields['additional_participants'] ??
0;
803 if ($numberAdditionalParticipants && !CRM_Utils_Rule
::positiveInteger($fields['additional_participants'])) {
804 $errors['additional_participants'] = ts('Please enter a whole number for Number of additional people.');
807 // during confirmation don't allow to increase additional participants, CRM-4320
808 if ($form->_allowConfirmation
&& $numberAdditionalParticipants &&
809 is_array($form->_additionalParticipantIds
) &&
810 $numberAdditionalParticipants > count($form->_additionalParticipantIds
)
812 $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
)]);
815 //don't allow to register w/ waiting if enough spaces available.
816 if (!empty($fields['bypass_payment']) && $form->_allowConfirmation
) {
817 if (!is_numeric($form->_availableRegistrations
) ||
818 (empty($fields['priceSetId']) && CRM_Utils_Array
::value('additional_participants', $fields) < $form->_availableRegistrations
)
820 $errors['bypass_payment'] = ts("Oops. There are enough available spaces in this event. You can not add yourself to the waiting list.");
824 // priceset validations
825 if (!empty($fields['priceSetId']) &&
826 !$form->_requireApproval
&& !$form->_allowWaitlist
829 $formatted = self
::formatPriceSetParams($form, $fields);
830 $ppParams = [$formatted];
831 $priceSetErrors = self
::validatePriceSet($form, $ppParams);
832 $primaryParticipantCount = self
::getParticipantCount($form, $ppParams);
834 //get price set fields errors in.
835 $errors = array_merge($errors, CRM_Utils_Array
::value(0, $priceSetErrors, []));
837 $totalParticipants = $primaryParticipantCount;
838 if ($numberAdditionalParticipants) {
839 $totalParticipants +
= $numberAdditionalParticipants;
842 if (empty($fields['bypass_payment']) &&
843 !$form->_allowConfirmation
&&
844 is_numeric($form->_availableRegistrations
) &&
845 $form->_availableRegistrations
< $totalParticipants
847 $errors['_qf_default'] = ts("Only %1 Registrations available.", [1 => $form->_availableRegistrations
]);
851 CRM_Price_BAO_PriceSet
::processAmount($form->_values
['fee'], $fields, $lineItem);
853 $minAmt = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $fields['priceSetId'], 'min_amount');
854 if ($fields['amount'] < 0) {
855 $errors['_qf_default'] = ts('Event Fee(s) can not be less than zero. Please select the options accordingly');
857 elseif (!empty($minAmt) && $fields['amount'] < $minAmt) {
858 $errors['_qf_default'] = ts('A minimum amount of %1 should be selected from Event Fee(s).', [
859 1 => CRM_Utils_Money
::format($minAmt),
863 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
864 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
865 $customizedValue = CRM_Core_PseudoConstant
::getKey('CRM_Contact_BAO_Contact', $greeting . '_id', 'Customized');
866 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
867 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
868 [1 => ucwords(str_replace('_', ' ', $greeting))]
874 // @todo - can we remove the 'is_monetary' concept?
875 if ($form->_values
['event']['is_monetary']) {
876 if (empty($form->_requireApproval
) && !empty($fields['amount']) && $fields['amount'] > 0 &&
877 !isset($fields['payment_processor_id'])) {
878 $errors['payment_processor_id'] = ts('Please select a Payment Method');
881 if (self
::isZeroAmount($fields, $form)) {
882 return empty($errors) ?
TRUE : $errors;
885 // also return if zero fees for valid members
886 if (!empty($fields['bypass_payment']) ||
887 (!$form->_allowConfirmation
&& ($form->_requireApproval ||
$form->_allowWaitlist
))
889 return empty($errors) ?
TRUE : $errors;
891 CRM_Core_Payment_Form
::validatePaymentInstrument(
892 $fields['payment_processor_id'],
895 (!$form->_isBillingAddressRequiredForPayLater ?
NULL : 'billing')
899 return empty($errors) ?
TRUE : $errors;
903 * Check if profiles are complete when event registration occurs(CRM-9587).
905 * @param array $fields
906 * @param array $errors
907 * @param int $eventId
909 public static function checkProfileComplete($fields, &$errors, $eventId) {
911 foreach ($fields as $fieldname => $fieldvalue) {
912 if (substr($fieldname, 0, 6) == 'email-' && $fieldvalue) {
913 $email = $fieldvalue;
917 if (!$email && !(!empty($fields['first_name']) && !empty($fields['last_name']))) {
918 $defaults = $params = ['id' => $eventId];
919 CRM_Event_BAO_Event
::retrieve($params, $defaults);
920 $message = ts("Mandatory fields (first name and last name, OR email address) are missing from this form.");
921 $errors['_qf_default'] = $message;
926 * Process the form submission.
928 public function postProcess() {
929 // get the submitted form values.
930 $params = $this->controller
->exportValues($this->_name
);
932 //set as Primary participant
933 $params['is_primary'] = 1;
935 if ($this->_values
['event']['is_pay_later']
936 && (!array_key_exists('hidden_processor', $params) ||
$params['payment_processor_id'] == 0)
938 $params['is_pay_later'] = 1;
941 $params['is_pay_later'] = 0;
944 $this->set('is_pay_later', $params['is_pay_later']);
946 // assign pay later stuff
947 $this->_params
['is_pay_later'] = CRM_Utils_Array
::value('is_pay_later', $params, FALSE);
948 $this->assign('is_pay_later', $params['is_pay_later']);
949 if ($params['is_pay_later']) {
950 $this->assign('pay_later_text', $this->_values
['event']['pay_later_text']);
951 $this->assign('pay_later_receipt', $this->_values
['event']['pay_later_receipt']);
954 if (!$this->_allowConfirmation
) {
955 // check if the participant is already registered
956 if (!$this->_skipDupeRegistrationCheck
) {
957 $params['contact_id'] = self
::getRegistrationContactID($params, $this, FALSE);
961 if (!empty($params['image_URL'])) {
962 CRM_Contact_BAO_Contact
::processImageParams($params);
965 //carry campaign to partcipants.
966 if (array_key_exists('participant_campaign_id', $params)) {
967 $params['campaign_id'] = $params['participant_campaign_id'];
970 $params['campaign_id'] = CRM_Utils_Array
::value('campaign_id', $this->_values
['event']);
973 //hack to allow group to register w/ waiting
974 $primaryParticipantCount = self
::getParticipantCount($this, $params);
976 $totalParticipants = $primaryParticipantCount;
977 if (!empty($params['additional_participants'])) {
978 $totalParticipants +
= $params['additional_participants'];
980 if (!$this->_allowConfirmation
&& !empty($params['bypass_payment']) &&
981 is_numeric($this->_availableRegistrations
) &&
982 $totalParticipants > $this->_availableRegistrations
984 $this->_allowWaitlist
= TRUE;
985 $this->set('allowWaitlist', TRUE);
988 //carry participant id if pre-registered.
989 if ($this->_allowConfirmation
&& $this->_participantId
) {
990 $params['participant_id'] = $this->_participantId
;
993 $params['defaultRole'] = 1;
994 if (array_key_exists('participant_role', $params)) {
995 $params['participant_role_id'] = $params['participant_role'];
998 if (array_key_exists('participant_role_id', $params)) {
999 $params['defaultRole'] = 0;
1001 if (empty($params['participant_role_id']) &&
1002 $this->_values
['event']['default_role_id']
1004 $params['participant_role_id'] = $this->_values
['event']['default_role_id'];
1007 $config = CRM_Core_Config
::singleton();
1008 $params['currencyID'] = $config->defaultCurrency
;
1010 if ($this->_values
['event']['is_monetary']) {
1011 // we first reset the confirm page so it accepts new values
1012 $this->controller
->resetPage('Confirm');
1014 //added for discount
1015 $discountId = CRM_Core_BAO_Discount
::findSet($this->_eventId
, 'civicrm_event');
1016 $params['amount_level'] = $this->getAmountLevel($params, $discountId);
1017 if (!empty($this->_values
['discount'][$discountId])) {
1018 $params['discount_id'] = $discountId;
1019 $params['amount'] = $this->_values
['discount'][$discountId][$params['amount']]['value'];
1021 elseif (empty($params['priceSetId'])) {
1022 if (!empty($params['amount'])) {
1023 $params['amount'] = $this->_values
['fee'][$params['amount']]['value'];
1026 $params['amount'] = '';
1031 CRM_Price_BAO_PriceSet
::processAmount($this->_values
['fee'], $params, $lineItem);
1032 if ($params['tax_amount']) {
1033 $this->set('tax_amount', $params['tax_amount']);
1035 $submittedLineItems = $this->get('lineItem');
1036 if (!empty($submittedLineItems) && is_array($submittedLineItems)) {
1037 $submittedLineItems[0] = $lineItem;
1040 $submittedLineItems = [$lineItem];
1042 $submittedLineItems = array_filter($submittedLineItems);
1043 $this->set('lineItem', $submittedLineItems);
1044 $this->set('lineItemParticipantsCount', [$primaryParticipantCount]);
1047 $this->set('amount', $params['amount']);
1048 $this->set('amount_level', $params['amount_level']);
1050 // generate and set an invoiceID for this transaction
1051 $invoiceID = md5(uniqid(rand(), TRUE));
1052 $this->set('invoiceID', $invoiceID);
1054 if ($this->_paymentProcessor
) {
1055 $payment = $this->_paymentProcessor
['object'];
1056 $payment->setBaseReturnUrl('civicrm/event/register');
1059 // ContributeMode is a deprecated concept. It is short-hand for a bunch of
1060 // assumptions we are working to remove.
1061 $this->set('contributeMode', 'direct');
1063 if ($this->_values
['event']['is_monetary']) {
1064 $params['currencyID'] = $config->defaultCurrency
;
1065 $params['invoiceID'] = $invoiceID;
1067 $this->_params
= $this->get('params');
1068 // Set the button so we know what
1069 $params['button'] = $this->controller
->getButtonName();
1070 if (!empty($this->_params
) && is_array($this->_params
)) {
1071 $this->_params
[0] = $params;
1074 $this->_params
= [];
1075 $this->_params
[] = $params;
1077 $this->set('params', $this->_params
);
1078 if ($this->_paymentProcessor
&&
1079 // Actually we don't really need to check if it supports pre-approval - we could just call
1080 // it regardless as the function we call re-acts tot the rests of the preApproval call.
1081 $this->_paymentProcessor
['object']->supports('preApproval')
1082 && !$this->_allowWaitlist
&&
1083 !$this->_requireApproval
1086 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1087 $this->set('contributeMode', 'express');
1089 // Send Event Name & Id in Params
1090 $params['eventName'] = $this->_values
['event']['title'];
1091 $params['eventId'] = $this->_values
['event']['id'];
1093 $params['cancelURL'] = CRM_Utils_System
::url('civicrm/event/register',
1094 "_qf_Register_display=1&qfKey={$this->controller->_key}",
1097 if (!empty($params['additional_participants'])) {
1098 $urlArgs = "_qf_Participant_1_display=1&rfp=1&qfKey={$this->controller->_key}";
1101 $urlArgs = "_qf_Confirm_display=1&rfp=1&qfKey={$this->controller->_key}";
1103 $params['returnURL'] = CRM_Utils_System
::url('civicrm/event/register',
1107 $params['invoiceID'] = $invoiceID;
1109 $params['component'] = 'event';
1110 // This code is duplicated multiple places and should be consolidated.
1111 $params = $this->prepareParamsForPaymentProcessor($params);
1112 $this->handlePreApproval($params);
1114 elseif ($this->_paymentProcessor
&&
1115 (int) $this->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_NOTIFY
1117 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1118 $this->set('contributeMode', 'notify');
1122 $params['description'] = ts('Online Event Registration') . ' ' . $this->_values
['event']['title'];
1124 $this->_params
= [];
1125 $this->_params
[] = $params;
1126 $this->set('params', $this->_params
);
1129 empty($params['additional_participants'])
1130 // CRM-11182 - Optional confirmation screen
1131 && !$this->_values
['event']['is_confirm_enabled']
1133 $this->processRegistration($this->_params
);
1137 // If registering > 1 participant, give status message
1138 if (!empty($params['additional_participants'])) {
1139 $statusMsg = ts('Registration information for participant 1 has been saved.');
1140 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
1145 * Method to check if the user is already registered for the event.
1146 * and if result found redirect to the event info page
1148 * @param array $fields
1149 * The input form values(anonymous user).
1150 * @param CRM_Event_Form_Registration_Register $form
1152 * @param bool $isAdditional
1153 * Treat isAdditional participants a bit differently.
1157 public static function checkRegistration($fields, $form, $isAdditional = FALSE) {
1158 // CRM-3907, skip check for preview registrations
1159 // CRM-4320 participant need to walk wizard
1161 ($form->_mode
== 'test' ||
$form->_allowConfirmation
)
1166 $contactID = self
::getRegistrationContactID($fields, $form, $isAdditional);
1169 $participant = new CRM_Event_BAO_Participant();
1170 $participant->contact_id
= $contactID;
1171 $participant->event_id
= $form->_values
['event']['id'];
1172 if (!empty($fields['participant_role']) && is_numeric($fields['participant_role'])) {
1173 $participant->role_id
= $fields['participant_role'];
1176 $participant->role_id
= $form->_values
['event']['default_role_id'];
1178 $participant->is_test
= 0;
1179 $participant->find();
1180 // Event#30 - Anyone whose status type has `is_counted` OR is on the waitlist should be considered as registered.
1181 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1') + CRM_Event_PseudoConstant
::participantStatus(NULL, "name = 'On waitlist'");
1182 while ($participant->fetch()) {
1183 if (array_key_exists($participant->status_id
, $statusTypes)) {
1184 if (!$isAdditional && !$form->_values
['event']['allow_same_participant_emails']) {
1185 $registerUrl = CRM_Utils_System
::url('civicrm/event/register',
1186 "reset=1&id={$form->_values['event']['id']}&cid=0"
1188 if ($form->_pcpId
) {
1189 $registerUrl .= '&pcpId=' . $form->_pcpId
;
1191 $registrationType = (CRM_Event_PseudoConstant
::getKey('CRM_Event_BAO_Participant', 'participant_status_id', 'On waitlist') == $participant->status_id
) ?
'waitlisted' : 'registered';
1192 $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]);
1193 $status .= ' ' . ts('You can also <a href="%1">register another participant</a>.', [1 => $registerUrl]);
1194 CRM_Core_Session
::singleton()->setStatus($status, ts('Oops.'), 'alert');
1195 $url = CRM_Utils_System
::url('civicrm/event/info',
1196 "reset=1&id={$form->_values['event']['id']}&noFullMsg=true"
1198 if ($form->_action
& CRM_Core_Action
::PREVIEW
) {
1199 $url .= '&action=preview';
1202 if ($form->_pcpId
) {
1203 $url .= '&pcpId=' . $form->_pcpId
;
1206 CRM_Utils_System
::redirect($url);
1209 if ($isAdditional) {
1210 $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.");
1211 CRM_Core_Session
::singleton()->setStatus($status, ts('Oops.'), 'alert');
1212 return $participant->id
;