Merge pull request #14322 from AlainBenbassat/5.14
[civicrm-core.git] / CRM / Event / Form / Participant.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26 */
27
28 /**
29 *
30 *
31 * @package CRM
32 * @copyright CiviCRM LLC (c) 2004-2019
33 * $Id$
34 *
35 */
36
37 /**
38 * This class generates form components for processing a participation
39 * in an event
40 */
41 class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment {
42
43 public $useLivePageJS = TRUE;
44
45 /**
46 * The values for the contribution db object.
47 *
48 * @var array
49 */
50 public $_values;
51
52 /**
53 * The values for the quickconfig for priceset.
54 *
55 * @var boolean
56 */
57 public $_quickConfig = NULL;
58
59 /**
60 * Price Set ID, if the new price set method is used
61 *
62 * @var int
63 */
64 public $_priceSetId;
65
66 /**
67 * Array of fields for the price set.
68 *
69 * @var array
70 */
71 public $_priceSet;
72
73 /**
74 * The id of the participation that we are processing.
75 *
76 * @var int
77 */
78 public $_id;
79
80 /**
81 * The id of the note.
82 *
83 * @var int
84 */
85 protected $_noteId = NULL;
86
87 /**
88 *
89 * Use parent $this->contactID
90 *
91 * The id of the contact associated with this participation.
92 *
93 * @var int
94 * @deprecated
95 */
96 public $_contactId;
97
98 /**
99 * Array of event values.
100 *
101 * @var array
102 */
103 protected $_event;
104
105 /**
106 * Are we operating in "single mode", i.e. adding / editing only
107 * one participant record, or is this a batch add operation
108 *
109 * @var boolean
110 */
111 public $_single = FALSE;
112
113 /**
114 * If event is paid or unpaid.
115 * @var bool
116 */
117 public $_isPaidEvent;
118
119 /**
120 * Page action.
121 * @var int
122 */
123 public $_action;
124
125 /**
126 * Role Id.
127 * @var int
128 */
129 protected $_roleId = NULL;
130
131 /**
132 * Event Type Id.
133 * @var int
134 */
135 protected $_eventTypeId = NULL;
136
137 /**
138 * Participant status Id.
139 * @var int
140 */
141 protected $_statusId = NULL;
142
143 /**
144 * Cache all the participant statuses.
145 * @var array
146 */
147 protected $_participantStatuses;
148
149 /**
150 * Participant mode.
151 * @var string
152 */
153 public $_mode = NULL;
154
155 /**
156 * Event ID preselect.
157 * @var int
158 */
159 public $_eID = NULL;
160
161 /**
162 * Line Item for Price Set.
163 * @var array
164 */
165 public $_lineItem = NULL;
166
167 /**
168 * Contribution mode for event registration for offline mode.
169 * @var string
170 * @deprecated
171 */
172 public $_contributeMode = 'direct';
173
174 public $_online;
175
176 /**
177 * Store id of role custom data type ( option value )
178 * @var int
179 */
180 protected $_roleCustomDataTypeID;
181
182 /**
183 * Store id of event Name custom data type ( option value)
184 * @var int
185 */
186 protected $_eventNameCustomDataTypeID;
187
188 /**
189 * Selected discount id.
190 * @var int
191 */
192 public $_originalDiscountId = NULL;
193
194 /**
195 * Event id.
196 * @var int
197 */
198 public $_eventId = NULL;
199
200 /**
201 * Id of payment, if any
202 * @var int
203 */
204 public $_paymentId = NULL;
205
206 /**
207 * @var null
208 * @todo add explanatory note about this
209 */
210 public $_onlinePendingContributionId = NULL;
211
212 /**
213 * Explicitly declare the entity api name.
214 */
215 public function getDefaultEntity() {
216 return 'Participant';
217 }
218
219 /**
220 * Default form context used as part of addField()
221 */
222 public function getDefaultContext() {
223 return 'create';
224 }
225
226 /**
227 * Set variables up before form is built.
228 *
229 * @return void
230 * @throws \CRM_Core_Exception
231 */
232 public function preProcess() {
233 parent::preProcess();
234 $this->_showFeeBlock = CRM_Utils_Array::value('eventId', $_GET);
235 $this->assign('showFeeBlock', FALSE);
236 $this->assign('feeBlockPaid', FALSE);
237
238 // @todo eliminate this duplication.
239 $this->_contactId = $this->_contactID;
240 $this->_eID = CRM_Utils_Request::retrieve('eid', 'Positive', $this);
241 $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
242 $this->assign('context', $this->_context);
243
244 if ($this->_contactID) {
245 $this->setPageTitle(ts('Event Registration for %1', [1 => $this->userDisplayName]));
246 }
247 else {
248 $this->setPageTitle(ts('Event Registration'));
249 }
250
251 // check the current path, if search based, then dont get participantID
252 // CRM-5792
253 $path = CRM_Utils_System::currentPath();
254 if (
255 strpos($path, 'civicrm/contact/search') === 0 ||
256 strpos($path, 'civicrm/group/search') === 0
257 ) {
258 $this->_id = NULL;
259 }
260 else {
261 $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
262 }
263
264 if ($this->_id) {
265 $this->assign('participantId', $this->_id);
266
267 $this->_paymentId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment',
268 $this->_id, 'id', 'participant_id'
269 );
270
271 $this->assign('hasPayment', $this->_paymentId);
272 $this->assign('componentId', $this->_id);
273 $this->assign('component', 'event');
274
275 // CRM-12615 - Get payment information from the primary registration
276 if ((!$this->_paymentId) && ($this->_action == CRM_Core_Action::UPDATE)) {
277 $registered_by_id = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant',
278 $this->_id, 'registered_by_id', 'id'
279 );
280 if ($registered_by_id) {
281 $this->_paymentId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment',
282 $registered_by_id, 'id', 'participant_id'
283 );
284 $this->assign('registeredByParticipantId', $registered_by_id);
285 }
286 }
287 }
288 $this->setCustomDataTypes();
289
290 if ($this->_mode) {
291 $this->assign('participantMode', $this->_mode);
292 }
293
294 if ($this->_showFeeBlock) {
295 $this->assign('showFeeBlock', TRUE);
296 $isMonetary = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $this->_showFeeBlock, 'is_monetary');
297 if ($isMonetary) {
298 $this->assign('feeBlockPaid', TRUE);
299 }
300 return CRM_Event_Form_EventFees::preProcess($this);
301 }
302
303 //check the mode when this form is called either single or as
304 //search task action
305 if ($this->_id || $this->_contactId || $this->_context == 'standalone') {
306 $this->_single = TRUE;
307 $this->assign('urlPath', 'civicrm/contact/view/participant');
308 if (!$this->_id && !$this->_contactId) {
309 $breadCrumbs = [
310 [
311 'title' => ts('CiviEvent Dashboard'),
312 'url' => CRM_Utils_System::url('civicrm/event', 'reset=1'),
313 ],
314 ];
315
316 CRM_Utils_System::appendBreadCrumb($breadCrumbs);
317 }
318 }
319 else {
320 //set the appropriate action
321 $context = $this->get('context');
322 $urlString = 'civicrm/contact/search';
323 $this->_action = CRM_Core_Action::BASIC;
324 switch ($context) {
325 case 'advanced':
326 $urlString = 'civicrm/contact/search/advanced';
327 $this->_action = CRM_Core_Action::ADVANCED;
328 break;
329
330 case 'builder':
331 $urlString = 'civicrm/contact/search/builder';
332 $this->_action = CRM_Core_Action::PROFILE;
333 break;
334
335 case 'basic':
336 $urlString = 'civicrm/contact/search/basic';
337 $this->_action = CRM_Core_Action::BASIC;
338 break;
339
340 case 'custom':
341 $urlString = 'civicrm/contact/search/custom';
342 $this->_action = CRM_Core_Action::COPY;
343 break;
344 }
345 CRM_Contact_Form_Task::preProcessCommon($this);
346
347 $this->_single = FALSE;
348 $this->_contactId = NULL;
349
350 //set ajax path, this used for custom data building
351 $this->assign('urlPath', $urlString);
352 $this->assign('urlPathVar', "_qf_Participant_display=true&qfKey={$this->controller->_key}");
353 }
354
355 $this->assign('single', $this->_single);
356
357 if (!$this->_id) {
358 $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
359 }
360 $this->assign('action', $this->_action);
361
362 // check for edit permission
363 if (!CRM_Core_Permission::checkActionPermission('CiviEvent', $this->_action)) {
364 CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
365 }
366
367 if ($this->_action & CRM_Core_Action::DELETE) {
368 // check delete permission for contribution
369 if ($this->_id && $this->_paymentId && !CRM_Core_Permission::checkActionPermission('CiviContribute', $this->_action)) {
370 CRM_Core_Error::fatal(ts("This Participant is linked to a contribution. You must have 'delete in CiviContribute' permission in order to delete this record."));
371 }
372 return;
373 }
374
375 if ($this->_id) {
376 // assign participant id to the template
377 $this->assign('participantId', $this->_id);
378 $this->_roleId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'role_id');
379 }
380
381 // when fee amount is included in form
382 if (!empty($_POST['hidden_feeblock']) || !empty($_POST['send_receipt'])) {
383 CRM_Event_Form_EventFees::preProcess($this);
384 CRM_Event_Form_EventFees::buildQuickForm($this);
385 CRM_Event_Form_EventFees::setDefaultValues($this);
386 }
387
388 // when custom data is included in this page
389 if (!empty($_POST['hidden_custom'])) {
390 $eventId = (int) CRM_Utils_Array::value('event_id', $_POST);
391 // Custom data of type participant role
392 // Note: Some earlier commits imply $_POST['role_id'] could be a comma separated string,
393 // not sure if that ever really happens
394 if (!empty($_POST['role_id'])) {
395 foreach ($_POST['role_id'] as $roleID) {
396 CRM_Custom_Form_CustomData::preProcess($this, $this->_roleCustomDataTypeID, $roleID, 1, 'Participant', $this->_id);
397 CRM_Custom_Form_CustomData::buildQuickForm($this);
398 CRM_Custom_Form_CustomData::setDefaultValues($this);
399 }
400 }
401
402 //custom data of type participant event
403 CRM_Custom_Form_CustomData::preProcess($this, $this->_eventNameCustomDataTypeID, $eventId, 1, 'Participant', $this->_id);
404 CRM_Custom_Form_CustomData::buildQuickForm($this);
405 CRM_Custom_Form_CustomData::setDefaultValues($this);
406
407 // custom data of type participant event type
408 $eventTypeId = NULL;
409 if ($eventId) {
410 $eventTypeId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $eventId, 'event_type_id', 'id');
411 }
412 CRM_Custom_Form_CustomData::preProcess($this, $this->_eventTypeCustomDataTypeID, $eventTypeId,
413 1, 'Participant', $this->_id
414 );
415 CRM_Custom_Form_CustomData::buildQuickForm($this);
416 CRM_Custom_Form_CustomData::setDefaultValues($this);
417
418 //custom data of type participant, ( we 'null' to reset subType and subName)
419 CRM_Custom_Form_CustomData::preProcess($this, 'null', 'null', 1, 'Participant', $this->_id);
420 CRM_Custom_Form_CustomData::buildQuickForm($this);
421 CRM_Custom_Form_CustomData::setDefaultValues($this);
422 }
423
424 // CRM-4395, get the online pending contribution id.
425 $this->_onlinePendingContributionId = NULL;
426 if (!$this->_mode && $this->_id && ($this->_action & CRM_Core_Action::UPDATE)) {
427 $this->_onlinePendingContributionId = CRM_Contribute_BAO_Contribution::checkOnlinePendingContribution($this->_id,
428 'Event'
429 );
430 }
431 $this->set('onlinePendingContributionId', $this->_onlinePendingContributionId);
432 }
433
434 /**
435 * This function sets the default values for the form in edit/view mode
436 * the default values are retrieved from the database
437 *
438 * @return array
439 * @throws \CRM_Core_Exception
440 */
441 public function setDefaultValues() {
442 if ($this->_showFeeBlock) {
443 return CRM_Event_Form_EventFees::setDefaultValues($this);
444 }
445
446 $defaults = [];
447
448 if ($this->_action & CRM_Core_Action::DELETE) {
449 return $defaults;
450 }
451
452 if ($this->_id) {
453 $ids = [];
454 $params = ['id' => $this->_id];
455
456 CRM_Event_BAO_Participant::getValues($params, $defaults, $ids);
457 $sep = CRM_Core_DAO::VALUE_SEPARATOR;
458 if ($defaults[$this->_id]['role_id']) {
459 $roleIDs = explode($sep, $defaults[$this->_id]['role_id']);
460 }
461 $this->_contactId = $defaults[$this->_id]['contact_id'];
462 $this->_statusId = $defaults[$this->_id]['participant_status_id'];
463
464 //set defaults for note
465 $noteDetails = CRM_Core_BAO_Note::getNote($this->_id, 'civicrm_participant');
466 $defaults[$this->_id]['note'] = array_pop($noteDetails);
467
468 // Check if this is a primaryParticipant (registered for others) and retrieve additional participants if true (CRM-4859)
469 if (CRM_Event_BAO_Participant::isPrimaryParticipant($this->_id)) {
470 $this->assign('additionalParticipants', CRM_Event_BAO_Participant::getAdditionalParticipants($this->_id));
471 }
472
473 // Get registered_by contact ID and display_name if participant was registered by someone else (CRM-4859)
474 if (!empty($defaults[$this->_id]['participant_registered_by_id'])) {
475 $registered_by_contact_id = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant',
476 $defaults[$this->_id]['participant_registered_by_id'],
477 'contact_id', 'id'
478 );
479 $this->assign('participant_registered_by_id', $defaults[$this->_id]['participant_registered_by_id']);
480 $this->assign('registered_by_contact_id', $registered_by_contact_id);
481 $this->assign('registered_by_display_name', CRM_Contact_BAO_Contact::displayName($registered_by_contact_id));
482 }
483 }
484
485 //setting default register date
486 if ($this->_action == CRM_Core_Action::ADD) {
487 $statuses = array_flip(CRM_Event_PseudoConstant::participantStatus());
488 $defaults[$this->_id]['status_id'] = CRM_Utils_Array::value('Registered', $statuses);
489 if (!empty($defaults[$this->_id]['event_id'])) {
490 $contributionTypeId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event',
491 $defaults[$this->_id]['event_id'],
492 'financial_type_id'
493 );
494 if ($contributionTypeId) {
495 $defaults[$this->_id]['financial_type_id'] = $contributionTypeId;
496 }
497 }
498
499 if ($this->_mode) {
500 $fields["email-{$this->_bltID}"] = 1;
501 $fields['email-Primary'] = 1;
502
503 if ($this->_contactId) {
504 CRM_Core_BAO_UFGroup::setProfileDefaults($this->_contactId, $fields, $defaults);
505 }
506
507 if (empty($defaults["email-{$this->_bltID}"]) &&
508 !empty($defaults['email-Primary'])
509 ) {
510 $defaults[$this->_id]["email-{$this->_bltID}"] = $defaults['email-Primary'];
511 }
512 }
513
514 $submittedRole = $this->getElementValue('role_id');
515 if (!empty($submittedRole[0])) {
516 $roleID = $submittedRole[0];
517 }
518 $submittedEvent = $this->getElementValue('event_id');
519 if (!empty($submittedEvent[0])) {
520 $eventID = $submittedEvent[0];
521 }
522 $defaults[$this->_id]['register_date'] = date('Y-m-d H:i:s');
523 }
524 else {
525 $defaults[$this->_id]['record_contribution'] = 0;
526
527 if ($defaults[$this->_id]['participant_is_pay_later']) {
528 $this->assign('participant_is_pay_later', TRUE);
529 }
530
531 $this->assign('participant_status_id', $defaults[$this->_id]['participant_status_id']);
532 $eventID = $defaults[$this->_id]['event_id'];
533
534 $this->_eventTypeId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $eventID, 'event_type_id', 'id');
535
536 $this->_discountId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'discount_id');
537 if ($this->_discountId) {
538 $this->set('discountId', $this->_discountId);
539 }
540 }
541
542 //assign event and role id, this is needed for Custom data building
543 $sep = CRM_Core_DAO::VALUE_SEPARATOR;
544 if (!empty($defaults[$this->_id]['participant_role_id'])) {
545 $roleIDs = explode($sep, $defaults[$this->_id]['participant_role_id']);
546 }
547 if (isset($_POST['event_id'])) {
548 $eventID = $_POST['event_id'];
549 }
550
551 if ($this->_eID) {
552 $eventID = $this->_eID;
553 //@todo - rationalise the $this->_eID with $POST['event_id'], $this->_eid is set when eid=x is in the url
554 $roleID = CRM_Core_DAO::getFieldValue(
555 'CRM_Event_DAO_Event',
556 $this->_eID,
557 'default_role_id'
558 );
559 if (empty($roleIDs)) {
560 $roleIDs = (array) $defaults[$this->_id]['participant_role_id'] = $roleID;
561 }
562 $defaults[$this->_id]['event_id'] = $eventID;
563 }
564 if (!empty($eventID)) {
565 $this->_eventTypeId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $eventID, 'event_type_id', 'id');
566 }
567 //these should take precedence so we state them last
568 $urlRoleIDS = CRM_Utils_Request::retrieve('roles', 'String');
569 if ($urlRoleIDS) {
570 $roleIDs = explode(',', $urlRoleIDS);
571 }
572 if (isset($roleIDs)) {
573 $defaults[$this->_id]['role_id'] = implode(',', $roleIDs);
574 }
575
576 if (isset($eventID)) {
577 $this->assign('eventID', $eventID);
578 $this->set('eventId', $eventID);
579 }
580
581 if (isset($this->_eventTypeId)) {
582 $this->assign('eventTypeID', $this->_eventTypeId);
583 }
584
585 $this->assign('event_is_test', CRM_Utils_Array::value('event_is_test', $defaults[$this->_id]));
586 return $defaults[$this->_id];
587 }
588
589 /**
590 * Build the form object.
591 *
592 * @return void
593 * @throws \CRM_Core_Exception
594 * @throws \CiviCRM_API3_Exception
595 */
596 public function buildQuickForm() {
597 $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
598 $partiallyPaidStatusId = array_search('Partially paid', $participantStatuses);
599 $this->assign('partiallyPaidStatusId', $partiallyPaidStatusId);
600
601 if ($this->_showFeeBlock) {
602 return CRM_Event_Form_EventFees::buildQuickForm($this);
603 }
604
605 //need to assign custom data type to the template
606 $this->assign('customDataType', 'Participant');
607
608 $this->applyFilter('__ALL__', 'trim');
609
610 if ($this->_action & CRM_Core_Action::DELETE) {
611 if ($this->_single) {
612 $additionalParticipant = count(CRM_Event_BAO_Event::buildCustomProfile($this->_id,
613 NULL,
614 $this->_contactId,
615 FALSE,
616 TRUE
617 )) - 1;
618 if ($additionalParticipant) {
619 $deleteParticipants = [
620 1 => ts('Delete this participant record along with associated participant record(s).'),
621 2 => ts('Delete only this participant record.'),
622 ];
623 $this->addRadio('delete_participant', NULL, $deleteParticipants, NULL, '<br />');
624 $this->setDefaults(['delete_participant' => 1]);
625 $this->assign('additionalParticipant', $additionalParticipant);
626 }
627 }
628 $this->addButtons([
629 [
630 'type' => 'next',
631 'name' => ts('Delete'),
632 'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
633 'isDefault' => TRUE,
634 ],
635 [
636 'type' => 'cancel',
637 'name' => ts('Cancel'),
638 ],
639 ]);
640 return;
641 }
642
643 if ($this->_single && $this->_context == 'standalone') {
644 $this->addEntityRef('contact_id', ts('Contact'), [
645 'create' => TRUE,
646 'api' => ['extra' => ['email']],
647 ], TRUE);
648 }
649
650 $eventFieldParams = [
651 'entity' => 'Event',
652 'select' => ['minimumInputLength' => 0],
653 'api' => [
654 'extra' => ['campaign_id', 'default_role_id', 'event_type_id'],
655 ],
656 ];
657
658 if ($this->_mode) {
659 // exclude events which are not monetary when credit card registration is used
660 $eventFieldParams['api']['params']['is_monetary'] = 1;
661 }
662 $this->addPaymentProcessorSelect(TRUE, FALSE, FALSE);
663
664 $element = $this->addEntityRef('event_id', ts('Event'), $eventFieldParams, TRUE);
665
666 //frozen the field fix for CRM-4171
667 if ($this->_action & CRM_Core_Action::UPDATE && $this->_id) {
668 if (CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment',
669 $this->_id, 'contribution_id', 'participant_id'
670 )
671 ) {
672 $element->freeze();
673 }
674 }
675
676 //CRM-7362 --add campaigns.
677 $campaignId = NULL;
678 if ($this->_id) {
679 $campaignId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'campaign_id');
680 }
681 if (!$campaignId) {
682 $eventId = CRM_Utils_Request::retrieve('eid', 'Positive', $this);
683 if ($eventId) {
684 $campaignId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $eventId, 'campaign_id');
685 }
686 }
687 CRM_Campaign_BAO_Campaign::addCampaign($this, $campaignId);
688 $this->add('datepicker', 'register_date', ts('Registration Date'), [], TRUE, ['time' => TRUE]);
689
690 if ($this->_id) {
691 $this->assign('entityID', $this->_id);
692 }
693
694 $this->addSelect('role_id', ['multiple' => TRUE, 'class' => 'huge'], TRUE);
695
696 // CRM-4395
697 $checkCancelledJs = ['onchange' => "return sendNotification( );"];
698 $confirmJS = NULL;
699 if ($this->_onlinePendingContributionId) {
700 $cancelledparticipantStatusId = array_search('Cancelled', CRM_Event_PseudoConstant::participantStatus());
701 $cancelledContributionStatusId = array_search('Cancelled',
702 CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
703 );
704 $checkCancelledJs = [
705 'onchange' => "checkCancelled( this.value, {$cancelledparticipantStatusId},{$cancelledContributionStatusId});",
706 ];
707
708 $participantStatusId = array_search('Pending from pay later',
709 CRM_Event_PseudoConstant::participantStatus()
710 );
711 $contributionStatusId = array_search('Completed',
712 CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
713 );
714 $confirmJS = ['onclick' => "return confirmStatus( {$participantStatusId}, {$contributionStatusId} );"];
715 }
716
717 // get the participant status names to build special status array which is used to show notification
718 // checkbox below participant status select
719 $participantStatusName = CRM_Event_PseudoConstant::participantStatus();
720 $notificationStatuses = [
721 'Cancelled',
722 'Pending from waitlist',
723 'Pending from approval',
724 'Expired',
725 ];
726
727 // get the required status and then implode only ids
728 $notificationStatusIds = implode(',', array_keys(array_intersect($participantStatusName, $notificationStatuses)));
729 $this->assign('notificationStatusIds', $notificationStatusIds);
730
731 $this->_participantStatuses = $statusOptions = CRM_Event_BAO_Participant::buildOptions('status_id', 'create');
732
733 // Only show refund status when editing
734 if ($this->_action & CRM_Core_Action::ADD) {
735 $pendingRefundStatusId = array_search('Pending refund', $participantStatusName);
736 if ($pendingRefundStatusId) {
737 unset($statusOptions[$pendingRefundStatusId]);
738 }
739 }
740
741 $this->addSelect('status_id', $checkCancelledJs + [
742 'options' => $statusOptions,
743 'option_url' => 'civicrm/admin/participant_status',
744 ], TRUE);
745
746 $this->addElement('checkbox', 'is_notify', ts('Send Notification'), NULL);
747
748 $this->addField('source', ['entity' => 'Participant', 'name' => 'source']);
749 $noteAttributes = CRM_Core_DAO::getAttribute('CRM_Core_DAO_Note');
750 $this->add('textarea', 'note', ts('Notes'), $noteAttributes['note']);
751
752 $buttons[] = [
753 'type' => 'upload',
754 'name' => ts('Save'),
755 'isDefault' => TRUE,
756 'js' => $confirmJS,
757 ];
758
759 $path = CRM_Utils_System::currentPath();
760 $excludeForPaths = [
761 'civicrm/contact/search',
762 'civicrm/group/search',
763 ];
764 if (!in_array($path, $excludeForPaths)) {
765 $buttons[] = [
766 'type' => 'upload',
767 'name' => ts('Save and New'),
768 'subName' => 'new',
769 'js' => $confirmJS,
770 ];
771 }
772
773 $buttons[] = [
774 'type' => 'cancel',
775 'name' => ts('Cancel'),
776 ];
777
778 $this->addButtons($buttons);
779 if ($this->_action == CRM_Core_Action::VIEW) {
780 $this->freeze();
781 }
782 }
783
784 /**
785 * Add local and global form rules.
786 *
787 * @return void
788 */
789 public function addRules() {
790 $this->addFormRule(['CRM_Event_Form_Participant', 'formRule'], $this);
791 }
792
793 /**
794 * Global validation rules for the form.
795 *
796 * @param array $values
797 * Posted values of the form.
798 * @param $files
799 * @param $self
800 *
801 * @return array
802 * list of errors to be posted back to the form
803 */
804 public static function formRule($values, $files, $self) {
805 // If $values['_qf_Participant_next'] is Delete or
806 // $values['event_id'] is empty, then return
807 // instead of proceeding further.
808
809 if ((CRM_Utils_Array::value('_qf_Participant_next', $values) == 'Delete') ||
810 (!$values['event_id'])
811 ) {
812 return TRUE;
813 }
814
815 $errorMsg = [];
816
817 if (!empty($values['payment_processor_id'])) {
818 // make sure that payment instrument values (e.g. credit card number and cvv) are valid
819 CRM_Core_Payment_Form::validatePaymentInstrument($values['payment_processor_id'], $values, $errorMsg, NULL);
820 }
821
822 if (!empty($values['record_contribution'])) {
823 if (empty($values['financial_type_id'])) {
824 $errorMsg['financial_type_id'] = ts('Please enter the associated Financial Type');
825 }
826 if (empty($values['payment_instrument_id'])) {
827 $errorMsg['payment_instrument_id'] = ts('Payment Method is a required field.');
828 }
829 if (!empty($values['priceSetId'])) {
830 CRM_Price_BAO_PriceField::priceSetValidation($values['priceSetId'], $values, $errorMsg);
831 }
832 }
833
834 // validate contribution status for 'Failed'.
835 if ($self->_onlinePendingContributionId && !empty($values['record_contribution']) &&
836 (CRM_Utils_Array::value('contribution_status_id', $values) ==
837 array_search('Failed', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'))
838 )
839 ) {
840 $errorMsg['contribution_status_id'] = ts('Please select a valid payment status before updating.');
841 }
842
843 // do the amount validations.
844 //skip for update mode since amount is freeze, CRM-6052
845 if ((!$self->_id && empty($values['total_amount']) &&
846 empty($self->_values['line_items'])
847 ) ||
848 ($self->_id && !$self->_paymentId && isset($self->_values['line_items']) && is_array($self->_values['line_items']))
849 ) {
850 if ($priceSetId = CRM_Utils_Array::value('priceSetId', $values)) {
851 CRM_Price_BAO_PriceField::priceSetValidation($priceSetId, $values, $errorMsg, TRUE);
852 }
853 }
854 // For single additions - show validation error if the contact has already been registered
855 // for this event.
856 if ($self->_single && ($self->_action & CRM_Core_Action::ADD)) {
857 if ($self->_context == 'standalone') {
858 $contactId = CRM_Utils_Array::value('contact_id', $values);
859 }
860 else {
861 $contactId = $self->_contactId;
862 }
863
864 $eventId = CRM_Utils_Array::value('event_id', $values);
865 if (!empty($contactId) && !empty($eventId)) {
866 $cancelledStatusID = CRM_Core_PseudoConstant::getKey('CRM_Event_BAO_Participant', 'status_id', 'Cancelled');
867 $dupeCheck = new CRM_Event_BAO_Participant();
868 $dupeCheck->contact_id = $contactId;
869 $dupeCheck->event_id = $eventId;
870 $dupeCheck->whereAdd("status_id != {$cancelledStatusID} ");
871 $dupeCheck->find(TRUE);
872 if (!empty($dupeCheck->id)) {
873 $errorMsg['event_id'] = ts("This contact has already been assigned to this event.");
874 }
875 }
876 }
877 return CRM_Utils_Array::crmIsEmptyArray($errorMsg) ? TRUE : $errorMsg;
878 }
879
880 /**
881 * Process the form submission.
882 */
883 public function postProcess() {
884 // get the submitted form values.
885 $params = $this->controller->exportValues($this->_name);
886
887 if ($this->_action & CRM_Core_Action::DELETE) {
888 if (CRM_Utils_Array::value('delete_participant', $params) == 2) {
889 $additionalId = (CRM_Event_BAO_Participant::getAdditionalParticipantIds($this->_id));
890 $participantLinks = (CRM_Event_BAO_Participant::getAdditionalParticipantUrl($additionalId));
891 }
892 if (CRM_Utils_Array::value('delete_participant', $params) == 1) {
893 $additionalIds = CRM_Event_BAO_Participant::getAdditionalParticipantIds($this->_id);
894 foreach ($additionalIds as $value) {
895 CRM_Event_BAO_Participant::deleteParticipant($value);
896 }
897 }
898 CRM_Event_BAO_Participant::deleteParticipant($this->_id);
899 CRM_Core_Session::setStatus(ts('Selected participant was deleted successfully.'), ts('Record Deleted'), 'success');
900 if (!empty($participantLinks)) {
901 $status = ts('The following participants no longer have an event fee recorded. You can edit their registration and record a replacement contribution by clicking the links below:') . '<br/>' . $participantLinks;
902 CRM_Core_Session::setStatus($status, ts('Group Payment Deleted'));
903 }
904 return;
905 }
906 // When adding a single contact, the formRule prevents you from adding duplicates
907 // (See above in formRule()). When adding more than one contact, the duplicates are
908 // removed automatically and the user receives one notification.
909 if ($this->_action & CRM_Core_Action::ADD) {
910 $event_id = $this->_eventId;
911 if (empty($event_id) && !empty($params['event_id'])) {
912 $event_id = $params['event_id'];
913 }
914 if (!$this->_single && !empty($event_id)) {
915 $duplicateContacts = 0;
916 foreach ($this->_contactIds as $k => $dupeCheckContactId) {
917 // Eliminate contacts that have already been assigned to this event.
918 $dupeCheck = new CRM_Event_BAO_Participant();
919 $dupeCheck->contact_id = $dupeCheckContactId;
920 $dupeCheck->event_id = $event_id;
921 $dupeCheck->find(TRUE);
922 if (!empty($dupeCheck->id)) {
923 $duplicateContacts++;
924 unset($this->_contactIds[$k]);
925 }
926 }
927 if ($duplicateContacts > 0) {
928 $msg = ts(
929 "%1 contacts have already been assigned to this event. They were not added a second time.",
930 [1 => $duplicateContacts]
931 );
932 CRM_Core_Session::setStatus($msg);
933 }
934 if (count($this->_contactIds) == 0) {
935 CRM_Core_Session::setStatus(ts("No participants were added."));
936 return;
937 }
938 // We have to re-key $this->_contactIds so each contact has the same
939 // key as their corresponding record in the $participants array that
940 // will be created below.
941 $this->_contactIds = array_values($this->_contactIds);
942 }
943 }
944
945 $statusMsg = $this->submit($params);
946 CRM_Core_Session::setStatus($statusMsg, ts('Saved'), 'success');
947 $session = CRM_Core_Session::singleton();
948 $buttonName = $this->controller->getButtonName();
949 if ($this->_context == 'standalone') {
950 if ($buttonName == $this->getButtonName('upload', 'new')) {
951 $urlParams = 'reset=1&action=add&context=standalone';
952 if ($this->_mode) {
953 $urlParams .= '&mode=' . $this->_mode;
954 }
955 if ($this->_eID) {
956 $urlParams .= '&eid=' . $this->_eID;
957 }
958 $session->replaceUserContext(CRM_Utils_System::url('civicrm/participant/add', $urlParams));
959 }
960 else {
961 $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
962 "reset=1&cid={$this->_contactId}&selectedChild=participant"
963 ));
964 }
965 }
966 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
967 $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/participant',
968 "reset=1&action=add&context={$this->_context}&cid={$this->_contactId}"
969 ));
970 }
971 }
972
973 /**
974 * Submit form.
975 *
976 * @param array $params
977 *
978 * @return string
979 * @throws \CRM_Core_Exception
980 * @throws \CiviCRM_API3_Exception
981 */
982 public function submit($params) {
983 $participantStatus = CRM_Event_PseudoConstant::participantStatus();
984 // set the contact, when contact is selected
985 if (!empty($params['contact_id'])) {
986 $this->_contactID = $this->_contactId = $params['contact_id'];
987 }
988 if ($this->_priceSetId && $isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config')) {
989 $this->_quickConfig = $isQuickConfig;
990 }
991
992 if ($this->_id) {
993 $params['id'] = $this->_id;
994 }
995
996 $config = CRM_Core_Config::singleton();
997 if (isset($params['total_amount'])) {
998 $params['total_amount'] = CRM_Utils_Rule::cleanMoney($params['total_amount']);
999 }
1000 if ($this->_isPaidEvent) {
1001
1002 $contributionParams = ['skipCleanMoney' => TRUE];
1003 $lineItem = [];
1004 $additionalParticipantDetails = [];
1005 if (CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled')) {
1006 $eventStartDate = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $this->_eventId, 'start_date');
1007 if (strtotime($eventStartDate) > strtotime(date('Ymt'))) {
1008 $contributionParams['revenue_recognition_date'] = date('Ymd', strtotime($eventStartDate));
1009 }
1010 }
1011 if (($this->_id && $this->_action & CRM_Core_Action::UPDATE) && $this->_paymentId) {
1012 $participantBAO = new CRM_Event_BAO_Participant();
1013 $participantBAO->id = $this->_id;
1014 $participantBAO->find(TRUE);
1015 $contributionParams['total_amount'] = $participantBAO->fee_amount;
1016
1017 $params['discount_id'] = NULL;
1018 //re-enter the values for UPDATE mode
1019 $params['fee_level'] = $params['amount_level'] = $participantBAO->fee_level;
1020 $params['fee_amount'] = $participantBAO->fee_amount;
1021 if (isset($params['priceSetId'])) {
1022 $lineItem[0] = CRM_Price_BAO_LineItem::getLineItems($this->_id);
1023 }
1024 //also add additional participant's fee level/priceset
1025 if (CRM_Event_BAO_Participant::isPrimaryParticipant($this->_id)) {
1026 $additionalIds = CRM_Event_BAO_Participant::getAdditionalParticipantIds($this->_id);
1027 $hasLineItems = CRM_Utils_Array::value('priceSetId', $params, FALSE);
1028 $additionalParticipantDetails = CRM_Event_BAO_Participant::getFeeDetails($additionalIds,
1029 $hasLineItems
1030 );
1031 }
1032 }
1033 else {
1034
1035 // check that discount_id is set
1036 if (empty($params['discount_id'])) {
1037 $params['discount_id'] = 'null';
1038 }
1039
1040 //lets carry currency, CRM-4453
1041 $params['fee_currency'] = $config->defaultCurrency;
1042 if (!isset($lineItem[0])) {
1043 $lineItem[0] = [];
1044 }
1045 CRM_Price_BAO_PriceSet::processAmount($this->_values['fee'],
1046 $params, $lineItem[0]
1047 );
1048 //CRM-11529 for quick config backoffice transactions
1049 //when financial_type_id is passed in form, update the
1050 //lineitems with the financial type selected in form
1051 $submittedFinancialType = CRM_Utils_Array::value('financial_type_id', $params);
1052 $isPaymentRecorded = CRM_Utils_Array::value('record_contribution', $params);
1053 if ($isPaymentRecorded && $this->_quickConfig && $submittedFinancialType) {
1054 foreach ($lineItem[0] as &$values) {
1055 $values['financial_type_id'] = $submittedFinancialType;
1056 }
1057 }
1058
1059 $params['fee_level'] = $params['amount_level'];
1060 $contributionParams['total_amount'] = $params['amount'];
1061 if ($this->_quickConfig && !empty($params['total_amount']) &&
1062 $params['status_id'] != array_search('Partially paid', $participantStatus)
1063 ) {
1064 $params['fee_amount'] = $params['total_amount'];
1065 }
1066 else {
1067 //fix for CRM-3086
1068 $params['fee_amount'] = $params['amount'];
1069 }
1070 }
1071
1072 if (isset($params['priceSetId'])) {
1073 if (!empty($lineItem[0])) {
1074 $this->set('lineItem', $lineItem);
1075
1076 $this->_lineItem = $lineItem;
1077 $lineItem = array_merge($lineItem, $additionalParticipantDetails);
1078
1079 $participantCount = [];
1080 foreach ($lineItem as $k) {
1081 foreach ($k as $v) {
1082 if (CRM_Utils_Array::value('participant_count', $v) > 0) {
1083 $participantCount[] = $v['participant_count'];
1084 }
1085 }
1086 }
1087 }
1088 if (isset($participantCount)) {
1089 $this->assign('pricesetFieldsCount', $participantCount);
1090 }
1091 $this->assign('lineItem', empty($lineItem[0]) || $this->_quickConfig ? FALSE : $lineItem);
1092 }
1093 else {
1094 $this->assign('amount_level', $params['amount_level']);
1095 }
1096 }
1097
1098 $this->_params = $params;
1099 parent::beginPostProcess();
1100 $amountOwed = NULL;
1101 if (isset($params['amount'])) {
1102 $amountOwed = $params['amount'];
1103 unset($params['amount']);
1104 }
1105 $params['contact_id'] = $this->_contactId;
1106
1107 // overwrite actual payment amount if entered
1108 if (!empty($params['total_amount'])) {
1109 $contributionParams['total_amount'] = CRM_Utils_Array::value('total_amount', $params);
1110 }
1111
1112 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1113 $userName = CRM_Core_Session::singleton()->getLoggedInContactDisplayName();
1114
1115 if ($this->_contactId) {
1116 list($this->_contributorDisplayName, $this->_contributorEmail, $this->_toDoNotEmail) = CRM_Contact_BAO_Contact::getContactDetails($this->_contactId);
1117 }
1118
1119 //modify params according to parameter used in create
1120 //participant method (addParticipant)
1121 $this->_params['participant_status_id'] = $params['status_id'];
1122 $this->_params['participant_role_id'] = is_array($params['role_id']) ? $params['role_id'] : explode(',', $params['role_id']);
1123 $this->_params['participant_register_date'] = $params['register_date'];
1124 $roleIdWithSeparator = implode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_params['participant_role_id']);
1125
1126 $now = date('YmdHis');
1127
1128 if ($this->_mode) {
1129 if (!$this->_isPaidEvent) {
1130 CRM_Core_Error::fatal(ts('Selected Event is not Paid Event '));
1131 }
1132
1133 $eventTitle
1134 = CRM_Core_DAO::getFieldValue(
1135 'CRM_Event_DAO_Event',
1136 $params['event_id'],
1137 'title'
1138 );
1139
1140 // set source if not set
1141 if (empty($params['source'])) {
1142 $this->_params['participant_source'] = ts('Offline Registration for Event: %2 by: %1', [
1143 1 => $userName,
1144 2 => $eventTitle,
1145 ]);
1146 }
1147 else {
1148 $this->_params['participant_source'] = $params['source'];
1149 }
1150 $this->_params['description'] = $this->_params['participant_source'];
1151
1152 $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($this->_params['payment_processor_id'],
1153 $this->_mode
1154 );
1155 $fields = [];
1156
1157 // set email for primary location.
1158 $fields['email-Primary'] = 1;
1159 $params['email-Primary'] = $params["email-{$this->_bltID}"] = $this->_contributorEmail;
1160
1161 $params['register_date'] = $now;
1162
1163 // now set the values for the billing location.
1164 foreach ($this->_fields as $name => $dontCare) {
1165 $fields[$name] = 1;
1166 }
1167
1168 // also add location name to the array
1169 $params["address_name-{$this->_bltID}"]
1170 = CRM_Utils_Array::value('billing_first_name', $params) . ' ' .
1171 CRM_Utils_Array::value('billing_middle_name', $params) . ' ' .
1172 CRM_Utils_Array::value('billing_last_name', $params);
1173
1174 $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
1175 $fields["address_name-{$this->_bltID}"] = 1;
1176 $fields["email-{$this->_bltID}"] = 1;
1177 $ctype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId, 'contact_type');
1178
1179 $nameFields = ['first_name', 'middle_name', 'last_name'];
1180
1181 foreach ($nameFields as $name) {
1182 $fields[$name] = 1;
1183 if (array_key_exists("billing_$name", $params)) {
1184 $params[$name] = $params["billing_{$name}"];
1185 $params['preserveDBName'] = TRUE;
1186 }
1187 }
1188 $contactID = CRM_Contact_BAO_Contact::createProfileContact($params, $fields, $this->_contactId, NULL, NULL, $ctype);
1189 }
1190
1191 if (!empty($this->_params['participant_role_id'])) {
1192 $customFieldsRole = [];
1193 foreach ($this->_params['participant_role_id'] as $roleKey) {
1194 $customFieldsRole = CRM_Utils_Array::crmArrayMerge(CRM_Core_BAO_CustomField::getFields('Participant',
1195 FALSE, FALSE, $roleKey, $this->_roleCustomDataTypeID), $customFieldsRole);
1196 }
1197 $customFieldsEvent = CRM_Core_BAO_CustomField::getFields('Participant',
1198 FALSE,
1199 FALSE,
1200 CRM_Utils_Array::value('event_id', $params),
1201 $this->_eventNameCustomDataTypeID
1202 );
1203 $customFieldsEventType = CRM_Core_BAO_CustomField::getFields('Participant',
1204 FALSE,
1205 FALSE,
1206 $this->_eventTypeId,
1207 $this->_eventTypeCustomDataTypeID
1208 );
1209 $customFields = CRM_Utils_Array::crmArrayMerge($customFieldsRole,
1210 CRM_Core_BAO_CustomField::getFields('Participant', FALSE, FALSE, NULL, NULL, TRUE)
1211 );
1212 $customFields = CRM_Utils_Array::crmArrayMerge($customFieldsEvent, $customFields);
1213 $customFields = CRM_Utils_Array::crmArrayMerge($customFieldsEventType, $customFields);
1214
1215 $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params, $this->_id, $this->getDefaultEntity());
1216 }
1217
1218 //do cleanup line items if participant edit the Event Fee.
1219 if (($this->_lineItem || !isset($params['proceSetId'])) && !$this->_paymentId && $this->_id) {
1220 CRM_Price_BAO_LineItem::deleteLineItems($this->_id, 'civicrm_participant');
1221 }
1222
1223 if ($this->_mode) {
1224 // add all the additional payment params we need
1225 $this->_params["state_province-{$this->_bltID}"] = $this->_params["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($this->_params["billing_state_province_id-{$this->_bltID}"]);
1226 $this->_params["country-{$this->_bltID}"] = $this->_params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($this->_params["billing_country_id-{$this->_bltID}"]);
1227
1228 $this->_params['amount'] = $params['fee_amount'];
1229 $this->_params['amount_level'] = $params['amount_level'];
1230 $this->_params['currencyID'] = $config->defaultCurrency;
1231 $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
1232
1233 // at this point we've created a contact and stored its address etc
1234 // all the payment processors expect the name and address to be in the
1235 // so we copy stuff over to first_name etc.
1236 $paymentParams = $this->_params;
1237 if (!empty($this->_params['send_receipt'])) {
1238 $paymentParams['email'] = $this->_contributorEmail;
1239 }
1240
1241 // The only reason for merging in the 'contact_id' rather than ensuring it is set
1242 // is that this patch is being done around the time of the stable release
1243 // so more conservative approach is called for.
1244 // In fact the use of $params and $this->_params & $this->_contactId vs $contactID
1245 // needs rationalising.
1246 $mapParams = array_merge(['contact_id' => $contactID], $this->_params);
1247 CRM_Core_Payment_Form::mapParams($this->_bltID, $mapParams, $paymentParams, TRUE);
1248
1249 $payment = $this->_paymentProcessor['object'];
1250
1251 // CRM-15622: fix for incorrect contribution.fee_amount
1252 $paymentParams['fee_amount'] = NULL;
1253 $result = $payment->doPayment($paymentParams);
1254
1255 if (is_a($result, 'CRM_Core_Error')) {
1256 CRM_Core_Error::displaySessionError($result);
1257 CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/view/participant',
1258 "reset=1&action=add&cid={$this->_contactId}&context=participant&mode={$this->_mode}"
1259 ));
1260 }
1261
1262 if ($result) {
1263 $this->_params = array_merge($this->_params, $result);
1264 }
1265
1266 $this->_params['receive_date'] = $now;
1267
1268 if (!empty($this->_params['send_receipt'])) {
1269 $this->_params['receipt_date'] = $now;
1270 }
1271 else {
1272 $this->_params['receipt_date'] = NULL;
1273 }
1274
1275 $this->set('params', $this->_params);
1276 $this->assign('trxn_id', $result['trxn_id']);
1277 $this->assign('receive_date', $this->_params['receive_date']);
1278
1279 //add contribution record
1280 $this->_params['financial_type_id']
1281 = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'financial_type_id');
1282 $this->_params['mode'] = $this->_mode;
1283
1284 //add contribution record
1285 $contributions[] = $contribution = CRM_Event_Form_Registration_Confirm::processContribution(
1286 $this, $this->_params,
1287 $result, $contactID,
1288 FALSE, FALSE,
1289 $this->_paymentProcessor
1290 );
1291
1292 // add participant record
1293 $participants = [];
1294 if (!empty($this->_params['role_id']) && is_array($this->_params['role_id'])) {
1295 $this->_params['role_id'] = implode(CRM_Core_DAO::VALUE_SEPARATOR,
1296 $this->_params['role_id']
1297 );
1298 }
1299
1300 //CRM-15372 patch to fix fee amount replacing amount
1301 $this->_params['fee_amount'] = $this->_params['amount'];
1302
1303 $participants[] = CRM_Event_Form_Registration::addParticipant($this, $contactID);
1304
1305 //add custom data for participant
1306 CRM_Core_BAO_CustomValueTable::postProcess($this->_params,
1307 'civicrm_participant',
1308 $participants[0]->id,
1309 'Participant'
1310 );
1311 //add participant payment
1312 $paymentParticipant = [
1313 'participant_id' => $participants[0]->id,
1314 'contribution_id' => $contribution->id,
1315 ];
1316
1317 CRM_Event_BAO_ParticipantPayment::create($paymentParticipant);
1318 $this->_contactIds[] = $this->_contactId;
1319 }
1320 else {
1321 $participants = [];
1322 if ($this->_single) {
1323 if ($params['role_id']) {
1324 $params['role_id'] = $roleIdWithSeparator;
1325 }
1326 else {
1327 $params['role_id'] = 'NULL';
1328 }
1329 $participants[] = CRM_Event_BAO_Participant::create($params);
1330 }
1331 else {
1332 foreach ($this->_contactIds as $contactID) {
1333 $commonParams = $params;
1334 $commonParams['contact_id'] = $contactID;
1335 if ($commonParams['role_id']) {
1336 $commonParams['role_id'] = $commonParams['role_id'] = str_replace(',', CRM_Core_DAO::VALUE_SEPARATOR, $params['role_id']);
1337 }
1338 else {
1339 $commonParams['role_id'] = 'NULL';
1340 }
1341 $participants[] = CRM_Event_BAO_Participant::create($commonParams);
1342 }
1343 }
1344
1345 if (isset($params['event_id'])) {
1346 $eventTitle = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event',
1347 $params['event_id'],
1348 'title'
1349 );
1350 }
1351
1352 if ($this->_single) {
1353 $this->_contactIds[] = $this->_contactId;
1354 }
1355
1356 $contributions = [];
1357 if (!empty($params['record_contribution'])) {
1358 if (!empty($params['id'])) {
1359 if ($this->_onlinePendingContributionId) {
1360 $ids['contribution'] = $this->_onlinePendingContributionId;
1361 }
1362 else {
1363 $ids['contribution'] = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment',
1364 $params['id'],
1365 'contribution_id',
1366 'participant_id'
1367 );
1368 }
1369 }
1370 unset($params['note']);
1371
1372 //build contribution params
1373 if (!$this->_onlinePendingContributionId) {
1374 if (empty($params['source'])) {
1375 $contributionParams['source'] = ts('%1 : Offline registration (by %2)', [
1376 1 => $eventTitle,
1377 2 => $userName,
1378 ]);
1379 }
1380 else {
1381 $contributionParams['source'] = $params['source'];
1382 }
1383 }
1384
1385 $contributionParams['currency'] = $config->defaultCurrency;
1386 $contributionParams['non_deductible_amount'] = 'null';
1387 $contributionParams['receipt_date'] = !empty($params['send_receipt']) ? CRM_Utils_Array::value('receive_date', $params) : 'null';
1388 $contributionParams['contact_id'] = $this->_contactID;
1389 $contributionParams['receive_date'] = CRM_Utils_Array::value('receive_date', $params, 'null');
1390
1391 $recordContribution = [
1392 'financial_type_id',
1393 'payment_instrument_id',
1394 'trxn_id',
1395 'contribution_status_id',
1396 'check_number',
1397 'campaign_id',
1398 'pan_truncation',
1399 'card_type_id',
1400 ];
1401
1402 foreach ($recordContribution as $f) {
1403 $contributionParams[$f] = CRM_Utils_Array::value($f, $this->_params);
1404 if ($f == 'trxn_id') {
1405 $this->assign('trxn_id', $contributionParams[$f]);
1406 }
1407 }
1408
1409 //insert financial type name in receipt.
1410 $this->assign('financialTypeName', CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType',
1411 $contributionParams['financial_type_id']));
1412 // legacy support
1413 $this->assign('contributionTypeName', CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialType', $contributionParams['financial_type_id']));
1414 $contributionParams['skipLineItem'] = 1;
1415 if ($this->_id) {
1416 $contributionParams['contribution_mode'] = 'participant';
1417 $contributionParams['participant_id'] = $this->_id;
1418 }
1419 // Set is_pay_later flag for back-office offline Pending status contributions
1420 if ($contributionParams['contribution_status_id'] == CRM_Core_PseudoConstant::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Pending')) {
1421 $contributionParams['is_pay_later'] = 1;
1422 }
1423 elseif ($contributionParams['contribution_status_id'] == CRM_Core_PseudoConstant::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Completed')) {
1424 $contributionParams['is_pay_later'] = 0;
1425 }
1426
1427 if ($params['status_id'] == array_search('Partially paid', $participantStatus)) {
1428 if (!$amountOwed && $this->_action & CRM_Core_Action::UPDATE) {
1429 $amountOwed = $params['fee_amount'];
1430 }
1431
1432 // if multiple participants are link, consider contribution total amount as the amount Owed
1433 if ($this->_id && CRM_Event_BAO_Participant::isPrimaryParticipant($this->_id)) {
1434 $amountOwed = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
1435 $ids['contribution'],
1436 'total_amount'
1437 );
1438 }
1439
1440 // CRM-13964 partial_payment_total
1441 if ($amountOwed > $params['total_amount']) {
1442 // the owed amount
1443 $contributionParams['partial_payment_total'] = $amountOwed;
1444 // the actual amount paid
1445 $contributionParams['partial_amount_to_pay'] = $params['total_amount'];
1446 }
1447 }
1448
1449 if (CRM_Utils_Array::value('tax_amount', $this->_params)) {
1450 $contributionParams['tax_amount'] = $this->_params['tax_amount'];
1451 }
1452
1453 if ($this->_single) {
1454 if (empty($ids)) {
1455 $ids = [];
1456 }
1457 $contributions[] = CRM_Contribute_BAO_Contribution::create($contributionParams, $ids);
1458 }
1459 else {
1460 $ids = [];
1461 foreach ($this->_contactIds as $contactID) {
1462 $contributionParams['contact_id'] = $contactID;
1463 $contributions[] = CRM_Contribute_BAO_Contribution::create($contributionParams, $ids);
1464 }
1465 }
1466
1467 //insert payment record for this participation
1468 if (empty($ids['contribution'])) {
1469 foreach ($this->_contactIds as $num => $contactID) {
1470 $ppDAO = new CRM_Event_DAO_ParticipantPayment();
1471 $ppDAO->participant_id = $participants[$num]->id;
1472 $ppDAO->contribution_id = $contributions[$num]->id;
1473 $ppDAO->save();
1474 }
1475 }
1476 // next create the transaction record
1477 $transaction = new CRM_Core_Transaction();
1478
1479 // CRM-11124
1480 if ($this->_params['discount_id']) {
1481 CRM_Event_BAO_Participant::createDiscountTrxn(
1482 $this->_eventId,
1483 $contributionParams,
1484 NULL,
1485 CRM_Price_BAO_PriceSet::parseFirstPriceSetValueIDFromParams($this->_params)
1486 );
1487 }
1488 $transaction->commit();
1489 }
1490 }
1491
1492 // also store lineitem stuff here
1493 if ((($this->_lineItem & $this->_action & CRM_Core_Action::ADD) ||
1494 ($this->_lineItem && CRM_Core_Action::UPDATE && !$this->_paymentId))
1495 ) {
1496 foreach ($this->_contactIds as $num => $contactID) {
1497 foreach ($this->_lineItem as $key => $value) {
1498 if (is_array($value) && $value != 'skip') {
1499 foreach ($value as $lineKey => $line) {
1500 //10117 update the line items for participants if contribution amount is recorded
1501 if ($this->_quickConfig && !empty($params['total_amount']) &&
1502 ($params['status_id'] != array_search('Partially paid', $participantStatus))
1503 ) {
1504 $line['unit_price'] = $line['line_total'] = $params['total_amount'];
1505 if (!empty($params['tax_amount'])) {
1506 $line['unit_price'] = $line['unit_price'] - $params['tax_amount'];
1507 $line['line_total'] = $line['line_total'] - $params['tax_amount'];
1508 }
1509 }
1510 $lineItem[$this->_priceSetId][$lineKey] = $line;
1511 }
1512 CRM_Price_BAO_LineItem::processPriceSet($participants[$num]->id, $lineItem, CRM_Utils_Array::value($num, $contributions, NULL), 'civicrm_participant');
1513 CRM_Contribute_BAO_Contribution::addPayments($contributions);
1514 }
1515 }
1516 }
1517 }
1518
1519 $updateStatusMsg = NULL;
1520 //send mail when participant status changed, CRM-4326
1521 if ($this->_id && $this->_statusId &&
1522 $this->_statusId != CRM_Utils_Array::value('status_id', $params) && !empty($params['is_notify'])
1523 ) {
1524
1525 $updateStatusMsg = CRM_Event_BAO_Participant::updateStatusMessage($this->_id,
1526 $params['status_id'],
1527 $this->_statusId
1528 );
1529 }
1530
1531 $sent = [];
1532 $notSent = [];
1533 if (!empty($params['send_receipt'])) {
1534 if (array_key_exists($params['from_email_address'], $this->_fromEmails['from_email_id'])) {
1535 $receiptFrom = $params['from_email_address'];
1536 }
1537
1538 $this->assign('module', 'Event Registration');
1539 //use of the message template below requires variables in different format
1540 $event = $events = [];
1541 $returnProperties = ['event_type_id', 'fee_label', 'start_date', 'end_date', 'is_show_location', 'title'];
1542
1543 //get all event details.
1544 CRM_Core_DAO::commonRetrieveAll('CRM_Event_DAO_Event', 'id', $params['event_id'], $events, $returnProperties);
1545 $event = $events[$params['event_id']];
1546 unset($event['start_date']);
1547 unset($event['end_date']);
1548
1549 $role = CRM_Event_PseudoConstant::participantRole();
1550 $participantRoles = CRM_Utils_Array::value('role_id', $params);
1551 if (is_array($participantRoles)) {
1552 $selectedRoles = [];
1553 foreach ($participantRoles as $roleId) {
1554 $selectedRoles[] = $role[$roleId];
1555 }
1556 $event['participant_role'] = implode(', ', $selectedRoles);
1557 }
1558 else {
1559 $event['participant_role'] = CRM_Utils_Array::value($participantRoles, $role);
1560 }
1561 $event['is_monetary'] = $this->_isPaidEvent;
1562
1563 if ($params['receipt_text']) {
1564 $event['confirm_email_text'] = $params['receipt_text'];
1565 }
1566
1567 $this->assign('isAmountzero', 1);
1568 $this->assign('event', $event);
1569
1570 $this->assign('isShowLocation', $event['is_show_location']);
1571 if (CRM_Utils_Array::value('is_show_location', $event) == 1) {
1572 $locationParams = [
1573 'entity_id' => $params['event_id'],
1574 'entity_table' => 'civicrm_event',
1575 ];
1576 $location = CRM_Core_BAO_Location::getValues($locationParams, TRUE);
1577 $this->assign('location', $location);
1578 }
1579
1580 $status = CRM_Event_PseudoConstant::participantStatus();
1581 if ($this->_isPaidEvent) {
1582 $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
1583 if (!$this->_mode) {
1584 if (isset($params['payment_instrument_id'])) {
1585 $this->assign('paidBy',
1586 CRM_Utils_Array::value($params['payment_instrument_id'],
1587 $paymentInstrument
1588 )
1589 );
1590 }
1591 }
1592
1593 $this->assign('totalAmount', $contributionParams['total_amount']);
1594 if (isset($contributionParams['partial_payment_total'])) {
1595 // balance amount
1596 $balanceAmount = $contributionParams['partial_payment_total'] - $contributionParams['partial_amount_to_pay'];
1597 $this->assign('balanceAmount', $balanceAmount);
1598 }
1599 $this->assign('isPrimary', 1);
1600 $this->assign('checkNumber', CRM_Utils_Array::value('check_number', $params));
1601 }
1602 if ($this->_mode) {
1603 $this->assignBillingName($params);
1604 $this->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
1605 $this->_params,
1606 $this->_bltID
1607 ));
1608
1609 $date = CRM_Utils_Date::format($params['credit_card_exp_date']);
1610 $date = CRM_Utils_Date::mysqlToIso($date);
1611 $this->assign('credit_card_exp_date', $date);
1612 $this->assign('credit_card_number',
1613 CRM_Utils_System::mungeCreditCard($params['credit_card_number'])
1614 );
1615 $this->assign('credit_card_type', $params['credit_card_type']);
1616 // The concept of contributeMode is deprecated.
1617 $this->assign('contributeMode', 'direct');
1618 $this->assign('isAmountzero', 0);
1619 $this->assign('is_pay_later', 0);
1620 $this->assign('isPrimary', 1);
1621 }
1622
1623 $this->assign('register_date', $params['register_date']);
1624 if (isset($params['receive_date'])) {
1625 $this->assign('receive_date', $params['receive_date']);
1626 }
1627
1628 $participant = [['participant_id', '=', $participants[0]->id, 0, 0]];
1629 // check whether its a test drive ref CRM-3075
1630 if (!empty($this->_defaultValues['is_test'])) {
1631 $participant[] = ['participant_test', '=', 1, 0, 0];
1632 }
1633
1634 $customGroup = [];
1635 //format submitted data
1636 foreach ($params['custom'] as $fieldID => $values) {
1637 foreach ($values as $fieldValue) {
1638 $isPublic = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomGroup', $fieldValue['custom_group_id'], 'is_public');
1639 if ($isPublic) {
1640 $customFields[$fieldID]['id'] = $fieldID;
1641 $formattedValue = CRM_Core_BAO_CustomField::displayValue($fieldValue['value'], $fieldID, $participants[0]->id);
1642 $customGroup[$customFields[$fieldID]['groupTitle']][$customFields[$fieldID]['label']] = str_replace('&nbsp;', '', $formattedValue);
1643 }
1644 }
1645 }
1646
1647 foreach ($this->_contactIds as $num => $contactID) {
1648 // Retrieve the name and email of the contact - this will be the TO for receipt email
1649 list($this->_contributorDisplayName, $this->_contributorEmail, $this->_toDoNotEmail) = CRM_Contact_BAO_Contact::getContactDetails($contactID);
1650
1651 $this->_contributorDisplayName = ($this->_contributorDisplayName == ' ') ? $this->_contributorEmail : $this->_contributorDisplayName;
1652
1653 $waitStatus = CRM_Event_PseudoConstant::participantStatus(NULL, "class = 'Waiting'");
1654 if ($waitingStatus = CRM_Utils_Array::value($params['status_id'], $waitStatus)) {
1655 $this->assign('isOnWaitlist', TRUE);
1656 }
1657
1658 $this->assign('customGroup', $customGroup);
1659 $this->assign('contactID', $contactID);
1660 $this->assign('participantID', $participants[$num]->id);
1661
1662 $this->_id = $participants[$num]->id;
1663
1664 if ($this->_isPaidEvent) {
1665 // fix amount for each of participants ( for bulk mode )
1666 $eventAmount = [];
1667 $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
1668 $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
1669 $totalTaxAmount = 0;
1670
1671 //add dataArray in the receipts in ADD and UPDATE condition
1672 $dataArray = [];
1673 if ($this->_action & CRM_Core_Action::ADD) {
1674 $line = isset($lineItem[0]) ? $lineItem[0] : [];
1675 }
1676 elseif ($this->_action & CRM_Core_Action::UPDATE) {
1677 $line = $this->_values['line_items'];
1678 }
1679 if ($invoicing) {
1680 foreach ($line as $key => $value) {
1681 if (isset($value['tax_amount'])) {
1682 $totalTaxAmount += $value['tax_amount'];
1683 if (isset($dataArray[(string) $value['tax_rate']])) {
1684 $dataArray[(string) $value['tax_rate']] = $dataArray[(string) $value['tax_rate']] + CRM_Utils_Array::value('tax_amount', $value);
1685 }
1686 else {
1687 $dataArray[(string) $value['tax_rate']] = CRM_Utils_Array::value('tax_amount', $value);
1688 }
1689 }
1690 }
1691 $this->assign('totalTaxAmount', $totalTaxAmount);
1692 $this->assign('taxTerm', $this->getSalesTaxTerm());
1693 $this->assign('dataArray', $dataArray);
1694 }
1695 if (!empty($additionalParticipantDetails)) {
1696 $params['amount_level'] = preg_replace('/\ 1/', '', $params['amount_level']) . ' - ' . $this->_contributorDisplayName;
1697 }
1698
1699 $eventAmount[$num] = [
1700 'label' => preg_replace('/\ 1/', '', $params['amount_level']),
1701 'amount' => $params['fee_amount'],
1702 ];
1703 //as we are using same template for online & offline registration.
1704 //So we have to build amount as array.
1705 $eventAmount = array_merge($eventAmount, $additionalParticipantDetails);
1706 $this->assign('amount', $eventAmount);
1707 }
1708
1709 $sendTemplateParams = [
1710 'groupName' => 'msg_tpl_workflow_event',
1711 'valueName' => 'event_offline_receipt',
1712 'contactId' => $contactID,
1713 'isTest' => !empty($this->_defaultValues['is_test']),
1714 'PDFFilename' => ts('confirmation') . '.pdf',
1715 ];
1716
1717 // try to send emails only if email id is present
1718 // and the do-not-email option is not checked for that contact
1719 if ($this->_contributorEmail and !$this->_toDoNotEmail) {
1720 $sendTemplateParams['from'] = $receiptFrom;
1721 $sendTemplateParams['toName'] = $this->_contributorDisplayName;
1722 $sendTemplateParams['toEmail'] = $this->_contributorEmail;
1723 $sendTemplateParams['cc'] = CRM_Utils_Array::value('cc', $this->_fromEmails);
1724 $sendTemplateParams['bcc'] = CRM_Utils_Array::value('bcc', $this->_fromEmails);
1725 }
1726
1727 //send email with pdf invoice
1728 $template = CRM_Core_Smarty::singleton();
1729 $taxAmt = $template->get_template_vars('dataArray');
1730 $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment',
1731 $this->_id, 'contribution_id', 'participant_id'
1732 );
1733 $prefixValue = Civi::settings()->get('contribution_invoice_settings');
1734 $invoicing = CRM_Utils_Array::value('invoicing', $prefixValue);
1735 if (!empty($taxAmt) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
1736 $sendTemplateParams['isEmailPdf'] = TRUE;
1737 $sendTemplateParams['contributionId'] = $contributionId;
1738 }
1739 list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
1740 if ($mailSent) {
1741 $sent[] = $contactID;
1742 foreach ($participants as $ids => $values) {
1743 if ($values->contact_id == $contactID) {
1744 $values->details = CRM_Utils_Array::value('receipt_text', $params);
1745 CRM_Activity_BAO_Activity::addActivity($values, 'Email');
1746 break;
1747 }
1748 }
1749 }
1750 else {
1751 $notSent[] = $contactID;
1752 }
1753 }
1754 }
1755
1756 // set the participant id if it is not set
1757 if (!$this->_id) {
1758 $this->_id = $participants[0]->id;
1759 }
1760
1761 return $this->getStatusMsg($params, $sent, $updateStatusMsg, $notSent);
1762 }
1763
1764 /**
1765 * Set the various IDs relating to custom data types.
1766 */
1767 public function setCustomDataTypes() {
1768 $customDataType = CRM_Core_OptionGroup::values('custom_data_type', FALSE, FALSE, FALSE, NULL, 'name');
1769 $this->_roleCustomDataTypeID = array_search('ParticipantRole', $customDataType);
1770 $this->_eventNameCustomDataTypeID = array_search('ParticipantEventName', $customDataType);
1771 $this->_eventTypeCustomDataTypeID = array_search('ParticipantEventType', $customDataType);
1772 $this->assign('roleCustomDataTypeID', $this->_roleCustomDataTypeID);
1773 $this->assign('eventNameCustomDataTypeID', $this->_eventNameCustomDataTypeID);
1774 $this->assign('eventTypeCustomDataTypeID', $this->_eventTypeCustomDataTypeID);
1775 }
1776
1777 /**
1778 * Get status message
1779 *
1780 * @param array $params
1781 * @param int $sent
1782 * @param string $updateStatusMsg
1783 * @param int $notSent
1784 *
1785 * @return string
1786 */
1787 protected function getStatusMsg($params, $sent, $updateStatusMsg, $notSent) {
1788 $statusMsg = '';
1789 if (($this->_action & CRM_Core_Action::UPDATE)) {
1790 $statusMsg = ts('Event registration information for %1 has been updated.', [1 => $this->_contributorDisplayName]);
1791 if (!empty($params['send_receipt']) && count($sent)) {
1792 $statusMsg .= ' ' . ts('A confirmation email has been sent to %1', [1 => $this->_contributorEmail]);
1793 }
1794
1795 if ($updateStatusMsg) {
1796 $statusMsg = "{$statusMsg} {$updateStatusMsg}";
1797 }
1798 }
1799 elseif ($this->_action & CRM_Core_Action::ADD) {
1800 if ($this->_single) {
1801 $statusMsg = ts('Event registration for %1 has been added.', [1 => $this->_contributorDisplayName]);
1802 if (!empty($params['send_receipt']) && count($sent)) {
1803 $statusMsg .= ' ' . ts('A confirmation email has been sent to %1.', [1 => $this->_contributorEmail]);
1804 }
1805 }
1806 else {
1807 $statusMsg = ts('Total Participant(s) added to event: %1.', [1 => count($this->_contactIds)]);
1808 if (count($notSent) > 0) {
1809 $statusMsg .= ' ' . ts('Email has NOT been sent to %1 contact(s) - communication preferences specify DO NOT EMAIL OR valid Email is NOT present. ', [1 => count($notSent)]);
1810 }
1811 elseif (isset($params['send_receipt'])) {
1812 $statusMsg .= ' ' . ts('A confirmation email has been sent to ALL participants');
1813 }
1814 }
1815 }
1816 return $statusMsg;
1817 }
1818
1819 }