3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * This form records additional payments needed when event/contribution is partially paid.
37 class CRM_Contribute_Form_AdditionalPayment
extends CRM_Contribute_Form_AbstractEditPayment
{
38 public $_contributeMode = 'direct';
41 * Id of the component entity
46 protected $entity = 'Contribution';
48 protected $_owed = NULL;
50 protected $_refund = NULL;
54 * @deprecated - use parent $this->contactID
56 protected $_contactId = NULL;
58 protected $_contributorDisplayName = NULL;
60 protected $_contributorEmail = NULL;
62 protected $_toDoNotEmail = NULL;
64 protected $_paymentType = NULL;
66 protected $_contributionId = NULL;
68 protected $fromEmailId = NULL;
70 protected $_fromEmails = NULL;
72 protected $_view = NULL;
74 public $_action = NULL;
76 public function preProcess() {
78 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, TRUE);
80 $this->_contactId
= $this->_contactID
;
81 $this->_component
= CRM_Utils_Request
::retrieve('component', 'String', $this, FALSE, 'contribution');
82 $this->_view
= CRM_Utils_Request
::retrieve('view', 'String', $this, FALSE);
83 $this->assign('component', $this->_component
);
84 $this->assign('id', $this->_id
);
85 $this->assign('suppressPaymentFormButtons', $this->isBeingCalledFromSelectorContext());
87 if ($this->_view
== 'transaction' && ($this->_action
& CRM_Core_Action
::BROWSE
)) {
88 $title = $this->assignPaymentInfoBlock();
89 CRM_Utils_System
::setTitle($title);
92 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
94 $entityType = 'contribution';
95 if ($this->_component
== 'event') {
96 $entityType = 'participant';
97 $this->_contributionId
= CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id
, 'contribution_id', 'participant_id');
98 $eventId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $this->_id
, 'event_id', 'id');
99 $this->_fromEmails
= CRM_Event_BAO_Event
::getFromEmailIds($eventId);
102 $this->_contributionId
= $this->_id
;
103 $this->_fromEmails
['from_email_id'] = CRM_Core_BAO_Email
::getFromEmail();
106 $paymentInfo = CRM_Core_BAO_FinancialTrxn
::getPartialPaymentWithType($this->_id
, $entityType);
107 $paymentDetails = CRM_Contribute_BAO_Contribution
::getPaymentInfo($this->_id
, $this->_component
, FALSE, TRUE);
109 $this->_amtPaid
= $paymentDetails['paid'];
110 $this->_amtTotal
= $paymentDetails['total'];
112 if (!empty($paymentInfo['refund_due'])) {
113 $paymentAmt = $this->_refund
= $paymentInfo['refund_due'];
114 $this->_paymentType
= 'refund';
116 elseif (!empty($paymentInfo['amount_owed'])) {
117 $paymentAmt = $this->_owed
= $paymentInfo['amount_owed'];
118 $this->_paymentType
= 'owed';
121 CRM_Core_Error
::fatal(ts('No payment information found for this record'));
124 if (!empty($this->_mode
) && $this->_paymentType
== 'refund') {
125 CRM_Core_Error
::fatal(ts('Credit card payment is not for Refund payments use'));
128 list($this->_contributorDisplayName
, $this->_contributorEmail
) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
130 $this->assign('contributionMode', $this->_mode
);
131 $this->assign('contactId', $this->_contactID
);
132 $this->assign('paymentType', $this->_paymentType
);
133 $this->assign('paymentAmt', abs($paymentAmt));
135 $this->setPageTitle($this->_refund ?
ts('Refund') : ts('Payment'));
139 * Is this function being called from a datatable selector.
141 * If so we don't want to show the buttons.
143 protected function isBeingCalledFromSelectorContext() {
144 return CRM_Utils_Request
::retrieve('selector', 'Positive');
148 * This virtual function is used to set the default values of
149 * various form elements
154 * reference to the array of default values
160 public function setDefaultValues() {
161 if ($this->_view
== 'transaction' && ($this->_action
& CRM_Core_Action
::BROWSE
)) {
166 CRM_Core_Payment_Form
::setDefaultValues($this, $this->_contactId
);
167 $defaults = array_merge($defaults, $this->_defaults
);
170 if (empty($defaults['trxn_date'])) {
171 $defaults['trxn_date'] = date('Y-m-d H:i:s');
174 if ($this->_refund
) {
175 $defaults['total_amount'] = CRM_Utils_Money
::format(abs($this->_refund
), NULL, NULL, TRUE);
177 elseif ($this->_owed
) {
178 $defaults['total_amount'] = CRM_Utils_Money
::formatLocaleNumericRoundedForDefaultCurrency($this->_owed
);
181 // Set $newCredit variable in template to control whether link to credit card mode is included
182 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
187 * Build the form object.
189 public function buildQuickForm() {
190 if ($this->_view
== 'transaction' && ($this->_action
& CRM_Core_Action
::BROWSE
)) {
194 'name' => ts('Done'),
195 'spacing' => ' ',
202 CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, FALSE, TRUE, CRM_Utils_Request
::retrieve('payment_instrument_id', 'Integer'));
203 $this->add('select', 'payment_processor_id', ts('Payment Processor'), $this->_processors
, NULL);
205 $attributes = CRM_Core_DAO
::getAttribute('CRM_Financial_DAO_FinancialTrxn');
207 $label = ($this->_refund
) ?
ts('Refund Amount') : ts('Payment Amount');
208 $this->addMoney('total_amount',
211 $attributes['total_amount'],
212 TRUE, 'currency', NULL
215 //add receipt for offline contribution
216 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
218 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
['from_email_id']);
220 $this->add('textarea', 'receipt_text', ts('Confirmation Message'));
222 $dateLabel = ($this->_refund
) ?
ts('Refund Date') : ts('Date Received');
223 $this->addField('trxn_date', ['entity' => 'FinancialTrxn', 'label' => $dateLabel, 'context' => 'Contribution'], FALSE, FALSE);
225 if ($this->_contactId
&& $this->_id
) {
226 if ($this->_component
== 'event') {
227 $eventId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $this->_id
, 'event_id', 'id');
228 $event = CRM_Event_BAO_Event
::getEvents(0, $eventId);
229 $this->assign('eventName', $event[$eventId]);
233 $this->assign('displayName', $this->_contributorDisplayName
);
234 $this->assign('component', $this->_component
);
235 $this->assign('email', $this->_contributorEmail
);
238 // render backoffice payment fields only on offline mode
240 $js = ['onclick' => "return verify( );"];
242 $this->add('select', 'payment_instrument_id',
243 ts('Payment Method'),
244 ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::paymentInstrument(),
246 ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
249 $this->add('text', 'check_number', ts('Check Number'), $attributes['financial_trxn_check_number']);
250 $this->add('text', 'trxn_id', ts('Transaction ID'), ['class' => 'twelve'] +
$attributes['trxn_id']);
252 $this->add('text', 'fee_amount', ts('Fee Amount'),
253 $attributes['fee_amount']
255 $this->addRule('fee_amount', ts('Please enter a valid monetary value for Fee Amount.'), 'money');
257 $this->add('text', 'net_amount', ts('Net Amount'),
258 $attributes['net_amount']
260 $this->addRule('net_amount', ts('Please enter a valid monetary value for Net Amount.'), 'money');
263 $buttonName = $this->_refund ?
'Record Refund' : 'Record Payment';
267 'name' => ts('%1', [1 => $buttonName]),
273 'name' => ts('Cancel'),
276 $mailingInfo = Civi
::settings()->get('mailing_backend');
277 $this->assign('outBound_option', $mailingInfo['outBound_option']);
279 $this->addFormRule(['CRM_Contribute_Form_AdditionalPayment', 'formRule'], $this);
289 public static function formRule($fields, $files, $self) {
291 if ($self->_paymentType
== 'owed' && $fields['total_amount'] > $self->_owed
) {
292 $errors['total_amount'] = ts('Payment amount cannot be greater than owed amount');
294 if ($self->_paymentType
== 'refund' && $fields['total_amount'] != abs($self->_refund
)) {
295 $errors['total_amount'] = ts('Refund amount must equal refund due amount.');
297 $netAmt = (float) $fields['total_amount'] - (float) CRM_Utils_Array
::value('fee_amount', $fields, 0);
298 if (!empty($fields['net_amount']) && $netAmt != $fields['net_amount']) {
299 $errors['net_amount'] = ts('Net amount should be equal to the difference between payment amount and fee amount.');
301 if ($self->_paymentProcessor
['id'] === 0 && empty($fields['payment_instrument_id'])) {
302 $errors['payment_instrument_id'] = ts('Payment method is a required field');
309 * Process the form submission.
311 public function postProcess() {
312 $submittedValues = $this->controller
->exportValues($this->_name
);
313 $this->submit($submittedValues);
314 $childTab = 'contribute';
315 if ($this->_component
== 'event') {
316 $childTab = 'participant';
318 $session = CRM_Core_Session
::singleton();
319 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
320 "reset=1&cid={$this->_contactId}&selectedChild={$childTab}"
326 * @param array $submittedValues
329 public function submit($submittedValues) {
330 $this->_params
= $submittedValues;
331 $this->beginPostProcess();
332 $this->_contributorContactID
= $this->_contactID
;
333 $this->processBillingAddress();
334 $participantId = NULL;
335 if ($this->_component
== 'event') {
336 $participantId = $this->_id
;
338 $contributionStatuses = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution',
339 'contribution_status_id',
340 ['labelColumn' => 'name']
342 $contributionStatusID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_contributionId
, 'contribution_status_id');
343 if ($contributionStatuses[$contributionStatusID] == 'Pending') {
344 civicrm_api3('Contribution', 'create',
346 'id' => $this->_contributionId
,
347 'contribution_status_id' => array_search('Partially paid', $contributionStatuses),
354 // process credit card
355 $this->assign('contributeMode', 'direct');
356 $this->processCreditCard();
360 $contribution = civicrm_api3('Contribution', 'getsingle', [
361 'return' => ["contribution_status_id"],
362 'id' => $this->_contributionId
,
364 $contributionStatusId = CRM_Utils_Array
::value('contribution_status_id', $contribution);
365 $paymentID = CRM_Contribute_BAO_Contribution
::recordAdditionalPayment($this->_contributionId
, $this->_params
, $this->_paymentType
, $participantId);
366 // Fetch the contribution & do proportional line item assignment
367 $params = ['id' => $this->_contributionId
];
368 $contribution = CRM_Contribute_BAO_Contribution
::retrieve($params, $defaults, $params);
369 // @todo - this line needs to be moved to the Payment.create api - it's not form layer appropriate.
371 CRM_Contribute_BAO_Contribution
::addPayments([$contribution], $contributionStatusId);
372 if ($this->_contributionId
&& CRM_Core_Permission
::access('CiviMember')) {
373 $membershipPaymentCount = civicrm_api3('MembershipPayment', 'getCount', ['contribution_id' => $this->_contributionId
]);
374 if ($membershipPaymentCount) {
375 $this->ajaxResponse
['updateTabs']['#tab_member'] = CRM_Contact_BAO_Contact
::getCountComponent('membership', $this->_contactID
);
378 if ($this->_contributionId
&& CRM_Core_Permission
::access('CiviEvent')) {
379 $participantPaymentCount = civicrm_api3('ParticipantPayment', 'getCount', ['contribution_id' => $this->_contributionId
]);
380 if ($participantPaymentCount) {
381 $this->ajaxResponse
['updateTabs']['#tab_participant'] = CRM_Contact_BAO_Contact
::getCountComponent('participant', $this->_contactID
);
385 $statusMsg = ts('The payment record has been processed.');
387 if (!empty($paymentID) && !empty($this->_params
['is_email_receipt'])) {
388 $sendResult = civicrm_api3('Payment', 'sendconfirmation', ['id' => $paymentID])['values'][$paymentID];
389 if ($sendResult['is_sent']) {
390 $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
394 CRM_Core_Session
::setStatus($statusMsg, ts('Saved'), 'success');
397 public function processCreditCard() {
398 $config = CRM_Core_Config
::singleton();
399 $session = CRM_Core_Session
::singleton();
401 $now = date('YmdHis');
404 // we need to retrieve email address
405 if ($this->_context
== 'standalone' && !empty($this->_params
['is_email_receipt'])) {
406 list($this->userDisplayName
,
408 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactId
);
409 $this->assign('displayName', $this->userDisplayName
);
412 $this->formatParamsForPaymentProcessor($this->_params
);
414 $this->_params
['amount'] = $this->_params
['total_amount'];
415 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
416 // function to get correct amount level consistently. Remove setting of the amount level in
417 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
418 // to cover all variants.
419 $this->_params
['amount_level'] = 0;
420 $this->_params
['currencyID'] = CRM_Utils_Array
::value('currency',
422 $config->defaultCurrency
425 if (!empty($this->_params
['trxn_date'])) {
426 $this->_params
['receive_date'] = $this->_params
['trxn_date'];
429 if (empty($this->_params
['receive_date'])) {
430 $this->_params
['receive_date'] = date('YmdHis');
433 if (empty($this->_params
['invoice_id'])) {
434 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
437 $this->_params
['invoiceID'] = $this->_params
['invoice_id'];
440 $this->assign('address', CRM_Utils_Address
::getFormattedBillingAddressFieldsFromParameters(
445 //Add common data to formatted params
446 $params = $this->_params
;
447 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($params, $this->_params
, $this);
448 // at this point we've created a contact and stored its address etc
449 // all the payment processors expect the name and address to be in the
450 // so we copy stuff over to first_name etc.
451 $paymentParams = $this->_params
;
452 $paymentParams['contactID'] = $this->_contactId
;
453 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
455 $paymentParams['contributionPageID'] = NULL;
456 if (!empty($this->_params
['is_email_receipt'])) {
457 $paymentParams['email'] = $this->_contributorEmail
;
458 $paymentParams['is_email_receipt'] = TRUE;
461 $paymentParams['is_email_receipt'] = $this->_params
['is_email_receipt'] = FALSE;
466 if ($paymentParams['amount'] > 0.0) {
468 // force a reget of the payment processor in case the form changed it, CRM-7179
469 $payment = Civi\Payment\System
::singleton()->getByProcessor($this->_paymentProcessor
);
470 $result = $payment->doPayment($paymentParams);
472 catch (\Civi\Payment\Exception\PaymentProcessorException
$e) {
473 Civi
::log()->error('Payment processor exception: ' . $e->getMessage());
474 $urlParams = "action=add&cid={$this->_contactId}&id={$this->_contributionId}&component={$this->_component}&mode={$this->_mode}";
475 CRM_Core_Error
::statusBounce(CRM_Utils_System
::url($e->getMessage(), 'civicrm/payment/add', $urlParams));
479 if (!empty($result)) {
480 $this->_params
= array_merge($this->_params
, $result);
483 if (empty($this->_params
['receive_date'])) {
484 $this->_params
['receive_date'] = $now;
487 $this->set('params', $this->_params
);
489 // set source if not set
490 if (empty($this->_params
['source'])) {
491 $userID = $session->get('userID');
492 $userSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $userID,
495 $this->_params
['source'] = ts('Submit Credit Card Payment by: %1', [1 => $userSortName]);
500 * Wrapper for unit testing the post process submit function.
502 * @param array $params
503 * @param string|null $creditCardMode
504 * @param string $entityType
506 * @throws \CiviCRM_API3_Exception
508 public function testSubmit($params, $creditCardMode = NULL, $entityType = 'contribute') {
510 // Required because processCreditCard calls set method on this.
511 $_SERVER['REQUEST_METHOD'] = 'GET';
512 $this->controller
= new CRM_Core_Controller();
514 $this->assignPaymentRelatedVariables();
516 if (!empty($params['contribution_id'])) {
517 $this->_contributionId
= $params['contribution_id'];
519 $paymentInfo = CRM_Core_BAO_FinancialTrxn
::getPartialPaymentWithType($this->_contributionId
, $entityType);
520 $paymentDetails = CRM_Contribute_BAO_Contribution
::getPaymentInfo($this->_contributionId
, $entityType, FALSE, TRUE);
522 $this->_amtPaid
= $paymentDetails['paid'];
523 $this->_amtTotal
= $paymentDetails['total'];
525 if (!empty($paymentInfo['refund_due'])) {
526 $this->_refund
= $paymentInfo['refund_due'];
527 $this->_paymentType
= 'refund';
529 elseif (!empty($paymentInfo['amount_owed'])) {
530 $this->_owed
= $paymentInfo['amount_owed'];
531 $this->_paymentType
= 'owed';
535 if (!empty($params['contact_id'])) {
536 $this->_contactId
= $params['contact_id'];
539 if ($creditCardMode) {
540 $this->_mode
= $creditCardMode;
544 $this->set('cid', $this->_contactId
);
545 parent
::preProcess();
546 $this->submit($params);