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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This form records additional payments needed when event/contribution is partially paid.
21 class CRM_Contribute_Form_AdditionalPayment
extends CRM_Contribute_Form_AbstractEditPayment
{
22 public $_contributeMode = 'direct';
25 * Id of the component entity
30 protected $entity = 'Contribution';
32 protected $_owed = NULL;
34 protected $_refund = NULL;
38 * @deprecated - use parent $this->contactID
40 protected $_contactId = NULL;
42 protected $_contributorDisplayName = NULL;
44 protected $_contributorEmail = NULL;
46 protected $_toDoNotEmail = NULL;
48 protected $_paymentType = NULL;
50 protected $_contributionId = NULL;
52 protected $fromEmailId = NULL;
54 protected $_view = NULL;
56 public $_action = NULL;
61 * @throws \CRM_Core_Exception
63 public function preProcess() {
65 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, TRUE);
67 $this->_contactId
= $this->_contactID
;
68 $this->_component
= CRM_Utils_Request
::retrieve('component', 'String', $this, FALSE, 'contribution');
69 $this->_view
= CRM_Utils_Request
::retrieve('view', 'String', $this, FALSE);
70 $this->assign('component', $this->_component
);
71 $this->assign('id', $this->_id
);
72 $this->assign('suppressPaymentFormButtons', $this->isBeingCalledFromSelectorContext());
74 if ($this->_view
== 'transaction' && ($this->_action
& CRM_Core_Action
::BROWSE
)) {
75 $title = $this->assignPaymentInfoBlock();
76 CRM_Utils_System
::setTitle($title);
79 $entityType = 'contribution';
80 if ($this->_component
== 'event') {
81 $entityType = 'participant';
82 $this->_contributionId
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id
, 'contribution_id', 'participant_id');
83 $eventId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $this->_id
, 'event_id', 'id');
86 $this->_contributionId
= $this->_id
;
89 $paymentDetails = CRM_Contribute_BAO_Contribution
::getPaymentInfo($this->_id
, $this->_component
, FALSE, TRUE);
90 $paymentAmt = CRM_Contribute_BAO_Contribution
::getContributionBalance($this->_id
);
92 $this->_amtPaid
= $paymentDetails['paid'];
93 $this->_amtTotal
= $paymentDetails['total'];
95 if ($paymentAmt < 0) {
96 $this->_refund
= $paymentAmt;
97 $this->_paymentType
= 'refund';
99 elseif ($paymentAmt > 0) {
100 $this->_owed
= $paymentAmt;
101 $this->_paymentType
= 'owed';
104 throw new CRM_Core_Exception(ts('No payment information found for this record'));
107 if (!empty($this->_mode
) && $this->_paymentType
== 'refund') {
108 throw new CRM_Core_Exception(ts('Credit card payment is not for Refund payments use'));
111 list($this->_contributorDisplayName
, $this->_contributorEmail
) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
113 $this->assign('contributionMode', $this->_mode
);
114 $this->assign('contactId', $this->_contactID
);
115 $this->assign('paymentType', $this->_paymentType
);
116 $this->assign('paymentAmt', abs($paymentAmt));
118 $this->setPageTitle($this->_refund ?
ts('Refund') : ts('Payment'));
122 * Is this function being called from a datatable selector.
124 * If so we don't want to show the buttons.
126 * @throws \CRM_Core_Exception
128 protected function isBeingCalledFromSelectorContext() {
129 return CRM_Utils_Request
::retrieve('selector', 'Positive');
133 * This virtual function is used to set the default values of
134 * various form elements
139 * reference to the array of default values
145 public function setDefaultValues() {
146 if ($this->_view
== 'transaction' && ($this->_action
& CRM_Core_Action
::BROWSE
)) {
151 CRM_Core_Payment_Form
::setDefaultValues($this, $this->_contactId
);
152 $defaults = array_merge($defaults, $this->_defaults
);
155 if (empty($defaults['trxn_date'])) {
156 $defaults['trxn_date'] = date('Y-m-d H:i:s');
159 if ($this->_refund
) {
160 $defaults['total_amount'] = CRM_Utils_Money
::format(abs($this->_refund
), NULL, NULL, TRUE);
162 elseif ($this->_owed
) {
163 $defaults['total_amount'] = CRM_Utils_Money
::formatLocaleNumericRoundedForDefaultCurrency($this->_owed
);
166 // Set $newCredit variable in template to control whether link to credit card mode is included
167 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
172 * Build the form object.
174 public function buildQuickForm() {
175 if ($this->_view
== 'transaction' && ($this->_action
& CRM_Core_Action
::BROWSE
)) {
179 'name' => ts('Done'),
180 'spacing' => ' ',
187 CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, FALSE, TRUE, CRM_Utils_Request
::retrieve('payment_instrument_id', 'Integer'));
188 $this->add('select', 'payment_processor_id', ts('Payment Processor'), $this->_processors
, NULL);
190 $attributes = CRM_Core_DAO
::getAttribute('CRM_Financial_DAO_FinancialTrxn');
192 $label = ($this->_refund
) ?
ts('Refund Amount') : ts('Payment Amount');
193 $this->addMoney('total_amount',
196 $attributes['total_amount'],
197 TRUE, 'currency', NULL
200 //add receipt for offline contribution
201 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
203 if ($this->_component
=== 'event') {
204 $eventID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $this->_id
, 'event_id', 'id');
207 $this->add('select', 'from_email_address', ts('Receipt From'), CRM_Financial_BAO_Payment
::getValidFromEmailsForPayment($eventID ??
NULL));
209 $this->add('textarea', 'receipt_text', ts('Confirmation Message'));
211 $dateLabel = ($this->_refund
) ?
ts('Refund Date') : ts('Date Received');
212 $this->addField('trxn_date', ['entity' => 'FinancialTrxn', 'label' => $dateLabel, 'context' => 'Contribution'], FALSE, FALSE);
214 if ($this->_contactId
&& $this->_id
) {
215 if ($this->_component
== 'event') {
216 $eventId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $this->_id
, 'event_id', 'id');
217 $event = CRM_Event_BAO_Event
::getEvents(0, $eventId);
218 $this->assign('eventName', $event[$eventId]);
222 $this->assign('displayName', $this->_contributorDisplayName
);
223 $this->assign('component', $this->_component
);
224 $this->assign('email', $this->_contributorEmail
);
227 // render backoffice payment fields only on offline mode
229 $js = ['onclick' => "return verify( );"];
231 $this->add('select', 'payment_instrument_id',
232 ts('Payment Method'),
233 ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::paymentInstrument(),
235 ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
238 $this->add('text', 'check_number', ts('Check Number'), $attributes['financial_trxn_check_number']);
239 $this->add('text', 'trxn_id', ts('Transaction ID'), ['class' => 'twelve'] +
$attributes['trxn_id']);
241 $this->add('text', 'fee_amount', ts('Fee Amount'),
242 $attributes['fee_amount']
244 $this->addRule('fee_amount', ts('Please enter a valid monetary value for Fee Amount.'), 'money');
246 $this->add('text', 'net_amount', ts('Net Amount'),
247 $attributes['net_amount']
249 $this->addRule('net_amount', ts('Please enter a valid monetary value for Net Amount.'), 'money');
252 $buttonName = $this->_refund ?
ts('Record Refund') : ts('Record Payment');
256 'name' => $buttonName,
262 'name' => ts('Cancel'),
265 $mailingInfo = Civi
::settings()->get('mailing_backend');
266 $this->assign('outBound_option', $mailingInfo['outBound_option']);
268 $this->addFormRule(['CRM_Contribute_Form_AdditionalPayment', 'formRule'], $this);
278 public static function formRule($fields, $files, $self) {
280 if ($self->_paymentType
== 'owed' && $fields['total_amount'] > $self->_owed
) {
281 $errors['total_amount'] = ts('Payment amount cannot be greater than owed amount');
283 if ($self->_paymentType
== 'refund' && $fields['total_amount'] != abs($self->_refund
)) {
284 $errors['total_amount'] = ts('Refund amount must equal refund due amount.');
286 $netAmt = (float) $fields['total_amount'] - (float) CRM_Utils_Array
::value('fee_amount', $fields, 0);
287 if (!empty($fields['net_amount']) && $netAmt != $fields['net_amount']) {
288 $errors['net_amount'] = ts('Net amount should be equal to the difference between payment amount and fee amount.');
290 if ($self->_paymentProcessor
['id'] === 0 && empty($fields['payment_instrument_id'])) {
291 $errors['payment_instrument_id'] = ts('Payment method is a required field');
298 * Process the form submission.
300 public function postProcess() {
301 $submittedValues = $this->controller
->exportValues($this->_name
);
302 $this->submit($submittedValues);
303 $childTab = 'contribute';
304 if ($this->_component
== 'event') {
305 $childTab = 'participant';
307 $session = CRM_Core_Session
::singleton();
308 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
309 "reset=1&cid={$this->_contactId}&selectedChild={$childTab}"
316 * @param array $submittedValues
318 * @throws \CiviCRM_API3_Exception
320 public function submit($submittedValues) {
321 $this->_params
= $submittedValues;
322 $this->beginPostProcess();
323 $this->_contributorContactID
= $this->_contactID
;
324 $this->processBillingAddress();
325 $participantId = NULL;
326 if ($this->_component
== 'event') {
327 $participantId = $this->_id
;
331 // process credit card
332 $this->assign('contributeMode', 'direct');
333 $this->processCreditCard();
336 // @todo we should clean $ on the form & pass in skipCleanMoney
337 $trxnsData = $this->_params
;
338 if ($this->_paymentType
== 'refund') {
339 $trxnsData['total_amount'] = -$trxnsData['total_amount'];
341 $trxnsData['participant_id'] = $participantId;
342 $trxnsData['contribution_id'] = $this->_contributionId
;
344 $trxnsData['is_send_contribution_notification'] = FALSE;
345 $paymentID = civicrm_api3('Payment', 'create', $trxnsData)['id'];
347 if ($this->_contributionId
&& CRM_Core_Permission
::access('CiviMember')) {
348 $membershipPaymentCount = civicrm_api3('MembershipPayment', 'getCount', ['contribution_id' => $this->_contributionId
]);
349 if ($membershipPaymentCount) {
350 $this->ajaxResponse
['updateTabs']['#tab_member'] = CRM_Contact_BAO_Contact
::getCountComponent('membership', $this->_contactID
);
353 if ($this->_contributionId
&& CRM_Core_Permission
::access('CiviEvent')) {
354 $participantPaymentCount = civicrm_api3('ParticipantPayment', 'getCount', ['contribution_id' => $this->_contributionId
]);
355 if ($participantPaymentCount) {
356 $this->ajaxResponse
['updateTabs']['#tab_participant'] = CRM_Contact_BAO_Contact
::getCountComponent('participant', $this->_contactID
);
360 $statusMsg = ts('The payment record has been processed.');
362 if (!empty($paymentID) && !empty($this->_params
['is_email_receipt'])) {
363 $sendResult = civicrm_api3('Payment', 'sendconfirmation', ['id' => $paymentID, 'from' => $submittedValues['from_email_address']])['values'][$paymentID];
364 if ($sendResult['is_sent']) {
365 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
369 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
372 public function processCreditCard() {
373 $config = CRM_Core_Config
::singleton();
374 $session = CRM_Core_Session
::singleton();
376 $now = date('YmdHis');
379 // we need to retrieve email address
380 if ($this->_context
== 'standalone' && !empty($this->_params
['is_email_receipt'])) {
381 list($this->userDisplayName
,
383 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactId
);
384 $this->assign('displayName', $this->userDisplayName
);
387 $this->_params
['amount'] = $this->_params
['total_amount'];
388 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
389 // function to get correct amount level consistently. Remove setting of the amount level in
390 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
391 // to cover all variants.
392 $this->_params
['amount_level'] = 0;
393 $this->_params
['currencyID'] = CRM_Utils_Array
::value('currency',
395 $config->defaultCurrency
398 if (empty($this->_params
['invoice_id'])) {
399 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
402 $this->_params
['invoiceID'] = $this->_params
['invoice_id'];
405 $this->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
410 //Add common data to formatted params
411 $params = $this->_params
;
412 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($params, $this->_params
, $this);
413 // at this point we've created a contact and stored its address etc
414 // all the payment processors expect the name and address to be in the
415 // so we copy stuff over to first_name etc.
416 $paymentParams = $this->_params
;
417 $paymentParams['contactID'] = $this->_contactId
;
418 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
420 $paymentParams['contributionPageID'] = NULL;
421 if (!empty($this->_params
['is_email_receipt'])) {
422 $paymentParams['email'] = $this->_contributorEmail
;
423 $paymentParams['is_email_receipt'] = TRUE;
426 $paymentParams['is_email_receipt'] = $this->_params
['is_email_receipt'] = FALSE;
431 if ($paymentParams['amount'] > 0.0) {
433 // force a reget of the payment processor in case the form changed it, CRM-7179
434 $payment = Civi\Payment\System
::singleton()->getByProcessor($this->_paymentProcessor
);
435 $result = $payment->doPayment($paymentParams);
437 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
438 Civi
::log()->error('Payment processor exception: ' . $e->getMessage());
439 $urlParams = "action=add&cid={$this->_contactId}&id={$this->_contributionId}&component={$this->_component}&mode={$this->_mode}";
440 CRM_Core_Error
::statusBounce($e->getMessage(), CRM_Utils_System
::url('civicrm/payment/add', $urlParams));
444 if (!empty($result)) {
445 $this->_params
= array_merge($this->_params
, $result);
448 $this->set('params', $this->_params
);
450 // set source if not set
451 if (empty($this->_params
['source'])) {
452 $userID = $session->get('userID');
453 $userSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $userID,
456 $this->_params
['source'] = ts('Submit Credit Card Payment by: %1', [1 => $userSortName]);
461 * Wrapper for unit testing the post process submit function.
463 * @param array $params
464 * @param string|null $creditCardMode
465 * @param string $entityType
467 * @throws \CiviCRM_API3_Exception
469 public function testSubmit($params, $creditCardMode = NULL, $entityType = 'contribute') {
471 // Required because processCreditCard calls set method on this.
472 $_SERVER['REQUEST_METHOD'] = 'GET';
473 $this->controller
= new CRM_Core_Controller();
475 $this->assignPaymentRelatedVariables();
477 if (!empty($params['contribution_id'])) {
478 $this->_contributionId
= $params['contribution_id'];
480 $paymentDetails = CRM_Contribute_BAO_Contribution
::getPaymentInfo($this->_contributionId
, $entityType, FALSE, TRUE);
482 $paymentAmount = CRM_Contribute_BAO_Contribution
::getContributionBalance($this->_contributionId
);
483 $this->_amtPaid
= $paymentDetails['paid'];
484 $this->_amtTotal
= $paymentDetails['total'];
486 if ($paymentAmount < 0) {
487 $this->_refund
= $paymentAmount;
488 $this->_paymentType
= 'refund';
490 elseif ($paymentAmount > 0) {
491 $this->_owed
= $paymentAmount;
492 $this->_paymentType
= 'owed';
496 if (!empty($params['contact_id'])) {
497 $this->_contactId
= $params['contact_id'];
500 if ($creditCardMode) {
501 $this->_mode
= $creditCardMode;
505 $this->set('cid', $this->_contactId
);
506 parent
::preProcess();
507 $this->submit($params);