3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
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 * Array of payment related fields to potentially display on this form (generally credit card or debit card fields).
76 * This is rendered via billingBlock.tpl.
80 public $_paymentFields = array();
83 * Get the contact id for the registration.
85 * @param array $fields
86 * @param CRM_Core_Form $self
87 * @param bool $isAdditional
91 public static function getRegistrationContactID($fields, $self, $isAdditional) {
95 $contactID = $self->getContactID();
97 if (!$contactID && is_array($fields) && $fields) {
98 $contactID = CRM_Contact_BAO_Contact
::getFirstDuplicateContact($fields, 'Individual', 'Unsupervised', array(), FALSE, CRM_Utils_Array
::value('dedupe_rule_group_id', $self->_values
['event']));
104 * Set variables up before form is built.
106 public function preProcess() {
107 parent
::preProcess();
110 //here we can't use parent $this->_allowWaitlist as user might
111 //walk back and we might set this value in this postProcess.
112 //(we set when spaces < group count and want to allow become part of waiting )
113 $eventFull = CRM_Event_BAO_Participant
::eventFull($this->_eventId
, FALSE, CRM_Utils_Array
::value('has_waitlist', $this->_values
['event']));
115 // Get payment processors if appropriate for this event
116 // We hide the payment fields if the event is full or requires approval,
117 // and the current user has not yet been approved CRM-12279
118 $this->_noFees
= (($eventFull ||
$this->_requireApproval
) && !$this->_allowConfirmation
);
119 $this->_paymentProcessors
= $this->_noFees ?
array() : $this->get('paymentProcessors');
120 $this->preProcessPaymentOptions();
122 $this->_allowWaitlist
= FALSE;
123 if ($eventFull && !$this->_allowConfirmation
&& !empty($this->_values
['event']['has_waitlist'])) {
124 $this->_allowWaitlist
= TRUE;
125 $this->_waitlistMsg
= CRM_Utils_Array
::value('waitlist_text', $this->_values
['event']);
126 if (!$this->_waitlistMsg
) {
127 $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.');
130 $this->set('allowWaitlist', $this->_allowWaitlist
);
132 //To check if the user is already registered for the event(CRM-2426)
133 if (!$this->_skipDupeRegistrationCheck
) {
134 self
::checkRegistration(NULL, $this);
137 $this->assign('availableRegistrations', $this->_availableRegistrations
);
139 // get the participant values from EventFees.php, CRM-4320
140 if ($this->_allowConfirmation
) {
141 CRM_Event_Form_EventFees
::preProcess($this);
146 * Set default values for the form.
148 public function setDefaultValues() {
149 $this->_defaults
= array();
150 if (!$this->_allowConfirmation
&& $this->_requireApproval
) {
151 $this->_defaults
['bypass_payment'] = 1;
153 $contactID = $this->getContactID();
154 CRM_Core_Payment_Form
::setDefaultValues($this, $contactID);
156 CRM_Event_BAO_Participant
::formatFieldsAndSetProfileDefaults($contactID, $this);
158 // Set default payment processor as default payment_processor radio button value
159 if (!empty($this->_paymentProcessors
)) {
160 foreach ($this->_paymentProcessors
as $pid => $value) {
161 if (!empty($value['is_default'])) {
162 $this->_defaults
['payment_processor_id'] = $pid;
167 //if event is monetary and pay later is enabled and payment
168 //processor is not available then freeze the pay later checkbox with
170 if (!empty($this->_values
['event']['is_pay_later']) &&
171 !is_array($this->_paymentProcessor
)
173 $this->_defaults
['is_pay_later'] = 1;
176 //set custom field defaults
177 if (!empty($this->_fields
)) {
178 //load default campaign from page.
179 if (array_key_exists('participant_campaign_id', $this->_fields
)) {
180 $this->_defaults
['participant_campaign_id'] = CRM_Utils_Array
::value('campaign_id',
181 $this->_values
['event']
185 foreach ($this->_fields
as $name => $field) {
186 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
188 if (!isset($this->_defaults
[$name])) {
189 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID, $name, $this->_defaults
,
190 NULL, CRM_Profile_Form
::MODE_REGISTER
197 //fix for CRM-3088, default value for discount set.
199 if (!empty($this->_values
['discount'])) {
200 $discountId = CRM_Core_BAO_Discount
::findSet($this->_eventId
, 'civicrm_event');
202 if (isset($this->_values
['event']['default_discount_fee_id'])) {
203 $discountKey = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
204 $this->_values
['event']['default_discount_fee_id'],
208 $this->_defaults
['amount'] = key(array_slice($this->_values
['discount'][$discountId],
209 $discountKey - 1, $discountKey, TRUE
215 // add this event's default participant role to defaults array
216 // (for cases where participant_role field is included in form via profile)
217 if ($this->_values
['event']['default_role_id']) {
218 $this->_defaults
['participant_role']
219 = $this->_defaults
['participant_role_id'] = $this->_values
['event']['default_role_id'];
221 if ($this->_priceSetId
&& !empty($this->_feeBlock
)) {
222 foreach ($this->_feeBlock
as $key => $val) {
223 if (empty($val['options'])) {
226 $optionFullIds = CRM_Utils_Array
::value('option_full_ids', $val, array());
227 foreach ($val['options'] as $keys => $values) {
228 if ($values['is_default'] && empty($values['is_full'])) {
230 if ($val['html_type'] == 'CheckBox') {
231 $this->_defaults
["price_{$key}"][$keys] = 1;
234 $this->_defaults
["price_{$key}"] = $keys;
238 $unsetSubmittedOptions[$val['id']] = $optionFullIds;
240 //reset values for all options those are full.
241 CRM_Event_Form_Registration
::resetElementValue($unsetSubmittedOptions, $this);
244 //set default participant fields, CRM-4320.
245 $hasAdditionalParticipants = FALSE;
246 if ($this->_allowConfirmation
) {
247 $this->_contactId
= $contactID;
248 $this->_discountId
= $discountId;
249 $forcePayLater = CRM_Utils_Array
::value('is_pay_later', $this->_defaults
, FALSE);
250 $this->_defaults
= array_merge($this->_defaults
, CRM_Event_Form_EventFees
::setDefaultValues($this));
251 $this->_defaults
['is_pay_later'] = $forcePayLater;
253 if ($this->_additionalParticipantIds
) {
254 $hasAdditionalParticipants = TRUE;
255 $this->_defaults
['additional_participants'] = count($this->_additionalParticipantIds
);
258 $this->assign('hasAdditionalParticipants', $hasAdditionalParticipants);
260 // //hack to simplify credit card entry for testing
261 // $this->_defaults['credit_card_type'] = 'Visa';
262 // $this->_defaults['credit_card_number'] = '4807731747657838';
263 // $this->_defaults['cvv2'] = '000';
264 // $this->_defaults['credit_card_exp_date'] = array( 'Y' => '2010', 'M' => '05' );
266 // to process Custom data that are appended to URL
267 $getDefaults = CRM_Core_BAO_CustomGroup
::extractGetParams($this, "'Contact', 'Individual', 'Contribution', 'Participant'");
268 if (!empty($getDefaults)) {
269 $this->_defaults
= array_merge($this->_defaults
, $getDefaults);
272 return $this->_defaults
;
276 * Build the form object.
278 public function buildQuickForm() {
279 // build profiles first so that we can determine address fields etc
280 // and then show copy address checkbox
281 $this->buildCustom($this->_values
['custom_pre_id'], 'customPre');
282 $this->buildCustom($this->_values
['custom_post_id'], 'customPost');
284 // CRM-18399: used by template to pass pre profile id as a url arg
285 $this->assign('custom_pre_id', $this->_values
['custom_pre_id']);
287 CRM_Core_Payment_ProcessorForm
::buildQuickForm($this);
289 $contactID = $this->getContactID();
291 $this->assign('contact_id', $contactID);
292 $this->assign('display_name', CRM_Contact_BAO_Contact
::displayName($contactID));
295 $this->add('hidden', 'scriptFee', NULL);
296 $this->add('hidden', 'scriptArray', NULL);
298 $bypassPayment = $allowGroupOnWaitlist = $isAdditionalParticipants = FALSE;
299 if ($this->_values
['event']['is_multiple_registrations']) {
300 // don't allow to add additional during confirmation if not preregistered.
301 if (!$this->_allowConfirmation ||
$this->_additionalParticipantIds
) {
302 // CRM-17745: Make maximum additional participants configurable
303 // Label is value + 1, since the code sees this is ADDITIONAL participants (in addition to "self")
304 $additionalOptions = array();
305 $additionalOptions[''] = 1;
306 for ($i = 1; $i <= $this->_values
['event']['max_additional_participants']; $i++
) {
307 $additionalOptions[$i] = $i +
1;
309 $this->add('select', 'additional_participants',
310 ts('How many people are you registering?'),
313 array('onChange' => "allowParticipant()")
315 $isAdditionalParticipants = TRUE;
319 if (!$this->_allowConfirmation
) {
320 $bypassPayment = TRUE;
323 //hack to allow group to register w/ waiting
324 if ((!empty($this->_values
['event']['is_multiple_registrations']) ||
327 !$this->_allowConfirmation
&&
328 is_numeric($this->_availableRegistrations
) && !empty($this->_values
['event']['has_waitlist'])
330 $bypassPayment = TRUE;
331 //case might be group become as a part of waitlist.
332 //If not waitlist then they require admin approve.
333 $allowGroupOnWaitlist = TRUE;
334 $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
));
336 if ($this->_requireApproval
) {
337 $this->_requireApprovalMsg
= CRM_Utils_Array
::value('approval_req_text', $this->_values
['event'],
338 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.')
343 //case where only approval needed - no waitlist.
344 if ($this->_requireApproval
&&
345 !$this->_allowWaitlist
&& !$bypassPayment
347 $this->_requireApprovalMsg
= CRM_Utils_Array
::value('approval_req_text', $this->_values
['event'],
348 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.')
352 //lets display status to primary page only.
353 $this->assign('waitlistMsg', $this->_waitlistMsg
);
354 $this->assign('requireApprovalMsg', $this->_requireApprovalMsg
);
355 $this->assign('allowGroupOnWaitlist', $allowGroupOnWaitlist);
356 $this->assign('isAdditionalParticipants', $isAdditionalParticipants);
358 if ($this->_values
['event']['is_monetary']) {
359 self
::buildAmount($this);
363 //@todo this processor adding fn is another one duplicated on contribute - a shared
364 // common class would make this sort of thing extractable
365 $onlinePaymentProcessorEnabled = FALSE;
366 if (!empty($this->_paymentProcessors
)) {
367 foreach ($this->_paymentProcessors
as $key => $name) {
368 if ($name['billing_mode'] == 1) {
369 $onlinePaymentProcessorEnabled = TRUE;
371 $pps[$key] = $name['name'];
374 if ($this->getContactID() === 0 && !$this->_values
['event']['is_multiple_registrations']) {
375 //@todo we are blocking for multiple registrations because we haven't tested
376 $this->addCidZeroOptions($onlinePaymentProcessorEnabled);
378 if (!empty($this->_values
['event']['is_pay_later']) &&
379 ($this->_allowConfirmation ||
(!$this->_requireApproval
&& !$this->_allowWaitlist
))
381 $pps[0] = $this->_values
['event']['pay_later_text'];
384 if ($this->_values
['event']['is_monetary']) {
385 if (count($pps) > 1) {
386 $this->addRadio('payment_processor_id', ts('Payment Method'), $pps,
390 elseif (!empty($pps)) {
391 $ppKeys = array_keys($pps);
392 $currentPP = array_pop($ppKeys);
393 $this->addElement('hidden', 'payment_processor_id', $currentPP);
397 $this->addElement('hidden', 'bypass_payment', NULL, array('id' => 'bypass_payment'));
399 $this->assign('bypassPayment', $bypassPayment);
401 $userID = $this->getContactID();
404 $createCMSUser = FALSE;
406 if ($this->_values
['custom_pre_id']) {
407 $profileID = $this->_values
['custom_pre_id'];
408 $createCMSUser = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_cms_user');
411 if (!$createCMSUser &&
412 $this->_values
['custom_post_id']
414 if (!is_array($this->_values
['custom_post_id'])) {
415 $profileIDs = array($this->_values
['custom_post_id']);
418 $profileIDs = $this->_values
['custom_post_id'];
420 foreach ($profileIDs as $pid) {
421 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $pid, 'is_cms_user')) {
423 $createCMSUser = TRUE;
429 if ($createCMSUser) {
430 CRM_Core_BAO_CMSUser
::buildForm($this, $profileID, TRUE);
434 //we have to load confirm contribution button in template
435 //when multiple payment processor as the user
436 //can toggle with payment processor selection
437 $billingModePaymentProcessors = 0;
438 if (!CRM_Utils_System
::isNull($this->_paymentProcessors
)) {
439 foreach ($this->_paymentProcessors
as $key => $values) {
440 if ($values['billing_mode'] == CRM_Core_Payment
::BILLING_MODE_BUTTON
) {
441 $billingModePaymentProcessors++
;
446 if ($billingModePaymentProcessors && count($this->_paymentProcessors
) == $billingModePaymentProcessors) {
447 $allAreBillingModeProcessors = TRUE;
450 $allAreBillingModeProcessors = FALSE;
453 if (!$allAreBillingModeProcessors ||
!empty($this->_values
['event']['is_pay_later']) ||
$bypassPayment
456 //freeze button to avoid multiple calls.
459 if (empty($this->_values
['event']['is_monetary'])) {
460 $js = array('onclick' => "return submitOnce(this,'" . $this->_name
. "','" . ts('Processing') . "');");
463 // CRM-11182 - Optional confirmation screen
464 // Change button label depending on whether the next action is confirm or register
466 !$this->_values
['event']['is_multiple_registrations']
467 && !$this->_values
['event']['is_monetary']
468 && !$this->_values
['event']['is_confirm_enabled']
470 $buttonLabel = ts('Register');
473 $buttonLabel = ts('Continue');
476 $this->addButtons(array(
479 'name' => $buttonLabel,
480 'spacing' => ' ',
488 $this->addFormRule(array('CRM_Event_Form_Registration_Register', 'formRule'), $this);
489 $this->unsavedChangesWarn
= TRUE;
493 CRM_PCP_BAO_PCP
::buildPcp($this->_pcpId
, $this);
498 * Build the radio/text form elements for the amount field
500 * @param CRM_Core_Form $form
502 * @param bool $required
503 * True if you want to add formRule.
504 * @param int $discountId
505 * Discount id for the event.
507 static public function buildAmount(&$form, $required = TRUE, $discountId = NULL) {
508 // build amount only when needed, skip incase of event full and waitlisting is enabled
509 // and few other conditions check preProcess()
510 if (property_exists($form, '_noFees') && $form->_noFees
) {
514 //if payment done, no need to build the fee block.
515 if (!empty($form->_paymentId
)) {
516 //fix to display line item in update mode.
517 $form->assign('priceSet', isset($form->_priceSet
) ?
$form->_priceSet
: NULL);
521 $feeFields = CRM_Utils_Array
::value('fee', $form->_values
);
523 if (is_array($feeFields)) {
524 $form->_feeBlock
= &$form->_values
['fee'];
527 //check for discount.
528 $discountedFee = CRM_Utils_Array
::value('discount', $form->_values
);
529 if (is_array($discountedFee) && !empty($discountedFee)) {
531 $form->_discountId
= $discountId = CRM_Core_BAO_Discount
::findSet($form->_eventId
, 'civicrm_event');
534 $form->_feeBlock
= &$form->_values
['discount'][$discountId];
537 if (!is_array($form->_feeBlock
)) {
538 $form->_feeBlock
= array();
541 //its time to call the hook.
542 CRM_Utils_Hook
::buildAmount('event', $form, $form->_feeBlock
);
544 //reset required if participant is skipped.
545 $button = substr($form->controller
->getButtonName(), -4);
546 if ($required && $button == 'skip') {
550 $className = CRM_Utils_System
::getClassName($form);
552 //build the priceset fields.
553 if (isset($form->_priceSetId
) && $form->_priceSetId
) {
555 //format price set fields across option full.
556 self
::formatFieldsForOptionFull($form);
558 if (!empty($form->_priceSet
['is_quick_config'])) {
559 $form->_quickConfig
= $form->_priceSet
['is_quick_config'];
561 $form->add('hidden', 'priceSetId', $form->_priceSetId
);
563 // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
564 $adminFieldVisible = FALSE;
565 if (CRM_Core_Permission
::check('administer CiviCRM')) {
566 $adminFieldVisible = TRUE;
569 $hideAdminValues = TRUE;
570 if (CRM_Core_Permission
::check('edit event participants')) {
571 $hideAdminValues = FALSE;
574 foreach ($form->_feeBlock
as $field) {
575 // public AND admin visibility fields are included for back-office registration and back-office change selections
576 if (CRM_Utils_Array
::value('visibility', $field) == 'public' ||
577 (CRM_Utils_Array
::value('visibility', $field) == 'admin' && $adminFieldVisible == TRUE) ||
578 $className == 'CRM_Event_Form_Participant' ||
579 $className == 'CRM_Event_Form_ParticipantFeeSelection'
581 $fieldId = $field['id'];
582 $elementName = 'price_' . $fieldId;
584 $isRequire = CRM_Utils_Array
::value('is_required', $field);
585 if ($button == 'skip') {
589 //user might modified w/ hook.
590 $options = CRM_Utils_Array
::value('options', $field);
591 $formClasses = array('CRM_Event_Form_Participant', 'CRM_Event_Form_ParticipantFeeSelection');
593 if (!is_array($options)) {
596 elseif ($hideAdminValues && !in_array($className, $formClasses)) {
597 $publicVisibilityID = CRM_Price_BAO_PriceField
::getVisibilityOptionID('public');
598 $adminVisibilityID = CRM_Price_BAO_PriceField
::getVisibilityOptionID('admin');
600 foreach ($options as $key => $currentOption) {
601 $optionVisibility = CRM_Utils_Array
::value('visibility_id', $currentOption, $publicVisibilityID);
602 if ($optionVisibility == $adminVisibilityID) {
603 unset($options[$key]);
608 $optionFullIds = CRM_Utils_Array
::value('option_full_ids', $field, array());
610 //soft suppress required rule when option is full.
611 if (!empty($optionFullIds) && (count($options) == count($optionFullIds))) {
614 if (!empty($options)) {
616 CRM_Price_BAO_PriceField
::addQuickFormElement($form,
628 $form->assign('priceSet', $form->_priceSet
);
631 $eventFeeBlockValues = array();
632 foreach ($form->_feeBlock
as $fee) {
633 if (is_array($fee)) {
636 $totalAmountJs = NULL;
637 if ($className == 'CRM_Event_Form_Participant') {
638 $totalAmountJs = array('onClick' => "fillTotalAmount(" . $fee['value'] . ")");
641 $eventFeeBlockValues['amount_id_' . $fee['amount_id']] = $fee['value'];
642 $elements[] = &$form->createElement('radio', NULL, '',
643 CRM_Utils_Money
::format($fee['value']) . ' ' .
650 $form->assign('eventFeeBlockValues', json_encode($eventFeeBlockValues));
652 $form->_defaults
['amount'] = CRM_Utils_Array
::value('default_fee_id', $form->_values
['event']);
653 $element = &$form->addGroup($elements, 'amount', ts('Event Fee(s)'), '<br />');
654 if (isset($form->_online
) && $form->_online
) {
658 $form->addRule('amount', ts('Fee Level is a required field.'), 'required');
664 * @param CRM_Core_Form $form
666 public static function formatFieldsForOptionFull(&$form) {
667 $priceSet = $form->get('priceSet');
668 $priceSetId = $form->get('priceSetId');
669 $defaultPricefieldIds = array();
670 if (!empty($form->_values
['line_items'])) {
671 foreach ($form->_values
['line_items'] as $lineItem) {
672 $defaultPricefieldIds[] = $lineItem['price_field_value_id'];
676 !is_array($priceSet) ||
677 empty($priceSet) ||
empty($priceSet['optionsMaxValueTotal'])
682 $skipParticipants = $formattedPriceSetDefaults = array();
683 if (!empty($form->_allowConfirmation
) && (isset($form->_pId
) ||
isset($form->_additionalParticipantId
))) {
684 $participantId = isset($form->_pId
) ?
$form->_pId
: $form->_additionalParticipantId
;
685 $pricesetDefaults = CRM_Event_Form_EventFees
::setDefaultPriceSet($participantId,
688 // modify options full to respect the selected fields
689 // options on confirmation.
690 $formattedPriceSetDefaults = self
::formatPriceSetParams($form, $pricesetDefaults);
692 // to skip current registered participants fields option count on confirmation.
693 $skipParticipants[] = $form->_participantId
;
694 if (!empty($form->_additionalParticipantIds
)) {
695 $skipParticipants = array_merge($skipParticipants, $form->_additionalParticipantIds
);
699 $className = CRM_Utils_System
::getClassName($form);
701 //get the current price event price set options count.
702 $currentOptionsCount = self
::getPriceSetOptionCount($form);
703 $recordedOptionsCount = CRM_Event_BAO_Participant
::priceSetOptionsCount($form->_eventId
, $skipParticipants);
704 $optionFullTotalAmount = 0;
705 $currentParticipantNo = (int) substr($form->_name
, 12);
706 foreach ($form->_feeBlock
as & $field) {
707 $optionFullIds = array();
708 $fieldId = $field['id'];
709 if (!is_array($field['options'])) {
712 foreach ($field['options'] as & $option) {
713 $optId = $option['id'];
714 $count = CRM_Utils_Array
::value('count', $option, 0);
715 $maxValue = CRM_Utils_Array
::value('max_value', $option, 0);
716 $dbTotalCount = CRM_Utils_Array
::value($optId, $recordedOptionsCount, 0);
717 $currentTotalCount = CRM_Utils_Array
::value($optId, $currentOptionsCount, 0);
719 $totalCount = $currentTotalCount +
$dbTotalCount;
722 (($totalCount >= $maxValue) &&
723 (empty($form->_lineItem
[$currentParticipantNo][$optId]['price_field_id']) ||
$dbTotalCount >= $maxValue))
726 $optionFullIds[$optId] = $optId;
727 if ($field['html_type'] != 'Select') {
728 if (in_array($optId, $defaultPricefieldIds)) {
729 $optionFullTotalAmount +
= CRM_Utils_Array
::value('amount', $option);
733 if (!empty($defaultPricefieldIds) && in_array($optId, $defaultPricefieldIds)) {
734 unset($optionFullIds[$optId]);
738 //here option is not full,
739 //but we don't want to allow participant to increase
740 //seats at the time of re-walking registration.
742 !empty($form->_allowConfirmation
) &&
743 !empty($formattedPriceSetDefaults)
745 if (empty($formattedPriceSetDefaults["price_{$field}"]) ||
empty($formattedPriceSetDefaults["price_{$fieldId}"][$optId])) {
746 $optionFullIds[$optId] = $optId;
750 $option['is_full'] = $isFull;
751 $option['db_total_count'] = $dbTotalCount;
752 $option['total_option_count'] = $dbTotalCount +
$currentTotalCount;
755 //ignore option full for offline registration.
756 if ($className == 'CRM_Event_Form_Participant') {
757 $optionFullIds = array();
760 //finally get option ids in.
761 $field['option_full_ids'] = $optionFullIds;
763 $form->assign('optionFullTotalAmount', $optionFullTotalAmount);
769 * @param array $fields
770 * The input form values.
771 * @param array $files
772 * The uploaded files if any.
777 * true if no errors, else array of errors
779 public static function formRule($fields, $files, $self) {
781 //check that either an email or firstname+lastname is included in the form(CRM-9587)
782 self
::checkProfileComplete($fields, $errors, $self->_eventId
);
783 //To check if the user is already registered for the event(CRM-2426)
784 if (!$self->_skipDupeRegistrationCheck
) {
785 self
::checkRegistration($fields, $self);
787 //check for availability of registrations.
788 if (!$self->_allowConfirmation
&& empty($fields['bypass_payment']) &&
789 is_numeric($self->_availableRegistrations
) &&
790 CRM_Utils_Array
::value('additional_participants', $fields) >= $self->_availableRegistrations
792 $errors['additional_participants'] = ts("There is only enough space left on this event for %1 participant(s).", array(1 => $self->_availableRegistrations
));
795 // during confirmation don't allow to increase additional participants, CRM-4320
796 if ($self->_allowConfirmation
&& !empty($fields['additional_participants']) &&
797 is_array($self->_additionalParticipantIds
) &&
798 $fields['additional_participants'] > count($self->_additionalParticipantIds
)
800 $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($self->_additionalParticipantIds
)));
803 //don't allow to register w/ waiting if enough spaces available.
804 if (!empty($fields['bypass_payment']) && $self->_allowConfirmation
) {
805 if (!is_numeric($self->_availableRegistrations
) ||
806 (empty($fields['priceSetId']) && CRM_Utils_Array
::value('additional_participants', $fields) < $self->_availableRegistrations
)
808 $errors['bypass_payment'] = ts("Oops. There are enough available spaces in this event. You can not add yourself to the waiting list.");
812 if (!empty($fields['additional_participants']) &&
813 !CRM_Utils_Rule
::positiveInteger($fields['additional_participants'])
815 $errors['additional_participants'] = ts('Please enter a whole number for Number of additional people.');
818 // priceset validations
819 if (!empty($fields['priceSetId']) &&
820 !$self->_requireApproval
&& !$self->_allowWaitlist
823 $formatted = self
::formatPriceSetParams($self, $fields);
824 $ppParams = array($formatted);
825 $priceSetErrors = self
::validatePriceSet($self, $ppParams);
826 $primaryParticipantCount = self
::getParticipantCount($self, $ppParams);
828 //get price set fields errors in.
829 $errors = array_merge($errors, CRM_Utils_Array
::value(0, $priceSetErrors, array()));
831 $totalParticipants = $primaryParticipantCount;
832 if (!empty($fields['additional_participants'])) {
833 $totalParticipants +
= $fields['additional_participants'];
836 if (empty($fields['bypass_payment']) &&
837 !$self->_allowConfirmation
&&
838 is_numeric($self->_availableRegistrations
) &&
839 $self->_availableRegistrations
< $totalParticipants
841 $errors['_qf_default'] = ts("Only %1 Registrations available.", array(1 => $self->_availableRegistrations
));
845 CRM_Price_BAO_PriceSet
::processAmount($self->_values
['fee'], $fields, $lineItem);
847 $minAmt = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $fields['priceSetId'], 'min_amount');
848 if ($fields['amount'] < 0) {
849 $errors['_qf_default'] = ts('Event Fee(s) can not be less than zero. Please select the options accordingly');
851 elseif (!empty($minAmt) && $fields['amount'] < $minAmt) {
852 $errors['_qf_default'] = ts('A minimum amount of %1 should be selected from Event Fee(s).', array(
853 1 => CRM_Utils_Money
::format($minAmt),
858 // @todo - can we remove the 'is_monetary' concept?
859 if ($self->_values
['event']['is_monetary']) {
860 if (empty($self->_requireApproval
) && !empty($fields['amount']) && $fields['amount'] > 0 &&
861 !isset($fields['payment_processor_id'])) {
862 $errors['payment_processor_id'] = ts('Please select a Payment Method');
865 $isZeroAmount = $skipPaymentValidation = FALSE;
866 if (!empty($fields['priceSetId'])) {
867 if (CRM_Utils_Array
::value('amount', $fields) == 0) {
868 $isZeroAmount = TRUE;
871 elseif (!empty($fields['amount']) &&
872 (isset($self->_values
['discount'][$fields['amount']])
873 && CRM_Utils_Array
::value('value', $self->_values
['discount'][$fields['amount']]) == 0
876 $isZeroAmount = TRUE;
878 elseif (!empty($fields['amount']) &&
879 (isset($self->_values
['fee'][$fields['amount']])
880 && CRM_Utils_Array
::value('value', $self->_values
['fee'][$fields['amount']]) == 0
883 $isZeroAmount = TRUE;
886 if ($isZeroAmount && !($self->_forcePayement
&& !empty($fields['additional_participants']))) {
887 $skipPaymentValidation = TRUE;
890 // also return if zero fees for valid members
891 if (!empty($fields['bypass_payment']) ||
892 $skipPaymentValidation ||
893 (!$self->_allowConfirmation
&& ($self->_requireApproval ||
$self->_allowWaitlist
))
895 return empty($errors) ?
TRUE : $errors;
897 CRM_Core_Payment_Form
::validatePaymentInstrument(
898 $fields['payment_processor_id'],
901 (!$self->_isBillingAddressRequiredForPayLater ?
NULL : 'billing')
905 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
906 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
907 $customizedValue = CRM_Core_PseudoConstant
::getKey('CRM_Contact_BAO_Contact', $greeting . '_id', 'Customized');
908 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
909 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
910 array(1 => ucwords(str_replace('_', ' ', $greeting)))
915 return empty($errors) ?
TRUE : $errors;
919 * Check if profiles are complete when event registration occurs(CRM-9587).
921 * @param array $fields
922 * @param array $errors
923 * @param int $eventId
925 public static function checkProfileComplete($fields, &$errors, $eventId) {
927 foreach ($fields as $fieldname => $fieldvalue) {
928 if (substr($fieldname, 0, 6) == 'email-' && $fieldvalue) {
929 $email = $fieldvalue;
933 if (!$email && !(!empty($fields['first_name']) && !empty($fields['last_name']))) {
934 $defaults = $params = array('id' => $eventId);
935 CRM_Event_BAO_Event
::retrieve($params, $defaults);
936 $message = ts("Mandatory fields (first name and last name, OR email address) are missing from this form.");
937 $errors['_qf_default'] = $message;
942 * Process the form submission.
944 public function postProcess() {
945 // get the submitted form values.
946 $params = $this->controller
->exportValues($this->_name
);
948 //set as Primary participant
949 $params['is_primary'] = 1;
951 if ($this->_values
['event']['is_pay_later']
952 && (!array_key_exists('hidden_processor', $params) ||
$params['payment_processor_id'] == 0)
954 $params['is_pay_later'] = 1;
957 $params['is_pay_later'] = 0;
960 $this->set('is_pay_later', $params['is_pay_later']);
962 // assign pay later stuff
963 $this->_params
['is_pay_later'] = CRM_Utils_Array
::value('is_pay_later', $params, FALSE);
964 $this->assign('is_pay_later', $params['is_pay_later']);
965 if ($params['is_pay_later']) {
966 $this->assign('pay_later_text', $this->_values
['event']['pay_later_text']);
967 $this->assign('pay_later_receipt', $this->_values
['event']['pay_later_receipt']);
970 if (!$this->_allowConfirmation
) {
971 // check if the participant is already registered
972 if (!$this->_skipDupeRegistrationCheck
) {
973 $params['contact_id'] = self
::getRegistrationContactID($params, $this, FALSE);
977 if (!empty($params['image_URL'])) {
978 CRM_Contact_BAO_Contact
::processImageParams($params);
981 //carry campaign to partcipants.
982 if (array_key_exists('participant_campaign_id', $params)) {
983 $params['campaign_id'] = $params['participant_campaign_id'];
986 $params['campaign_id'] = CRM_Utils_Array
::value('campaign_id', $this->_values
['event']);
989 //hack to allow group to register w/ waiting
990 $primaryParticipantCount = self
::getParticipantCount($this, $params);
992 $totalParticipants = $primaryParticipantCount;
993 if (!empty($params['additional_participants'])) {
994 $totalParticipants +
= $params['additional_participants'];
996 if (!$this->_allowConfirmation
&& !empty($params['bypass_payment']) &&
997 is_numeric($this->_availableRegistrations
) &&
998 $totalParticipants > $this->_availableRegistrations
1000 $this->_allowWaitlist
= TRUE;
1001 $this->set('allowWaitlist', TRUE);
1004 //carry participant id if pre-registered.
1005 if ($this->_allowConfirmation
&& $this->_participantId
) {
1006 $params['participant_id'] = $this->_participantId
;
1009 $params['defaultRole'] = 1;
1010 if (array_key_exists('participant_role', $params)) {
1011 $params['participant_role_id'] = $params['participant_role'];
1014 if (array_key_exists('participant_role_id', $params)) {
1015 $params['defaultRole'] = 0;
1017 if (empty($params['participant_role_id']) &&
1018 $this->_values
['event']['default_role_id']
1020 $params['participant_role_id'] = $this->_values
['event']['default_role_id'];
1023 $config = CRM_Core_Config
::singleton();
1024 $params['currencyID'] = $config->defaultCurrency
;
1026 if ($this->_values
['event']['is_monetary']) {
1027 // we first reset the confirm page so it accepts new values
1028 $this->controller
->resetPage('Confirm');
1030 //added for discount
1031 $discountId = CRM_Core_BAO_Discount
::findSet($this->_eventId
, 'civicrm_event');
1032 $params['amount_level'] = $this->getAmountLevel($params, $discountId);
1033 if (!empty($this->_values
['discount'][$discountId])) {
1034 $params['discount_id'] = $discountId;
1035 $params['amount'] = $this->_values
['discount'][$discountId][$params['amount']]['value'];
1037 elseif (empty($params['priceSetId'])) {
1038 if (!empty($params['amount'])) {
1039 $params['amount'] = $this->_values
['fee'][$params['amount']]['value'];
1042 $params['amount'] = '';
1046 $lineItem = array();
1047 CRM_Price_BAO_PriceSet
::processAmount($this->_values
['fee'], $params, $lineItem);
1048 if ($params['tax_amount']) {
1049 $this->set('tax_amount', $params['tax_amount']);
1051 $submittedLineItems = $this->get('lineItem');
1052 if (!empty($submittedLineItems) && is_array($submittedLineItems)) {
1053 $submittedLineItems[0] = $lineItem;
1056 $submittedLineItems = array($lineItem);
1058 $submittedLineItems = array_filter($submittedLineItems);
1059 $this->set('lineItem', $submittedLineItems);
1060 $this->set('lineItemParticipantsCount', array($primaryParticipantCount));
1063 $this->set('amount', $params['amount']);
1064 $this->set('amount_level', $params['amount_level']);
1066 // generate and set an invoiceID for this transaction
1067 $invoiceID = md5(uniqid(rand(), TRUE));
1068 $this->set('invoiceID', $invoiceID);
1070 if ($this->_paymentProcessor
) {
1071 $payment = $this->_paymentProcessor
['object'];
1072 $payment->setBaseReturnUrl('civicrm/event/register');
1075 // ContributeMode is a deprecated concept. It is short-hand for a bunch of
1076 // assumptions we are working to remove.
1077 $this->set('contributeMode', 'direct');
1079 // This code is duplicated multiple places and should be consolidated.
1080 if (isset($params["state_province_id-{$this->_bltID}"]) &&
1081 $params["state_province_id-{$this->_bltID}"]
1083 $params["state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($params["state_province_id-{$this->_bltID}"]);
1086 if (isset($params["country_id-{$this->_bltID}"]) &&
1087 $params["country_id-{$this->_bltID}"]
1089 $params["country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($params["country_id-{$this->_bltID}"]);
1091 if (isset($params['credit_card_exp_date'])) {
1092 $params['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($params);
1093 $params['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($params);
1095 if ($this->_values
['event']['is_monetary']) {
1096 $params['ip_address'] = CRM_Utils_System
::ipAddress();
1097 $params['currencyID'] = $config->defaultCurrency
;
1098 $params['invoiceID'] = $invoiceID;
1100 $this->_params
= $this->get('params');
1101 // Set the button so we know what
1102 $params['button'] = $this->controller
->getButtonName();
1103 if (!empty($this->_params
) && is_array($this->_params
)) {
1104 $this->_params
[0] = $params;
1107 $this->_params
= array();
1108 $this->_params
[] = $params;
1110 $this->set('params', $this->_params
);
1111 if ($this->_paymentProcessor
&&
1112 // Actually we don't really need to check if it supports pre-approval - we could just call
1113 // it regardless as the function we call re-acts tot the rests of the preApproval call.
1114 $this->_paymentProcessor
['object']->supports('preApproval')
1115 && !$this->_allowWaitlist
&&
1116 !$this->_requireApproval
1119 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1120 $this->set('contributeMode', 'express');
1122 // Send Event Name & Id in Params
1123 $params['eventName'] = $this->_values
['event']['title'];
1124 $params['eventId'] = $this->_values
['event']['id'];
1126 $params['cancelURL'] = CRM_Utils_System
::url('civicrm/event/register',
1127 "_qf_Register_display=1&qfKey={$this->controller->_key}",
1130 if (CRM_Utils_Array
::value('additional_participants', $params, FALSE)) {
1131 $urlArgs = "_qf_Participant_1_display=1&rfp=1&qfKey={$this->controller->_key}";
1134 $urlArgs = "_qf_Confirm_display=1&rfp=1&qfKey={$this->controller->_key}";
1136 $params['returnURL'] = CRM_Utils_System
::url('civicrm/event/register',
1140 $params['invoiceID'] = $invoiceID;
1142 $params['component'] = 'event';
1143 $this->handlePreApproval($params);
1145 elseif ($this->_paymentProcessor
&&
1146 $this->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_NOTIFY
1148 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1149 $this->set('contributeMode', 'notify');
1153 $params['description'] = ts('Online Event Registration') . ' ' . $this->_values
['event']['title'];
1155 $this->_params
= array();
1156 $this->_params
[] = $params;
1157 $this->set('params', $this->_params
);
1160 empty($params['additional_participants'])
1161 && !$this->_values
['event']['is_confirm_enabled'] // CRM-11182 - Optional confirmation screen
1163 $this->processRegistration($this->_params
);
1167 // If registering > 1 participant, give status message
1168 if (CRM_Utils_Array
::value('additional_participants', $params, FALSE)) {
1169 $statusMsg = ts('Registration information for participant 1 has been saved.');
1170 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
1175 * Method to check if the user is already registered for the event.
1176 * and if result found redirect to the event info page
1178 * @param array $fields
1179 * The input form values(anonymous user).
1180 * @param CRM_Event_Form_Registration_Register $self
1182 * @param bool $isAdditional
1183 * Treat isAdditional participants a bit differently.
1187 public static function checkRegistration($fields, &$self, $isAdditional = FALSE) {
1188 // CRM-3907, skip check for preview registrations
1189 // CRM-4320 participant need to walk wizard
1191 ($self->_mode
== 'test' ||
$self->_allowConfirmation
)
1196 $contactID = self
::getRegistrationContactID($fields, $self, $isAdditional);
1199 $participant = new CRM_Event_BAO_Participant();
1200 $participant->contact_id
= $contactID;
1201 $participant->event_id
= $self->_values
['event']['id'];
1202 if (!empty($fields['participant_role']) && is_numeric($fields['participant_role'])) {
1203 $participant->role_id
= $fields['participant_role'];
1206 $participant->role_id
= $self->_values
['event']['default_role_id'];
1208 $participant->is_test
= 0;
1209 $participant->find();
1210 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
1211 while ($participant->fetch()) {
1212 if (array_key_exists($participant->status_id
, $statusTypes)) {
1213 if (!$isAdditional && !$self->_values
['event']['allow_same_participant_emails']) {
1214 $registerUrl = CRM_Utils_System
::url('civicrm/event/register',
1215 "reset=1&id={$self->_values['event']['id']}&cid=0"
1217 if ($self->_pcpId
) {
1218 $registerUrl .= '&pcpId=' . $self->_pcpId
;
1221 $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));
1222 CRM_Core_Session
::singleton()->setStatus($status, ts('Oops.'), 'alert');
1223 $url = CRM_Utils_System
::url('civicrm/event/info',
1224 "reset=1&id={$self->_values['event']['id']}&noFullMsg=true"
1226 if ($self->_action
& CRM_Core_Action
::PREVIEW
) {
1227 $url .= '&action=preview';
1230 if ($self->_pcpId
) {
1231 $url .= '&pcpId=' . $self->_pcpId
;
1234 CRM_Utils_System
::redirect($url);
1237 if ($isAdditional) {
1238 $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.");
1239 CRM_Core_Session
::singleton()->setStatus($status, ts('Oops.'), 'alert');
1240 return $participant->id
;