3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2019
34 * This class generates form components for processing Event.
36 class CRM_Event_Form_Registration_Register
extends CRM_Event_Form_Registration
{
39 * The fields involved in this page.
44 * The status message that user view.
46 protected $_waitlistMsg = NULL;
47 protected $_requireApprovalMsg = NULL;
50 * Deprecated parameter that we hope to remove.
54 public $_quickConfig = NULL;
57 * Skip duplicate check.
59 * This can be set using hook_civicrm_buildForm() to override the registration dupe check.
62 public $_skipDupeRegistrationCheck = FALSE;
64 public $_paymentProcessorID;
67 * Show fee block or not.
69 * @var boolean determines if fee block should be shown or hidden
74 * @var array Fee Block
79 * Array of payment related fields to potentially display on this form (generally credit card or debit card fields).
81 * This is rendered via billingBlock.tpl.
85 public $_paymentFields = array();
88 * Get the contact id for the registration.
90 * @param array $fields
91 * @param CRM_Event_Form_Registration $form
92 * @param bool $isAdditional
96 public static function getRegistrationContactID($fields, $form, $isAdditional) {
99 $contactID = $form->getContactID();
101 if (!$contactID && is_array($fields) && $fields) {
102 $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'])]);
108 * Set variables up before form is built.
110 public function preProcess() {
111 parent
::preProcess();
114 //here we can't use parent $this->_allowWaitlist as user might
115 //walk back and we might set this value in this postProcess.
116 //(we set when spaces < group count and want to allow become part of waiting )
117 $eventFull = CRM_Event_BAO_Participant
::eventFull($this->_eventId
, FALSE, CRM_Utils_Array
::value('has_waitlist', $this->_values
['event']));
119 // Get payment processors if appropriate for this event
120 // We hide the payment fields if the event is full or requires approval,
121 // and the current user has not yet been approved CRM-12279
122 $this->_noFees
= (($eventFull ||
$this->_requireApproval
) && !$this->_allowConfirmation
);
123 $this->_paymentProcessors
= $this->_noFees ?
array() : $this->get('paymentProcessors');
124 $this->preProcessPaymentOptions();
126 $this->_allowWaitlist
= FALSE;
127 if ($eventFull && !$this->_allowConfirmation
&& !empty($this->_values
['event']['has_waitlist'])) {
128 $this->_allowWaitlist
= TRUE;
129 $this->_waitlistMsg
= CRM_Utils_Array
::value('waitlist_text', $this->_values
['event']);
130 if (!$this->_waitlistMsg
) {
131 $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.');
134 $this->set('allowWaitlist', $this->_allowWaitlist
);
136 //To check if the user is already registered for the event(CRM-2426)
137 if (!$this->_skipDupeRegistrationCheck
) {
138 self
::checkRegistration(NULL, $this);
141 $this->assign('availableRegistrations', $this->_availableRegistrations
);
143 // get the participant values from EventFees.php, CRM-4320
144 if ($this->_allowConfirmation
) {
145 CRM_Event_Form_EventFees
::preProcess($this);
150 * Set default values for the form.
152 public function setDefaultValues() {
153 $this->_defaults
= array();
154 if (!$this->_allowConfirmation
&& $this->_requireApproval
) {
155 $this->_defaults
['bypass_payment'] = 1;
157 $contactID = $this->getContactID();
158 CRM_Core_Payment_Form
::setDefaultValues($this, $contactID);
160 CRM_Event_BAO_Participant
::formatFieldsAndSetProfileDefaults($contactID, $this);
162 // Set default payment processor as default payment_processor radio button value
163 if (!empty($this->_paymentProcessors
)) {
164 foreach ($this->_paymentProcessors
as $pid => $value) {
165 if (!empty($value['is_default'])) {
166 $this->_defaults
['payment_processor_id'] = $pid;
171 //if event is monetary and pay later is enabled and payment
172 //processor is not available then freeze the pay later checkbox with
174 if (!empty($this->_values
['event']['is_pay_later']) &&
175 !is_array($this->_paymentProcessor
)
177 $this->_defaults
['is_pay_later'] = 1;
180 //set custom field defaults
181 if (!empty($this->_fields
)) {
182 //load default campaign from page.
183 if (array_key_exists('participant_campaign_id', $this->_fields
)) {
184 $this->_defaults
['participant_campaign_id'] = CRM_Utils_Array
::value('campaign_id',
185 $this->_values
['event']
189 foreach ($this->_fields
as $name => $field) {
190 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
192 if (!isset($this->_defaults
[$name])) {
193 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID, $name, $this->_defaults
,
194 NULL, CRM_Profile_Form
::MODE_REGISTER
201 //fix for CRM-3088, default value for discount set.
203 if (!empty($this->_values
['discount'])) {
204 $discountId = CRM_Core_BAO_Discount
::findSet($this->_eventId
, 'civicrm_event');
206 if (isset($this->_values
['event']['default_discount_fee_id'])) {
207 $discountKey = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
208 $this->_values
['event']['default_discount_fee_id'],
212 $this->_defaults
['amount'] = key(array_slice($this->_values
['discount'][$discountId],
213 $discountKey - 1, $discountKey, TRUE
219 // add this event's default participant role to defaults array
220 // (for cases where participant_role field is included in form via profile)
221 if ($this->_values
['event']['default_role_id']) {
222 $this->_defaults
['participant_role']
223 = $this->_defaults
['participant_role_id'] = $this->_values
['event']['default_role_id'];
225 if ($this->_priceSetId
&& !empty($this->_feeBlock
)) {
226 foreach ($this->_feeBlock
as $key => $val) {
227 if (empty($val['options'])) {
230 $optionFullIds = CRM_Utils_Array
::value('option_full_ids', $val, array());
231 foreach ($val['options'] as $keys => $values) {
232 if ($values['is_default'] && empty($values['is_full'])) {
234 if ($val['html_type'] == 'CheckBox') {
235 $this->_defaults
["price_{$key}"][$keys] = 1;
238 $this->_defaults
["price_{$key}"] = $keys;
242 $unsetSubmittedOptions[$val['id']] = $optionFullIds;
244 //reset values for all options those are full.
245 CRM_Event_Form_Registration
::resetElementValue($unsetSubmittedOptions, $this);
248 //set default participant fields, CRM-4320.
249 $hasAdditionalParticipants = FALSE;
250 if ($this->_allowConfirmation
) {
251 $this->_contactId
= $contactID;
252 $this->_discountId
= $discountId;
253 $forcePayLater = CRM_Utils_Array
::value('is_pay_later', $this->_defaults
, FALSE);
254 $this->_defaults
= array_merge($this->_defaults
, CRM_Event_Form_EventFees
::setDefaultValues($this));
255 $this->_defaults
['is_pay_later'] = $forcePayLater;
257 if ($this->_additionalParticipantIds
) {
258 $hasAdditionalParticipants = TRUE;
259 $this->_defaults
['additional_participants'] = count($this->_additionalParticipantIds
);
262 $this->assign('hasAdditionalParticipants', $hasAdditionalParticipants);
264 // //hack to simplify credit card entry for testing
265 // $this->_defaults['credit_card_type'] = 'Visa';
266 // $this->_defaults['credit_card_number'] = '4807731747657838';
267 // $this->_defaults['cvv2'] = '000';
268 // $this->_defaults['credit_card_exp_date'] = array( 'Y' => '2010', 'M' => '05' );
270 // to process Custom data that are appended to URL
271 $getDefaults = CRM_Core_BAO_CustomGroup
::extractGetParams($this, "'Contact', 'Individual', 'Contribution', 'Participant'");
272 if (!empty($getDefaults)) {
273 $this->_defaults
= array_merge($this->_defaults
, $getDefaults);
276 return $this->_defaults
;
280 * Build the form object.
282 public function buildQuickForm() {
283 // build profiles first so that we can determine address fields etc
284 // and then show copy address checkbox
285 $this->buildCustom($this->_values
['custom_pre_id'], 'customPre');
286 $this->buildCustom($this->_values
['custom_post_id'], 'customPost');
288 // CRM-18399: used by template to pass pre profile id as a url arg
289 $this->assign('custom_pre_id', $this->_values
['custom_pre_id']);
291 CRM_Core_Payment_ProcessorForm
::buildQuickForm($this);
293 $contactID = $this->getContactID();
295 $this->assign('contact_id', $contactID);
296 $this->assign('display_name', CRM_Contact_BAO_Contact
::displayName($contactID));
299 $this->add('hidden', 'scriptFee', NULL);
300 $this->add('hidden', 'scriptArray', NULL);
302 $bypassPayment = $allowGroupOnWaitlist = $isAdditionalParticipants = FALSE;
303 if ($this->_values
['event']['is_multiple_registrations']) {
304 // don't allow to add additional during confirmation if not preregistered.
305 if (!$this->_allowConfirmation ||
$this->_additionalParticipantIds
) {
306 // CRM-17745: Make maximum additional participants configurable
307 // Label is value + 1, since the code sees this is ADDITIONAL participants (in addition to "self")
308 $additionalOptions = array();
309 $additionalOptions[''] = 1;
310 for ($i = 1; $i <= $this->_values
['event']['max_additional_participants']; $i++
) {
311 $additionalOptions[$i] = $i +
1;
313 $this->add('select', 'additional_participants',
314 ts('How many people are you registering?'),
317 array('onChange' => "allowParticipant()")
319 $isAdditionalParticipants = TRUE;
323 if (!$this->_allowConfirmation
) {
324 $bypassPayment = TRUE;
327 //hack to allow group to register w/ waiting
328 if ((!empty($this->_values
['event']['is_multiple_registrations']) ||
331 !$this->_allowConfirmation
&&
332 is_numeric($this->_availableRegistrations
) && !empty($this->_values
['event']['has_waitlist'])
334 $bypassPayment = TRUE;
335 //case might be group become as a part of waitlist.
336 //If not waitlist then they require admin approve.
337 $allowGroupOnWaitlist = TRUE;
338 $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.", array(1 => $this->_availableRegistrations
));
340 if ($this->_requireApproval
) {
341 $this->_requireApprovalMsg
= CRM_Utils_Array
::value('approval_req_text', $this->_values
['event'],
342 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.')
347 //case where only approval needed - no waitlist.
348 if ($this->_requireApproval
&&
349 !$this->_allowWaitlist
&& !$bypassPayment
351 $this->_requireApprovalMsg
= CRM_Utils_Array
::value('approval_req_text', $this->_values
['event'],
352 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.')
356 //lets display status to primary page only.
357 $this->assign('waitlistMsg', $this->_waitlistMsg
);
358 $this->assign('requireApprovalMsg', $this->_requireApprovalMsg
);
359 $this->assign('allowGroupOnWaitlist', $allowGroupOnWaitlist);
360 $this->assign('isAdditionalParticipants', $isAdditionalParticipants);
362 if ($this->_values
['event']['is_monetary']) {
363 self
::buildAmount($this);
367 //@todo this processor adding fn is another one duplicated on contribute - a shared
368 // common class would make this sort of thing extractable
369 $onlinePaymentProcessorEnabled = FALSE;
370 if (!empty($this->_paymentProcessors
)) {
371 foreach ($this->_paymentProcessors
as $key => $name) {
372 if ($name['billing_mode'] == 1) {
373 $onlinePaymentProcessorEnabled = TRUE;
375 $pps[$key] = $name['name'];
378 if ($this->getContactID() === 0 && !$this->_values
['event']['is_multiple_registrations']) {
379 //@todo we are blocking for multiple registrations because we haven't tested
380 $this->addCidZeroOptions($onlinePaymentProcessorEnabled);
382 if (!empty($this->_values
['event']['is_pay_later']) &&
383 ($this->_allowConfirmation ||
(!$this->_requireApproval
&& !$this->_allowWaitlist
))
385 $pps[0] = $this->_values
['event']['pay_later_text'];
388 if ($this->_values
['event']['is_monetary']) {
389 if (count($pps) > 1) {
390 $this->addRadio('payment_processor_id', ts('Payment Method'), $pps,
394 elseif (!empty($pps)) {
395 $ppKeys = array_keys($pps);
396 $currentPP = array_pop($ppKeys);
397 $this->addElement('hidden', 'payment_processor_id', $currentPP);
401 $this->addElement('hidden', 'bypass_payment', NULL, array('id' => 'bypass_payment'));
403 $this->assign('bypassPayment', $bypassPayment);
405 $userID = $this->getContactID();
408 $createCMSUser = FALSE;
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');
415 if (!$createCMSUser &&
416 $this->_values
['custom_post_id']
418 if (!is_array($this->_values
['custom_post_id'])) {
419 $profileIDs = array($this->_values
['custom_post_id']);
422 $profileIDs = $this->_values
['custom_post_id'];
424 foreach ($profileIDs as $pid) {
425 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $pid, 'is_cms_user')) {
427 $createCMSUser = TRUE;
433 if ($createCMSUser) {
434 CRM_Core_BAO_CMSUser
::buildForm($this, $profileID, TRUE);
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++
;
450 if ($billingModePaymentProcessors && count($this->_paymentProcessors
) == $billingModePaymentProcessors) {
451 $allAreBillingModeProcessors = TRUE;
454 $allAreBillingModeProcessors = FALSE;
457 if (!$allAreBillingModeProcessors ||
!empty($this->_values
['event']['is_pay_later']) ||
$bypassPayment
460 //freeze button to avoid multiple calls.
463 if (empty($this->_values
['event']['is_monetary'])) {
464 $js = array('onclick' => "return submitOnce(this,'" . $this->_name
. "','" . ts('Processing') . "');");
467 // CRM-11182 - Optional confirmation screen
468 // Change button label depending on whether the next action is confirm or register
470 !$this->_values
['event']['is_multiple_registrations']
471 && !$this->_values
['event']['is_monetary']
472 && !$this->_values
['event']['is_confirm_enabled']
474 $buttonLabel = ts('Register');
477 $buttonLabel = ts('Continue');
480 $this->addButtons(array(
483 'name' => $buttonLabel,
484 'spacing' => ' ',
492 $this->addFormRule(array('CRM_Event_Form_Registration_Register', 'formRule'), $this);
493 $this->unsavedChangesWarn
= TRUE;
497 CRM_PCP_BAO_PCP
::buildPcp($this->_pcpId
, $this);
502 * Build the radio/text form elements for the amount field
504 * @param CRM_Event_Form_Registration_Register $form
506 * @param bool $required
507 * True if you want to add formRule.
508 * @param int $discountId
509 * Discount id for the event.
511 static public function buildAmount(&$form, $required = TRUE, $discountId = NULL) {
512 // build amount only when needed, skip incase of event full and waitlisting is enabled
513 // and few other conditions check preProcess()
514 if (property_exists($form, '_noFees') && $form->_noFees
) {
518 //if payment done, no need to build the fee block.
519 if (!empty($form->_paymentId
)) {
520 //fix to display line item in update mode.
521 $form->assign('priceSet', isset($form->_priceSet
) ?
$form->_priceSet
: NULL);
525 $feeFields = CRM_Utils_Array
::value('fee', $form->_values
);
527 if (is_array($feeFields)) {
528 $form->_feeBlock
= &$form->_values
['fee'];
531 //check for discount.
532 $discountedFee = CRM_Utils_Array
::value('discount', $form->_values
);
533 if (is_array($discountedFee) && !empty($discountedFee)) {
535 $form->_discountId
= $discountId = CRM_Core_BAO_Discount
::findSet($form->_eventId
, 'civicrm_event');
538 $form->_feeBlock
= &$form->_values
['discount'][$discountId];
541 if (!is_array($form->_feeBlock
)) {
542 $form->_feeBlock
= array();
545 //its time to call the hook.
546 CRM_Utils_Hook
::buildAmount('event', $form, $form->_feeBlock
);
548 //reset required if participant is skipped.
549 $button = substr($form->controller
->getButtonName(), -4);
550 if ($required && $button == 'skip') {
554 $className = CRM_Utils_System
::getClassName($form);
556 //build the priceset fields.
557 if (isset($form->_priceSetId
) && $form->_priceSetId
) {
559 //format price set fields across option full.
560 self
::formatFieldsForOptionFull($form);
562 if (!empty($form->_priceSet
['is_quick_config'])) {
563 $form->_quickConfig
= $form->_priceSet
['is_quick_config'];
565 $form->add('hidden', 'priceSetId', $form->_priceSetId
);
567 // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
568 $adminFieldVisible = FALSE;
569 if (CRM_Core_Permission
::check('administer CiviCRM')) {
570 $adminFieldVisible = TRUE;
573 $hideAdminValues = TRUE;
574 if (CRM_Core_Permission
::check('edit event participants')) {
575 $hideAdminValues = FALSE;
578 foreach ($form->_feeBlock
as $field) {
579 // public AND admin visibility fields are included for back-office registration and back-office change selections
580 if (CRM_Utils_Array
::value('visibility', $field) == 'public' ||
581 (CRM_Utils_Array
::value('visibility', $field) == 'admin' && $adminFieldVisible == TRUE) ||
582 $className == 'CRM_Event_Form_Participant' ||
583 $className == 'CRM_Event_Form_ParticipantFeeSelection'
585 $fieldId = $field['id'];
586 $elementName = 'price_' . $fieldId;
588 $isRequire = CRM_Utils_Array
::value('is_required', $field);
589 if ($button == 'skip') {
593 //user might modified w/ hook.
594 $options = CRM_Utils_Array
::value('options', $field);
595 $formClasses = array('CRM_Event_Form_Participant', 'CRM_Event_Form_ParticipantFeeSelection');
597 if (!is_array($options)) {
600 elseif ($hideAdminValues && !in_array($className, $formClasses)) {
601 $publicVisibilityID = CRM_Price_BAO_PriceField
::getVisibilityOptionID('public');
602 $adminVisibilityID = CRM_Price_BAO_PriceField
::getVisibilityOptionID('admin');
604 foreach ($options as $key => $currentOption) {
605 $optionVisibility = CRM_Utils_Array
::value('visibility_id', $currentOption, $publicVisibilityID);
606 if ($optionVisibility == $adminVisibilityID) {
607 unset($options[$key]);
612 $optionFullIds = CRM_Utils_Array
::value('option_full_ids', $field, array());
614 //soft suppress required rule when option is full.
615 if (!empty($optionFullIds) && (count($options) == count($optionFullIds))) {
618 if (!empty($options)) {
620 CRM_Price_BAO_PriceField
::addQuickFormElement($form,
632 $form->assign('priceSet', $form->_priceSet
);
635 $eventFeeBlockValues = array();
636 foreach ($form->_feeBlock
as $fee) {
637 if (is_array($fee)) {
640 $totalAmountJs = NULL;
641 if ($className == 'CRM_Event_Form_Participant') {
642 $totalAmountJs = array('onClick' => "fillTotalAmount(" . $fee['value'] . ")");
645 $eventFeeBlockValues['amount_id_' . $fee['amount_id']] = $fee['value'];
646 $elements[] = &$form->createElement('radio', NULL, '',
647 CRM_Utils_Money
::format($fee['value']) . ' ' .
654 $form->assign('eventFeeBlockValues', json_encode($eventFeeBlockValues));
656 $form->_defaults
['amount'] = CRM_Utils_Array
::value('default_fee_id', $form->_values
['event']);
657 $element = &$form->addGroup($elements, 'amount', ts('Event Fee(s)'), '<br />');
658 if (isset($form->_online
) && $form->_online
) {
662 $form->addRule('amount', ts('Fee Level is a required field.'), 'required');
668 * @param CRM_Event_Form_Registration $form
670 public static function formatFieldsForOptionFull(&$form) {
671 $priceSet = $form->get('priceSet');
672 $priceSetId = $form->get('priceSetId');
673 $defaultPricefieldIds = array();
674 if (!empty($form->_values
['line_items'])) {
675 foreach ($form->_values
['line_items'] as $lineItem) {
676 $defaultPricefieldIds[] = $lineItem['price_field_value_id'];
680 !is_array($priceSet) ||
681 empty($priceSet) ||
empty($priceSet['optionsMaxValueTotal'])
686 $skipParticipants = $formattedPriceSetDefaults = array();
687 if (!empty($form->_allowConfirmation
) && (isset($form->_pId
) ||
isset($form->_additionalParticipantId
))) {
688 $participantId = isset($form->_pId
) ?
$form->_pId
: $form->_additionalParticipantId
;
689 $pricesetDefaults = CRM_Event_Form_EventFees
::setDefaultPriceSet($participantId,
692 // modify options full to respect the selected fields
693 // options on confirmation.
694 $formattedPriceSetDefaults = self
::formatPriceSetParams($form, $pricesetDefaults);
696 // to skip current registered participants fields option count on confirmation.
697 $skipParticipants[] = $form->_participantId
;
698 if (!empty($form->_additionalParticipantIds
)) {
699 $skipParticipants = array_merge($skipParticipants, $form->_additionalParticipantIds
);
703 $className = CRM_Utils_System
::getClassName($form);
705 //get the current price event price set options count.
706 $currentOptionsCount = self
::getPriceSetOptionCount($form);
707 $recordedOptionsCount = CRM_Event_BAO_Participant
::priceSetOptionsCount($form->_eventId
, $skipParticipants);
708 $optionFullTotalAmount = 0;
709 $currentParticipantNo = (int) substr($form->_name
, 12);
710 foreach ($form->_feeBlock
as & $field) {
711 $optionFullIds = array();
712 $fieldId = $field['id'];
713 if (!is_array($field['options'])) {
716 foreach ($field['options'] as & $option) {
717 $optId = $option['id'];
718 $count = CRM_Utils_Array
::value('count', $option, 0);
719 $maxValue = CRM_Utils_Array
::value('max_value', $option, 0);
720 $dbTotalCount = CRM_Utils_Array
::value($optId, $recordedOptionsCount, 0);
721 $currentTotalCount = CRM_Utils_Array
::value($optId, $currentOptionsCount, 0);
723 $totalCount = $currentTotalCount +
$dbTotalCount;
726 (($totalCount >= $maxValue) &&
727 (empty($form->_lineItem
[$currentParticipantNo][$optId]['price_field_id']) ||
$dbTotalCount >= $maxValue))
730 $optionFullIds[$optId] = $optId;
731 if ($field['html_type'] != 'Select') {
732 if (in_array($optId, $defaultPricefieldIds)) {
733 $optionFullTotalAmount +
= CRM_Utils_Array
::value('amount', $option);
737 if (!empty($defaultPricefieldIds) && in_array($optId, $defaultPricefieldIds)) {
738 unset($optionFullIds[$optId]);
742 //here option is not full,
743 //but we don't want to allow participant to increase
744 //seats at the time of re-walking registration.
746 !empty($form->_allowConfirmation
) &&
747 !empty($formattedPriceSetDefaults)
749 if (empty($formattedPriceSetDefaults["price_{$field}"]) ||
empty($formattedPriceSetDefaults["price_{$fieldId}"][$optId])) {
750 $optionFullIds[$optId] = $optId;
754 $option['is_full'] = $isFull;
755 $option['db_total_count'] = $dbTotalCount;
756 $option['total_option_count'] = $dbTotalCount +
$currentTotalCount;
759 //ignore option full for offline registration.
760 if ($className == 'CRM_Event_Form_Participant') {
761 $optionFullIds = array();
764 //finally get option ids in.
765 $field['option_full_ids'] = $optionFullIds;
767 $form->assign('optionFullTotalAmount', $optionFullTotalAmount);
773 * @param array $fields
774 * The input form values.
775 * @param array $files
776 * The uploaded files if any.
777 * @param CRM_Event_Form_Registration $form
781 * true if no errors, else array of errors
783 public static function formRule($fields, $files, $form) {
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);
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
796 $errors['additional_participants'] = ts("There is only enough space left on this event for %1 participant(s).", array(1 => $form->_availableRegistrations
));
799 // during confirmation don't allow to increase additional participants, CRM-4320
800 if ($form->_allowConfirmation
&& !empty($fields['additional_participants']) &&
801 is_array($form->_additionalParticipantIds
) &&
802 $fields['additional_participants'] > count($form->_additionalParticipantIds
)
804 $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.", array(1 => count($form->_additionalParticipantIds
)));
807 //don't allow to register w/ waiting if enough spaces available.
808 if (!empty($fields['bypass_payment']) && $form->_allowConfirmation
) {
809 if (!is_numeric($form->_availableRegistrations
) ||
810 (empty($fields['priceSetId']) && CRM_Utils_Array
::value('additional_participants', $fields) < $form->_availableRegistrations
)
812 $errors['bypass_payment'] = ts("Oops. There are enough available spaces in this event. You can not add yourself to the waiting list.");
816 if (!empty($fields['additional_participants']) &&
817 !CRM_Utils_Rule
::positiveInteger($fields['additional_participants'])
819 $errors['additional_participants'] = ts('Please enter a whole number for Number of additional people.');
822 // priceset validations
823 if (!empty($fields['priceSetId']) &&
824 !$form->_requireApproval
&& !$form->_allowWaitlist
827 $formatted = self
::formatPriceSetParams($form, $fields);
828 $ppParams = array($formatted);
829 $priceSetErrors = self
::validatePriceSet($form, $ppParams);
830 $primaryParticipantCount = self
::getParticipantCount($form, $ppParams);
832 //get price set fields errors in.
833 $errors = array_merge($errors, CRM_Utils_Array
::value(0, $priceSetErrors, array()));
835 $totalParticipants = $primaryParticipantCount;
836 if (!empty($fields['additional_participants'])) {
837 $totalParticipants +
= $fields['additional_participants'];
840 if (empty($fields['bypass_payment']) &&
841 !$form->_allowConfirmation
&&
842 is_numeric($form->_availableRegistrations
) &&
843 $form->_availableRegistrations
< $totalParticipants
845 $errors['_qf_default'] = ts("Only %1 Registrations available.", array(1 => $form->_availableRegistrations
));
849 CRM_Price_BAO_PriceSet
::processAmount($form->_values
['fee'], $fields, $lineItem);
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');
855 elseif (!empty($minAmt) && $fields['amount'] < $minAmt) {
856 $errors['_qf_default'] = ts('A minimum amount of %1 should be selected from Event Fee(s).', array(
857 1 => CRM_Utils_Money
::format($minAmt),
862 // @todo - can we remove the 'is_monetary' concept?
863 if ($form->_values
['event']['is_monetary']) {
864 if (empty($form->_requireApproval
) && !empty($fields['amount']) && $fields['amount'] > 0 &&
865 !isset($fields['payment_processor_id'])) {
866 $errors['payment_processor_id'] = ts('Please select a Payment Method');
869 $isZeroAmount = $skipPaymentValidation = FALSE;
870 if (!empty($fields['priceSetId'])) {
871 if (CRM_Utils_Array
::value('amount', $fields) == 0) {
872 $isZeroAmount = TRUE;
875 elseif (!empty($fields['amount']) &&
876 (isset($form->_values
['discount'][$fields['amount']])
877 && CRM_Utils_Array
::value('value', $form->_values
['discount'][$fields['amount']]) == 0
880 $isZeroAmount = TRUE;
882 elseif (!empty($fields['amount']) &&
883 (isset($form->_values
['fee'][$fields['amount']])
884 && CRM_Utils_Array
::value('value', $form->_values
['fee'][$fields['amount']]) == 0
887 $isZeroAmount = TRUE;
890 if ($isZeroAmount && !($form->_forcePayement
&& !empty($fields['additional_participants']))) {
891 $skipPaymentValidation = TRUE;
894 // also return if zero fees for valid members
895 if (!empty($fields['bypass_payment']) ||
896 $skipPaymentValidation ||
897 (!$form->_allowConfirmation
&& ($form->_requireApproval ||
$form->_allowWaitlist
))
899 return empty($errors) ?
TRUE : $errors;
901 CRM_Core_Payment_Form
::validatePaymentInstrument(
902 $fields['payment_processor_id'],
905 (!$form->_isBillingAddressRequiredForPayLater ?
NULL : 'billing')
909 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
910 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
911 $customizedValue = CRM_Core_PseudoConstant
::getKey('CRM_Contact_BAO_Contact', $greeting . '_id', 'Customized');
912 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
913 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
914 array(1 => ucwords(str_replace('_', ' ', $greeting)))
919 return empty($errors) ?
TRUE : $errors;
923 * Check if profiles are complete when event registration occurs(CRM-9587).
925 * @param array $fields
926 * @param array $errors
927 * @param int $eventId
929 public static function checkProfileComplete($fields, &$errors, $eventId) {
931 foreach ($fields as $fieldname => $fieldvalue) {
932 if (substr($fieldname, 0, 6) == 'email-' && $fieldvalue) {
933 $email = $fieldvalue;
937 if (!$email && !(!empty($fields['first_name']) && !empty($fields['last_name']))) {
938 $defaults = $params = array('id' => $eventId);
939 CRM_Event_BAO_Event
::retrieve($params, $defaults);
940 $message = ts("Mandatory fields (first name and last name, OR email address) are missing from this form.");
941 $errors['_qf_default'] = $message;
946 * Process the form submission.
948 public function postProcess() {
949 // get the submitted form values.
950 $params = $this->controller
->exportValues($this->_name
);
952 //set as Primary participant
953 $params['is_primary'] = 1;
955 if ($this->_values
['event']['is_pay_later']
956 && (!array_key_exists('hidden_processor', $params) ||
$params['payment_processor_id'] == 0)
958 $params['is_pay_later'] = 1;
961 $params['is_pay_later'] = 0;
964 $this->set('is_pay_later', $params['is_pay_later']);
966 // assign pay later stuff
967 $this->_params
['is_pay_later'] = CRM_Utils_Array
::value('is_pay_later', $params, FALSE);
968 $this->assign('is_pay_later', $params['is_pay_later']);
969 if ($params['is_pay_later']) {
970 $this->assign('pay_later_text', $this->_values
['event']['pay_later_text']);
971 $this->assign('pay_later_receipt', $this->_values
['event']['pay_later_receipt']);
974 if (!$this->_allowConfirmation
) {
975 // check if the participant is already registered
976 if (!$this->_skipDupeRegistrationCheck
) {
977 $params['contact_id'] = self
::getRegistrationContactID($params, $this, FALSE);
981 if (!empty($params['image_URL'])) {
982 CRM_Contact_BAO_Contact
::processImageParams($params);
985 //carry campaign to partcipants.
986 if (array_key_exists('participant_campaign_id', $params)) {
987 $params['campaign_id'] = $params['participant_campaign_id'];
990 $params['campaign_id'] = CRM_Utils_Array
::value('campaign_id', $this->_values
['event']);
993 //hack to allow group to register w/ waiting
994 $primaryParticipantCount = self
::getParticipantCount($this, $params);
996 $totalParticipants = $primaryParticipantCount;
997 if (!empty($params['additional_participants'])) {
998 $totalParticipants +
= $params['additional_participants'];
1000 if (!$this->_allowConfirmation
&& !empty($params['bypass_payment']) &&
1001 is_numeric($this->_availableRegistrations
) &&
1002 $totalParticipants > $this->_availableRegistrations
1004 $this->_allowWaitlist
= TRUE;
1005 $this->set('allowWaitlist', TRUE);
1008 //carry participant id if pre-registered.
1009 if ($this->_allowConfirmation
&& $this->_participantId
) {
1010 $params['participant_id'] = $this->_participantId
;
1013 $params['defaultRole'] = 1;
1014 if (array_key_exists('participant_role', $params)) {
1015 $params['participant_role_id'] = $params['participant_role'];
1018 if (array_key_exists('participant_role_id', $params)) {
1019 $params['defaultRole'] = 0;
1021 if (empty($params['participant_role_id']) &&
1022 $this->_values
['event']['default_role_id']
1024 $params['participant_role_id'] = $this->_values
['event']['default_role_id'];
1027 $config = CRM_Core_Config
::singleton();
1028 $params['currencyID'] = $config->defaultCurrency
;
1030 if ($this->_values
['event']['is_monetary']) {
1031 // we first reset the confirm page so it accepts new values
1032 $this->controller
->resetPage('Confirm');
1034 //added for discount
1035 $discountId = CRM_Core_BAO_Discount
::findSet($this->_eventId
, 'civicrm_event');
1036 $params['amount_level'] = $this->getAmountLevel($params, $discountId);
1037 if (!empty($this->_values
['discount'][$discountId])) {
1038 $params['discount_id'] = $discountId;
1039 $params['amount'] = $this->_values
['discount'][$discountId][$params['amount']]['value'];
1041 elseif (empty($params['priceSetId'])) {
1042 if (!empty($params['amount'])) {
1043 $params['amount'] = $this->_values
['fee'][$params['amount']]['value'];
1046 $params['amount'] = '';
1050 $lineItem = array();
1051 CRM_Price_BAO_PriceSet
::processAmount($this->_values
['fee'], $params, $lineItem);
1052 if ($params['tax_amount']) {
1053 $this->set('tax_amount', $params['tax_amount']);
1055 $submittedLineItems = $this->get('lineItem');
1056 if (!empty($submittedLineItems) && is_array($submittedLineItems)) {
1057 $submittedLineItems[0] = $lineItem;
1060 $submittedLineItems = array($lineItem);
1062 $submittedLineItems = array_filter($submittedLineItems);
1063 $this->set('lineItem', $submittedLineItems);
1064 $this->set('lineItemParticipantsCount', array($primaryParticipantCount));
1067 $this->set('amount', $params['amount']);
1068 $this->set('amount_level', $params['amount_level']);
1070 // generate and set an invoiceID for this transaction
1071 $invoiceID = md5(uniqid(rand(), TRUE));
1072 $this->set('invoiceID', $invoiceID);
1074 if ($this->_paymentProcessor
) {
1075 $payment = $this->_paymentProcessor
['object'];
1076 $payment->setBaseReturnUrl('civicrm/event/register');
1079 // ContributeMode is a deprecated concept. It is short-hand for a bunch of
1080 // assumptions we are working to remove.
1081 $this->set('contributeMode', 'direct');
1083 // This code is duplicated multiple places and should be consolidated.
1084 if (isset($params["state_province_id-{$this->_bltID}"]) &&
1085 $params["state_province_id-{$this->_bltID}"]
1087 $params["state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($params["state_province_id-{$this->_bltID}"]);
1090 if (isset($params["country_id-{$this->_bltID}"]) &&
1091 $params["country_id-{$this->_bltID}"]
1093 $params["country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($params["country_id-{$this->_bltID}"]);
1095 if (isset($params['credit_card_exp_date'])) {
1096 $params['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($params);
1097 $params['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($params);
1099 if ($this->_values
['event']['is_monetary']) {
1100 $params['ip_address'] = CRM_Utils_System
::ipAddress();
1101 $params['currencyID'] = $config->defaultCurrency
;
1102 $params['invoiceID'] = $invoiceID;
1104 $this->_params
= $this->get('params');
1105 // Set the button so we know what
1106 $params['button'] = $this->controller
->getButtonName();
1107 if (!empty($this->_params
) && is_array($this->_params
)) {
1108 $this->_params
[0] = $params;
1111 $this->_params
= array();
1112 $this->_params
[] = $params;
1114 $this->set('params', $this->_params
);
1115 if ($this->_paymentProcessor
&&
1116 // Actually we don't really need to check if it supports pre-approval - we could just call
1117 // it regardless as the function we call re-acts tot the rests of the preApproval call.
1118 $this->_paymentProcessor
['object']->supports('preApproval')
1119 && !$this->_allowWaitlist
&&
1120 !$this->_requireApproval
1123 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1124 $this->set('contributeMode', 'express');
1126 // Send Event Name & Id in Params
1127 $params['eventName'] = $this->_values
['event']['title'];
1128 $params['eventId'] = $this->_values
['event']['id'];
1130 $params['cancelURL'] = CRM_Utils_System
::url('civicrm/event/register',
1131 "_qf_Register_display=1&qfKey={$this->controller->_key}",
1134 if (CRM_Utils_Array
::value('additional_participants', $params, FALSE)) {
1135 $urlArgs = "_qf_Participant_1_display=1&rfp=1&qfKey={$this->controller->_key}";
1138 $urlArgs = "_qf_Confirm_display=1&rfp=1&qfKey={$this->controller->_key}";
1140 $params['returnURL'] = CRM_Utils_System
::url('civicrm/event/register',
1144 $params['invoiceID'] = $invoiceID;
1146 $params['component'] = 'event';
1147 $this->handlePreApproval($params);
1149 elseif ($this->_paymentProcessor
&&
1150 (int) $this->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_NOTIFY
1152 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1153 $this->set('contributeMode', 'notify');
1157 $params['description'] = ts('Online Event Registration') . ' ' . $this->_values
['event']['title'];
1159 $this->_params
= array();
1160 $this->_params
[] = $params;
1161 $this->set('params', $this->_params
);
1164 empty($params['additional_participants'])
1165 && !$this->_values
['event']['is_confirm_enabled'] // CRM-11182 - Optional confirmation screen
1167 $this->processRegistration($this->_params
);
1171 // If registering > 1 participant, give status message
1172 if (CRM_Utils_Array
::value('additional_participants', $params, FALSE)) {
1173 $statusMsg = ts('Registration information for participant 1 has been saved.');
1174 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
1179 * Method to check if the user is already registered for the event.
1180 * and if result found redirect to the event info page
1182 * @param array $fields
1183 * The input form values(anonymous user).
1184 * @param CRM_Event_Form_Registration_Register $form
1186 * @param bool $isAdditional
1187 * Treat isAdditional participants a bit differently.
1191 public static function checkRegistration($fields, $form, $isAdditional = FALSE) {
1192 // CRM-3907, skip check for preview registrations
1193 // CRM-4320 participant need to walk wizard
1195 ($form->_mode
== 'test' ||
$form->_allowConfirmation
)
1200 $contactID = self
::getRegistrationContactID($fields, $form, $isAdditional);
1203 $participant = new CRM_Event_BAO_Participant();
1204 $participant->contact_id
= $contactID;
1205 $participant->event_id
= $form->_values
['event']['id'];
1206 if (!empty($fields['participant_role']) && is_numeric($fields['participant_role'])) {
1207 $participant->role_id
= $fields['participant_role'];
1210 $participant->role_id
= $form->_values
['event']['default_role_id'];
1212 $participant->is_test
= 0;
1213 $participant->find();
1214 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
1215 while ($participant->fetch()) {
1216 if (array_key_exists($participant->status_id
, $statusTypes)) {
1217 if (!$isAdditional && !$form->_values
['event']['allow_same_participant_emails']) {
1218 $registerUrl = CRM_Utils_System
::url('civicrm/event/register',
1219 "reset=1&id={$form->_values['event']['id']}&cid=0"
1221 if ($form->_pcpId
) {
1222 $registerUrl .= '&pcpId=' . $form->_pcpId
;
1225 $status = ts("It looks like you are 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.") . ' ' . ts('You can also <a href="%1">register another participant</a>.', array(1 => $registerUrl));
1226 CRM_Core_Session
::singleton()->setStatus($status, ts('Oops.'), 'alert');
1227 $url = CRM_Utils_System
::url('civicrm/event/info',
1228 "reset=1&id={$form->_values['event']['id']}&noFullMsg=true"
1230 if ($form->_action
& CRM_Core_Action
::PREVIEW
) {
1231 $url .= '&action=preview';
1234 if ($form->_pcpId
) {
1235 $url .= '&pcpId=' . $form->_pcpId
;
1238 CRM_Utils_System
::redirect($url);
1241 if ($isAdditional) {
1242 $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.");
1243 CRM_Core_Session
::singleton()->setStatus($status, ts('Oops.'), 'alert');
1244 return $participant->id
;