*/
/**
- *
+ * Back office participant form.
*
* @package CRM
* @copyright CiviCRM LLC https://civicrm.org/licensing
*/
/**
- * This class generates form components for processing a participation
- * in an event
+ * Back office participant form.
*/
class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment {
+ /**
+ * Participant ID - use getParticipantID.
+ *
+ * @var int
+ */
+ public $_pId;
+
+ /**
+ * ID of discount record.
+ *
+ * @var int
+ */
+ public $_discountId;
+
public $useLivePageJS = TRUE;
/**
/**
* If event is paid or unpaid.
+ *
* @var bool
*/
public $_isPaidEvent;
/**
* Page action.
+ *
* @var int
*/
public $_action;
/**
* Role Id.
+ *
* @var int
*/
protected $_roleId = NULL;
/**
* Event Type Id.
+ *
* @var int
*/
protected $_eventTypeId = NULL;
/**
* Participant status Id.
+ *
* @var int
*/
protected $_statusId = NULL;
/**
* Cache all the participant statuses.
+ *
* @var array
*/
protected $_participantStatuses;
/**
* Participant mode.
+ *
* @var string
*/
public $_mode = NULL;
/**
* Event ID preselect.
+ *
* @var int
*/
public $_eID = NULL;
/**
* Line Item for Price Set.
+ *
* @var array
*/
public $_lineItem = NULL;
/**
* Contribution mode for event registration for offline mode.
+ *
* @var string
* @deprecated
*/
/**
* Store id of role custom data type ( option value )
+ *
* @var int
*/
protected $_roleCustomDataTypeID;
/**
* Store id of event Name custom data type ( option value)
+ *
* @var int
*/
protected $_eventNameCustomDataTypeID;
/**
* Selected discount id.
+ *
* @var int
*/
public $_originalDiscountId = NULL;
/**
* Event id.
+ *
* @var int
*/
public $_eventId = NULL;
/**
* Id of payment, if any
+ *
* @var int
*/
public $_paymentId = NULL;
*/
public $_onlinePendingContributionId = NULL;
+ /**
+ * Stored participant record.
+ *
+ * @var array
+ */
+ protected $participantRecord;
+
/**
* Explicitly declare the entity api name.
*/
/**
* Set variables up before form is built.
*
- * @return void
* @throws \CRM_Core_Exception
+ * @throws \CiviCRM_API3_Exception
*/
public function preProcess() {
parent::preProcess();
if (!empty($params['contact_id'])) {
$this->_contactID = $this->_contactId = $params['contact_id'];
}
+ if (!$this->_priceSetId && $this->_isPaidEvent) {
+ CRM_Core_Error::deprecatedFunctionWarning('this should never be true, handling to be removed');
+ }
if ($this->_priceSetId && $isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config')) {
$this->_quickConfig = $isQuickConfig;
}
//participant method (addParticipant)
$this->_params['participant_status_id'] = $params['status_id'];
$this->_params['participant_role_id'] = is_array($params['role_id']) ? $params['role_id'] : explode(',', $params['role_id']);
- $this->_params['participant_register_date'] = $params['register_date'];
$roleIdWithSeparator = implode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_params['participant_role_id']);
$now = date('YmdHis');
$fields['email-Primary'] = 1;
$params['email-Primary'] = $params["email-{$this->_bltID}"] = $this->_contributorEmail;
- $params['register_date'] = $now;
-
// now set the values for the billing location.
foreach ($this->_fields as $name => $dontCare) {
$fields[$name] = 1;
//CRM-15372 patch to fix fee amount replacing amount
$this->_params['fee_amount'] = $this->_params['amount'];
- $participants[] = $this->addParticipant($this, $contactID);
+ $participants[] = $this->addParticipant($this, $this->_params, $contactID);
//add custom data for participant
CRM_Core_BAO_CustomValueTable::postProcess($this->_params,
$lineItem[$this->_priceSetId][$lineKey] = $line;
}
CRM_Price_BAO_LineItem::processPriceSet($participants[$num]->id, $lineItem, CRM_Utils_Array::value($num, $contributions, NULL), 'civicrm_participant');
- CRM_Contribute_BAO_Contribution::addPayments($contributions);
}
}
}
+ foreach ($contributions as $contribution) {
+ if ('Partially paid' === CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution->contribution_status_id)) {
+ CRM_Contribute_BAO_Contribution::addPayments($contribution);
+ }
+ }
}
$updateStatusMsg = NULL;
$sent = [];
$notSent = [];
if (!empty($params['send_receipt'])) {
- if (array_key_exists($params['from_email_address'], $this->_fromEmails['from_email_id'])) {
- $receiptFrom = $params['from_email_address'];
- }
$this->assign('module', 'Event Registration');
$this->assignEventDetailsToTpl($params['event_id'], CRM_Utils_Array::value('role_id', $params), CRM_Utils_Array::value('receipt_text', $params), $this->_isPaidEvent);
// try to send emails only if email id is present
// and the do-not-email option is not checked for that contact
if ($this->_contributorEmail and !$this->_toDoNotEmail) {
+ if (array_key_exists($params['from_email_address'], $this->_fromEmails['from_email_id'])) {
+ $receiptFrom = $params['from_email_address'];
+ }
$sendTemplateParams['from'] = $receiptFrom;
$sendTemplateParams['toName'] = $this->_contributorDisplayName;
$sendTemplateParams['toEmail'] = $this->_contributorEmail;
$form->addElement('hidden', 'hidden_feeblock', 1);
}
- $eventfullMsg = CRM_Event_BAO_Participant::eventFullMessage($form->_eventId, $form->_pId);
+ $eventfullMsg = CRM_Event_BAO_Participant::eventFullMessage($form->_eventId, $this->getParticipantID());
$form->addElement('hidden', 'hidden_eventFullMsg', $eventfullMsg, ['id' => 'hidden_eventFullMsg']);
}
- if ($form->_pId) {
- if (CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment',
- $form->_pId, 'contribution_id', 'participant_id'
- )
- ) {
- $form->_online = !$form->isBackOffice;
- }
- }
-
if ($form->_isPaidEvent) {
$params = ['id' => $form->_eventId];
CRM_Event_BAO_Event::retrieve($params, $event);
FALSE,
['class' => "crm-select2"]
);
-
- if ($form->_online) {
- $element->freeze();
- }
}
if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
&& !CRM_Utils_Array::value('fee', $form->_values)
*
* @return array
*
- * @throws \CRM_Core_Exception
* @throws \CiviCRM_API3_Exception
*/
protected function preparePaidEventProcessing($params): array {
$participantStatus = CRM_Event_PseudoConstant::participantStatus();
- $contributionParams = ['skipCleanMoney' => TRUE];
+ $contributionParams = [
+ 'skipCleanMoney' => TRUE,
+ 'revenue_recognition_date' => $this->getRevenueRecognitionDate(),
+ ];
$lineItem = [];
$additionalParticipantDetails = [];
- if (Civi::settings()->get('deferred_revenue_enabled')) {
- $eventStartDate = $this->getEventValue('start_date');
- if (strtotime($eventStartDate) > strtotime(date('Ymt'))) {
- $contributionParams['revenue_recognition_date'] = date('Ymd', strtotime($eventStartDate));
- }
- }
+
if ($this->isPaymentOnExistingContribution()) {
- $participantBAO = new CRM_Event_BAO_Participant();
- $participantBAO->id = $this->_id;
- $participantBAO->find(TRUE);
- $contributionParams['total_amount'] = $participantBAO->fee_amount;
+ $contributionParams['total_amount'] = $this->getParticipantValue('fee_amount');
$params['discount_id'] = NULL;
//re-enter the values for UPDATE mode
- $params['fee_level'] = $params['amount_level'] = $participantBAO->fee_level;
- $params['fee_amount'] = $participantBAO->fee_amount;
+ $params['fee_level'] = $params['amount_level'] = $this->getParticipantValue('fee_level');
+ $params['fee_amount'] = $this->getParticipantValue('fee_amount');
if (isset($params['priceSetId'])) {
$lineItem[0] = CRM_Price_BAO_LineItem::getLineItems($this->_id);
}
'invoice_id'
);
}
+ $contribParams['revenue_recognition_date'] = $this->getRevenueRecognitionDate();
- if (Civi::settings()->get('deferred_revenue_enabled')) {
- $eventStartDate = CRM_Utils_Array::value(
- 'start_date',
- CRM_Utils_Array::value(
- 'event',
- $form->_values
- )
- );
- if (strtotime($eventStartDate) > strtotime(date('Ymt'))) {
- $contribParams['revenue_recognition_date'] = date('Ymd', strtotime($eventStartDate));
- }
- }
//create an contribution address
// The concept of contributeMode is deprecated. Elsewhere we use the function processBillingAddress() - although
// currently that is only inherited by back-office forms.
* Process the participant.
*
* @param CRM_Core_Form $form
+ * @param array $params
* @param int $contactID
*
* @return \CRM_Event_BAO_Participant
+ * @throws \CRM_Core_Exception
* @throws \CiviCRM_API3_Exception
*/
- protected function addParticipant(&$form, $contactID) {
- if (empty($form->_params)) {
- return NULL;
- }
- $params = $form->_params;
+ protected function addParticipant(&$form, $params, $contactID) {
$transaction = new CRM_Core_Transaction();
- // handle register date CRM-4320
- $registerDate = NULL;
- if (!empty($form->_allowConfirmation) && $form->_participantId) {
- $registerDate = $params['participant_register_date'];
- }
- elseif (!empty($params['participant_register_date']) &&
- is_array($params['participant_register_date']) &&
- !empty($params['participant_register_date'])
- ) {
- $registerDate = CRM_Utils_Date::format($params['participant_register_date']);
- }
-
$participantFields = CRM_Event_DAO_Participant::fields();
- $participantParams = array(
+ $participantParams = [
'id' => CRM_Utils_Array::value('participant_id', $params),
'contact_id' => $contactID,
'event_id' => $form->_eventId ? $form->_eventId : $params['event_id'],
'status_id' => CRM_Utils_Array::value('participant_status',
$params, 1
),
- 'role_id' => CRM_Utils_Array::value('participant_role_id', $params) ?: self::getDefaultRoleID(),
- 'register_date' => ($registerDate) ? $registerDate : date('YmdHis'),
+ 'role_id' => CRM_Utils_Array::value('participant_role_id', $params) ?: CRM_Event_BAO_Participant::getDefaultRoleID(),
+ 'register_date' => $params['register_date'],
'source' => CRM_Utils_String::ellipsify(
isset($params['participant_source']) ? CRM_Utils_Array::value('participant_source', $params) : CRM_Utils_Array::value('description', $params),
$participantFields['participant_source']['maxlength']
'discount_id' => CRM_Utils_Array::value('discount_id', $params),
'fee_currency' => CRM_Utils_Array::value('currencyID', $params),
'campaign_id' => CRM_Utils_Array::value('campaign_id', $params),
- );
+ ];
if ($form->_action & CRM_Core_Action::PREVIEW || CRM_Utils_Array::value('mode', $params) == 'test') {
$participantParams['is_test'] = 1;
* @return bool
*/
protected function isPaymentOnExistingContribution(): bool {
- return ($this->_id && $this->_action & CRM_Core_Action::UPDATE) && $this->_paymentId;
+ return ($this->getParticipantID() && $this->_action & CRM_Core_Action::UPDATE) && $this->_paymentId;
}
/**
return $this->_event[$fieldName];
}
+ /**
+ * Get a value from the existing participant record (applies to edits).
+ *
+ * @param string $fieldName
+ *
+ * @return array
+ * @throws \CiviCRM_API3_Exception
+ */
+ protected function getParticipantValue($fieldName) {
+ if (!$this->participantRecord) {
+ $this->participantRecord = civicrm_api3('Participant', 'get', ['id' => $this->_id]);
+ }
+ return $this->participantRecord[$fieldName];
+ }
+
+ /**
+ * Get id of participant being edited.
+ *
+ * @return int|null
+ */
+ protected function getParticipantID() {
+ return $this->_id ?? $this->_pId;
+ }
+
+ /**
+ * Get the value for the revenue recognition date field.
+ *
+ * @return string
+ *
+ * @throws \CiviCRM_API3_Exception
+ */
+ protected function getRevenueRecognitionDate() {
+ if (Civi::settings()->get('deferred_revenue_enabled')) {
+ $eventStartDate = $this->getEventValue('start_date');
+ if (strtotime($eventStartDate) > strtotime(date('Ymt'))) {
+ return date('Ymd', strtotime($eventStartDate));
+ }
+ }
+ return '';
+ }
+
}