3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 |
9 +--------------------------------------------------------------------+
13 * Back office participant form.
16 * @copyright CiviCRM LLC https://civicrm.org/licensing
20 * Back office participant form.
22 class CRM_Event_Form_Participant
extends CRM_Contribute_Form_AbstractEditPayment
{
25 * Participant ID - use getParticipantID.
32 * ID of discount record.
38 public $useLivePageJS = TRUE;
41 * The values for the contribution db object.
48 * The values for the quickconfig for priceset.
52 public $_quickConfig = NULL;
55 * Price Set ID, if the new price set method is used
62 * Array of fields for the price set.
69 * The id of the participation that we are processing.
80 protected $_noteId = NULL;
84 * Use parent $this->contactID
86 * The id of the contact associated with this participation.
94 * Array of event values.
101 * Are we operating in "single mode", i.e. adding / editing only
102 * one participant record, or is this a batch add operation
106 public $_single = FALSE;
109 * If event is paid or unpaid.
113 public $_isPaidEvent;
127 protected $_eventTypeId = NULL;
130 * Participant status Id.
134 protected $_statusId = NULL;
137 * Cache all the participant statuses.
141 protected $_participantStatuses;
148 public $_mode = NULL;
151 * Event ID preselect.
158 * Line Item for Price Set.
162 public $_lineItem = NULL;
165 * Contribution mode for event registration for offline mode.
170 public $_contributeMode = 'direct';
175 * Store id of role custom data type ( option value )
179 protected $_roleCustomDataTypeID;
182 * Store id of event Name custom data type ( option value)
186 protected $_eventNameCustomDataTypeID;
189 * Selected discount id.
193 public $_originalDiscountId = NULL;
200 public $_eventId = NULL;
203 * Id of payment, if any
207 public $_paymentId = NULL;
211 * @todo add explanatory note about this
213 public $_onlinePendingContributionId = NULL;
216 * Stored participant record.
220 protected $participantRecord;
223 * Params for creating a payment to add to the contribution.
227 protected $createPaymentParams = [];
230 * Get params to create payments.
234 public function getCreatePaymentParams(): array {
235 return $this->createPaymentParams
;
239 * Set params to create payments.
241 * @param array $createPaymentParams
243 public function setCreatePaymentParams(array $createPaymentParams) {
244 $this->createPaymentParams
= $createPaymentParams;
248 * Explicitly declare the entity api name.
250 public function getDefaultEntity() {
251 return 'Participant';
255 * Default form context used as part of addField()
257 public function getDefaultContext() {
262 * Set variables up before form is built.
264 * @throws \CRM_Core_Exception
265 * @throws \CiviCRM_API3_Exception
267 public function preProcess() {
268 parent
::preProcess();
269 $this->_showFeeBlock
= $_GET['eventId'] ??
NULL;
270 $this->assign('showFeeBlock', FALSE);
271 $this->assign('feeBlockPaid', FALSE);
273 // @todo eliminate this duplication.
274 $this->_contactId
= $this->_contactID
;
275 $this->_eID
= CRM_Utils_Request
::retrieve('eid', 'Positive', $this);
276 $this->_context
= CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
277 $this->assign('context', $this->_context
);
279 if ($this->_contactID
) {
280 $this->setPageTitle(ts('Event Registration for %1', [1 => $this->userDisplayName
]));
283 $this->setPageTitle(ts('Event Registration'));
286 // check the current path, if search based, then dont get participantID
288 $path = CRM_Utils_System
::currentPath();
290 strpos($path, 'civicrm/contact/search') === 0 ||
291 strpos($path, 'civicrm/group/search') === 0
296 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
300 $this->assign('participantId', $this->_id
);
302 $this->_paymentId
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment',
303 $this->_id
, 'id', 'participant_id'
306 $this->assign('hasPayment', $this->_paymentId
);
307 $this->assign('componentId', $this->_id
);
308 $this->assign('component', 'event');
310 // CRM-12615 - Get payment information from the primary registration
311 if ((!$this->_paymentId
) && ($this->_action
== CRM_Core_Action
::UPDATE
)) {
312 $registered_by_id = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
313 $this->_id
, 'registered_by_id', 'id'
315 if ($registered_by_id) {
316 $this->_paymentId
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment',
317 $registered_by_id, 'id', 'participant_id'
319 $this->assign('registeredByParticipantId', $registered_by_id);
323 $this->setCustomDataTypes();
326 $this->assign('participantMode', $this->_mode
);
329 if ($this->_showFeeBlock
) {
330 $this->assign('showFeeBlock', TRUE);
331 $isMonetary = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $this->_showFeeBlock
, 'is_monetary');
333 $this->assign('feeBlockPaid', TRUE);
335 return CRM_Event_Form_EventFees
::preProcess($this);
338 //check the mode when this form is called either single or as
340 if ($this->_id ||
$this->_contactId ||
$this->_context
== 'standalone') {
341 $this->_single
= TRUE;
342 $this->assign('urlPath', 'civicrm/contact/view/participant');
343 if (!$this->_id
&& !$this->_contactId
) {
346 'title' => ts('CiviEvent Dashboard'),
347 'url' => CRM_Utils_System
::url('civicrm/event', 'reset=1'),
351 CRM_Utils_System
::appendBreadCrumb($breadCrumbs);
355 //set the appropriate action
356 $context = $this->get('context');
357 $urlString = 'civicrm/contact/search';
358 $this->_action
= CRM_Core_Action
::BASIC
;
361 $urlString = 'civicrm/contact/search/advanced';
362 $this->_action
= CRM_Core_Action
::ADVANCED
;
366 $urlString = 'civicrm/contact/search/builder';
367 $this->_action
= CRM_Core_Action
::PROFILE
;
371 $urlString = 'civicrm/contact/search/basic';
372 $this->_action
= CRM_Core_Action
::BASIC
;
376 $urlString = 'civicrm/contact/search/custom';
377 $this->_action
= CRM_Core_Action
::COPY
;
380 CRM_Contact_Form_Task
::preProcessCommon($this);
382 $this->_single
= FALSE;
383 $this->_contactId
= NULL;
385 //set ajax path, this used for custom data building
386 $this->assign('urlPath', $urlString);
387 $this->assign('urlPathVar', "_qf_Participant_display=true&qfKey={$this->controller->_key}");
390 $this->assign('single', $this->_single
);
393 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'add');
395 $this->assign('action', $this->_action
);
397 // check for edit permission
398 if (!CRM_Core_Permission
::checkActionPermission('CiviEvent', $this->_action
)) {
399 CRM_Core_Error
::statusBounce(ts('You do not have permission to access this page.'));
402 if ($this->_action
& CRM_Core_Action
::DELETE
) {
403 // check delete permission for contribution
404 if ($this->_id
&& $this->_paymentId
&& !CRM_Core_Permission
::checkActionPermission('CiviContribute', $this->_action
)) {
405 CRM_Core_Error
::statusBounce(ts("This Participant is linked to a contribution. You must have 'delete in CiviContribute' permission in order to delete this record."));
411 // assign participant id to the template
412 $this->assign('participantId', $this->_id
);
415 // when fee amount is included in form
416 if (!empty($_POST['hidden_feeblock']) ||
!empty($_POST['send_receipt'])) {
417 CRM_Event_Form_EventFees
::preProcess($this);
418 $this->buildEventFeeForm($this);
419 CRM_Event_Form_EventFees
::setDefaultValues($this);
422 // when custom data is included in this page
423 if (!empty($_POST['hidden_custom'])) {
424 $eventId = (int) ($_POST['event_id'] ??
0);
425 // Custom data of type participant role
426 // Note: Some earlier commits imply $_POST['role_id'] could be a comma separated string,
427 // not sure if that ever really happens
428 if (!empty($_POST['role_id'])) {
429 foreach ($_POST['role_id'] as $roleID) {
430 CRM_Custom_Form_CustomData
::preProcess($this, $this->_roleCustomDataTypeID
, $roleID, 1, 'Participant', $this->_id
);
431 CRM_Custom_Form_CustomData
::buildQuickForm($this);
432 CRM_Custom_Form_CustomData
::setDefaultValues($this);
436 //custom data of type participant event
437 CRM_Custom_Form_CustomData
::preProcess($this, $this->_eventNameCustomDataTypeID
, $eventId, 1, 'Participant', $this->_id
);
438 CRM_Custom_Form_CustomData
::buildQuickForm($this);
439 CRM_Custom_Form_CustomData
::setDefaultValues($this);
441 // custom data of type participant event type
444 $eventTypeId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $eventId, 'event_type_id', 'id');
446 CRM_Custom_Form_CustomData
::preProcess($this, $this->_eventTypeCustomDataTypeID
, $eventTypeId,
447 1, 'Participant', $this->_id
449 CRM_Custom_Form_CustomData
::buildQuickForm($this);
450 CRM_Custom_Form_CustomData
::setDefaultValues($this);
452 //custom data of type participant, ( we 'null' to reset subType and subName)
453 CRM_Custom_Form_CustomData
::preProcess($this, 'null', 'null', 1, 'Participant', $this->_id
);
454 CRM_Custom_Form_CustomData
::buildQuickForm($this);
455 CRM_Custom_Form_CustomData
::setDefaultValues($this);
458 // CRM-4395, get the online pending contribution id.
459 $this->_onlinePendingContributionId
= NULL;
460 if (!$this->_mode
&& $this->_id
&& ($this->_action
& CRM_Core_Action
::UPDATE
)) {
461 $this->_onlinePendingContributionId
= CRM_Contribute_BAO_Contribution
::checkOnlinePendingContribution($this->_id
,
465 $this->set('onlinePendingContributionId', $this->_onlinePendingContributionId
);
469 * This function sets the default values for the form in edit/view mode
470 * the default values are retrieved from the database
473 * @throws \CRM_Core_Exception
475 public function setDefaultValues() {
476 if ($this->_showFeeBlock
) {
477 return CRM_Event_Form_EventFees
::setDefaultValues($this);
482 if ($this->_action
& CRM_Core_Action
::DELETE
) {
488 $params = ['id' => $this->_id
];
490 CRM_Event_BAO_Participant
::getValues($params, $defaults, $ids);
491 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
492 if ($defaults[$this->_id
]['role_id']) {
493 $roleIDs = explode($sep, $defaults[$this->_id
]['role_id']);
495 $this->_contactId
= $defaults[$this->_id
]['contact_id'];
496 $this->_statusId
= $defaults[$this->_id
]['participant_status_id'];
498 //set defaults for note
499 $noteDetails = CRM_Core_BAO_Note
::getNote($this->_id
, 'civicrm_participant');
500 $defaults[$this->_id
]['note'] = array_pop($noteDetails);
502 // Check if this is a primaryParticipant (registered for others) and retrieve additional participants if true (CRM-4859)
503 if (CRM_Event_BAO_Participant
::isPrimaryParticipant($this->_id
)) {
504 $this->assign('additionalParticipants', CRM_Event_BAO_Participant
::getAdditionalParticipants($this->_id
));
507 // Get registered_by contact ID and display_name if participant was registered by someone else (CRM-4859)
508 if (!empty($defaults[$this->_id
]['participant_registered_by_id'])) {
509 $registered_by_contact_id = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
510 $defaults[$this->_id
]['participant_registered_by_id'],
513 $this->assign('participant_registered_by_id', $defaults[$this->_id
]['participant_registered_by_id']);
514 $this->assign('registered_by_contact_id', $registered_by_contact_id);
515 $this->assign('registered_by_display_name', CRM_Contact_BAO_Contact
::displayName($registered_by_contact_id));
518 elseif ($this->_contactID
) {
519 $defaults[$this->_id
]['contact_id'] = $this->_contactID
;
522 //setting default register date
523 if ($this->_action
== CRM_Core_Action
::ADD
) {
524 $statuses = array_flip(CRM_Event_PseudoConstant
::participantStatus());
525 $defaults[$this->_id
]['status_id'] = $statuses['Registered'] ??
NULL;
526 if (!empty($defaults[$this->_id
]['event_id'])) {
527 $contributionTypeId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event',
528 $defaults[$this->_id
]['event_id'],
531 if ($contributionTypeId) {
532 $defaults[$this->_id
]['financial_type_id'] = $contributionTypeId;
537 $fields["email-{$this->_bltID}"] = 1;
538 $fields['email-Primary'] = 1;
540 if ($this->_contactId
) {
541 CRM_Core_BAO_UFGroup
::setProfileDefaults($this->_contactId
, $fields, $defaults);
544 if (empty($defaults["email-{$this->_bltID}"]) &&
545 !empty($defaults['email-Primary'])
547 $defaults[$this->_id
]["email-{$this->_bltID}"] = $defaults['email-Primary'];
551 $submittedRole = $this->getElementValue('role_id');
552 if (!empty($submittedRole[0])) {
553 $roleID = $submittedRole[0];
555 $submittedEvent = $this->getElementValue('event_id');
556 if (!empty($submittedEvent[0])) {
557 $eventID = $submittedEvent[0];
559 $defaults[$this->_id
]['register_date'] = date('Y-m-d H:i:s');
562 $defaults[$this->_id
]['record_contribution'] = 0;
564 if ($defaults[$this->_id
]['participant_is_pay_later']) {
565 $this->assign('participant_is_pay_later', TRUE);
568 $this->assign('participant_status_id', $defaults[$this->_id
]['participant_status_id']);
569 $eventID = $defaults[$this->_id
]['event_id'];
571 $this->_eventTypeId
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $eventID, 'event_type_id', 'id');
573 $this->_discountId
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $this->_id
, 'discount_id');
574 if ($this->_discountId
) {
575 $this->set('discountId', $this->_discountId
);
579 //assign event and role id, this is needed for Custom data building
580 $sep = CRM_Core_DAO
::VALUE_SEPARATOR
;
581 if (!empty($defaults[$this->_id
]['participant_role_id'])) {
582 $roleIDs = explode($sep, $defaults[$this->_id
]['participant_role_id']);
584 if (isset($_POST['event_id'])) {
585 $eventID = $_POST['event_id'];
589 $eventID = $this->_eID
;
590 //@todo - rationalise the $this->_eID with $POST['event_id'], $this->_eid is set when eid=x is in the url
591 $roleID = CRM_Core_DAO
::getFieldValue(
592 'CRM_Event_DAO_Event',
596 if (empty($roleIDs)) {
597 $roleIDs = (array) $defaults[$this->_id
]['participant_role_id'] = $roleID;
599 $defaults[$this->_id
]['event_id'] = $eventID;
601 if (!empty($eventID)) {
602 $this->_eventTypeId
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $eventID, 'event_type_id', 'id');
604 //these should take precedence so we state them last
605 $urlRoleIDS = CRM_Utils_Request
::retrieve('roles', 'String');
607 $roleIDs = explode(',', $urlRoleIDS);
609 if (isset($roleIDs)) {
610 $defaults[$this->_id
]['role_id'] = implode(',', $roleIDs);
613 if (isset($eventID)) {
614 $this->assign('eventID', $eventID);
615 $this->set('eventId', $eventID);
618 if (isset($this->_eventTypeId
)) {
619 $this->assign('eventTypeID', $this->_eventTypeId
);
622 $this->assign('event_is_test', CRM_Utils_Array
::value('event_is_test', $defaults[$this->_id
]));
623 return $defaults[$this->_id
];
627 * Build the form object.
630 * @throws \CRM_Core_Exception
631 * @throws \CiviCRM_API3_Exception
633 public function buildQuickForm() {
635 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
636 $partiallyPaidStatusId = array_search('Partially paid', $participantStatuses);
637 $this->assign('partiallyPaidStatusId', $partiallyPaidStatusId);
639 if ($this->_showFeeBlock
) {
640 return $this->buildEventFeeForm($this);
643 //need to assign custom data type to the template
644 $this->assign('customDataType', 'Participant');
646 $this->applyFilter('__ALL__', 'trim');
648 if ($this->_action
& CRM_Core_Action
::DELETE
) {
649 if ($this->_single
) {
650 $additionalParticipant = count(CRM_Event_BAO_Event
::buildCustomProfile($this->_id
,
656 if ($additionalParticipant) {
657 $deleteParticipants = [
658 1 => ts('Delete this participant record along with associated participant record(s).'),
659 2 => ts('Delete only this participant record.'),
661 $this->addRadio('delete_participant', NULL, $deleteParticipants, NULL, '<br />');
662 $this->setDefaults(['delete_participant' => 1]);
663 $this->assign('additionalParticipant', $additionalParticipant);
669 'name' => ts('Delete'),
670 'spacing' => ' ',
675 'name' => ts('Cancel'),
681 if ($this->_single
) {
682 $contactField = $this->addEntityRef('contact_id', ts('Participant'), ['create' => TRUE, 'api' => ['extra' => ['email']]], TRUE);
683 if ($this->_context
!= 'standalone') {
684 $contactField->freeze();
688 $eventFieldParams = [
690 'select' => ['minimumInputLength' => 0],
692 'extra' => ['campaign_id', 'default_role_id', 'event_type_id'],
697 // exclude events which are not monetary when credit card registration is used
698 $eventFieldParams['api']['params']['is_monetary'] = 1;
700 $this->addPaymentProcessorSelect(TRUE, FALSE, FALSE);
702 $element = $this->addEntityRef('event_id', ts('Event'), $eventFieldParams, TRUE);
704 //frozen the field fix for CRM-4171
705 if ($this->_action
& CRM_Core_Action
::UPDATE
&& $this->_id
) {
706 if (CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment',
707 $this->_id
, 'contribution_id', 'participant_id'
714 //CRM-7362 --add campaigns.
717 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $this->_id
, 'campaign_id');
720 $eventId = CRM_Utils_Request
::retrieve('eid', 'Positive', $this);
722 $campaignId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $eventId, 'campaign_id');
725 CRM_Campaign_BAO_Campaign
::addCampaign($this, $campaignId);
726 $this->add('datepicker', 'register_date', ts('Registration Date'), [], TRUE, ['time' => TRUE]);
729 $this->assign('entityID', $this->_id
);
732 $this->addSelect('role_id', ['multiple' => TRUE, 'class' => 'huge'], TRUE);
735 $checkCancelledJs = ['onchange' => "return sendNotification( );"];
737 if ($this->_onlinePendingContributionId
) {
738 $cancelledparticipantStatusId = array_search('Cancelled', CRM_Event_PseudoConstant
::participantStatus());
739 $cancelledContributionStatusId = array_search('Cancelled',
740 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
742 $checkCancelledJs = [
743 'onchange' => "checkCancelled( this.value, {$cancelledparticipantStatusId},{$cancelledContributionStatusId});",
746 $participantStatusId = array_search('Pending from pay later',
747 CRM_Event_PseudoConstant
::participantStatus()
749 $contributionStatusId = array_search('Completed',
750 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
752 $confirmJS = ['onclick' => "return confirmStatus( {$participantStatusId}, {$contributionStatusId} );"];
755 // get the participant status names to build special status array which is used to show notification
756 // checkbox below participant status select
757 $participantStatusName = CRM_Event_PseudoConstant
::participantStatus();
758 $notificationStatuses = [
760 'Pending from waitlist',
761 'Pending from approval',
765 // get the required status and then implode only ids
766 $notificationStatusIds = implode(',', array_keys(array_intersect($participantStatusName, $notificationStatuses)));
767 $this->assign('notificationStatusIds', $notificationStatusIds);
769 $this->_participantStatuses
= $statusOptions = CRM_Event_BAO_Participant
::buildOptions('status_id', 'create');
771 // Only show refund status when editing
772 if ($this->_action
& CRM_Core_Action
::ADD
) {
773 $pendingRefundStatusId = array_search('Pending refund', $participantStatusName);
774 if ($pendingRefundStatusId) {
775 unset($statusOptions[$pendingRefundStatusId]);
779 $this->addSelect('status_id', $checkCancelledJs +
[
780 'options' => $statusOptions,
781 'option_url' => 'civicrm/admin/participant_status',
784 $this->addElement('checkbox', 'is_notify', ts('Send Notification'), NULL);
786 $this->addField('source', ['entity' => 'Participant', 'name' => 'source']);
787 $noteAttributes = CRM_Core_DAO
::getAttribute('CRM_Core_DAO_Note');
788 $this->add('textarea', 'note', ts('Notes'), $noteAttributes['note']);
792 'name' => ts('Save'),
797 $path = CRM_Utils_System
::currentPath();
799 'civicrm/contact/search',
800 'civicrm/group/search',
802 if (!in_array($path, $excludeForPaths)) {
805 'name' => ts('Save and New'),
813 'name' => ts('Cancel'),
816 $this->addButtons($buttons);
817 if ($this->_action
== CRM_Core_Action
::VIEW
) {
823 * Add local and global form rules.
827 public function addRules() {
828 $this->addFormRule(['CRM_Event_Form_Participant', 'formRule'], $this);
832 * Global validation rules for the form.
834 * @param array $values
835 * Posted values of the form.
840 * list of errors to be posted back to the form
842 public static function formRule($values, $files, $self) {
843 // If $values['_qf_Participant_next'] is Delete or
844 // $values['event_id'] is empty, then return
845 // instead of proceeding further.
847 if ((CRM_Utils_Array
::value('_qf_Participant_next', $values) == 'Delete') ||
848 (!$values['event_id'])
855 if (!empty($values['payment_processor_id'])) {
856 // make sure that payment instrument values (e.g. credit card number and cvv) are valid
857 CRM_Core_Payment_Form
::validatePaymentInstrument($values['payment_processor_id'], $values, $errorMsg, NULL);
860 if (!empty($values['record_contribution'])) {
861 if (empty($values['financial_type_id'])) {
862 $errorMsg['financial_type_id'] = ts('Please enter the associated Financial Type');
864 if (empty($values['payment_instrument_id'])) {
865 $errorMsg['payment_instrument_id'] = ts('Payment Method is a required field.');
867 if (!empty($values['priceSetId'])) {
868 CRM_Price_BAO_PriceField
::priceSetValidation($values['priceSetId'], $values, $errorMsg);
872 // validate contribution status for 'Failed'.
873 if ($self->_onlinePendingContributionId
&& !empty($values['record_contribution']) &&
874 (CRM_Utils_Array
::value('contribution_status_id', $values) ==
875 array_search('Failed', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'))
878 $errorMsg['contribution_status_id'] = ts('Please select a valid payment status before updating.');
881 // do the amount validations.
882 //skip for update mode since amount is freeze, CRM-6052
883 if ((!$self->_id
&& empty($values['total_amount']) &&
884 empty($self->_values
['line_items'])
886 ($self->_id
&& !$self->_paymentId
&& isset($self->_values
['line_items']) && is_array($self->_values
['line_items']))
888 if ($priceSetId = CRM_Utils_Array
::value('priceSetId', $values)) {
889 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $values, $errorMsg, TRUE);
892 // For single additions - show validation error if the contact has already been registered
894 if ($self->_single
&& ($self->_action
& CRM_Core_Action
::ADD
)) {
895 if ($self->_context
== 'standalone') {
896 $contactId = $values['contact_id'] ??
NULL;
899 $contactId = $self->_contactId
;
902 $eventId = $values['event_id'] ??
NULL;
904 $event = new CRM_Event_DAO_Event();
905 $event->id
= $eventId;
908 if (!$event->allow_same_participant_emails
&& !empty($contactId) && !empty($eventId)) {
909 $cancelledStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Event_BAO_Participant', 'status_id', 'Cancelled');
910 $dupeCheck = new CRM_Event_BAO_Participant();
911 $dupeCheck->contact_id
= $contactId;
912 $dupeCheck->event_id
= $eventId;
913 $dupeCheck->whereAdd("status_id != {$cancelledStatusID} ");
914 $dupeCheck->find(TRUE);
915 if (!empty($dupeCheck->id
)) {
916 $errorMsg['event_id'] = ts("This contact has already been assigned to this event.");
920 return CRM_Utils_Array
::crmIsEmptyArray($errorMsg) ?
TRUE : $errorMsg;
924 * Process the form submission.
926 public function postProcess() {
927 // get the submitted form values.
928 $params = $this->controller
->exportValues($this->_name
);
930 if ($this->_action
& CRM_Core_Action
::DELETE
) {
931 if (CRM_Utils_Array
::value('delete_participant', $params) == 2) {
932 $additionalId = (CRM_Event_BAO_Participant
::getAdditionalParticipantIds($this->_id
));
933 $participantLinks = (CRM_Event_BAO_Participant
::getAdditionalParticipantUrl($additionalId));
935 if (CRM_Utils_Array
::value('delete_participant', $params) == 1) {
936 $additionalIds = CRM_Event_BAO_Participant
::getAdditionalParticipantIds($this->_id
);
937 foreach ($additionalIds as $value) {
938 CRM_Event_BAO_Participant
::deleteParticipant($value);
941 CRM_Event_BAO_Participant
::deleteParticipant($this->_id
);
942 CRM_Core_Session
::setStatus(ts('Selected participant was deleted successfully.'), ts('Record Deleted'), 'success');
943 if (!empty($participantLinks)) {
944 $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;
945 CRM_Core_Session
::setStatus($status, ts('Group Payment Deleted'));
949 // When adding a single contact, the formRule prevents you from adding duplicates
950 // (See above in formRule()). When adding more than one contact, the duplicates are
951 // removed automatically and the user receives one notification.
952 if ($this->_action
& CRM_Core_Action
::ADD
) {
953 $event_id = $this->_eventId
;
954 if (empty($event_id) && !empty($params['event_id'])) {
955 $event_id = $params['event_id'];
957 if (!$this->_single
&& !empty($event_id)) {
958 $duplicateContacts = 0;
959 foreach ($this->_contactIds
as $k => $dupeCheckContactId) {
960 // Eliminate contacts that have already been assigned to this event.
961 $dupeCheck = new CRM_Event_BAO_Participant();
962 $dupeCheck->contact_id
= $dupeCheckContactId;
963 $dupeCheck->event_id
= $event_id;
964 $dupeCheck->find(TRUE);
965 if (!empty($dupeCheck->id
)) {
966 $duplicateContacts++
;
967 unset($this->_contactIds
[$k]);
970 if ($duplicateContacts > 0) {
972 "%1 contacts have already been assigned to this event. They were not added a second time.",
973 [1 => $duplicateContacts]
975 CRM_Core_Session
::setStatus($msg);
977 if (count($this->_contactIds
) == 0) {
978 CRM_Core_Session
::setStatus(ts("No participants were added."));
981 // We have to re-key $this->_contactIds so each contact has the same
982 // key as their corresponding record in the $participants array that
983 // will be created below.
984 $this->_contactIds
= array_values($this->_contactIds
);
988 $statusMsg = $this->submit($params);
989 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
990 $session = CRM_Core_Session
::singleton();
991 $buttonName = $this->controller
->getButtonName();
992 if ($this->_context
== 'standalone') {
993 if ($buttonName == $this->getButtonName('upload', 'new')) {
994 $urlParams = 'reset=1&action=add&context=standalone';
996 $urlParams .= '&mode=' . $this->_mode
;
999 $urlParams .= '&eid=' . $this->_eID
;
1001 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/participant/add', $urlParams));
1004 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
1005 "reset=1&cid={$this->_contactId}&selectedChild=participant"
1009 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1010 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/participant',
1011 "reset=1&action=add&context={$this->_context}&cid={$this->_contactId}"
1019 * @param array $params
1022 * @throws \CRM_Core_Exception
1023 * @throws \CiviCRM_API3_Exception
1025 public function submit($params) {
1026 if ($this->_mode
&& !$this->_isPaidEvent
) {
1027 CRM_Core_Error
::statusBounce(ts('Selected Event is not Paid Event '));
1029 $participantStatus = CRM_Event_PseudoConstant
::participantStatus();
1030 // set the contact, when contact is selected
1031 if (!empty($params['contact_id'])) {
1032 $this->_contactID
= $this->_contactId
= $params['contact_id'];
1034 if (!$this->_priceSetId
&& $this->_isPaidEvent
) {
1035 CRM_Core_Error
::deprecatedFunctionWarning('this should never be true, handling to be removed');
1037 if ($this->_priceSetId
&& $isQuickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1038 $this->_quickConfig
= $isQuickConfig;
1042 $params['id'] = $this->_id
;
1045 $config = CRM_Core_Config
::singleton();
1046 if (isset($params['total_amount'])) {
1047 $params['total_amount'] = CRM_Utils_Rule
::cleanMoney($params['total_amount']);
1049 if ($this->_isPaidEvent
) {
1050 list($contributionParams, $lineItem, $additionalParticipantDetails, $params) = $this->preparePaidEventProcessing($params);
1053 $this->_params
= $params;
1054 parent
::beginPostProcess();
1056 if (isset($params['amount'])) {
1057 $amountOwed = $params['amount'];
1058 unset($params['amount']);
1060 $params['contact_id'] = $this->_contactId
;
1062 // overwrite actual payment amount if entered
1063 if (!empty($params['total_amount'])) {
1064 $contributionParams['total_amount'] = $params['total_amount'] ??
NULL;
1067 // Retrieve the name and email of the current user - this will be the FROM for the receipt email
1068 $userName = CRM_Core_Session
::singleton()->getLoggedInContactDisplayName();
1070 if ($this->_contactId
) {
1071 list($this->_contributorDisplayName
, $this->_contributorEmail
, $this->_toDoNotEmail
) = CRM_Contact_BAO_Contact
::getContactDetails($this->_contactId
);
1074 //modify params according to parameter used in create
1075 //participant method (addParticipant)
1076 $this->_params
['participant_status_id'] = $params['status_id'];
1077 $this->_params
['participant_role_id'] = is_array($params['role_id']) ?
$params['role_id'] : explode(',', $params['role_id']);
1078 $roleIdWithSeparator = implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->_params
['participant_role_id']);
1080 $now = date('YmdHis');
1083 // set source if not set
1084 if (empty($params['source'])) {
1085 $this->_params
['participant_source'] = ts('Offline Registration for Event: %2 by: %1', [
1087 2 => $this->getEventValue('title'),
1091 $this->_params
['participant_source'] = $params['source'];
1093 $this->_params
['description'] = $this->_params
['participant_source'];
1095 $this->_paymentProcessor
= CRM_Financial_BAO_PaymentProcessor
::getPayment($this->_params
['payment_processor_id'],
1100 // set email for primary location.
1101 $fields['email-Primary'] = 1;
1102 $params['email-Primary'] = $params["email-{$this->_bltID}"] = $this->_contributorEmail
;
1104 // now set the values for the billing location.
1105 foreach ($this->_fields
as $name => $dontCare) {
1109 // also add location name to the array
1110 $params["address_name-{$this->_bltID}"]
1111 = CRM_Utils_Array
::value('billing_first_name', $params) . ' ' .
1112 CRM_Utils_Array
::value('billing_middle_name', $params) . ' ' .
1113 CRM_Utils_Array
::value('billing_last_name', $params);
1115 $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
1116 $fields["address_name-{$this->_bltID}"] = 1;
1117 $fields["email-{$this->_bltID}"] = 1;
1118 $ctype = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactId
, 'contact_type');
1120 $nameFields = ['first_name', 'middle_name', 'last_name'];
1122 foreach ($nameFields as $name) {
1124 if (array_key_exists("billing_$name", $params)) {
1125 $params[$name] = $params["billing_{$name}"];
1126 $params['preserveDBName'] = TRUE;
1129 $contactID = CRM_Contact_BAO_Contact
::createProfileContact($params, $fields, $this->_contactId
, NULL, NULL, $ctype);
1132 if (!empty($this->_params
['participant_role_id'])) {
1133 $customFieldsRole = [];
1134 foreach ($this->_params
['participant_role_id'] as $roleKey) {
1135 $customFieldsRole = CRM_Utils_Array
::crmArrayMerge(CRM_Core_BAO_CustomField
::getFields('Participant',
1136 FALSE, FALSE, $roleKey, $this->_roleCustomDataTypeID
), $customFieldsRole);
1138 $customFieldsEvent = CRM_Core_BAO_CustomField
::getFields('Participant',
1141 CRM_Utils_Array
::value('event_id', $params),
1142 $this->_eventNameCustomDataTypeID
1144 $customFieldsEventType = CRM_Core_BAO_CustomField
::getFields('Participant',
1147 $this->_eventTypeId
,
1148 $this->_eventTypeCustomDataTypeID
1150 $customFields = CRM_Utils_Array
::crmArrayMerge($customFieldsRole,
1151 CRM_Core_BAO_CustomField
::getFields('Participant', FALSE, FALSE, NULL, NULL, TRUE)
1153 $customFields = CRM_Utils_Array
::crmArrayMerge($customFieldsEvent, $customFields);
1154 $customFields = CRM_Utils_Array
::crmArrayMerge($customFieldsEventType, $customFields);
1156 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params, $this->_id
, $this->getDefaultEntity());
1159 //do cleanup line items if participant edit the Event Fee.
1160 if (($this->_lineItem ||
!isset($params['proceSetId'])) && !$this->_paymentId
&& $this->_id
) {
1161 CRM_Price_BAO_LineItem
::deleteLineItems($this->_id
, 'civicrm_participant');
1165 // add all the additional payment params we need
1166 $this->_params
= $this->prepareParamsForPaymentProcessor($this->_params
);
1167 $this->_params
['amount'] = $params['fee_amount'];
1168 $this->_params
['amount_level'] = $params['amount_level'];
1169 $this->_params
['currencyID'] = $config->defaultCurrency
;
1170 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1172 // at this point we've created a contact and stored its address etc
1173 // all the payment processors expect the name and address to be in the
1174 // so we copy stuff over to first_name etc.
1175 $paymentParams = $this->_params
;
1176 if (!empty($this->_params
['send_receipt'])) {
1177 $paymentParams['email'] = $this->_contributorEmail
;
1180 // The only reason for merging in the 'contact_id' rather than ensuring it is set
1181 // is that this patch is being done around the time of the stable release
1182 // so more conservative approach is called for.
1183 // In fact the use of $params and $this->_params & $this->_contactId vs $contactID
1184 // needs rationalising.
1185 $mapParams = array_merge(['contact_id' => $contactID], $this->_params
);
1186 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $mapParams, $paymentParams, TRUE);
1188 $payment = $this->_paymentProcessor
['object'];
1190 // CRM-15622: fix for incorrect contribution.fee_amount
1191 $paymentParams['fee_amount'] = NULL;
1193 $result = $payment->doPayment($paymentParams);
1195 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
1196 // @todo un comment the following line out when we are creating a contribution before we get to this point
1197 // see dev/financial#53 about ensuring we create a pending contribution before we try processing payment
1198 // CRM_Contribute_BAO_Contribution::failPayment($contributionID);
1199 CRM_Core_Session
::singleton()->setStatus($e->getMessage());
1200 CRM_Utils_System
::redirect(CRM_Utils_System
::url('civicrm/contact/view/participant',
1201 "reset=1&action=add&cid={$this->_contactId}&context=participant&mode={$this->_mode}"
1206 $this->_params
= array_merge($this->_params
, $result);
1209 $this->_params
['receive_date'] = $now;
1211 if (!empty($this->_params
['send_receipt'])) {
1212 $this->_params
['receipt_date'] = $now;
1215 $this->_params
['receipt_date'] = NULL;
1218 $this->set('params', $this->_params
);
1219 $this->assign('trxn_id', $result['trxn_id']);
1220 $this->assign('receive_date', $this->_params
['receive_date']);
1222 //add contribution record
1223 $this->_params
['financial_type_id']
1224 = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $params['event_id'], 'financial_type_id');
1225 $this->_params
['mode'] = $this->_mode
;
1227 //add contribution record
1228 $contributions[] = $contribution = $this->processContribution(
1229 $this, $this->_params
,
1230 $result, $contactID,
1232 $this->_paymentProcessor
1235 // add participant record
1237 if (!empty($this->_params
['role_id']) && is_array($this->_params
['role_id'])) {
1238 $this->_params
['role_id'] = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1239 $this->_params
['role_id']
1243 //CRM-15372 patch to fix fee amount replacing amount
1244 $this->_params
['fee_amount'] = $this->_params
['amount'];
1246 $participants[] = $this->addParticipant($this, $this->_params
, $contactID);
1248 //add custom data for participant
1249 CRM_Core_BAO_CustomValueTable
::postProcess($this->_params
,
1250 'civicrm_participant',
1251 $participants[0]->id
,
1255 // Add participant payment
1256 $participantPaymentParams = [
1257 'participant_id' => $participants[0]->id
,
1258 'contribution_id' => $contribution->id
,
1260 civicrm_api3('ParticipantPayment', 'create', $participantPaymentParams);
1262 $this->_contactIds
[] = $this->_contactId
;
1265 if ($this->_single
) {
1266 $this->_contactIds
[] = $this->_contactId
;
1269 foreach ($this->_contactIds
as $contactID) {
1270 $commonParams = $params;
1271 $commonParams['contact_id'] = $contactID;
1272 $participants[] = CRM_Event_BAO_Participant
::create($commonParams);
1275 $contributions = [];
1276 if (!empty($params['record_contribution'])) {
1277 if (!empty($params['id'])) {
1278 if ($this->_onlinePendingContributionId
) {
1279 $contributionParams['id'] = $this->_onlinePendingContributionId
;
1282 $contributionParams['id'] = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment',
1289 unset($params['note']);
1291 //build contribution params
1292 if (!$this->_onlinePendingContributionId
) {
1293 if (empty($params['source'])) {
1294 $contributionParams['source'] = ts('%1 : Offline registration (by %2)', [
1295 1 => $this->getEventValue('title'),
1300 $contributionParams['source'] = $params['source'];
1304 $contributionParams['currency'] = $config->defaultCurrency
;
1305 $contributionParams['non_deductible_amount'] = 'null';
1306 $contributionParams['receipt_date'] = !empty($params['send_receipt']) ? CRM_Utils_Array
::value('receive_date', $params) : 'null';
1307 $contributionParams['contact_id'] = $this->_contactID
;
1308 $contributionParams['receive_date'] = CRM_Utils_Array
::value('receive_date', $params, 'null');
1310 $recordContribution = [
1311 'financial_type_id',
1312 'payment_instrument_id',
1314 'contribution_status_id',
1321 foreach ($recordContribution as $f) {
1322 $contributionParams[$f] = $this->_params
[$f] ??
NULL;
1323 if ($f == 'trxn_id') {
1324 $this->assign('trxn_id', $contributionParams[$f]);
1328 //insert financial type name in receipt.
1329 $this->assign('financialTypeName', CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType',
1330 $contributionParams['financial_type_id']));
1332 $this->assign('contributionTypeName', CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialType', $contributionParams['financial_type_id']));
1333 $contributionParams['skipLineItem'] = 1;
1335 $contributionParams['contribution_mode'] = 'participant';
1336 $contributionParams['participant_id'] = $this->_id
;
1338 // Set is_pay_later flag for back-office offline Pending status contributions
1339 if ($contributionParams['contribution_status_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Pending')) {
1340 $contributionParams['is_pay_later'] = 1;
1342 elseif ($contributionParams['contribution_status_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Completed')) {
1343 $contributionParams['is_pay_later'] = 0;
1346 if ($params['status_id'] == array_search('Partially paid', $participantStatus)) {
1347 if (!$amountOwed && $this->_action
& CRM_Core_Action
::UPDATE
) {
1348 $amountOwed = $params['fee_amount'];
1351 // if multiple participants are link, consider contribution total amount as the amount Owed
1352 if ($this->_id
&& CRM_Event_BAO_Participant
::isPrimaryParticipant($this->_id
)) {
1353 $amountOwed = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
1354 $contributionParams['id'],
1359 // CRM-13964 partial_payment_total
1360 if ($amountOwed > $params['total_amount']) {
1362 $contributionParams['total_amount'] = $amountOwed;
1363 $contributionParams['contribution_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1364 $this->assign('balanceAmount', $amountOwed - $params['total_amount']);
1365 $this->storePaymentCreateParams($params);
1369 if (!empty($this->_params
['tax_amount'])) {
1370 $contributionParams['tax_amount'] = $this->_params
['tax_amount'];
1373 if ($this->_single
) {
1374 $contributions[] = CRM_Contribute_BAO_Contribution
::create($contributionParams);
1377 foreach ($this->_contactIds
as $contactID) {
1378 $contributionParams['contact_id'] = $contactID;
1379 $contributions[] = CRM_Contribute_BAO_Contribution
::create($contributionParams);
1383 // Insert payment record for this participant
1384 if (empty($contributionParams['id'])) {
1385 foreach ($this->_contactIds
as $num => $contactID) {
1386 $participantPaymentParams = [
1387 'participant_id' => $participants[$num]->id
,
1388 'contribution_id' => $contributions[$num]->id
,
1390 civicrm_api3('ParticipantPayment', 'create', $participantPaymentParams);
1395 if ($this->_params
['discount_id']) {
1396 CRM_Event_BAO_Participant
::createDiscountTrxn(
1398 $contributionParams,
1400 CRM_Price_BAO_PriceSet
::parseFirstPriceSetValueIDFromParams($this->_params
)
1406 // also store lineitem stuff here
1407 if ((($this->_lineItem
& $this->_action
& CRM_Core_Action
::ADD
) ||
1408 ($this->_lineItem
&& CRM_Core_Action
::UPDATE
&& !$this->_paymentId
))
1410 foreach ($this->_contactIds
as $num => $contactID) {
1411 foreach ($this->_lineItem
as $key => $value) {
1412 if (is_array($value) && $value != 'skip') {
1413 foreach ($value as $lineKey => $line) {
1414 //10117 update the line items for participants if contribution amount is recorded
1415 if ($this->_quickConfig
&& !empty($params['total_amount']) &&
1416 ($params['status_id'] != array_search('Partially paid', $participantStatus))
1418 $line['unit_price'] = $line['line_total'] = $params['total_amount'];
1419 if (!empty($params['tax_amount'])) {
1420 $line['unit_price'] = $line['unit_price'] - $params['tax_amount'];
1421 $line['line_total'] = $line['line_total'] - $params['tax_amount'];
1424 $lineItem[$this->_priceSetId
][$lineKey] = $line;
1426 CRM_Price_BAO_LineItem
::processPriceSet($participants[$num]->id
, $lineItem, CRM_Utils_Array
::value($num, $contributions, NULL), 'civicrm_participant');
1430 foreach ($contributions as $contribution) {
1431 if (!empty($this->getCreatePaymentParams())) {
1432 civicrm_api3('Payment', 'create', array_merge(['contribution_id' => $contribution->id
], $this->getCreatePaymentParams()));
1437 $updateStatusMsg = NULL;
1438 //send mail when participant status changed, CRM-4326
1439 if ($this->_id
&& $this->_statusId
&&
1440 $this->_statusId
!= CRM_Utils_Array
::value('status_id', $params) && !empty($params['is_notify'])
1443 $updateStatusMsg = CRM_Event_BAO_Participant
::updateStatusMessage($this->_id
,
1444 $params['status_id'],
1451 if (!empty($params['send_receipt'])) {
1453 $this->assign('module', 'Event Registration');
1454 $this->assignEventDetailsToTpl($params['event_id'], CRM_Utils_Array
::value('role_id', $params), CRM_Utils_Array
::value('receipt_text', $params), $this->_isPaidEvent
);
1455 $this->assign('isAmountzero', 1);
1457 if ($this->_isPaidEvent
) {
1458 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
1459 if (!$this->_mode
) {
1460 if (isset($params['payment_instrument_id'])) {
1461 $this->assign('paidBy',
1462 CRM_Utils_Array
::value($params['payment_instrument_id'],
1469 $this->assign('totalAmount', $params['total_amount'] ??
$contributionParams['total_amount']);
1470 $this->assign('isPrimary', 1);
1471 $this->assign('checkNumber', CRM_Utils_Array
::value('check_number', $params));
1474 $this->assignBillingName($params);
1475 $this->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
1480 $date = CRM_Utils_Date
::format($params['credit_card_exp_date']);
1481 $date = CRM_Utils_Date
::mysqlToIso($date);
1482 $this->assign('credit_card_exp_date', $date);
1483 $this->assign('credit_card_number',
1484 CRM_Utils_System
::mungeCreditCard($params['credit_card_number'])
1486 $this->assign('credit_card_type', $params['credit_card_type']);
1487 // The concept of contributeMode is deprecated.
1488 $this->assign('contributeMode', 'direct');
1489 $this->assign('isAmountzero', 0);
1490 $this->assign('is_pay_later', 0);
1491 $this->assign('isPrimary', 1);
1494 $this->assign('register_date', $params['register_date']);
1495 if (isset($params['receive_date'])) {
1496 $this->assign('receive_date', $params['receive_date']);
1500 //format submitted data
1501 foreach ($params['custom'] as $fieldID => $values) {
1502 foreach ($values as $fieldValue) {
1503 $isPublic = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $fieldValue['custom_group_id'], 'is_public');
1505 $customFields[$fieldID]['id'] = $fieldID;
1506 $formattedValue = CRM_Core_BAO_CustomField
::displayValue($fieldValue['value'], $fieldID, $participants[0]->id
);
1507 $customGroup[$customFields[$fieldID]['groupTitle']][$customFields[$fieldID]['label']] = str_replace(' ', '', $formattedValue);
1512 foreach ($this->_contactIds
as $num => $contactID) {
1513 // Retrieve the name and email of the contact - this will be the TO for receipt email
1514 list($this->_contributorDisplayName
, $this->_contributorEmail
, $this->_toDoNotEmail
) = CRM_Contact_BAO_Contact
::getContactDetails($contactID);
1516 $this->_contributorDisplayName
= ($this->_contributorDisplayName
== ' ') ?
$this->_contributorEmail
: $this->_contributorDisplayName
;
1518 $waitStatus = CRM_Event_PseudoConstant
::participantStatus(NULL, "class = 'Waiting'");
1519 if ($waitingStatus = CRM_Utils_Array
::value($params['status_id'], $waitStatus)) {
1520 $this->assign('isOnWaitlist', TRUE);
1523 $this->assign('customGroup', $customGroup);
1524 $this->assign('contactID', $contactID);
1525 $this->assign('participantID', $participants[$num]->id
);
1527 $this->_id
= $participants[$num]->id
;
1529 if ($this->_isPaidEvent
) {
1530 // fix amount for each of participants ( for bulk mode )
1532 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
1533 $invoicing = $invoiceSettings['invoicing'] ??
NULL;
1534 $totalTaxAmount = 0;
1536 //add dataArray in the receipts in ADD and UPDATE condition
1538 if ($this->_action
& CRM_Core_Action
::ADD
) {
1539 $line = $lineItem[0] ??
[];
1541 elseif ($this->_action
& CRM_Core_Action
::UPDATE
) {
1542 $line = $this->_values
['line_items'];
1545 foreach ($line as $key => $value) {
1546 if (isset($value['tax_amount'])) {
1547 $totalTaxAmount +
= $value['tax_amount'];
1548 if (isset($dataArray[(string) $value['tax_rate']])) {
1549 $dataArray[(string) $value['tax_rate']] = $dataArray[(string) $value['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $value);
1552 $dataArray[(string) $value['tax_rate']] = $value['tax_amount'] ??
NULL;
1556 $this->assign('totalTaxAmount', $totalTaxAmount);
1557 $this->assign('taxTerm', $this->getSalesTaxTerm());
1558 $this->assign('dataArray', $dataArray);
1560 if (!empty($additionalParticipantDetails)) {
1561 $params['amount_level'] = preg_replace('/\ 1/', '', $params['amount_level']) . ' - ' . $this->_contributorDisplayName
;
1564 $eventAmount[$num] = [
1565 'label' => preg_replace('/\ 1/', '', $params['amount_level']),
1566 'amount' => $params['fee_amount'],
1568 //as we are using same template for online & offline registration.
1569 //So we have to build amount as array.
1570 $eventAmount = array_merge($eventAmount, $additionalParticipantDetails);
1571 $this->assign('amount', $eventAmount);
1574 $sendTemplateParams = [
1575 'groupName' => 'msg_tpl_workflow_event',
1576 'valueName' => 'event_offline_receipt',
1577 'contactId' => $contactID,
1578 'isTest' => !empty($this->_defaultValues
['is_test']),
1579 'PDFFilename' => ts('confirmation') . '.pdf',
1582 // try to send emails only if email id is present
1583 // and the do-not-email option is not checked for that contact
1584 if ($this->_contributorEmail
and !$this->_toDoNotEmail
) {
1585 if (array_key_exists($params['from_email_address'], $this->_fromEmails
['from_email_id'])) {
1586 $receiptFrom = $params['from_email_address'];
1588 $sendTemplateParams['from'] = $receiptFrom;
1589 $sendTemplateParams['toName'] = $this->_contributorDisplayName
;
1590 $sendTemplateParams['toEmail'] = $this->_contributorEmail
;
1591 $sendTemplateParams['cc'] = $this->_fromEmails
['cc'] ??
NULL;
1592 $sendTemplateParams['bcc'] = $this->_fromEmails
['bcc'] ??
NULL;
1595 //send email with pdf invoice
1596 $template = CRM_Core_Smarty
::singleton();
1597 $taxAmt = $template->get_template_vars('dataArray');
1598 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment',
1599 $this->_id
, 'contribution_id', 'participant_id'
1601 $prefixValue = Civi
::settings()->get('contribution_invoice_settings');
1602 $invoicing = $prefixValue['invoicing'] ??
NULL;
1603 if (!empty($taxAmt) && (isset($invoicing) && isset($prefixValue['is_email_pdf']))) {
1604 $sendTemplateParams['isEmailPdf'] = TRUE;
1605 $sendTemplateParams['contributionId'] = $contributionId;
1607 list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate
::sendTemplate($sendTemplateParams);
1609 $sent[] = $contactID;
1610 foreach ($participants as $ids => $values) {
1611 if ($values->contact_id
== $contactID) {
1612 $values->details
= $params['receipt_text'] ??
NULL;
1613 CRM_Activity_BAO_Activity
::addActivity($values, 'Email');
1619 $notSent[] = $contactID;
1624 // set the participant id if it is not set
1626 $this->_id
= $participants[0]->id
;
1629 return $this->getStatusMsg($params, $sent, $updateStatusMsg, $notSent);
1633 * Set the various IDs relating to custom data types.
1635 public function setCustomDataTypes() {
1636 $customDataType = CRM_Core_OptionGroup
::values('custom_data_type', FALSE, FALSE, FALSE, NULL, 'name');
1637 $this->_roleCustomDataTypeID
= array_search('ParticipantRole', $customDataType);
1638 $this->_eventNameCustomDataTypeID
= array_search('ParticipantEventName', $customDataType);
1639 $this->_eventTypeCustomDataTypeID
= array_search('ParticipantEventType', $customDataType);
1640 $this->assign('roleCustomDataTypeID', $this->_roleCustomDataTypeID
);
1641 $this->assign('eventNameCustomDataTypeID', $this->_eventNameCustomDataTypeID
);
1642 $this->assign('eventTypeCustomDataTypeID', $this->_eventTypeCustomDataTypeID
);
1646 * Get status message
1648 * @param array $params
1650 * @param string $updateStatusMsg
1651 * @param int $notSent
1655 protected function getStatusMsg($params, $sent, $updateStatusMsg, $notSent) {
1657 if (($this->_action
& CRM_Core_Action
::UPDATE
)) {
1658 $statusMsg = ts('Event registration information for %1 has been updated.', [1 => $this->_contributorDisplayName
]);
1659 if (!empty($params['send_receipt']) && count($sent)) {
1660 $statusMsg .= ' ' . ts('A confirmation email has been sent to %1', [1 => $this->_contributorEmail
]);
1663 if ($updateStatusMsg) {
1664 $statusMsg = "{$statusMsg} {$updateStatusMsg}";
1667 elseif ($this->_action
& CRM_Core_Action
::ADD
) {
1668 if ($this->_single
) {
1669 $statusMsg = ts('Event registration for %1 has been added.', [1 => $this->_contributorDisplayName
]);
1670 if (!empty($params['send_receipt']) && count($sent)) {
1671 $statusMsg .= ' ' . ts('A confirmation email has been sent to %1.', [1 => $this->_contributorEmail
]);
1675 $statusMsg = ts('Total Participant(s) added to event: %1.', [1 => count($this->_contactIds
)]);
1676 if (count($notSent) > 0) {
1677 $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)]);
1679 elseif (isset($params['send_receipt'])) {
1680 $statusMsg .= ' ' . ts('A confirmation email has been sent to ALL participants');
1688 * Build the form object.
1690 * @param \CRM_Event_Form_Participant $form
1693 * @throws \CRM_Core_Exception
1694 * @throws \Exception
1696 public function buildEventFeeForm($form) {
1697 if ($form->_eventId
) {
1698 $form->_isPaidEvent
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Event', $form->_eventId
, 'is_monetary');
1699 if ($form->_isPaidEvent
) {
1700 $form->addElement('hidden', 'hidden_feeblock', 1);
1703 $eventfullMsg = CRM_Event_BAO_Participant
::eventFullMessage($form->_eventId
, $this->getParticipantID());
1704 $form->addElement('hidden', 'hidden_eventFullMsg', $eventfullMsg, ['id' => 'hidden_eventFullMsg']);
1707 if ($form->_isPaidEvent
) {
1708 $params = ['id' => $form->_eventId
];
1709 CRM_Event_BAO_Event
::retrieve($params, $event);
1711 //retrieve custom information
1712 $form->_values
= [];
1713 CRM_Event_Form_Registration
::initEventFee($form, $event['id']);
1714 CRM_Event_Form_Registration_Register
::buildAmount($form, TRUE, $form->_discountId
);
1716 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
1717 $invoicing = $invoiceSettings['invoicing'] ??
NULL;
1718 $totalTaxAmount = 0;
1719 if (!CRM_Utils_System
::isNull(CRM_Utils_Array
::value('line_items', $form->_values
))) {
1720 $lineItem[] = $form->_values
['line_items'];
1721 foreach ($form->_values
['line_items'] as $key => $value) {
1722 $totalTaxAmount = $value['tax_amount'] +
$totalTaxAmount;
1726 $form->assign('totalTaxAmount', $totalTaxAmount);
1728 $form->assign('lineItem', empty($lineItem) ?
FALSE : $lineItem);
1730 if (!empty($form->_values
['discount'])) {
1731 foreach ($form->_values
['discount'] as $key => $value) {
1732 $value = current($value);
1733 $discounts[$key] = $value['name'];
1736 $element = $form->add('select', 'discount_id',
1739 0 => ts('- select -'),
1742 ['class' => "crm-select2"]
1745 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
1746 && empty($form->_values
['fee'])
1747 && CRM_Utils_Array
::value('snippet', $_REQUEST) == CRM_Core_Smarty
::PRINT_NOFORM
1749 CRM_Core_Session
::setStatus(ts('You do not have all the permissions needed for this page.'), 'Permission Denied', 'error');
1753 CRM_Core_Payment_Form
::buildPaymentForm($form, $form->_paymentProcessor
, FALSE, TRUE, self
::getDefaultPaymentInstrumentId());
1754 if (!$form->_mode
) {
1755 $form->addElement('checkbox', 'record_contribution', ts('Record Payment?'), NULL,
1756 ['onclick' => "return showHideByValue('record_contribution','','payment_information','table-row','radio',false);"]
1758 // Check permissions for financial type first
1759 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
1760 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, $form->_action
);
1763 $financialTypes = CRM_Contribute_PseudoConstant
::financialType();
1766 $form->add('select', 'financial_type_id',
1767 ts('Financial Type'),
1768 ['' => ts('- select -')] +
$financialTypes
1771 $form->add('datepicker', 'receive_date', ts('Received'), [], FALSE, ['time' => TRUE]);
1773 $form->add('select', 'payment_instrument_id',
1774 ts('Payment Method'),
1775 ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::paymentInstrument(),
1776 FALSE, ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
1778 // don't show transaction id in batch update mode
1779 $path = CRM_Utils_System
::currentPath();
1780 $form->assign('showTransactionId', FALSE);
1781 if ($path != 'civicrm/contact/search/basic') {
1782 $form->add('text', 'trxn_id', ts('Transaction ID'));
1783 $form->addRule('trxn_id', ts('Transaction ID already exists in Database.'),
1784 'objectExists', ['CRM_Contribute_DAO_Contribution', $form->_eventId
, 'trxn_id']
1786 $form->assign('showTransactionId', TRUE);
1789 $form->add('select', 'contribution_status_id',
1790 ts('Payment Status'), CRM_Contribute_BAO_Contribution_Utils
::getContributionStatuses('participant')
1793 $form->add('text', 'check_number', ts('Check Number'),
1794 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'check_number')
1797 $form->add('text', 'total_amount', ts('Amount'),
1798 CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution', 'total_amount')
1803 $form->add('text', 'amount', ts('Event Fee(s)'));
1805 $form->assign('onlinePendingContributionId', $form->get('onlinePendingContributionId'));
1807 $form->assign('paid', $form->_isPaidEvent
);
1809 $form->addElement('checkbox',
1811 ts('Send Confirmation?'), NULL,
1812 ['onclick' => "showHideByValue('send_receipt','','notice','table-row','radio',false); showHideByValue('send_receipt','','from-email','table-row','radio',false);"]
1815 $form->add('select', 'from_email_address', ts('Receipt From'), $form->_fromEmails
['from_email_id']);
1817 $form->add('textarea', 'receipt_text', ts('Confirmation Message'));
1819 // Retrieve the name and email of the contact - form will be the TO for receipt email ( only if context is not standalone)
1820 if ($form->_context
!= 'standalone') {
1821 if ($form->_contactId
) {
1822 list($form->_contributorDisplayName
,
1823 $form->_contributorEmail
1824 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($form->_contactId
);
1825 $form->assign('email', $form->_contributorEmail
);
1828 //show email block for batch update for event
1829 $form->assign('batchEmail', TRUE);
1833 $mailingInfo = Civi
::settings()->get('mailing_backend');
1834 $form->assign('outBound_option', $mailingInfo['outBound_option']);
1835 $form->assign('hasPayment', $form->_paymentId
);
1839 * Extracted code relating to paid events.
1845 * @throws \CiviCRM_API3_Exception
1847 protected function preparePaidEventProcessing($params): array {
1848 $participantStatus = CRM_Event_PseudoConstant
::participantStatus();
1849 $contributionParams = [
1850 'skipCleanMoney' => TRUE,
1851 'revenue_recognition_date' => $this->getRevenueRecognitionDate(),
1854 $additionalParticipantDetails = [];
1856 if ($this->isPaymentOnExistingContribution()) {
1857 $contributionParams['total_amount'] = $this->getParticipantValue('fee_amount');
1859 $params['discount_id'] = NULL;
1860 //re-enter the values for UPDATE mode
1861 $params['fee_level'] = $params['amount_level'] = $this->getParticipantValue('fee_level');
1862 $params['fee_amount'] = $this->getParticipantValue('fee_amount');
1863 if (isset($params['priceSetId'])) {
1864 CRM_Core_Error
::deprecatedFunctionWarning('It seems this line is never hit & can go.');
1865 $lineItem[0] = CRM_Price_BAO_LineItem
::getLineItems($this->_id
);
1867 //also add additional participant's fee level/priceset
1868 if (CRM_Event_BAO_Participant
::isPrimaryParticipant($this->_id
)) {
1869 $additionalIds = CRM_Event_BAO_Participant
::getAdditionalParticipantIds($this->_id
);
1870 $hasLineItems = CRM_Utils_Array
::value('priceSetId', $params, FALSE);
1871 $additionalParticipantDetails = $this->getFeeDetails($additionalIds, $hasLineItems);
1876 // check that discount_id is set
1877 if (empty($params['discount_id'])) {
1878 $params['discount_id'] = 'null';
1881 //lets carry currency, CRM-4453
1882 $params['fee_currency'] = CRM_Core_Config
::singleton()->defaultCurrency
;
1883 if (!isset($lineItem[0])) {
1886 CRM_Price_BAO_PriceSet
::processAmount($this->_values
['fee'],
1887 $params, $lineItem[0]
1889 //CRM-11529 for quick config backoffice transactions
1890 //when financial_type_id is passed in form, update the
1891 //lineitems with the financial type selected in form
1892 $submittedFinancialType = $params['financial_type_id'] ??
NULL;
1893 $isPaymentRecorded = $params['record_contribution'] ??
NULL;
1894 if ($isPaymentRecorded && $this->_quickConfig
&& $submittedFinancialType) {
1895 foreach ($lineItem[0] as &$values) {
1896 $values['financial_type_id'] = $submittedFinancialType;
1900 $params['fee_level'] = $params['amount_level'];
1901 $contributionParams['total_amount'] = $params['amount'];
1902 if ($this->_quickConfig
&& !empty($params['total_amount']) &&
1903 $params['status_id'] != array_search('Partially paid', $participantStatus)
1905 $params['fee_amount'] = $params['total_amount'];
1909 $params['fee_amount'] = $params['amount'];
1913 if (isset($params['priceSetId'])) {
1914 if (!empty($lineItem[0])) {
1915 $this->set('lineItem', $lineItem);
1917 $this->_lineItem
= $lineItem;
1918 $lineItem = array_merge($lineItem, $additionalParticipantDetails);
1920 $participantCount = [];
1921 foreach ($lineItem as $k) {
1922 foreach ($k as $v) {
1923 if (CRM_Utils_Array
::value('participant_count', $v) > 0) {
1924 $participantCount[] = $v['participant_count'];
1929 if (isset($participantCount)) {
1930 $this->assign('pricesetFieldsCount', $participantCount);
1932 $this->assign('lineItem', empty($lineItem[0]) ||
$this->_quickConfig ?
FALSE : $lineItem);
1935 $this->assign('amount_level', $params['amount_level']);
1937 return [$contributionParams, $lineItem, $additionalParticipantDetails, $params];
1942 * @param $participantRoles
1943 * @param $receiptText
1944 * @param $isPaidEvent
1948 protected function assignEventDetailsToTpl($eventID, $participantRoles, $receiptText, $isPaidEvent) {
1949 //use of the message template below requires variables in different format
1951 $returnProperties = ['event_type_id', 'fee_label', 'start_date', 'end_date', 'is_show_location', 'title'];
1953 //get all event details.
1954 CRM_Core_DAO
::commonRetrieveAll('CRM_Event_DAO_Event', 'id', $eventID, $events, $returnProperties);
1955 $event = $events[$eventID];
1956 unset($event['start_date']);
1957 unset($event['end_date']);
1959 $role = CRM_Event_PseudoConstant
::participantRole();
1961 if (is_array($participantRoles)) {
1962 $selectedRoles = [];
1963 foreach ($participantRoles as $roleId) {
1964 $selectedRoles[] = $role[$roleId];
1966 $event['participant_role'] = implode(', ', $selectedRoles);
1969 $event['participant_role'] = $role[$participantRoles] ??
NULL;
1971 $event['is_monetary'] = $isPaidEvent;
1974 $event['confirm_email_text'] = $receiptText;
1976 $this->assign('event', $event);
1977 $this->assign('isShowLocation', $event['is_show_location']);
1978 if (CRM_Utils_Array
::value('is_show_location', $event) == 1) {
1980 'entity_id' => $eventID,
1981 'entity_table' => 'civicrm_event',
1983 $location = CRM_Core_BAO_Location
::getValues($locationParams, TRUE);
1984 $this->assign('location', $location);
1989 * Process the contribution.
1991 * @param CRM_Core_Form $form
1992 * @param array $params
1993 * @param array $result
1994 * @param int $contactID
1995 * @param bool $pending
1996 * @param array $paymentProcessor
1998 * @return \CRM_Contribute_BAO_Contribution
2000 * @throws \CRM_Core_Exception
2001 * @throws \CiviCRM_API3_Exception
2003 public function processContribution(
2004 &$form, $params, $result, $contactID,
2006 $paymentProcessor = NULL
2008 $transaction = new CRM_Core_Transaction();
2010 $now = date('YmdHis');
2011 $receiptDate = NULL;
2013 if (!empty($form->_values
['event']['is_email_confirm'])) {
2014 $receiptDate = $now;
2017 // CRM-20264: fetch CC type ID and number (last 4 digit) and assign it back to $params
2018 CRM_Contribute_Form_AbstractEditPayment
::formatCreditCardDetails($params);
2021 'contact_id' => $contactID,
2022 'financial_type_id' => !empty($form->_values
['event']['financial_type_id']) ?
$form->_values
['event']['financial_type_id'] : $params['financial_type_id'],
2023 'receive_date' => $now,
2024 'total_amount' => $params['amount'],
2025 'tax_amount' => $params['tax_amount'],
2026 'amount_level' => $params['amount_level'],
2027 'invoice_id' => $params['invoiceID'],
2028 'currency' => $params['currencyID'],
2029 'source' => !empty($params['participant_source']) ?
$params['participant_source'] : $params['description'],
2030 'is_pay_later' => CRM_Utils_Array
::value('is_pay_later', $params, 0),
2031 'campaign_id' => $params['campaign_id'] ??
NULL,
2032 'card_type_id' => $params['card_type_id'] ??
NULL,
2033 'pan_truncation' => $params['pan_truncation'] ??
NULL,
2036 if ($paymentProcessor) {
2037 $contribParams['payment_instrument_id'] = $paymentProcessor['payment_instrument_id'];
2038 $contribParams['payment_processor'] = $paymentProcessor['id'];
2041 if (!$pending && $result) {
2043 'fee_amount' => $result['fee_amount'] ??
NULL,
2044 'trxn_id' => $result['trxn_id'],
2045 'receipt_date' => $receiptDate,
2049 $allStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2050 $contribParams['contribution_status_id'] = array_search('Completed', $allStatuses);
2052 $contribParams['contribution_status_id'] = array_search('Pending', $allStatuses);
2055 $contribParams['is_test'] = 0;
2056 if ($form->_action
& CRM_Core_Action
::PREVIEW || CRM_Utils_Array
::value('mode', $params) == 'test') {
2057 $contribParams['is_test'] = 1;
2060 if (!empty($contribParams['invoice_id'])) {
2061 $contribParams['id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2062 $contribParams['invoice_id'],
2067 $contribParams['revenue_recognition_date'] = $this->getRevenueRecognitionDate();
2069 //create an contribution address
2070 // The concept of contributeMode is deprecated. Elsewhere we use the function processBillingAddress() - although
2071 // currently that is only inherited by back-office forms.
2072 if ($form->_contributeMode
!= 'notify' && empty($params['is_pay_later'])) {
2073 $contribParams['address_id'] = CRM_Contribute_BAO_Contribution
::createAddress($params, $form->_bltID
);
2076 $contribParams['skipLineItem'] = 1;
2077 $contribParams['skipCleanMoney'] = 1;
2078 // create contribution record
2079 $contribution = CRM_Contribute_BAO_Contribution
::add($contribParams);
2081 CRM_Event_BAO_Participant
::createDiscountTrxn($form->_eventId
, $contribParams, NULL, CRM_Price_BAO_PriceSet
::parseFirstPriceSetValueIDFromParams($params));
2083 // process soft credit / pcp pages
2084 if (!empty($params['pcp_made_through_id'])) {
2085 CRM_Contribute_BAO_ContributionSoft
::formatSoftCreditParams($params, $form);
2086 CRM_Contribute_BAO_ContributionSoft
::processSoftContribution($params, $contribution);
2089 $transaction->commit();
2091 return $contribution;
2095 * Process the participant.
2097 * @param CRM_Core_Form $form
2098 * @param array $params
2099 * @param int $contactID
2101 * @return \CRM_Event_BAO_Participant
2102 * @throws \CRM_Core_Exception
2103 * @throws \CiviCRM_API3_Exception
2105 protected function addParticipant(&$form, $params, $contactID) {
2106 $transaction = new CRM_Core_Transaction();
2108 $participantFields = CRM_Event_DAO_Participant
::fields();
2109 $participantParams = [
2110 'id' => $params['participant_id'] ??
NULL,
2111 'contact_id' => $contactID,
2112 'event_id' => $form->_eventId ?
$form->_eventId
: $params['event_id'],
2113 'status_id' => CRM_Utils_Array
::value('participant_status',
2116 'role_id' => CRM_Utils_Array
::value('participant_role_id', $params) ?
: CRM_Event_BAO_Participant
::getDefaultRoleID(),
2117 'register_date' => $params['register_date'],
2118 'source' => CRM_Utils_String
::ellipsify(
2119 isset($params['participant_source']) ? CRM_Utils_Array
::value('participant_source', $params) : CRM_Utils_Array
::value('description', $params),
2120 $participantFields['participant_source']['maxlength']
2122 'fee_level' => $params['amount_level'] ??
NULL,
2123 'is_pay_later' => CRM_Utils_Array
::value('is_pay_later', $params, 0),
2124 'fee_amount' => $params['fee_amount'] ??
NULL,
2125 'registered_by_id' => $params['registered_by_id'] ??
NULL,
2126 'discount_id' => $params['discount_id'] ??
NULL,
2127 'fee_currency' => $params['currencyID'] ??
NULL,
2128 'campaign_id' => $params['campaign_id'] ??
NULL,
2131 if ($form->_action
& CRM_Core_Action
::PREVIEW || CRM_Utils_Array
::value('mode', $params) == 'test') {
2132 $participantParams['is_test'] = 1;
2135 $participantParams['is_test'] = 0;
2138 if (!empty($form->_params
['note'])) {
2139 $participantParams['note'] = $form->_params
['note'];
2141 elseif (!empty($form->_params
['participant_note'])) {
2142 $participantParams['note'] = $form->_params
['participant_note'];
2145 // reuse id if one already exists for this one (can happen
2146 // with back button being hit etc)
2147 if (!$participantParams['id'] && !empty($params['contributionID'])) {
2148 $pID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment',
2149 $params['contributionID'],
2153 $participantParams['id'] = $pID;
2155 $participantParams['discount_id'] = CRM_Core_BAO_Discount
::findSet($form->_eventId
, 'civicrm_event');
2157 if (!$participantParams['discount_id']) {
2158 $participantParams['discount_id'] = "null";
2161 $participant = CRM_Event_BAO_Participant
::create($participantParams);
2163 $transaction->commit();
2165 return $participant;
2169 * Is a payment being made on an existing contribution.
2172 * 1) ideally we should not permit this on this form! Perhaps we don't & this is just cruft.
2173 * 2) _paymentID is the contribution id.
2177 protected function isPaymentOnExistingContribution(): bool {
2178 return ($this->getParticipantID() && $this->_action
& CRM_Core_Action
::UPDATE
) && $this->_paymentId
;
2182 * Get the value for a field relating to the event.
2184 * @param string $fieldName
2187 * @throws \CiviCRM_API3_Exception
2189 protected function getEventValue(string $fieldName) {
2190 if (!isset($this->_event
)) {
2191 $this->_event
= civicrm_api3('Event', 'getsingle', ['id' => $this->_eventId
]);
2193 return $this->_event
[$fieldName];
2197 * Get a value from the existing participant record (applies to edits).
2199 * @param string $fieldName
2202 * @throws \CiviCRM_API3_Exception
2204 protected function getParticipantValue($fieldName) {
2205 if (!$this->participantRecord
) {
2206 $this->participantRecord
= civicrm_api3('Participant', 'getsingle', ['id' => $this->_id
]);
2208 return $this->participantRecord
[$fieldName] ??
$this->participantRecord
['participant_' . $fieldName];
2212 * Get id of participant being edited.
2216 protected function getParticipantID() {
2217 return $this->_id ??
$this->_pId
;
2221 * Get the value for the revenue recognition date field.
2225 * @throws \CiviCRM_API3_Exception
2227 protected function getRevenueRecognitionDate() {
2228 if (Civi
::settings()->get('deferred_revenue_enabled')) {
2229 $eventStartDate = $this->getEventValue('start_date');
2230 if (strtotime($eventStartDate) > strtotime(date('Ymt'))) {
2231 return date('Ymd', strtotime($eventStartDate));
2238 * Store the parameters to create a payment, if approprite, on the form.
2240 * @param array $params
2241 * Params as submitted.
2243 protected function storePaymentCreateParams($params) {
2244 if ('Completed' === CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution_status_id'])) {
2245 $this->setCreatePaymentParams([
2246 'total_amount' => $params['total_amount'],
2247 'is_send_contribution_notification' => FALSE,
2248 'payment_instrument_id' => $params['payment_instrument_id'],
2249 'trxn_date' => $params['receive_date'] ??
date('Y-m-d'),
2250 'trxn_id' => $params['trxn_id'],
2251 'pan_truncation' => $params['pan_truncation'] ??
'',
2252 'card_type_id' => $params['card_type_id'] ??
'',
2253 'check_number' => $params['check_number'] ??
'',
2254 'skipCleanMoney' => TRUE,
2260 * Get the event fee info for given participant ids
2261 * either from line item table / participant table.
2263 * @param array $participantIds
2265 * @param bool $hasLineItems
2266 * Do fetch from line items.
2270 public function getFeeDetails($participantIds, $hasLineItems = FALSE) {
2272 if (!is_array($participantIds) ||
empty($participantIds)) {
2277 SELECT participant.id as id,
2278 participant.fee_level as fee_level,
2279 participant.fee_amount as fee_amount';
2280 $from = 'FROM civicrm_participant participant';
2281 if ($hasLineItems) {
2283 lineItem.id as lineId,
2284 lineItem.label as label,
2285 lineItem.qty as qty,
2286 lineItem.unit_price as unit_price,
2287 lineItem.line_total as line_total,
2288 field.label as field_title,
2289 field.html_type as html_type,
2290 field.id as price_field_id,
2291 value.id as price_field_value_id,
2292 value.description as description,
2293 IF( value.count, value.count, 0 ) as participant_count';
2295 INNER JOIN civicrm_line_item lineItem ON ( lineItem.entity_table = 'civicrm_participant'
2296 AND lineItem.entity_id = participant.id )
2297 INNER JOIN civicrm_price_field field ON ( field.id = lineItem.price_field_id )
2298 INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_value_id )
2301 $where = 'WHERE participant.id IN ( ' . implode(', ', $participantIds) . ' )';
2302 $query = "$select $from $where";
2304 $feeInfo = CRM_Core_DAO
::executeQuery($query);
2305 $feeProperties = ['fee_level', 'fee_amount'];
2315 'participant_count',
2316 'price_field_value_id',
2319 while ($feeInfo->fetch()) {
2320 if ($hasLineItems) {
2321 foreach ($lineProperties as $property) {
2322 $feeDetails[$feeInfo->id
][$feeInfo->lineId
][$property] = $feeInfo->$property;
2326 foreach ($feeProperties as $property) {
2327 $feeDetails[$feeInfo->id
][$property] = $feeInfo->$property;