3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
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 * Set variables up before form is built.
85 public function preProcess() {
89 //here we can't use parent $this->_allowWaitlist as user might
90 //walk back and we might set this value in this postProcess.
91 //(we set when spaces < group count and want to allow become part of waiting )
92 $eventFull = CRM_Event_BAO_Participant
::eventFull($this->_eventId
, FALSE, CRM_Utils_Array
::value('has_waitlist', $this->_values
['event']));
94 // Get payment processors if appropriate for this event
95 // We hide the payment fields if the event is full or requires approval,
96 // and the current user has not yet been approved CRM-12279
97 $this->_noFees
= (($eventFull ||
$this->_requireApproval
) && !$this->_allowConfirmation
);
98 $this->_paymentProcessors
= $this->_noFees ?
array() : $this->get('paymentProcessors');
99 $this->preProcessPaymentOptions();
101 $this->_allowWaitlist
= FALSE;
102 if ($eventFull && !$this->_allowConfirmation
&& !empty($this->_values
['event']['has_waitlist'])) {
103 $this->_allowWaitlist
= TRUE;
104 $this->_waitlistMsg
= CRM_Utils_Array
::value('waitlist_text', $this->_values
['event']);
105 if (!$this->_waitlistMsg
) {
106 $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.');
109 $this->set('allowWaitlist', $this->_allowWaitlist
);
111 //To check if the user is already registered for the event(CRM-2426)
112 if (!$this->_skipDupeRegistrationCheck
) {
113 self
::checkRegistration(NULL, $this);
116 $this->assign('availableRegistrations', $this->_availableRegistrations
);
118 // get the participant values from EventFees.php, CRM-4320
119 if ($this->_allowConfirmation
) {
120 CRM_Event_Form_EventFees
::preProcess($this);
125 * Set default values for the form.
127 public function setDefaultValues() {
128 $this->_defaults
= array();
129 if (!$this->_allowConfirmation
&& $this->_requireApproval
) {
130 $this->_defaults
['bypass_payment'] = 1;
132 $contactID = $this->getContactID();
133 CRM_Core_Payment_Form
::setDefaultValues($this, $contactID);
135 CRM_Event_BAO_Participant
::formatFieldsAndSetProfileDefaults($contactID, $this);
137 // Set default payment processor as default payment_processor radio button value
138 if (!empty($this->_paymentProcessors
)) {
139 foreach ($this->_paymentProcessors
as $pid => $value) {
140 if (!empty($value['is_default'])) {
141 $this->_defaults
['payment_processor_id'] = $pid;
146 //if event is monetary and pay later is enabled and payment
147 //processor is not available then freeze the pay later checkbox with
149 if (!empty($this->_values
['event']['is_pay_later']) &&
150 !is_array($this->_paymentProcessor
)
152 $this->_defaults
['is_pay_later'] = 1;
155 //set custom field defaults
156 if (!empty($this->_fields
)) {
157 //load default campaign from page.
158 if (array_key_exists('participant_campaign_id', $this->_fields
)) {
159 $this->_defaults
['participant_campaign_id'] = CRM_Utils_Array
::value('campaign_id',
160 $this->_values
['event']
164 foreach ($this->_fields
as $name => $field) {
165 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
167 if (!isset($this->_defaults
[$name])) {
168 CRM_Core_BAO_CustomField
::setProfileDefaults($customFieldID, $name, $this->_defaults
,
169 NULL, CRM_Profile_Form
::MODE_REGISTER
176 //fix for CRM-3088, default value for discount set.
178 if (!empty($this->_values
['discount'])) {
179 $discountId = CRM_Core_BAO_Discount
::findSet($this->_eventId
, 'civicrm_event');
181 if (isset($this->_values
['event']['default_discount_fee_id'])) {
182 $discountKey = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
183 $this->_values
['event']['default_discount_fee_id'],
187 $this->_defaults
['amount'] = key(array_slice($this->_values
['discount'][$discountId],
188 $discountKey - 1, $discountKey, TRUE
194 // add this event's default participant role to defaults array
195 // (for cases where participant_role field is included in form via profile)
196 if ($this->_values
['event']['default_role_id']) {
197 $this->_defaults
['participant_role']
198 = $this->_defaults
['participant_role_id'] = $this->_values
['event']['default_role_id'];
200 if ($this->_priceSetId
&& !empty($this->_feeBlock
)) {
201 foreach ($this->_feeBlock
as $key => $val) {
202 if (empty($val['options'])) {
205 $optionFullIds = CRM_Utils_Array
::value('option_full_ids', $val, array());
206 foreach ($val['options'] as $keys => $values) {
207 if ($values['is_default'] && empty($values['is_full'])) {
209 if ($val['html_type'] == 'CheckBox') {
210 $this->_defaults
["price_{$key}"][$keys] = 1;
213 $this->_defaults
["price_{$key}"] = $keys;
217 $unsetSubmittedOptions[$val['id']] = $optionFullIds;
219 //reset values for all options those are full.
220 CRM_Event_Form_Registration
::resetElementValue($unsetSubmittedOptions, $this);
223 //set default participant fields, CRM-4320.
224 $hasAdditionalParticipants = FALSE;
225 if ($this->_allowConfirmation
) {
226 $this->_contactId
= $contactID;
227 $this->_discountId
= $discountId;
228 $forcePayLater = CRM_Utils_Array
::value('is_pay_later', $this->_defaults
, FALSE);
229 $this->_defaults
= array_merge($this->_defaults
, CRM_Event_Form_EventFees
::setDefaultValues($this));
230 $this->_defaults
['is_pay_later'] = $forcePayLater;
232 if ($this->_additionalParticipantIds
) {
233 $hasAdditionalParticipants = TRUE;
234 $this->_defaults
['additional_participants'] = count($this->_additionalParticipantIds
);
237 $this->assign('hasAdditionalParticipants', $hasAdditionalParticipants);
239 // //hack to simplify credit card entry for testing
240 // $this->_defaults['credit_card_type'] = 'Visa';
241 // $this->_defaults['credit_card_number'] = '4807731747657838';
242 // $this->_defaults['cvv2'] = '000';
243 // $this->_defaults['credit_card_exp_date'] = array( 'Y' => '2010', 'M' => '05' );
245 // to process Custom data that are appended to URL
246 $getDefaults = CRM_Core_BAO_CustomGroup
::extractGetParams($this, "'Contact', 'Individual', 'Contribution', 'Participant'");
247 if (!empty($getDefaults)) {
248 $this->_defaults
= array_merge($this->_defaults
, $getDefaults);
251 return $this->_defaults
;
255 * Build the form object.
257 public function buildQuickForm() {
258 // build profiles first so that we can determine address fields etc
259 // and then show copy address checkbox
260 $this->buildCustom($this->_values
['custom_pre_id'], 'customPre');
261 $this->buildCustom($this->_values
['custom_post_id'], 'customPost');
263 // CRM-18399: used by template to pass pre profile id as a url arg
264 $this->assign('custom_pre_id', $this->_values
['custom_pre_id']);
266 CRM_Core_Payment_ProcessorForm
::buildQuickForm($this);
268 $contactID = $this->getContactID();
270 $this->assign('contact_id', $contactID);
271 $this->assign('display_name', CRM_Contact_BAO_Contact
::displayName($contactID));
274 $this->add('hidden', 'scriptFee', NULL);
275 $this->add('hidden', 'scriptArray', NULL);
277 $bypassPayment = $allowGroupOnWaitlist = $isAdditionalParticipants = FALSE;
278 if ($this->_values
['event']['is_multiple_registrations']) {
279 // don't allow to add additional during confirmation if not preregistered.
280 if (!$this->_allowConfirmation ||
$this->_additionalParticipantIds
) {
281 // CRM-17745: Make maximum additional participants configurable
282 // Label is value + 1, since the code sees this is ADDITIONAL participants (in addition to "self")
283 $additionalOptions = array();
284 $additionalOptions[''] = 1;
285 for ($i = 1; $i <= $this->_values
['event']['max_additional_participants']; $i++
) {
286 $additionalOptions[$i] = $i +
1;
288 $this->add('select', 'additional_participants',
289 ts('How many people are you registering?'),
292 array('onChange' => "allowParticipant()")
294 $isAdditionalParticipants = TRUE;
298 if (!$this->_allowConfirmation
) {
299 $bypassPayment = TRUE;
302 //hack to allow group to register w/ waiting
303 if ((!empty($this->_values
['event']['is_multiple_registrations']) ||
306 !$this->_allowConfirmation
&&
307 is_numeric($this->_availableRegistrations
) && !empty($this->_values
['event']['has_waitlist'])
309 $bypassPayment = TRUE;
310 //case might be group become as a part of waitlist.
311 //If not waitlist then they require admin approve.
312 $allowGroupOnWaitlist = TRUE;
313 $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
));
315 if ($this->_requireApproval
) {
316 $this->_requireApprovalMsg
= CRM_Utils_Array
::value('approval_req_text', $this->_values
['event'],
317 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.')
322 //case where only approval needed - no waitlist.
323 if ($this->_requireApproval
&&
324 !$this->_allowWaitlist
&& !$bypassPayment
326 $this->_requireApprovalMsg
= CRM_Utils_Array
::value('approval_req_text', $this->_values
['event'],
327 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.')
331 //lets display status to primary page only.
332 $this->assign('waitlistMsg', $this->_waitlistMsg
);
333 $this->assign('requireApprovalMsg', $this->_requireApprovalMsg
);
334 $this->assign('allowGroupOnWaitlist', $allowGroupOnWaitlist);
335 $this->assign('isAdditionalParticipants', $isAdditionalParticipants);
337 if ($this->_values
['event']['is_monetary']) {
338 self
::buildAmount($this);
342 //@todo this processor adding fn is another one duplicated on contribute - a shared
343 // common class would make this sort of thing extractable
344 $onlinePaymentProcessorEnabled = FALSE;
345 if (!empty($this->_paymentProcessors
)) {
346 foreach ($this->_paymentProcessors
as $key => $name) {
347 if ($name['billing_mode'] == 1) {
348 $onlinePaymentProcessorEnabled = TRUE;
350 $pps[$key] = $name['name'];
353 if ($this->getContactID() === 0 && !$this->_values
['event']['is_multiple_registrations']) {
354 //@todo we are blocking for multiple registrations because we haven't tested
355 $this->addCidZeroOptions($onlinePaymentProcessorEnabled);
357 if (!empty($this->_values
['event']['is_pay_later']) &&
358 ($this->_allowConfirmation ||
(!$this->_requireApproval
&& !$this->_allowWaitlist
))
360 $pps[0] = $this->_values
['event']['pay_later_text'];
363 if ($this->_values
['event']['is_monetary']) {
364 if (count($pps) > 1) {
365 $this->addRadio('payment_processor_id', ts('Payment Method'), $pps,
369 elseif (!empty($pps)) {
370 $ppKeys = array_keys($pps);
371 $currentPP = array_pop($ppKeys);
372 $this->addElement('hidden', 'payment_processor_id', $currentPP);
376 $this->addElement('hidden', 'bypass_payment', NULL, array('id' => 'bypass_payment'));
378 $this->assign('bypassPayment', $bypassPayment);
380 $userID = $this->getContactID();
383 $createCMSUser = FALSE;
385 if ($this->_values
['custom_pre_id']) {
386 $profileID = $this->_values
['custom_pre_id'];
387 $createCMSUser = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $profileID, 'is_cms_user');
390 if (!$createCMSUser &&
391 $this->_values
['custom_post_id']
393 if (!is_array($this->_values
['custom_post_id'])) {
394 $profileIDs = array($this->_values
['custom_post_id']);
397 $profileIDs = $this->_values
['custom_post_id'];
399 foreach ($profileIDs as $pid) {
400 if (CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFGroup', $pid, 'is_cms_user')) {
402 $createCMSUser = TRUE;
408 if ($createCMSUser) {
409 CRM_Core_BAO_CMSUser
::buildForm($this, $profileID, TRUE);
413 //we have to load confirm contribution button in template
414 //when multiple payment processor as the user
415 //can toggle with payment processor selection
416 $billingModePaymentProcessors = 0;
417 if (!CRM_Utils_System
::isNull($this->_paymentProcessors
)) {
418 foreach ($this->_paymentProcessors
as $key => $values) {
419 if ($values['billing_mode'] == CRM_Core_Payment
::BILLING_MODE_BUTTON
) {
420 $billingModePaymentProcessors++
;
425 if ($billingModePaymentProcessors && count($this->_paymentProcessors
) == $billingModePaymentProcessors) {
426 $allAreBillingModeProcessors = TRUE;
429 $allAreBillingModeProcessors = FALSE;
432 if (!$allAreBillingModeProcessors ||
!empty($this->_values
['event']['is_pay_later']) ||
$bypassPayment
435 //freeze button to avoid multiple calls.
438 if (empty($this->_values
['event']['is_monetary'])) {
439 $js = array('onclick' => "return submitOnce(this,'" . $this->_name
. "','" . ts('Processing') . "');");
442 // CRM-11182 - Optional confirmation screen
443 // Change button label depending on whether the next action is confirm or register
445 !$this->_values
['event']['is_multiple_registrations']
446 && !$this->_values
['event']['is_monetary']
447 && !$this->_values
['event']['is_confirm_enabled']
449 $buttonLabel = ts('Register');
452 $buttonLabel = ts('Continue');
455 $this->addButtons(array(
458 'name' => $buttonLabel,
459 'spacing' => ' ',
467 $this->addFormRule(array('CRM_Event_Form_Registration_Register', 'formRule'), $this);
468 $this->unsavedChangesWarn
= TRUE;
472 CRM_PCP_BAO_PCP
::buildPcp($this->_pcpId
, $this);
477 * Build the radio/text form elements for the amount field
479 * @param CRM_Core_Form $form
481 * @param bool $required
482 * True if you want to add formRule.
483 * @param int $discountId
484 * Discount id for the event.
486 static public function buildAmount(&$form, $required = TRUE, $discountId = NULL) {
487 // build amount only when needed, skip incase of event full and waitlisting is enabled
488 // and few other conditions check preProcess()
489 if (property_exists($form, '_noFees') && $form->_noFees
) {
493 //if payment done, no need to build the fee block.
494 if (!empty($form->_paymentId
)) {
495 //fix to display line item in update mode.
496 $form->assign('priceSet', isset($form->_priceSet
) ?
$form->_priceSet
: NULL);
500 $feeFields = CRM_Utils_Array
::value('fee', $form->_values
);
502 if (is_array($feeFields)) {
503 $form->_feeBlock
= &$form->_values
['fee'];
506 //check for discount.
507 $discountedFee = CRM_Utils_Array
::value('discount', $form->_values
);
508 if (is_array($discountedFee) && !empty($discountedFee)) {
510 $form->_discountId
= $discountId = CRM_Core_BAO_Discount
::findSet($form->_eventId
, 'civicrm_event');
513 $form->_feeBlock
= &$form->_values
['discount'][$discountId];
516 if (!is_array($form->_feeBlock
)) {
517 $form->_feeBlock
= array();
520 //its time to call the hook.
521 CRM_Utils_Hook
::buildAmount('event', $form, $form->_feeBlock
);
523 //reset required if participant is skipped.
524 $button = substr($form->controller
->getButtonName(), -4);
525 if ($required && $button == 'skip') {
529 $className = CRM_Utils_System
::getClassName($form);
531 //build the priceset fields.
532 if (isset($form->_priceSetId
) && $form->_priceSetId
) {
534 //format price set fields across option full.
535 self
::formatFieldsForOptionFull($form);
537 if (!empty($form->_priceSet
['is_quick_config'])) {
538 $form->_quickConfig
= $form->_priceSet
['is_quick_config'];
540 $form->add('hidden', 'priceSetId', $form->_priceSetId
);
542 // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
543 $adminFieldVisible = FALSE;
544 if (CRM_Core_Permission
::check('administer CiviCRM')) {
545 $adminFieldVisible = TRUE;
548 foreach ($form->_feeBlock
as $field) {
549 // public AND admin visibility fields are included for back-office registration and back-office change selections
550 if (CRM_Utils_Array
::value('visibility', $field) == 'public' ||
551 (CRM_Utils_Array
::value('visibility', $field) == 'admin' && $adminFieldVisible == TRUE) ||
552 $className == 'CRM_Event_Form_Participant' ||
553 $className == 'CRM_Event_Form_ParticipantFeeSelection'
555 $fieldId = $field['id'];
556 $elementName = 'price_' . $fieldId;
558 $isRequire = CRM_Utils_Array
::value('is_required', $field);
559 if ($button == 'skip') {
563 //user might modified w/ hook.
564 $options = CRM_Utils_Array
::value('options', $field);
565 if (!is_array($options)) {
569 $optionFullIds = CRM_Utils_Array
::value('option_full_ids', $field, array());
571 //soft suppress required rule when option is full.
572 if (!empty($optionFullIds) && (count($options) == count($optionFullIds))) {
577 CRM_Price_BAO_PriceField
::addQuickFormElement($form,
588 $form->assign('priceSet', $form->_priceSet
);
591 $eventFeeBlockValues = array();
592 foreach ($form->_feeBlock
as $fee) {
593 if (is_array($fee)) {
596 $totalAmountJs = NULL;
597 if ($className == 'CRM_Event_Form_Participant') {
598 $totalAmountJs = array('onClick' => "fillTotalAmount(" . $fee['value'] . ")");
601 $eventFeeBlockValues['amount_id_' . $fee['amount_id']] = $fee['value'];
602 $elements[] = &$form->createElement('radio', NULL, '',
603 CRM_Utils_Money
::format($fee['value']) . ' ' .
610 $form->assign('eventFeeBlockValues', json_encode($eventFeeBlockValues));
612 $form->_defaults
['amount'] = CRM_Utils_Array
::value('default_fee_id', $form->_values
['event']);
613 $element = &$form->addGroup($elements, 'amount', ts('Event Fee(s)'), '<br />');
614 if (isset($form->_online
) && $form->_online
) {
618 $form->addRule('amount', ts('Fee Level is a required field.'), 'required');
624 * @param CRM_Core_Form $form
626 public static function formatFieldsForOptionFull(&$form) {
627 $priceSet = $form->get('priceSet');
628 $priceSetId = $form->get('priceSetId');
629 $defaultPricefieldIds = array();
630 if (!empty($form->_values
['line_items'])) {
631 foreach ($form->_values
['line_items'] as $lineItem) {
632 $defaultPricefieldIds[] = $lineItem['price_field_value_id'];
636 !is_array($priceSet) ||
637 empty($priceSet) ||
empty($priceSet['optionsMaxValueTotal'])
642 $skipParticipants = $formattedPriceSetDefaults = array();
643 if (!empty($form->_allowConfirmation
) && (isset($form->_pId
) ||
isset($form->_additionalParticipantId
))) {
644 $participantId = isset($form->_pId
) ?
$form->_pId
: $form->_additionalParticipantId
;
645 $pricesetDefaults = CRM_Event_Form_EventFees
::setDefaultPriceSet($participantId,
648 // modify options full to respect the selected fields
649 // options on confirmation.
650 $formattedPriceSetDefaults = self
::formatPriceSetParams($form, $pricesetDefaults);
652 // to skip current registered participants fields option count on confirmation.
653 $skipParticipants[] = $form->_participantId
;
654 if (!empty($form->_additionalParticipantIds
)) {
655 $skipParticipants = array_merge($skipParticipants, $form->_additionalParticipantIds
);
659 $className = CRM_Utils_System
::getClassName($form);
661 //get the current price event price set options count.
662 $currentOptionsCount = self
::getPriceSetOptionCount($form);
663 $recordedOptionsCount = CRM_Event_BAO_Participant
::priceSetOptionsCount($form->_eventId
, $skipParticipants);
664 $optionFullTotalAmount = 0;
665 $currentParticipantNo = (int) substr($form->_name
, 12);
666 foreach ($form->_feeBlock
as & $field) {
667 $optionFullIds = array();
668 $fieldId = $field['id'];
669 if (!is_array($field['options'])) {
672 foreach ($field['options'] as & $option) {
673 $optId = $option['id'];
674 $count = CRM_Utils_Array
::value('count', $option, 0);
675 $maxValue = CRM_Utils_Array
::value('max_value', $option, 0);
676 $dbTotalCount = CRM_Utils_Array
::value($optId, $recordedOptionsCount, 0);
677 $currentTotalCount = CRM_Utils_Array
::value($optId, $currentOptionsCount, 0);
679 $totalCount = $currentTotalCount +
$dbTotalCount;
682 (($totalCount >= $maxValue) &&
683 (empty($form->_lineItem
[$currentParticipantNo][$optId]['price_field_id']) ||
$dbTotalCount >= $maxValue))
686 $optionFullIds[$optId] = $optId;
687 if ($field['html_type'] != 'Select') {
688 if (in_array($optId, $defaultPricefieldIds)) {
689 $optionFullTotalAmount +
= CRM_Utils_Array
::value('amount', $option);
693 if (!empty($defaultPricefieldIds) && in_array($optId, $defaultPricefieldIds)) {
694 unset($optionFullIds[$optId]);
698 //here option is not full,
699 //but we don't want to allow participant to increase
700 //seats at the time of re-walking registration.
702 !empty($form->_allowConfirmation
) &&
703 !empty($formattedPriceSetDefaults)
705 if (empty($formattedPriceSetDefaults["price_{$field}"]) ||
empty($formattedPriceSetDefaults["price_{$fieldId}"][$optId])) {
706 $optionFullIds[$optId] = $optId;
710 $option['is_full'] = $isFull;
711 $option['db_total_count'] = $dbTotalCount;
712 $option['total_option_count'] = $dbTotalCount +
$currentTotalCount;
715 //ignore option full for offline registration.
716 if ($className == 'CRM_Event_Form_Participant') {
717 $optionFullIds = array();
720 //finally get option ids in.
721 $field['option_full_ids'] = $optionFullIds;
723 $form->assign('optionFullTotalAmount', $optionFullTotalAmount);
729 * @param array $fields
730 * The input form values.
731 * @param array $files
732 * The uploaded files if any.
737 * true if no errors, else array of errors
739 public static function formRule($fields, $files, $self) {
741 //check that either an email or firstname+lastname is included in the form(CRM-9587)
742 self
::checkProfileComplete($fields, $errors, $self->_eventId
);
743 //To check if the user is already registered for the event(CRM-2426)
744 if (!$self->_skipDupeRegistrationCheck
) {
745 self
::checkRegistration($fields, $self);
747 //check for availability of registrations.
748 if (!$self->_allowConfirmation
&& empty($fields['bypass_payment']) &&
749 is_numeric($self->_availableRegistrations
) &&
750 CRM_Utils_Array
::value('additional_participants', $fields) >= $self->_availableRegistrations
752 $errors['additional_participants'] = ts("There is only enough space left on this event for %1 participant(s).", array(1 => $self->_availableRegistrations
));
755 // during confirmation don't allow to increase additional participants, CRM-4320
756 if ($self->_allowConfirmation
&& !empty($fields['additional_participants']) &&
757 is_array($self->_additionalParticipantIds
) &&
758 $fields['additional_participants'] > count($self->_additionalParticipantIds
)
760 $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
)));
763 //don't allow to register w/ waiting if enough spaces available.
764 if (!empty($fields['bypass_payment']) && $self->_allowConfirmation
) {
765 if (!is_numeric($self->_availableRegistrations
) ||
766 (empty($fields['priceSetId']) && CRM_Utils_Array
::value('additional_participants', $fields) < $self->_availableRegistrations
)
768 $errors['bypass_payment'] = ts("Oops. There are enough available spaces in this event. You can not add yourself to the waiting list.");
772 if (!empty($fields['additional_participants']) &&
773 !CRM_Utils_Rule
::positiveInteger($fields['additional_participants'])
775 $errors['additional_participants'] = ts('Please enter a whole number for Number of additional people.');
778 // priceset validations
779 if (!empty($fields['priceSetId']) &&
780 !$self->_requireApproval
&& !$self->_allowWaitlist
783 $formatted = self
::formatPriceSetParams($self, $fields);
784 $ppParams = array($formatted);
785 $priceSetErrors = self
::validatePriceSet($self, $ppParams);
786 $primaryParticipantCount = self
::getParticipantCount($self, $ppParams);
788 //get price set fields errors in.
789 $errors = array_merge($errors, CRM_Utils_Array
::value(0, $priceSetErrors, array()));
791 $totalParticipants = $primaryParticipantCount;
792 if (!empty($fields['additional_participants'])) {
793 $totalParticipants +
= $fields['additional_participants'];
796 if (empty($fields['bypass_payment']) &&
797 !$self->_allowConfirmation
&&
798 is_numeric($self->_availableRegistrations
) &&
799 $self->_availableRegistrations
< $totalParticipants
801 $errors['_qf_default'] = ts("Only %1 Registrations available.", array(1 => $self->_availableRegistrations
));
805 CRM_Price_BAO_PriceSet
::processAmount($self->_values
['fee'], $fields, $lineItem);
807 $minAmt = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $fields['priceSetId'], 'min_amount');
808 if ($fields['amount'] < 0) {
809 $errors['_qf_default'] = ts('Event Fee(s) can not be less than zero. Please select the options accordingly');
811 elseif (!empty($minAmt) && $fields['amount'] < $minAmt) {
812 $errors['_qf_default'] = ts('A minimum amount of %1 should be selected from Event Fee(s).', array(
813 1 => CRM_Utils_Money
::format($minAmt),
818 // @todo - can we remove the 'is_monetary' concept?
819 if ($self->_values
['event']['is_monetary']) {
820 if (empty($self->_requireApproval
) && !empty($fields['amount']) && $fields['amount'] > 0 && !isset
821 ($fields['payment_processor_id'])) {
822 $errors['payment_processor_id'] = ts('Please select a Payment Method');
825 $isZeroAmount = $skipPaymentValidation = FALSE;
826 if (!empty($fields['priceSetId'])) {
827 if (CRM_Utils_Array
::value('amount', $fields) == 0) {
828 $isZeroAmount = TRUE;
831 elseif (!empty($fields['amount']) &&
832 (isset($self->_values
['discount'][$fields['amount']])
833 && CRM_Utils_Array
::value('value', $self->_values
['discount'][$fields['amount']]) == 0
836 $isZeroAmount = TRUE;
838 elseif (!empty($fields['amount']) &&
839 (isset($self->_values
['fee'][$fields['amount']])
840 && CRM_Utils_Array
::value('value', $self->_values
['fee'][$fields['amount']]) == 0
843 $isZeroAmount = TRUE;
846 if ($isZeroAmount && !($self->_forcePayement
&& !empty($fields['additional_participants']))) {
847 $skipPaymentValidation = TRUE;
850 // also return if zero fees for valid members
851 if (!empty($fields['bypass_payment']) ||
852 $skipPaymentValidation ||
853 (!$self->_allowConfirmation
&& ($self->_requireApproval ||
$self->_allowWaitlist
))
855 return empty($errors) ?
TRUE : $errors;
857 CRM_Core_Payment_Form
::validatePaymentInstrument(
858 $fields['payment_processor_id'],
861 (!$self->_isBillingAddressRequiredForPayLater ?
NULL : 'billing')
865 foreach (CRM_Contact_BAO_Contact
::$_greetingTypes as $greeting) {
866 if ($greetingType = CRM_Utils_Array
::value($greeting, $fields)) {
867 $customizedValue = CRM_Core_OptionGroup
::getValue($greeting, 'Customized', 'name');
868 if ($customizedValue == $greetingType && empty($fields[$greeting . '_custom'])) {
869 $errors[$greeting . '_custom'] = ts('Custom %1 is a required field if %1 is of type Customized.',
870 array(1 => ucwords(str_replace('_', ' ', $greeting)))
875 return empty($errors) ?
TRUE : $errors;
879 * Check if profiles are complete when event registration occurs(CRM-9587).
881 * @param array $fields
882 * @param array $errors
883 * @param int $eventId
885 public static function checkProfileComplete($fields, &$errors, $eventId) {
887 foreach ($fields as $fieldname => $fieldvalue) {
888 if (substr($fieldname, 0, 6) == 'email-' && $fieldvalue) {
889 $email = $fieldvalue;
893 if (!$email && !(!empty($fields['first_name']) && !empty($fields['last_name']))) {
894 $defaults = $params = array('id' => $eventId);
895 CRM_Event_BAO_Event
::retrieve($params, $defaults);
896 $message = ts("Mandatory fields (first name and last name, OR email address) are missing from this form.");
897 $errors['_qf_default'] = $message;
902 * Process the form submission.
904 public function postProcess() {
905 // get the submitted form values.
906 $params = $this->controller
->exportValues($this->_name
);
908 //set as Primary participant
909 $params['is_primary'] = 1;
911 if ($this->_values
['event']['is_pay_later']
912 && (!array_key_exists('hidden_processor', $params) ||
$params['payment_processor_id'] == 0)
914 $params['is_pay_later'] = 1;
917 $params['is_pay_later'] = 0;
920 $this->set('is_pay_later', $params['is_pay_later']);
922 // assign pay later stuff
923 $this->_params
['is_pay_later'] = CRM_Utils_Array
::value('is_pay_later', $params, FALSE);
924 $this->assign('is_pay_later', $params['is_pay_later']);
925 if ($params['is_pay_later']) {
926 $this->assign('pay_later_text', $this->_values
['event']['pay_later_text']);
927 $this->assign('pay_later_receipt', $this->_values
['event']['pay_later_receipt']);
930 if (!$this->_allowConfirmation
) {
931 // check if the participant is already registered
932 if (!$this->_skipDupeRegistrationCheck
) {
933 $params['contact_id'] = self
::checkRegistration($params, $this, FALSE, TRUE, TRUE);
937 if (!empty($params['image_URL'])) {
938 CRM_Contact_BAO_Contact
::processImageParams($params);
941 //carry campaign to partcipants.
942 if (array_key_exists('participant_campaign_id', $params)) {
943 $params['campaign_id'] = $params['participant_campaign_id'];
946 $params['campaign_id'] = CRM_Utils_Array
::value('campaign_id', $this->_values
['event']);
949 //hack to allow group to register w/ waiting
950 $primaryParticipantCount = self
::getParticipantCount($this, $params);
952 $totalParticipants = $primaryParticipantCount;
953 if (!empty($params['additional_participants'])) {
954 $totalParticipants +
= $params['additional_participants'];
956 if (!$this->_allowConfirmation
&& !empty($params['bypass_payment']) &&
957 is_numeric($this->_availableRegistrations
) &&
958 $totalParticipants > $this->_availableRegistrations
960 $this->_allowWaitlist
= TRUE;
961 $this->set('allowWaitlist', TRUE);
964 //carry participant id if pre-registered.
965 if ($this->_allowConfirmation
&& $this->_participantId
) {
966 $params['participant_id'] = $this->_participantId
;
969 $params['defaultRole'] = 1;
970 if (array_key_exists('participant_role', $params)) {
971 $params['participant_role_id'] = $params['participant_role'];
974 if (array_key_exists('participant_role_id', $params)) {
975 $params['defaultRole'] = 0;
977 if (empty($params['participant_role_id']) &&
978 $this->_values
['event']['default_role_id']
980 $params['participant_role_id'] = $this->_values
['event']['default_role_id'];
983 $config = CRM_Core_Config
::singleton();
984 $params['currencyID'] = $config->defaultCurrency
;
986 if ($this->_values
['event']['is_monetary']) {
987 // we first reset the confirm page so it accepts new values
988 $this->controller
->resetPage('Confirm');
991 $discountId = CRM_Core_BAO_Discount
::findSet($this->_eventId
, 'civicrm_event');
992 $params['amount_level'] = $this->getAmountLevel($params, $discountId);
993 if (!empty($this->_values
['discount'][$discountId])) {
994 $params['discount_id'] = $discountId;
995 $params['amount'] = $this->_values
['discount'][$discountId][$params['amount']]['value'];
997 elseif (empty($params['priceSetId'])) {
998 if (!empty($params['amount'])) {
999 $params['amount'] = $this->_values
['fee'][$params['amount']]['value'];
1002 $params['amount'] = '';
1006 $lineItem = array();
1007 CRM_Price_BAO_PriceSet
::processAmount($this->_values
['fee'], $params, $lineItem);
1008 if ($params['tax_amount']) {
1009 $this->set('tax_amount', $params['tax_amount']);
1011 $submittedLineItems = $this->get('lineItem');
1012 if (!empty($submittedLineItems) && is_array($submittedLineItems)) {
1013 $submittedLineItems[0] = $lineItem;
1016 $submittedLineItems = array($lineItem);
1018 $submittedLineItems = array_filter($submittedLineItems);
1019 $this->set('lineItem', $submittedLineItems);
1020 $this->set('lineItemParticipantsCount', array($primaryParticipantCount));
1023 $this->set('amount', $params['amount']);
1024 $this->set('amount_level', $params['amount_level']);
1026 // generate and set an invoiceID for this transaction
1027 $invoiceID = md5(uniqid(rand(), TRUE));
1028 $this->set('invoiceID', $invoiceID);
1030 if ($this->_paymentProcessor
) {
1031 $payment = $this->_paymentProcessor
['object'];
1032 $payment->setBaseReturnUrl('civicrm/event/register');
1035 // ContributeMode is a deprecated concept. It is short-hand for a bunch of
1036 // assumptions we are working to remove.
1037 $this->set('contributeMode', 'direct');
1039 // This code is duplicated multiple places and should be consolidated.
1040 if (isset($params["state_province_id-{$this->_bltID}"]) &&
1041 $params["state_province_id-{$this->_bltID}"]
1043 $params["state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($params["state_province_id-{$this->_bltID}"]);
1046 if (isset($params["country_id-{$this->_bltID}"]) &&
1047 $params["country_id-{$this->_bltID}"]
1049 $params["country-{$this->_bltID}"] = CRM_Core_PseudoConstant
::countryIsoCode($params["country_id-{$this->_bltID}"]);
1051 if (isset($params['credit_card_exp_date'])) {
1052 $params['year'] = CRM_Core_Payment_Form
::getCreditCardExpirationYear($params);
1053 $params['month'] = CRM_Core_Payment_Form
::getCreditCardExpirationMonth($params);
1055 if ($this->_values
['event']['is_monetary']) {
1056 $params['ip_address'] = CRM_Utils_System
::ipAddress();
1057 $params['currencyID'] = $config->defaultCurrency
;
1058 $params['invoiceID'] = $invoiceID;
1060 $this->_params
= $this->get('params');
1061 // Set the button so we know what
1062 $params['button'] = $this->controller
->getButtonName();
1063 if (!empty($this->_params
) && is_array($this->_params
)) {
1064 $this->_params
[0] = $params;
1067 $this->_params
= array();
1068 $this->_params
[] = $params;
1070 $this->set('params', $this->_params
);
1071 if ($this->_paymentProcessor
&&
1072 // Actually we don't really need to check if it supports pre-approval - we could just call
1073 // it regardless as the function we call re-acts tot the rests of the preApproval call.
1074 $this->_paymentProcessor
['object']->supports('preApproval')
1075 && !$this->_allowWaitlist
&&
1076 !$this->_requireApproval
1079 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1080 $this->set('contributeMode', 'express');
1082 // Send Event Name & Id in Params
1083 $params['eventName'] = $this->_values
['event']['title'];
1084 $params['eventId'] = $this->_values
['event']['id'];
1086 $params['cancelURL'] = CRM_Utils_System
::url('civicrm/event/register',
1087 "_qf_Register_display=1&qfKey={$this->controller->_key}",
1090 if (CRM_Utils_Array
::value('additional_participants', $params, FALSE)) {
1091 $urlArgs = "_qf_Participant_1_display=1&rfp=1&qfKey={$this->controller->_key}";
1094 $urlArgs = "_qf_Confirm_display=1&rfp=1&qfKey={$this->controller->_key}";
1096 $params['returnURL'] = CRM_Utils_System
::url('civicrm/event/register',
1100 $params['invoiceID'] = $invoiceID;
1102 $params['component'] = 'event';
1103 $this->handlePreApproval($params);
1105 elseif ($this->_paymentProcessor
&&
1106 $this->_paymentProcessor
['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_NOTIFY
1108 // The concept of contributeMode is deprecated - but still needs removal from the message templates.
1109 $this->set('contributeMode', 'notify');
1113 $params['description'] = ts('Online Event Registration') . ' ' . $this->_values
['event']['title'];
1115 $this->_params
= array();
1116 $this->_params
[] = $params;
1117 $this->set('params', $this->_params
);
1120 empty($params['additional_participants'])
1121 && !$this->_values
['event']['is_confirm_enabled'] // CRM-11182 - Optional confirmation screen
1123 $this->processRegistration($this->_params
);
1127 // If registering > 1 participant, give status message
1128 if (CRM_Utils_Array
::value('additional_participants', $params, FALSE)) {
1129 $statusMsg = ts('Registration information for participant 1 has been saved.');
1130 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
1135 * Method to check if the user is already registered for the event.
1136 * and if result found redirect to the event info page
1138 * @param array $fields
1139 * The input form values(anonymous user).
1140 * @param CRM_Event_Form_Registration_Register $self
1142 * @param bool $isAdditional
1143 * Treat isAdditional participants a bit differently.
1144 * @param bool $returnContactId
1145 * Just find and return the contactID match to use.
1146 * @param bool $useDedupeRules
1147 * Force usage of dedupe rules.
1151 public static function checkRegistration($fields, &$self, $isAdditional = FALSE, $returnContactId = FALSE, $useDedupeRules = FALSE) {
1152 // CRM-3907, skip check for preview registrations
1153 // CRM-4320 participant need to walk wizard
1154 if (!$returnContactId &&
1155 ($self->_mode
== 'test' ||
$self->_allowConfirmation
)
1161 $session = CRM_Core_Session
::singleton();
1162 if (!$isAdditional) {
1163 $contactID = $self->getContactID();
1166 if (!$contactID && is_array($fields) && $fields) {
1168 //CRM-14134 use Unsupervised rule for everyone
1169 $dedupeParams = CRM_Dedupe_Finder
::formatParams($fields, 'Individual');
1171 // disable permission based on cache since event registration is public page/feature.
1172 $dedupeParams['check_permission'] = FALSE;
1174 // find event dedupe rule
1175 if (CRM_Utils_Array
::value('dedupe_rule_group_id', $self->_values
['event'], 0) > 0) {
1176 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, 'Individual', 'Unsupervised', array(), $self->_values
['event']['dedupe_rule_group_id']);
1179 $ids = CRM_Dedupe_Finder
::dupesByParams($dedupeParams, 'Individual', 'Unsupervised');
1181 $contactID = CRM_Utils_Array
::value(0, $ids);
1185 if ($returnContactId) {
1187 // return contactID if contact already exists
1192 $participant = new CRM_Event_BAO_Participant();
1193 $participant->contact_id
= $contactID;
1194 $participant->event_id
= $self->_values
['event']['id'];
1195 if (!empty($fields['participant_role']) && is_numeric($fields['participant_role'])) {
1196 $participant->role_id
= $fields['participant_role'];
1199 $participant->role_id
= $self->_values
['event']['default_role_id'];
1201 $participant->is_test
= 0;
1202 $participant->find();
1203 $statusTypes = CRM_Event_PseudoConstant
::participantStatus(NULL, 'is_counted = 1');
1204 while ($participant->fetch()) {
1205 if (array_key_exists($participant->status_id
, $statusTypes)) {
1206 if (!$isAdditional && !$self->_values
['event']['allow_same_participant_emails']) {
1207 $registerUrl = CRM_Utils_System
::url('civicrm/event/register',
1208 "reset=1&id={$self->_values['event']['id']}&cid=0"
1210 if ($self->_pcpId
) {
1211 $registerUrl .= '&pcpId=' . $self->_pcpId
;
1214 $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));
1215 $session->setStatus($status, ts('Oops.'), 'alert');
1216 $url = CRM_Utils_System
::url('civicrm/event/info',
1217 "reset=1&id={$self->_values['event']['id']}&noFullMsg=true"
1219 if ($self->_action
& CRM_Core_Action
::PREVIEW
) {
1220 $url .= '&action=preview';
1223 if ($self->_pcpId
) {
1224 $url .= '&pcpId=' . $self->_pcpId
;
1227 CRM_Utils_System
::redirect($url);
1230 if ($isAdditional) {
1231 $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.");
1232 $session->setStatus($status, ts('Oops.'), 'alert');
1233 return $participant->id
;