Merge pull request #18148 from civicrm/5.29
[civicrm-core.git] / CRM / Event / Form / Registration.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
bc77d7c0 4 | Copyright CiviCRM LLC. All rights reserved. |
6a488035 5 | |
bc77d7c0
TO
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
6a488035 9 +--------------------------------------------------------------------+
d25dd0ee 10 */
6a488035
TO
11
12/**
6a488035 13 * @package CRM
ca5cec67 14 * @copyright CiviCRM LLC https://civicrm.org/licensing
6a488035
TO
15 */
16
17/**
3bdf1f3a 18 * This class generates form components for processing Event.
6a488035
TO
19 */
20class CRM_Event_Form_Registration extends CRM_Core_Form {
bc66279e 21
573aa07e 22 use CRM_Financial_Form_FrontEndPaymentFormTrait;
6a488035
TO
23
24 /**
100fef9d 25 * How many locationBlocks should we display?
6a488035
TO
26 *
27 * @var int
28 * @const
29 */
7da04cde 30 const LOCATION_BLOCKS = 1;
6a488035
TO
31
32 /**
66f9e52b 33 * The id of the event we are proceessing.
6a488035
TO
34 *
35 * @var int
6a488035
TO
36 */
37 public $_eventId;
38
39 /**
66f9e52b 40 * The array of ids of all the participant we are proceessing.
6a488035
TO
41 *
42 * @var int
6a488035
TO
43 */
44 protected $_participantIDS = NULL;
45
46 /**
66f9e52b 47 * The id of the participant we are proceessing.
6a488035
TO
48 *
49 * @var int
6a488035
TO
50 */
51 protected $_participantId;
52
53 /**
100fef9d 54 * Is participant able to walk registration wizard.
6a488035 55 *
d51c6add 56 * @var bool
6a488035
TO
57 */
58 public $_allowConfirmation;
59
60 /**
66f9e52b 61 * Is participant requires approval.
6a488035 62 *
d51c6add 63 * @var bool
6a488035
TO
64 */
65 public $_requireApproval;
66
67 /**
100fef9d 68 * Is event configured for waitlist.
6a488035 69 *
d51c6add 70 * @var bool
6a488035
TO
71 */
72 public $_allowWaitlist;
73
74 /**
66f9e52b 75 * Store additional participant ids.
6a488035
TO
76 * when there are pre-registered.
77 *
78 * @var array
6a488035
TO
79 */
80 public $_additionalParticipantIds;
81
6a488035 82 /**
66f9e52b 83 * The values for the contribution db object.
6a488035
TO
84 *
85 * @var array
6a488035
TO
86 */
87 public $_values;
88
89 /**
66f9e52b 90 * The paymentProcessor attributes for this page.
6a488035
TO
91 *
92 * @var array
6a488035
TO
93 */
94 public $_paymentProcessor;
95
96 /**
66f9e52b 97 * The params submitted by the form and computed by the app.
6a488035
TO
98 *
99 * @var array
6a488035
TO
100 */
101 protected $_params;
102
103 /**
66f9e52b 104 * The fields involved in this contribution page.
6a488035
TO
105 *
106 * @var array
6a488035
TO
107 */
108 public $_fields;
109
110 /**
66f9e52b 111 * The billing location id for this contribiution page.
6a488035
TO
112 *
113 * @var int
6a488035
TO
114 */
115 public $_bltID;
116
117 /**
118 * Price Set ID, if the new price set method is used
119 *
120 * @var int
6a488035
TO
121 */
122 public $_priceSetId = NULL;
123
124 /**
66f9e52b 125 * Array of fields for the price set.
6a488035
TO
126 *
127 * @var array
6a488035
TO
128 */
129 public $_priceSet;
130
131 public $_action;
132
133 public $_pcpId;
134
90b461f1
SL
135 /**
136 * Is event already full.
e70a7fc0 137 *
d51c6add 138 * @var bool
90b461f1 139 *
e70a7fc0 140 */
6a488035 141
90b461f1 142
6a488035
TO
143 public $_isEventFull;
144
145 public $_lineItem;
bc66279e 146
6a488035 147 public $_lineItemParticipantsCount;
bc66279e 148
6a488035
TO
149 public $_availableRegistrations;
150
18135422 151 /**
90b461f1 152 * @var bool
18135422 153 * @deprecated
18135422 154 */
8ae4d0d3 155 public $_isBillingAddressRequiredForPayLater;
156
18135422 157 /**
158 * Is this a back office form
159 *
160 * @var bool
161 */
162 public $isBackOffice = FALSE;
163
164 /**
165 * Payment instrument iD for the transaction.
166 *
167 * This will generally be drawn from the payment processor and is ignored for
168 * front end forms.
169 *
170 * @var int
171 */
172 public $paymentInstrumentID;
173
6a488035 174 /**
66f9e52b 175 * Set variables up before form is built.
6a488035 176 */
00be9182 177 public function preProcess() {
6a488035 178 $this->_eventId = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
0ebdca14 179 $this->_action = CRM_Utils_Request::retrieve('action', 'Alphanumeric', $this, FALSE, CRM_Core_Action::ADD);
6a488035
TO
180 //CRM-4320
181 $this->_participantId = CRM_Utils_Request::retrieve('participantId', 'Positive', $this);
6a2b3da2 182 $this->setPaymentMode();
6a488035
TO
183
184 $this->_values = $this->get('values');
185 $this->_fields = $this->get('fields');
186 $this->_bltID = $this->get('bltID');
187 $this->_paymentProcessor = $this->get('paymentProcessor');
188 $this->_priceSetId = $this->get('priceSetId');
189 $this->_priceSet = $this->get('priceSet');
190 $this->_lineItem = $this->get('lineItem');
191 $this->_isEventFull = $this->get('isEventFull');
192 $this->_lineItemParticipantsCount = $this->get('lineItemParticipants');
193 if (!is_array($this->_lineItem)) {
affcc9d2 194 $this->_lineItem = [];
6a488035
TO
195 }
196 if (!is_array($this->_lineItemParticipantsCount)) {
affcc9d2 197 $this->_lineItemParticipantsCount = [];
6a488035
TO
198 }
199 $this->_availableRegistrations = $this->get('availableRegistrations');
6a488035
TO
200 $this->_participantIDS = $this->get('participantIDs');
201
202 //check if participant allow to walk registration wizard.
203 $this->_allowConfirmation = $this->get('allowConfirmation');
204
205 // check for Approval
206 $this->_requireApproval = $this->get('requireApproval');
207
208 // check for waitlisting.
209 $this->_allowWaitlist = $this->get('allowWaitlist');
210
6a488035
TO
211 //get the additional participant ids.
212 $this->_additionalParticipantIds = $this->get('additionalParticipantIds');
6a488035
TO
213 $config = CRM_Core_Config::singleton();
214
215 if (!$this->_values) {
216 // create redirect URL to send folks back to event info page is registration not available
96f7c53e 217 $infoUrl = CRM_Utils_System::url('civicrm/event/info', "reset=1&id={$this->_eventId}",
6a488035
TO
218 FALSE, NULL, FALSE, TRUE
219 );
220
221 // this is the first time we are hitting this, so check for permissions here
e2d09ab4 222 if (!CRM_Core_Permission::event(CRM_Core_Permission::EDIT, $this->_eventId, 'register for events')) {
6a488035
TO
223 CRM_Core_Error::statusBounce(ts('You do not have permission to register for this event'), $infoUrl);
224 }
225
226 // get all the values from the dao object
affcc9d2 227 $this->_values = $this->_fields = [];
6a488035
TO
228
229 //retrieve event information
bc66279e 230 $params = ['id' => $this->_eventId];
6a488035 231 CRM_Event_BAO_Event::retrieve($params, $this->_values['event']);
9ed3cd18 232 // check for is_monetary status
9c1bc317 233 $isMonetary = $this->_values['event']['is_monetary'] ?? NULL;
9ed3cd18 234 // check for ability to add contributions of type
a8b59c2c 235 if ($isMonetary
4323dc6c
PN
236 && CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
237 && !CRM_Core_Permission::check('add contributions of type ' . CRM_Contribute_PseudoConstant::financialType($this->_values['event']['financial_type_id']))
238 ) {
beb414cc 239 CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
9ed3cd18 240 }
6a488035
TO
241
242 $this->checkValidEvent($infoUrl);
6a488035
TO
243 // get the participant values, CRM-4320
244 $this->_allowConfirmation = FALSE;
245 if ($this->_participantId) {
246 $this->processFirstParticipant($this->_participantId);
247 }
6a488035
TO
248 //check for additional participants.
249 if ($this->_allowConfirmation && $this->_values['event']['is_multiple_registrations']) {
250 $additionalParticipantIds = CRM_Event_BAO_Participant::getAdditionalParticipantIds($this->_participantId);
251 $cnt = 1;
252 foreach ($additionalParticipantIds as $additionalParticipantId) {
253 $this->_additionalParticipantIds[$cnt] = $additionalParticipantId;
254 $cnt++;
255 }
256 $this->set('additionalParticipantIds', $this->_additionalParticipantIds);
257 }
258
96f7c53e 259 $eventFull = CRM_Event_BAO_Participant::eventFull($this->_eventId, FALSE,
6a488035
TO
260 CRM_Utils_Array::value('has_waitlist', $this->_values['event'])
261 );
262
96f7c53e 263 $this->_allowWaitlist = $this->_isEventFull = FALSE;
6a488035
TO
264 if ($eventFull && !$this->_allowConfirmation) {
265 $this->_isEventFull = TRUE;
266 //lets redirecting to info only when to waiting list.
9c1bc317 267 $this->_allowWaitlist = $this->_values['event']['has_waitlist'] ?? NULL;
6a488035
TO
268 if (!$this->_allowWaitlist) {
269 CRM_Utils_System::redirect($infoUrl);
270 }
271 }
272 $this->set('isEventFull', $this->_isEventFull);
273 $this->set('allowWaitlist', $this->_allowWaitlist);
274
275 //check for require requires approval.
276 $this->_requireApproval = FALSE;
a7488080 277 if (!empty($this->_values['event']['requires_approval']) && !$this->_allowConfirmation) {
6a488035
TO
278 $this->_requireApproval = TRUE;
279 }
280 $this->set('requireApproval', $this->_requireApproval);
281
6a488035
TO
282 if (isset($this->_values['event']['default_role_id'])) {
283 $participant_role = CRM_Core_OptionGroup::values('participant_role');
284 $this->_values['event']['participant_role'] = $participant_role["{$this->_values['event']['default_role_id']}"];
285 }
96f7c53e 286 $isPayLater = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $this->_eventId, 'is_pay_later');
55d21031 287 $this->setPayLaterLabel($isPayLater ? $this->_values['event']['pay_later_text'] : '');
2c5311b9 288 //check for various combinations for paylater, payment
6a488035 289 //process with paid event.
8cc574cf 290 if ($isMonetary && (!$isPayLater || !empty($this->_values['event']['payment_processor']))) {
2c5311b9 291 $this->_paymentProcessorIDs = explode(CRM_Core_DAO::VALUE_SEPARATOR, CRM_Utils_Array::value('payment_processor',
6a488035 292 $this->_values['event']
2c5311b9 293 ));
cbcb5b49 294 $this->assignPaymentProcessor($isPayLater);
6a488035 295 }
6a488035 296 //init event fee.
96f7c53e 297 self::initEventFee($this, $this->_eventId);
6a488035
TO
298
299 // get the profile ids
bc66279e 300 $ufJoinParams = [
6a488035
TO
301 'entity_table' => 'civicrm_event',
302 // CRM-4377: CiviEvent for the main participant, CiviEvent_Additional for additional participants
303 'module' => 'CiviEvent',
304 'entity_id' => $this->_eventId,
bc66279e 305 ];
6a488035
TO
306 list($this->_values['custom_pre_id'],
307 $this->_values['custom_post_id']
353ffa53 308 ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
6a488035
TO
309
310 // set profiles for additional participants
311 if ($this->_values['event']['is_multiple_registrations']) {
96f7c53e
PJ
312 // CRM-4377: CiviEvent for the main participant, CiviEvent_Additional for additional participants
313 $ufJoinParams['module'] = 'CiviEvent_Additional';
314
6a488035
TO
315 list($this->_values['additional_custom_pre_id'],
316 $this->_values['additional_custom_post_id'], $preActive, $postActive
353ffa53 317 ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
6a488035
TO
318
319 // CRM-4377: we need to maintain backward compatibility, hence if there is profile for main contact
320 // set same profile for additional contacts.
321 if ($this->_values['custom_pre_id'] && !$this->_values['additional_custom_pre_id']) {
322 $this->_values['additional_custom_pre_id'] = $this->_values['custom_pre_id'];
323 }
324
325 if ($this->_values['custom_post_id'] && !$this->_values['additional_custom_post_id']) {
326 $this->_values['additional_custom_post_id'] = $this->_values['custom_post_id'];
327 }
6a488035
TO
328 // now check for no profile condition, in that case is_active = 0
329 if (isset($preActive) && !$preActive) {
330 unset($this->_values['additional_custom_pre_id']);
331 }
6a488035
TO
332 if (isset($postActive) && !$postActive) {
333 unset($this->_values['additional_custom_post_id']);
334 }
335 }
8345c9d3
EM
336
337 $this->assignBillingType();
6a488035 338
a6513ad5
EM
339 if ($this->_values['event']['is_monetary']) {
340 CRM_Core_Payment_Form::setPaymentFieldsByProcessor($this, $this->_paymentProcessor);
6a488035 341 }
bc66279e 342 $params = ['entity_id' => $this->_eventId, 'entity_table' => 'civicrm_event'];
6a488035
TO
343 $this->_values['location'] = CRM_Core_BAO_Location::getValues($params, TRUE);
344
345 $this->set('values', $this->_values);
346 $this->set('fields', $this->_fields);
347
7c550ca0
WA
348 $this->_availableRegistrations
349 = CRM_Event_BAO_Participant::eventFull(
bc66279e 350 $this->_values['event']['id'], TRUE,
351 CRM_Utils_Array::value('has_waitlist', $this->_values['event'])
352 );
6a488035
TO
353 $this->set('availableRegistrations', $this->_availableRegistrations);
354 }
6a488035
TO
355 $this->assign_by_ref('paymentProcessor', $this->_paymentProcessor);
356
357 // check if this is a paypal auto return and redirect accordingly
358 if (CRM_Core_Payment::paypalRedirect($this->_paymentProcessor)) {
359 $url = CRM_Utils_System::url('civicrm/event/register',
360 "_qf_ThankYou_display=1&qfKey={$this->controller->_key}"
361 );
362 CRM_Utils_System::redirect($url);
363 }
0f2b049e 364 // The concept of contributeMode is deprecated.
6a488035
TO
365 $this->_contributeMode = $this->get('contributeMode');
366 $this->assign('contributeMode', $this->_contributeMode);
367
d7188a5d 368 $this->setTitle($this->_values['event']['title']);
6a488035
TO
369
370 $this->assign('paidEvent', $this->_values['event']['is_monetary']);
371
372 // we do not want to display recently viewed items on Registration pages
373 $this->assign('displayRecent', FALSE);
6a488035 374
9c1bc317 375 $isShowLocation = $this->_values['event']['is_show_location'] ?? NULL;
6a488035 376 $this->assign('isShowLocation', $isShowLocation);
6a488035
TO
377 // Handle PCP
378 $pcpId = CRM_Utils_Request::retrieve('pcpId', 'Positive', $this);
379 if ($pcpId) {
353ffa53
TO
380 $pcp = CRM_PCP_BAO_PCP::handlePcp($pcpId, 'event', $this->_values['event']);
381 $this->_pcpId = $pcp['pcpId'];
9c1bc317 382 $this->_values['event']['intro_text'] = $pcp['pcpInfo']['intro_text'] ?? NULL;
6a488035
TO
383 }
384
385 // assign all event properties so wizard templates can display event info.
386 $this->assign('event', $this->_values['event']);
387 $this->assign('location', $this->_values['location']);
388 $this->assign('bltID', $this->_bltID);
9c1bc317 389 $isShowLocation = $this->_values['event']['is_show_location'] ?? NULL;
6a488035 390 $this->assign('isShowLocation', $isShowLocation);
85939a77 391 CRM_Contribute_BAO_Contribution_Utils::overrideDefaultCurrency($this->_values['event']);
6a488035
TO
392
393 //lets allow user to override campaign.
394 $campID = CRM_Utils_Request::retrieve('campID', 'Positive', $this);
395 if ($campID && CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Campaign', $campID)) {
396 $this->_values['event']['campaign_id'] = $campID;
397 }
8ae4d0d3 398
f48e6cf7 399 // Set the same value for is_billing_required as contribution page so code can be shared.
9c1bc317 400 $this->_values['is_billing_required'] = $this->_values['event']['is_billing_required'] ?? NULL;
8ae4d0d3 401 // check if billing block is required for pay later
f48e6cf7 402 // note that I have started removing the use of isBillingAddressRequiredForPayLater in favour of letting
403 // the CRM_Core_Payment_Manual class handle it - but there are ~300 references to it in the code base so only
404 // removing in very limited cases.
f3acfdd9 405 if (!empty($this->_values['event']['is_pay_later'])) {
9c1bc317 406 $this->_isBillingAddressRequiredForPayLater = $this->_values['event']['is_billing_required'] ?? NULL;
8ae4d0d3 407 $this->assign('isBillingAddressRequiredForPayLater', $this->_isBillingAddressRequiredForPayLater);
408 }
6a488035
TO
409 }
410
411 /**
66f9e52b 412 * Assign the minimal set of variables to the template.
6a488035 413 */
00be9182 414 public function assignToTemplate() {
6a488035
TO
415 //process only primary participant params
416 $this->_params = $this->get('params');
417 if (isset($this->_params[0])) {
418 $params = $this->_params[0];
419 }
420 $name = '';
a7488080 421 if (!empty($params['billing_first_name'])) {
6a488035
TO
422 $name = $params['billing_first_name'];
423 }
424
a7488080 425 if (!empty($params['billing_middle_name'])) {
6a488035
TO
426 $name .= " {$params['billing_middle_name']}";
427 }
428
a7488080 429 if (!empty($params['billing_last_name'])) {
6a488035
TO
430 $name .= " {$params['billing_last_name']}";
431 }
432 $this->assign('billingName', $name);
433 $this->set('name', $name);
434
bc66279e 435 $vars = [
353ffa53
TO
436 'amount',
437 'currencyID',
438 'credit_card_type',
439 'trxn_id',
440 'amount_level',
441 'receive_date',
bc66279e 442 ];
6a488035
TO
443
444 foreach ($vars as $v) {
a7488080 445 if (!empty($params[$v])) {
6a488035
TO
446 if ($v == 'receive_date') {
447 $this->assign($v, CRM_Utils_Date::mysqlToIso($params[$v]));
448 }
449 else {
450 $this->assign($v, $params[$v]);
451 }
452 }
de6c59ca 453 elseif (empty($params['amount'])) {
6a488035
TO
454 $this->assign($v, CRM_Utils_Array::value($v, $params));
455 }
456 }
457
0b50eca0 458 $this->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters($params, $this->_bltID));
6a488035 459
0f2b049e 460 // The concept of contributeMode is deprecated.
8cc574cf 461 if ($this->_contributeMode == 'direct' && empty($params['is_pay_later'])) {
6a488035
TO
462 $date = CRM_Utils_Date::format(CRM_Utils_Array::value('credit_card_exp_date', $params));
463 $date = CRM_Utils_Date::mysqlToIso($date);
464 $this->assign('credit_card_exp_date', $date);
465 $this->assign('credit_card_number',
466 CRM_Utils_System::mungeCreditCard(CRM_Utils_Array::value('credit_card_number', $params))
467 );
468 }
469
470 // get the email that the confirmation would have been sent to
471 $session = CRM_Core_Session::singleton();
472
473 // assign is_email_confirm to templates
474 if (isset($this->_values['event']['is_email_confirm'])) {
475 $this->assign('is_email_confirm', $this->_values['event']['is_email_confirm']);
476 }
477
478 // assign pay later stuff
479 $params['is_pay_later'] = CRM_Utils_Array::value('is_pay_later', $params, FALSE);
480 $this->assign('is_pay_later', $params['is_pay_later']);
481 if ($params['is_pay_later']) {
55d21031 482 $this->assign('pay_later_text', $this->getPayLaterLabel());
6a488035
TO
483 $this->assign('pay_later_receipt', $this->_values['event']['pay_later_receipt']);
484 }
485
486 // also assign all participantIDs to the template
487 // useful in generating confirmation numbers if needed
f12392c8 488 $this->assign('participantIDs', $this->_participantIDS);
6a488035
TO
489 }
490
491 /**
66f9e52b 492 * Add the custom fields.
6a488035 493 *
100fef9d
CW
494 * @param int $id
495 * @param string $name
77b97be7 496 * @param bool $viewOnly
6a488035 497 */
00be9182 498 public function buildCustom($id, $name, $viewOnly = FALSE) {
6a488035 499 if ($id) {
353ffa53
TO
500 $button = substr($this->controller->getButtonName(), -4);
501 $cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
502 $session = CRM_Core_Session::singleton();
6a488035
TO
503 $contactID = $session->get('userID');
504
505 // we don't allow conflicting fields to be
506 // configured via profile
bc66279e 507 $fieldsToIgnore = [
6a488035
TO
508 'participant_fee_amount' => 1,
509 'participant_fee_level' => 1,
bc66279e 510 ];
6a488035
TO
511 if ($contactID) {
512 //FIX CRM-9653
513 if (is_array($id)) {
affcc9d2 514 $fields = [];
6a488035
TO
515 foreach ($id as $profileID) {
516 $field = CRM_Core_BAO_UFGroup::getFields($profileID, FALSE, CRM_Core_Action::ADD,
517 NULL, NULL, FALSE, NULL,
518 FALSE, NULL, CRM_Core_Permission::CREATE,
519 'field_name', TRUE
520 );
521 $fields = array_merge($fields, $field);
522 }
523 }
524 else {
525 if (CRM_Core_BAO_UFGroup::filterUFGroups($id, $contactID)) {
526 $fields = CRM_Core_BAO_UFGroup::getFields($id, FALSE, CRM_Core_Action::ADD,
527 NULL, NULL, FALSE, NULL,
528 FALSE, NULL, CRM_Core_Permission::CREATE,
529 'field_name', TRUE
530 );
531 }
532 }
533 }
534 else {
535 $fields = CRM_Core_BAO_UFGroup::getFields($id, FALSE, CRM_Core_Action::ADD,
536 NULL, NULL, FALSE, NULL,
537 FALSE, NULL, CRM_Core_Permission::CREATE,
538 'field_name', TRUE
539 );
540 }
541
542 if (array_intersect_key($fields, $fieldsToIgnore)) {
543 $fields = array_diff_key($fields, $fieldsToIgnore);
544 CRM_Core_Session::setStatus(ts('Some of the profile fields cannot be configured for this page.'));
545 }
546 $addCaptcha = FALSE;
a2149acc 547
548 if (!empty($this->_fields)) {
549 $fields = @array_diff_assoc($fields, $this->_fields);
550 }
551
a7488080 552 if (empty($this->_params[0]['additional_participants']) &&
6a488035
TO
553 is_null($cid)
554 ) {
555 CRM_Core_BAO_Address::checkContactSharedAddressFields($fields, $contactID);
556 }
557 $this->assign($name, $fields);
6a488035
TO
558 if (is_array($fields)) {
559 foreach ($fields as $key => $field) {
560 if ($viewOnly &&
561 isset($field['data_type']) &&
562 $field['data_type'] == 'File' || ($viewOnly && $field['name'] == 'image_URL')
563 ) {
564 // ignore file upload fields
565 continue;
566 }
567 //make the field optional if primary participant
568 //have been skip the additional participant.
569 if ($button == 'skip') {
570 $field['is_required'] = FALSE;
da8d9879 571 }
71fc6ea4 572 // CRM-11316 Is ReCAPTCHA enabled for this profile AND is this an anonymous visitor
353ffa53 573 elseif ($field['add_captcha'] && !$contactID) {
6a488035
TO
574 // only add captcha for first page
575 $addCaptcha = TRUE;
576 }
6a488035 577 list($prefixName, $index) = CRM_Utils_System::explode('-', $key, 2);
6a488035
TO
578 CRM_Core_BAO_UFGroup::buildProfile($this, $field, CRM_Profile_Form::MODE_CREATE, $contactID, TRUE);
579
580 $this->_fields[$key] = $field;
581 }
582 }
4839c695 583
6a488035 584 if ($addCaptcha && !$viewOnly) {
268ff0e8 585 CRM_Utils_ReCAPTCHA::enableCaptchaOnForm($this);
6a488035
TO
586 }
587 }
588 }
589
0cf587a7 590 /**
3bdf1f3a 591 * Initiate event fee.
592 *
c490a46a 593 * @param CRM_Core_Form $form
100fef9d 594 * @param int $eventID
1cb5e2d3 595 * @param bool $includeExpiredFields
596 * See CRM-16456.
0cf587a7
EM
597 *
598 * @throws Exception
599 */
1cb5e2d3 600 public static function initEventFee(&$form, $eventID, $includeExpiredFields = TRUE) {
6a488035
TO
601 // get price info
602
603 // retrive all active price set fields.
604 $discountId = CRM_Core_BAO_Discount::findSet($eventID, 'civicrm_event');
8567d0f8
PN
605 if (property_exists($form, '_discountId') && $form->_discountId) {
606 $discountId = $form->_discountId;
607 }
d4acad97 608
6a488035
TO
609 if ($discountId) {
610 $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Core_BAO_Discount', $discountId, 'price_set_id');
1cb5e2d3 611 CRM_Price_BAO_PriceSet::initSet($form, 'civicrm_event', $includeExpiredFields, $priceSetId);
6a488035
TO
612 }
613 else {
d1d16083 614 $priceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_event', $eventID);
1cb5e2d3 615 CRM_Price_BAO_PriceSet::initSet($form, 'civicrm_event', $includeExpiredFields, $priceSetId);
6a488035 616 }
8ef12e64 617
618 if (property_exists($form, '_context') && ($form->_context == 'standalone'
353ffa53
TO
619 || $form->_context == 'participant')
620 ) {
8567d0f8 621 $discountedEvent = CRM_Core_BAO_Discount::getOptionGroup($eventID, 'civicrm_event');
481a74f4 622 if (is_array($discountedEvent)) {
8567d0f8 623 foreach ($discountedEvent as $key => $priceSetId) {
9da8dc8c 624 $priceSet = CRM_Price_BAO_PriceSet::getSetDetail($priceSetId);
9c1bc317
CW
625 $priceSet = $priceSet[$priceSetId] ?? NULL;
626 $form->_values['discount'][$key] = $priceSet['fields'] ?? NULL;
8567d0f8
PN
627 $fieldID = key($form->_values['discount'][$key]);
628 $form->_values['discount'][$key][$fieldID]['name'] = CRM_Core_DAO::getFieldValue(
9da8dc8c 629 'CRM_Price_DAO_PriceSet',
8567d0f8
PN
630 $priceSetId,
631 'title'
632 );
633 }
634 }
635 }
9c1bc317 636 $eventFee = $form->_values['fee'] ?? NULL;
6a488035 637 if (!is_array($eventFee) || empty($eventFee)) {
affcc9d2 638 $form->_values['fee'] = [];
6a488035
TO
639 }
640
641 //fix for non-upgraded price sets.CRM-4256.
642 if (isset($form->_isPaidEvent)) {
643 $isPaidEvent = $form->_isPaidEvent;
644 }
645 else {
9c1bc317 646 $isPaidEvent = $form->_values['event']['is_monetary'] ?? NULL;
6a488035 647 }
a8b59c2c 648 if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
4323dc6c
PN
649 && !empty($form->_values['fee'])
650 ) {
b61d1bce 651 foreach ($form->_values['fee'] as $k => $fees) {
9ed3cd18
E
652 foreach ($fees['options'] as $options) {
653 if (!CRM_Core_Permission::check('add contributions of type ' . CRM_Contribute_PseudoConstant::financialType($options['financial_type_id']))) {
b61d1bce 654 unset($form->_values['fee'][$k]);
9ed3cd18
E
655 }
656 }
657 }
658 }
6a488035
TO
659 if ($isPaidEvent && empty($form->_values['fee'])) {
660 if (CRM_Utils_System::getClassName($form) != 'CRM_Event_Form_Participant') {
bc66279e 661 CRM_Core_Error::statusBounce(ts('No Fee Level(s) or Price Set is configured for this event.<br />Click <a href=\'%1\'>CiviEvent >> Manage Event >> Configure >> Event Fees</a> to configure the Fee Level(s) or Price Set for this event.', [1 => CRM_Utils_System::url('civicrm/event/manage/fee', 'reset=1&action=update&id=' . $form->_eventId)]));
6a488035
TO
662 }
663 }
664 }
665
666 /**
66f9e52b 667 * Handle process after the confirmation of payment by User.
6a488035 668 *
100fef9d 669 * @param int $contactID
d5ce773d 670 * @param \CRM_Contribute_BAO_Contribution $contribution
f55a8ac8
MWMC
671 *
672 * @throws \CiviCRM_API3_Exception
6a488035 673 */
d5ce773d 674 public function confirmPostProcess($contactID = NULL, $contribution = NULL) {
6a488035 675 // add/update contact information
6a488035
TO
676 unset($this->_params['note']);
677
678 //to avoid conflict overwrite $this->_params
679 $this->_params = $this->get('value');
680
681 //get the amount of primary participant
a7488080 682 if (!empty($this->_params['is_primary'])) {
6a488035
TO
683 $this->_params['fee_amount'] = $this->get('primaryParticipantAmount');
684 }
685
686 // add participant record
44237a29 687 $participant = $this->addParticipant($this, $contactID);
6a488035
TO
688 $this->_participantIDS[] = $participant->id;
689
690 //setting register_by_id field and primaryContactId
a7488080 691 if (!empty($this->_params['is_primary'])) {
6a488035
TO
692 $this->set('registerByID', $participant->id);
693 $this->set('primaryContactId', $contactID);
694
695 // CRM-10032
696 $this->processFirstParticipant($participant->id);
697 }
2fda3ece
SL
698
699 if (!empty($this->_params['is_primary'])) {
700 $this->_params['participantID'] = $participant->id;
701 $this->set('primaryParticipant', $this->_params);
702 }
6a488035
TO
703
704 CRM_Core_BAO_CustomValueTable::postProcess($this->_params,
6a488035
TO
705 'civicrm_participant',
706 $participant->id,
707 'Participant'
708 );
709
710 $createPayment = (CRM_Utils_Array::value('amount', $this->_params, 0) != 0) ? TRUE : FALSE;
711
712 // force to create zero amount payment, CRM-5095
713 // we know the amout is zero since createPayment is false
714 if (!$createPayment &&
715 (isset($contribution) && $contribution->id) &&
716 $this->_priceSetId &&
717 $this->_lineItem
718 ) {
719 $createPayment = TRUE;
720 }
721
8cc574cf 722 if ($createPayment && $this->_values['event']['is_monetary'] && !empty($this->_params['contributionID'])) {
f55a8ac8 723 $paymentParams = [
6a488035
TO
724 'participant_id' => $participant->id,
725 'contribution_id' => $contribution->id,
f55a8ac8
MWMC
726 ];
727 civicrm_api3('ParticipantPayment', 'create', $paymentParams);
6a488035
TO
728 }
729
6a488035
TO
730 $this->assign('action', $this->_action);
731
732 // create CMS user
a7488080 733 if (!empty($this->_params['cms_create_account'])) {
6a488035
TO
734 $this->_params['contactID'] = $contactID;
735
736 if (array_key_exists('email-5', $this->_params)) {
353ffa53 737 $mail = 'email-5';
0db6c3e1
TO
738 }
739 else {
6a488035
TO
740 foreach ($this->_params as $name => $dontCare) {
741 if (substr($name, 0, 5) == 'email') {
742 $mail = $name;
743 break;
744 }
745 }
746 }
747
748 // we should use primary email for
e13b1333 749 // 1. pay later participant.
750 // 2. waiting list participant.
751 // 3. require approval participant.
a7488080 752 if (!empty($this->_params['is_pay_later']) ||
e13b1333 753 $this->_allowWaitlist || $this->_requireApproval
353ffa53 754 ) {
6a488035
TO
755 $mail = 'email-Primary';
756 }
757
758 if (!CRM_Core_BAO_CMSUser::create($this->_params, $mail)) {
759 CRM_Core_Error::statusBounce(ts('Your profile is not saved and Account is not created.'));
760 }
761 }
762 }
763
764 /**
66f9e52b 765 * Process the participant.
6a488035 766 *
3ab5efa9 767 * @param CRM_Core_Form $form
100fef9d 768 * @param int $contactID
3bdf1f3a 769 *
3ab5efa9 770 * @return \CRM_Event_BAO_Participant
f55a8ac8 771 * @throws \CiviCRM_API3_Exception
6a488035 772 */
44237a29 773 protected function addParticipant(&$form, $contactID) {
bf2c70af 774 if (empty($form->_params)) {
7c550ca0 775 return NULL;
bf2c70af 776 }
44237a29 777 // Note this used to be shared with the backoffice form & no longer is, some code may no longer be required.
bf2c70af 778 $params = $form->_params;
6a488035
TO
779 $transaction = new CRM_Core_Transaction();
780
6a488035
TO
781 // handle register date CRM-4320
782 $registerDate = NULL;
bf2c70af 783 if (!empty($form->_allowConfirmation) && $form->_participantId) {
6a488035
TO
784 $registerDate = $params['participant_register_date'];
785 }
a7488080 786 elseif (!empty($params['participant_register_date']) &&
6a488035
TO
787 is_array($params['participant_register_date']) &&
788 !empty($params['participant_register_date'])
789 ) {
790 $registerDate = CRM_Utils_Date::format($params['participant_register_date']);
791 }
792
6441bcc8 793 $participantFields = CRM_Event_DAO_Participant::fields();
bc66279e 794 $participantParams = [
6b409353 795 'id' => $params['participant_id'] ?? NULL,
6a488035 796 'contact_id' => $contactID,
bf2c70af 797 'event_id' => $form->_eventId ? $form->_eventId : $params['event_id'],
6a488035
TO
798 'status_id' => CRM_Utils_Array::value('participant_status',
799 $params, 1
800 ),
fc076fe3 801 'role_id' => CRM_Utils_Array::value('participant_role_id', $params) ?: CRM_Event_BAO_Participant::getDefaultRoleID(),
6a488035 802 'register_date' => ($registerDate) ? $registerDate : date('YmdHis'),
6441bcc8 803 'source' => CRM_Utils_String::ellipsify(
7c550ca0 804 isset($params['participant_source']) ? CRM_Utils_Array::value('participant_source', $params) : CRM_Utils_Array::value('description', $params),
6441bcc8
NG
805 $participantFields['participant_source']['maxlength']
806 ),
6b409353 807 'fee_level' => $params['amount_level'] ?? NULL,
6a488035 808 'is_pay_later' => CRM_Utils_Array::value('is_pay_later', $params, 0),
6b409353
CW
809 'fee_amount' => $params['fee_amount'] ?? NULL,
810 'registered_by_id' => $params['registered_by_id'] ?? NULL,
811 'discount_id' => $params['discount_id'] ?? NULL,
812 'fee_currency' => $params['currencyID'] ?? NULL,
813 'campaign_id' => $params['campaign_id'] ?? NULL,
bc66279e 814 ];
6a488035 815
bf2c70af 816 if ($form->_action & CRM_Core_Action::PREVIEW || CRM_Utils_Array::value('mode', $params) == 'test') {
6a488035
TO
817 $participantParams['is_test'] = 1;
818 }
819 else {
820 $participantParams['is_test'] = 0;
821 }
822
bf2c70af 823 if (!empty($form->_params['note'])) {
824 $participantParams['note'] = $form->_params['note'];
6a488035 825 }
bf2c70af 826 elseif (!empty($form->_params['participant_note'])) {
827 $participantParams['note'] = $form->_params['participant_note'];
6a488035
TO
828 }
829
830 // reuse id if one already exists for this one (can happen
831 // with back button being hit etc)
8cc574cf 832 if (!$participantParams['id'] && !empty($params['contributionID'])) {
6a488035
TO
833 $pID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment',
834 $params['contributionID'],
835 'participant_id',
836 'contribution_id'
837 );
838 $participantParams['id'] = $pID;
839 }
bf2c70af 840 $participantParams['discount_id'] = CRM_Core_BAO_Discount::findSet($form->_eventId, 'civicrm_event');
6a488035
TO
841
842 if (!$participantParams['discount_id']) {
843 $participantParams['discount_id'] = "null";
844 }
845
846 $participant = CRM_Event_BAO_Participant::create($participantParams);
847
848 $transaction->commit();
849
850 return $participant;
851 }
852
0cf587a7 853 /**
3bdf1f3a 854 * Calculate the total participant count as per params.
855 *
c490a46a
CW
856 * @param CRM_Core_Form $form
857 * @param array $params
3bdf1f3a 858 * User params.
0cf587a7
EM
859 * @param bool $skipCurrent
860 *
3bdf1f3a 861 * @return int
0cf587a7 862 */
6a488035
TO
863 public static function getParticipantCount(&$form, $params, $skipCurrent = FALSE) {
864 $totalCount = 0;
865 if (!is_array($params) || empty($params)) {
866 return $totalCount;
867 }
868
353ffa53
TO
869 $priceSetId = $form->get('priceSetId');
870 $addParticipantNum = substr($form->_name, 12);
affcc9d2 871 $priceSetFields = $priceSetDetails = [];
6a488035
TO
872 $hasPriceFieldsCount = FALSE;
873 if ($priceSetId) {
874 $priceSetDetails = $form->get('priceSet');
875 if (isset($priceSetDetails['optionsCountTotal'])
876 && $priceSetDetails['optionsCountTotal']
877 ) {
878 $hasPriceFieldsCount = TRUE;
879 $priceSetFields = $priceSetDetails['optionsCountDetails']['fields'];
880 }
881 }
882
883 $singleFormParams = FALSE;
884 foreach ($params as $key => $val) {
885 if (!is_numeric($key)) {
886 $singleFormParams = TRUE;
887 break;
888 }
889 }
890
891 //first format the params.
892 if ($singleFormParams) {
893 $params = self::formatPriceSetParams($form, $params);
bc66279e 894 $params = [$params];
6a488035
TO
895 }
896
897 foreach ($params as $key => $values) {
898 if (!is_numeric($key) ||
899 $values == 'skip' ||
900 ($skipCurrent && ($addParticipantNum == $key))
901 ) {
902 continue;
903 }
904 $count = 1;
905
906 $usedCache = FALSE;
9c1bc317 907 $cacheCount = $form->_lineItemParticipantsCount[$key] ?? NULL;
6a488035
TO
908 if ($cacheCount && is_numeric($cacheCount)) {
909 $count = $cacheCount;
910 $usedCache = TRUE;
911 }
912
913 if (!$usedCache && $hasPriceFieldsCount) {
914 $count = 0;
915 foreach ($values as $valKey => $value) {
916 if (strpos($valKey, 'price_') === FALSE) {
917 continue;
918 }
919 $priceFieldId = substr($valKey, 6);
920 if (!$priceFieldId ||
921 !is_array($value) ||
922 !array_key_exists($priceFieldId, $priceSetFields)
923 ) {
924 continue;
925 }
926 foreach ($value as $optId => $optVal) {
927 $currentCount = $priceSetFields[$priceFieldId]['options'][$optId] * $optVal;
928 if ($currentCount) {
929 $count += $currentCount;
930 }
931 }
932 }
933 if (!$count) {
934 $count = 1;
935 }
936 }
937 $totalCount += $count;
938 }
939 if (!$totalCount) {
940 $totalCount = 1;
941 }
942
943 return $totalCount;
944 }
945
3bdf1f3a 946 /**
947 * Format user submitted price set params.
948 *
6a488035
TO
949 * Convert price set each param as an array.
950 *
3bdf1f3a 951 * @param CRM_Core_Form $form
5a4f6742 952 * @param array $params
d4dd1e85 953 * An array of user submitted params.
6a488035 954 *
a6c01b45 955 * @return array
3bdf1f3a 956 * Formatted price set params.
0cf587a7 957 */
6a488035
TO
958 public static function formatPriceSetParams(&$form, $params) {
959 if (!is_array($params) || empty($params)) {
960 return $params;
961 }
962
963 $priceSetId = $form->get('priceSetId');
964 if (!$priceSetId) {
965 return $params;
966 }
967 $priceSetDetails = $form->get('priceSet');
968
969 foreach ($params as $key => & $value) {
affcc9d2 970 $vals = [];
6a488035
TO
971 if (strpos($key, 'price_') !== FALSE) {
972 $fieldId = substr($key, 6);
973 if (!array_key_exists($fieldId, $priceSetDetails['fields']) ||
974 is_array($value) ||
975 !$value
976 ) {
977 continue;
978 }
979 $field = $priceSetDetails['fields'][$fieldId];
980 if ($field['html_type'] == 'Text') {
981 $fieldOption = current($field['options']);
bc66279e 982 $value = [$fieldOption['id'] => $value];
6a488035
TO
983 }
984 else {
bc66279e 985 $value = [$value => TRUE];
6a488035
TO
986 }
987 }
988 }
989
990 return $params;
991 }
992
3bdf1f3a 993 /**
994 * Calculate total count for each price set options.
6a488035 995 *
3bdf1f3a 996 * - currently selected by user.
6a488035 997 *
3bdf1f3a 998 * @param CRM_Core_Form $form
999 * Form object.
0cf587a7
EM
1000 *
1001 * @return array
3bdf1f3a 1002 * array of each option w/ count total.
0cf587a7 1003 */
169be3c1 1004 public static function getPriceSetOptionCount(&$form) {
353ffa53
TO
1005 $params = $form->get('params');
1006 $priceSet = $form->get('priceSet');
6a488035
TO
1007 $priceSetId = $form->get('priceSetId');
1008
affcc9d2 1009 $optionsCount = [];
6a488035
TO
1010 if (!$priceSetId ||
1011 !is_array($priceSet) ||
1012 empty($priceSet) ||
1013 !is_array($params) ||
1014 empty($params)
1015 ) {
1016 return $optionsCount;
1017 }
1018
affcc9d2 1019 $priceSetFields = $priceMaxFieldDetails = [];
a7488080 1020 if (!empty($priceSet['optionsCountTotal'])) {
6a488035
TO
1021 $priceSetFields = $priceSet['optionsCountDetails']['fields'];
1022 }
1023
a7488080 1024 if (!empty($priceSet['optionsMaxValueTotal'])) {
6a488035
TO
1025 $priceMaxFieldDetails = $priceSet['optionsMaxValueDetails']['fields'];
1026 }
1027
1028 $addParticipantNum = substr($form->_name, 12);
1029 foreach ($params as $pCnt => $values) {
1030 if ($values == 'skip' ||
79b152ac 1031 $pCnt === $addParticipantNum
6a488035
TO
1032 ) {
1033 continue;
1034 }
1035
1036 foreach ($values as $valKey => $value) {
1037 if (strpos($valKey, 'price_') === FALSE) {
1038 continue;
1039 }
1040
1041 $priceFieldId = substr($valKey, 6);
1042 if (!$priceFieldId ||
1043 !is_array($value) ||
1044 !(array_key_exists($priceFieldId, $priceSetFields) || array_key_exists($priceFieldId, $priceMaxFieldDetails))
1045 ) {
1046 continue;
1047 }
1048
1049 foreach ($value as $optId => $optVal) {
1050 if (CRM_Utils_Array::value('html_type', $priceSet['fields'][$priceFieldId]) == 'Text') {
1051 $currentCount = $optVal;
1052 }
1053 else {
1054 $currentCount = 1;
1055 }
1056
1057 if (isset($priceSetFields[$priceFieldId]) && isset($priceSetFields[$priceFieldId]['options'][$optId])) {
1058 $currentCount = $priceSetFields[$priceFieldId]['options'][$optId] * $optVal;
1059 }
1060
1061 $optionsCount[$optId] = $currentCount + CRM_Utils_Array::value($optId, $optionsCount, 0);
1062 }
1063 }
1064 }
1065
1066 return $optionsCount;
1067 }
1068
0cf587a7 1069 /**
3bdf1f3a 1070 * Check if template file exists.
1071 *
0cf587a7
EM
1072 * @param string $suffix
1073 *
1074 * @return null|string
1075 */
00be9182 1076 public function checkTemplateFileExists($suffix = '') {
6a488035
TO
1077 if ($this->_eventId) {
1078 $templateName = $this->_name;
1079 if (substr($templateName, 0, 12) == 'Participant_') {
1080 $templateName = 'AdditionalParticipant';
1081 }
1082
1083 $templateFile = "CRM/Event/Form/Registration/{$this->_eventId}/{$templateName}.{$suffix}tpl";
1084 $template = CRM_Core_Form::getTemplate();
1085 if ($template->template_exists($templateFile)) {
1086 return $templateFile;
1087 }
1088 }
1089 return NULL;
1090 }
1091
0cf587a7 1092 /**
3bdf1f3a 1093 * Get template file name.
1094 *
0cf587a7
EM
1095 * @return null|string
1096 */
00be9182 1097 public function getTemplateFileName() {
6a488035
TO
1098 $fileName = $this->checkTemplateFileExists();
1099 return $fileName ? $fileName : parent::getTemplateFileName();
1100 }
1101
0cf587a7 1102 /**
3bdf1f3a 1103 * Override extra template name.
1104 *
0cf587a7
EM
1105 * @return null|string
1106 */
00be9182 1107 public function overrideExtraTemplateFileName() {
6a488035
TO
1108 $fileName = $this->checkTemplateFileExists('extra.');
1109 return $fileName ? $fileName : parent::overrideExtraTemplateFileName();
1110 }
1111
0dc0b759 1112 /**
1113 * Reset values for all options those are full.
1114 *
780422d7 1115 * @param array $optionFullIds
3bdf1f3a 1116 * @param CRM_Core_Form $form
0dc0b759 1117 */
affcc9d2 1118 public static function resetElementValue($optionFullIds = [], &$form) {
0dc0b759 1119 if (!is_array($optionFullIds) ||
1120 empty($optionFullIds) ||
1121 !$form->isSubmitted()
1122 ) {
1123 return;
1124 }
1125
1126 foreach ($optionFullIds as $fldId => $optIds) {
1127 $name = "price_$fldId";
1128 if (!$form->elementExists($name)) {
1129 continue;
1130 }
1131
1132 $element = $form->getElement($name);
1133 $eleType = $element->getType();
1134
1135 $resetSubmitted = FALSE;
1136 switch ($eleType) {
1137 case 'text':
1138 if ($element->getValue() && $element->isFrozen()) {
1139 $label = "{$element->getLabel()}<tt>(x)</tt>";
1140 $element->setLabel($label);
1141 $element->setPersistantFreeze();
1142 $resetSubmitted = TRUE;
1143 }
1144 break;
1145
1146 case 'group':
1147 if (is_array($element->_elements)) {
1148 foreach ($element->_elements as $child) {
1149 $childType = $child->getType();
1150 $methodName = 'getName';
1151 if ($childType) {
1152 $methodName = 'getValue';
1153 }
1154 if (in_array($child->{$methodName}(), $optIds) && $child->isFrozen()) {
1155 $resetSubmitted = TRUE;
1156 $child->setPersistantFreeze();
1157 }
1158 }
1159 }
1160 break;
1161
1162 case 'select':
9d8d8fd0 1163 $value = $element->getValue();
1164 if (in_array($value[0], $optIds)) {
0dc0b759 1165 foreach ($element->_options as $option) {
d0ebccea 1166 if ($option['attr']['value'] === "crm_disabled_opt-{$value[0]}") {
2ae4d103 1167 $placeholder = html_entity_decode($option['text'], ENT_QUOTES, "UTF-8");
bc66279e 1168 $element->updateAttributes(['placeholder' => $placeholder]);
0dc0b759 1169 break;
1170 }
1171 }
1172 $resetSubmitted = TRUE;
1173 }
1174 break;
1175 }
1176
1177 //finally unset values from submitted.
1178 if ($resetSubmitted) {
1179 self::resetSubmittedValue($name, $optIds, $form);
1180 }
1181 }
1182 }
1183
1184 /**
3bdf1f3a 1185 * Reset submitted value.
1186 *
0dc0b759 1187 * @param string $elementName
1188 * @param array $optionIds
c91b34a5 1189 * @param CRM_Core_Form $form
0dc0b759 1190 */
affcc9d2 1191 public static function resetSubmittedValue($elementName, $optionIds = [], &$form) {
0dc0b759 1192 if (empty($elementName) ||
1193 !$form->elementExists($elementName) ||
1194 !$form->getSubmitValue($elementName)
1195 ) {
1196 return;
1197 }
bc66279e 1198 foreach (['constantValues', 'submitValues', 'defaultValues'] as $val) {
0dc0b759 1199 $values = $form->{"_$val"};
1200 if (!is_array($values) || empty($values)) {
1201 continue;
1202 }
9c1bc317 1203 $eleVal = $values[$elementName] ?? NULL;
0dc0b759 1204 if (empty($eleVal)) {
1205 continue;
1206 }
1207 if (is_array($eleVal)) {
1208 $found = FALSE;
1209 foreach ($eleVal as $keyId => $ignore) {
1210 if (in_array($keyId, $optionIds)) {
1211 $found = TRUE;
1212 unset($values[$elementName][$keyId]);
1213 }
1214 }
1215 if ($found && empty($values[$elementName][$keyId])) {
1216 $values[$elementName][$keyId] = NULL;
1217 }
1218 }
1219 else {
1220 if (!empty($keyId)) {
1221 $values[$elementName][$keyId] = NULL;
1222 }
1223 }
1224 }
1225 }
1226
da8d9879 1227 /**
3bdf1f3a 1228 * Validate price set submitted params for price option limit.
1229 *
1230 * User should select at least one price field option.
72b3a70c
CW
1231 *
1232 * @param CRM_Core_Form $form
1233 * @param array $params
1234 *
1235 * @return array
6a488035 1236 */
00be9182 1237 public static function validatePriceSet(&$form, $params) {
affcc9d2 1238 $errors = [];
6a488035
TO
1239 $hasOptMaxValue = FALSE;
1240 if (!is_array($params) || empty($params)) {
1241 return $errors;
1242 }
1243
1244 $currentParticipantNum = substr($form->_name, 12);
1245 if (!$currentParticipantNum) {
1246 $currentParticipantNum = 0;
1247 }
1248
1249 $priceSetId = $form->get('priceSetId');
1250 $priceSetDetails = $form->get('priceSet');
1251 if (
1252 !$priceSetId ||
1253 !is_array($priceSetDetails) ||
1254 empty($priceSetDetails)
1255 ) {
1256 return $errors;
1257 }
1258
affcc9d2 1259 $optionsCountDetails = $optionsMaxValueDetails = [];
6a488035
TO
1260 if (
1261 isset($priceSetDetails['optionsMaxValueTotal'])
1262 && $priceSetDetails['optionsMaxValueTotal']
1263 ) {
1264 $hasOptMaxValue = TRUE;
1265 $optionsMaxValueDetails = $priceSetDetails['optionsMaxValueDetails']['fields'];
1266 }
1267 if (
1268 isset($priceSetDetails['optionsCountTotal'])
1269 && $priceSetDetails['optionsCountTotal']
1270 ) {
1271 $hasOptCount = TRUE;
1272 $optionsCountDetails = $priceSetDetails['optionsCountDetails']['fields'];
1273 }
1274 $feeBlock = $form->_feeBlock;
1275
1276 if (empty($feeBlock)) {
1277 $feeBlock = $priceSetDetails['fields'];
1278 }
1279
affcc9d2 1280 $optionMaxValues = $fieldSelected = [];
6a488035
TO
1281 foreach ($params as $pNum => $values) {
1282 if (!is_array($values) || $values == 'skip') {
1283 continue;
1284 }
1285
1286 foreach ($values as $valKey => $value) {
1287 if (strpos($valKey, 'price_') === FALSE) {
1288 continue;
1289 }
1290 $priceFieldId = substr($valKey, 6);
1291 $noneOptionValueSelected = FALSE;
1292 if (!$feeBlock[$priceFieldId]['is_required'] && $value == 0) {
1293 $noneOptionValueSelected = TRUE;
1294 }
1295
1296 if (
1297 !$priceFieldId ||
1298 (!$noneOptionValueSelected && !is_array($value))
1299 ) {
1300 continue;
1301 }
1302
1303 $fieldSelected[$pNum] = TRUE;
1304
1305 if (!$hasOptMaxValue || !is_array($value)) {
1306 continue;
1307 }
1308
1309 foreach ($value as $optId => $optVal) {
1310 if (CRM_Utils_Array::value('html_type', $feeBlock[$priceFieldId]) == 'Text') {
1311 $currentMaxValue = $optVal;
1312 }
1313 else {
1314 $currentMaxValue = 1;
1315 }
1316
1317 if (isset($optionsCountDetails[$priceFieldId]) && isset($optionsCountDetails[$priceFieldId]['options'][$optId])) {
1318 $currentMaxValue = $optionsCountDetails[$priceFieldId]['options'][$optId] * $optVal;
1319 }
1320 if (empty($optionMaxValues)) {
1321 $optionMaxValues[$priceFieldId][$optId] = $currentMaxValue;
1322 }
1323 else {
7c550ca0
WA
1324 $optionMaxValues[$priceFieldId][$optId]
1325 = $currentMaxValue + CRM_Utils_Array::value($optId, CRM_Utils_Array::value($priceFieldId, $optionMaxValues), 0);
6a488035 1326 }
0dc0b759 1327 $soldOutPnum[$optId] = $pNum;
6a488035
TO
1328 }
1329 }
0dc0b759 1330
1331 //validate for price field selection.
db7f1024 1332 if (empty($fieldSelected[$pNum])) {
bc66279e 1333 $errors[$pNum]['_qf_default'] = ts('SELECT at least one OPTION FROM EVENT Fee(s).');
0dc0b759 1334 }
6a488035
TO
1335 }
1336
1337 //validate for option max value.
1338 foreach ($optionMaxValues as $fieldId => $values) {
affcc9d2 1339 $options = CRM_Utils_Array::value('options', $feeBlock[$fieldId], []);
6a488035
TO
1340 foreach ($values as $optId => $total) {
1341 $optMax = $optionsMaxValueDetails[$fieldId]['options'][$optId];
1342 $opDbCount = CRM_Utils_Array::value('db_total_count', $options[$optId], 0);
1343 $total += $opDbCount;
0dc0b759 1344 if ($optMax && ($total > $optMax)) {
6a488035 1345 if ($opDbCount && ($opDbCount >= $optMax)) {
0dc0b759 1346 $errors[$soldOutPnum[$optId]]["price_{$fieldId}"]
7c550ca0 1347 = ts('Sorry, this option is currently sold out.');
6a488035
TO
1348 }
1349 elseif (($optMax - $opDbCount) == 1) {
0dc0b759 1350 $errors[$soldOutPnum[$optId]]["price_{$fieldId}"]
bc66279e 1351 = ts('Sorry, currently only a single space is available for this option.', [1 => ($optMax - $opDbCount)]);
6a488035
TO
1352 }
1353 else {
0dc0b759 1354 $errors[$soldOutPnum[$optId]]["price_{$fieldId}"]
bc66279e 1355 = ts('Sorry, currently only %1 spaces are available for this option.', [1 => ($optMax - $opDbCount)]);
6a488035
TO
1356 }
1357 }
1358 }
1359 }
6a488035
TO
1360 return $errors;
1361 }
1362
0cf587a7 1363 /**
3bdf1f3a 1364 * Set the first participant ID if not set.
1365 *
1366 * CRM-10032.
72b3a70c 1367 *
100fef9d 1368 * @param int $participantID
0cf587a7 1369 */
00be9182 1370 public function processFirstParticipant($participantID) {
6a488035
TO
1371 $this->_participantId = $participantID;
1372 $this->set('participantId', $this->_participantId);
1373
affcc9d2 1374 $ids = $participantValues = [];
bc66279e 1375 $participantParams = ['id' => $this->_participantId];
6a488035
TO
1376 CRM_Event_BAO_Participant::getValues($participantParams, $participantValues, $ids);
1377 $this->_values['participant'] = $participantValues[$this->_participantId];
1378 $this->set('values', $this->_values);
1379
1380 // also set the allow confirmation stuff
1381 if (array_key_exists(
353ffa53
TO
1382 $this->_values['participant']['status_id'],
1383 CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Pending'")
1384 )) {
6a488035
TO
1385 $this->_allowConfirmation = TRUE;
1386 $this->set('allowConfirmation', TRUE);
1387 }
1388 }
1389
e2d09ab4 1390 /**
3bdf1f3a 1391 * Check if event is valid.
1392 *
bc66279e 1393 * @param string $redirect
1394 *
e2d09ab4
EM
1395 * @todo - combine this with CRM_Event_BAO_Event::validRegistrationRequest
1396 * (probably extract relevant values here & call that with them & handle bounces & redirects here -as
1397 * those belong in the form layer)
1398 *
e2d09ab4 1399 */
00be9182 1400 public function checkValidEvent($redirect = NULL) {
6a488035
TO
1401 // is the event active (enabled)?
1402 if (!$this->_values['event']['is_active']) {
1403 // form is inactive, die a fatal death
1404 CRM_Core_Error::statusBounce(ts('The event you requested is currently unavailable (contact the site administrator for assistance).'));
1405 }
1406
1407 // is online registration is enabled?
1408 if (!$this->_values['event']['is_online_registration']) {
1409 CRM_Core_Error::statusBounce(ts('Online registration is not currently available for this event (contact the site administrator for assistance).'), $redirect);
1410 }
1411
1412 // is this an event template ?
a7488080 1413 if (!empty($this->_values['event']['is_template'])) {
6a488035
TO
1414 CRM_Core_Error::statusBounce(ts('Event templates are not meant to be registered.'), $redirect);
1415 }
1416
1417 $now = date('YmdHis');
1418 $startDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('registration_start_date',
353ffa53
TO
1419 $this->_values['event']
1420 ));
6a488035
TO
1421
1422 if (
1423 $startDate &&
1424 $startDate >= $now
1425 ) {
bc66279e 1426 CRM_Core_Error::statusBounce(ts('Registration for this event begins on %1', [1 => CRM_Utils_Date::customFormat(CRM_Utils_Array::value('registration_start_date', $this->_values['event']))]), $redirect, ts('Sorry'));
6a488035
TO
1427 }
1428
ce5694b5 1429 $regEndDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('registration_end_date',
353ffa53
TO
1430 $this->_values['event']
1431 ));
4bd9b7a9 1432 $eventEndDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('event_end_date', $this->_values['event']));
b612d89b 1433 if (($regEndDate && ($regEndDate < $now)) || (empty($regEndDate) && !empty($eventEndDate) && ($eventEndDate < $now))) {
ce5694b5 1434 $endDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('registration_end_date', $this->_values['event']));
1435 if (empty($regEndDate)) {
1436 $endDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('event_end_date', $this->_values['event']));
1437 }
bc66279e 1438 CRM_Core_Error::statusBounce(ts('Registration for this event ended on %1', [1 => $endDate]), $redirect, ts('Sorry'));
6a488035
TO
1439 }
1440 }
96025800 1441
c039f658 1442 /**
1443 * Get the amount level for the event payment.
1444 *
1445 * The amount level is the string stored on the contribution record that describes the purchase.
1446 *
1447 * @param array $params
1448 * @param int|null $discountID
1449 *
1450 * @return string
1451 */
1452 protected function getAmountLevel($params, $discountID) {
1453 // @todo move handling of discount ID to the BAO function - preferably by converting it to a price_set with
1454 // time settings.
1455 if (!empty($this->_values['discount'][$discountID])) {
1456 return $this->_values['discount'][$discountID][$params['amount']]['label'];
1457 }
e173279c 1458 if (empty($params['priceSetId'])) {
1459 // CRM-17509 An example of this is where the person is being waitlisted & there is no payment.
1460 // ideally we would have calculated amount first & only call this is there is an
1461 // amount but the flow needs more changes for that.
1462 return '';
1463 }
c039f658 1464 return CRM_Price_BAO_PriceSet::getAmountLevelText($params);
1465 }
1466
3033e657 1467 /**
1468 * Process Registration of free event.
1469 *
1470 * @param array $params
1471 * Form values.
1472 * @param int $contactID
d7ade6fe 1473 *
1474 * @throws \CiviCRM_API3_Exception
3033e657 1475 */
1476 public function processRegistration($params, $contactID = NULL) {
1477 $session = CRM_Core_Session::singleton();
affcc9d2 1478 $this->_participantInfo = [];
3033e657 1479
1480 // CRM-4320, lets build array of cancelled additional participant ids
1481 // those are drop or skip by primary at the time of confirmation.
1482 // get all in and then unset those are confirmed.
1483 $cancelledIds = $this->_additionalParticipantIds;
1484
affcc9d2 1485 $participantCount = [];
3033e657 1486 foreach ($params as $participantNum => $record) {
1487 if ($record == 'skip') {
1488 $participantCount[$participantNum] = 'skip';
1489 }
1490 elseif ($participantNum) {
1491 $participantCount[$participantNum] = 'participant';
1492 }
1493 }
1494
1495 $registerByID = NULL;
1496 foreach ($params as $key => $value) {
1497 if ($value != 'skip') {
1498 $fields = NULL;
1499
1500 // setting register by Id and unset contactId.
1501 if (empty($value['is_primary'])) {
1502 $contactID = NULL;
1503 $registerByID = $this->get('registerByID');
1504 if ($registerByID) {
1505 $value['registered_by_id'] = $registerByID;
1506 }
1507 // get an email if one exists for the participant
1508 $participantEmail = '';
1509 foreach (array_keys($value) as $valueName) {
1510 if (substr($valueName, 0, 6) == 'email-') {
1511 $participantEmail = $value[$valueName];
1512 }
1513 }
1514 if ($participantEmail) {
1515 $this->_participantInfo[] = $participantEmail;
1516 }
1517 else {
1518 $this->_participantInfo[] = $value['first_name'] . ' ' . $value['last_name'];
1519 }
1520 }
1521 elseif (!empty($value['contact_id'])) {
1522 $contactID = $value['contact_id'];
1523 }
1524 else {
1525 $contactID = $this->getContactID();
1526 }
1527
1528 CRM_Event_Form_Registration_Confirm::fixLocationFields($value, $fields, $this);
1529 //for free event or additional participant, dont create billing email address.
1530 if (empty($value['is_primary']) || !$this->_values['event']['is_monetary']) {
1531 unset($value["email-{$this->_bltID}"]);
1532 }
1533
1534 $contactID = CRM_Event_Form_Registration_Confirm::updateContactFields($contactID, $value, $fields, $this);
1535
1536 // lets store the contactID in the session
1537 // we dont store in userID in case the user is doing multiple
1538 // transactions etc
1539 // for things like tell a friend
1540 if (!$this->getContactID() && !empty($value['is_primary'])) {
1541 $session->set('transaction.userID', $contactID);
1542 }
1543
1544 //lets get the status if require approval or waiting.
1545
1546 $waitingStatuses = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Waiting'");
1547 if ($this->_allowWaitlist && !$this->_allowConfirmation) {
1548 $value['participant_status_id'] = $value['participant_status'] = array_search('On waitlist', $waitingStatuses);
1549 }
1550 elseif ($this->_requireApproval && !$this->_allowConfirmation) {
1551 $value['participant_status_id'] = $value['participant_status'] = array_search('Awaiting approval', $waitingStatuses);
1552 }
1553
1554 $this->set('value', $value);
d5ce773d 1555 $this->confirmPostProcess($contactID, NULL);
3033e657 1556
1557 //lets get additional participant id to cancel.
1558 if ($this->_allowConfirmation && is_array($cancelledIds)) {
9c1bc317 1559 $additonalId = $value['participant_id'] ?? NULL;
3033e657 1560 if ($additonalId && $key = array_search($additonalId, $cancelledIds)) {
1561 unset($cancelledIds[$key]);
1562 }
1563 }
1564 }
1565 }
1566
1567 // update status and send mail to cancelled additional participants, CRM-4320
1568 if ($this->_allowConfirmation && is_array($cancelledIds) && !empty($cancelledIds)) {
1569 $cancelledId = array_search('Cancelled',
1570 CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Negative'")
1571 );
1572 CRM_Event_BAO_Participant::transitionParticipants($cancelledIds, $cancelledId);
1573 }
1574
1575 //set information about additional participants if exists
1576 if (count($this->_participantInfo)) {
1577 $this->set('participantInfo', $this->_participantInfo);
1578 }
1579
1580 //send mail Confirmation/Receipt
1581 if ($this->_contributeMode != 'checkout' ||
1582 $this->_contributeMode != 'notify'
1583 ) {
d7ade6fe 1584 $this->sendMails($params, $registerByID, $participantCount);
1585 }
1586 }
3033e657 1587
d7ade6fe 1588 /**
1589 * Send Mail to participants.
1590 *
1591 * @param $params
1592 * @param $registerByID
1593 * @param array $participantCount
1594 *
1595 * @throws \CiviCRM_API3_Exception
1596 */
1597 private function sendMails($params, $registerByID, array $participantCount) {
1598 $isTest = FALSE;
1599 if ($this->_action & CRM_Core_Action::PREVIEW) {
1600 $isTest = TRUE;
1601 }
3033e657 1602
d7ade6fe 1603 //handle if no additional participant.
1604 if (!$registerByID) {
1605 $registerByID = $this->get('registerByID');
1606 }
1607 $primaryContactId = $this->get('primaryContactId');
3033e657 1608
d7ade6fe 1609 //build an array of custom profile and assigning it to template.
1610 $additionalIDs = CRM_Event_BAO_Event::buildCustomProfile($registerByID, NULL,
1611 $primaryContactId, $isTest, TRUE
1612 );
3033e657 1613
d7ade6fe 1614 //lets carry all participant params w/ values.
1615 foreach ($additionalIDs as $participantID => $contactId) {
1616 $participantNum = NULL;
1617 if ($participantID == $registerByID) {
1618 $participantNum = 0;
1619 }
1620 else {
1621 if ($participantNum = array_search('participant', $participantCount)) {
1622 unset($participantCount[$participantNum]);
3033e657 1623 }
d7ade6fe 1624 }
3033e657 1625
d7ade6fe 1626 if ($participantNum === NULL) {
1627 break;
3033e657 1628 }
1629
d7ade6fe 1630 //carry the participant submitted values.
1631 $this->_values['params'][$participantID] = $params[$participantNum];
1632 }
1633
1634 //lets send mails to all with meanigful text, CRM-4320.
1635 $this->assign('isOnWaitlist', $this->_allowWaitlist);
1636 $this->assign('isRequireApproval', $this->_requireApproval);
3033e657 1637
d7ade6fe 1638 foreach ($additionalIDs as $participantID => $contactId) {
1639 if ($participantID == $registerByID) {
1640 //set as Primary Participant
1641 $this->assign('isPrimary', 1);
3033e657 1642
d7ade6fe 1643 $customProfile = CRM_Event_BAO_Event::buildCustomProfile($participantID, $this->_values, NULL, $isTest);
3033e657 1644
d7ade6fe 1645 if (count($customProfile)) {
1646 $this->assign('customProfile', $customProfile);
1647 $this->set('customProfile', $customProfile);
3033e657 1648 }
3033e657 1649 }
d7ade6fe 1650 else {
1651 $this->assign('isPrimary', 0);
1652 $this->assign('customProfile', NULL);
1653 }
1654
1655 //send Confirmation mail to Primary & additional Participants if exists
1656 CRM_Event_BAO_Event::sendMail($contactId, $this->_values, $participantID, $isTest);
3033e657 1657 }
1658 }
1659
6a488035 1660}