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 +--------------------------------------------------------------------+
12 use Civi\Payment\Exception\PaymentProcessorException
;
15 * This class generates form components for processing a contribution.
17 class CRM_Contribute_Form_Contribution
extends CRM_Contribute_Form_AbstractEditPayment
{
19 * The id of the contribution that we are processing.
26 * The id of the premium that we are processing.
30 public $_premiumID = NULL;
33 * @var CRM_Contribute_DAO_ContributionProduct
35 public $_productDAO = NULL;
45 * The id of the contact associated with this contribution.
52 * The id of the pledge payment that we are processing.
59 * Is this contribution associated with an online.
60 * financial transaction
64 public $_online = FALSE;
67 * Stores all product options.
74 * Storage of parameters from form
81 * Store the contribution Type ID
85 public $_contributionType;
88 * The contribution values if an existing contribution
94 * The pledge values if this contribution is associated with pledge
97 public $_pledgeValues;
99 public $_contributeMode = 'direct';
104 * Parameter with confusing name.
108 public $_compContext;
113 * Possible From email addresses
126 * Store the line items if price set used.
134 * @todo explain why we use lineItem & lineItems
143 public $_softCreditInfo;
145 protected $_formType;
148 * Array of the payment fields to be displayed in the payment fieldset (pane) in billingBlock.tpl
149 * this contains all the information to describe these fields from quickform. See CRM_Core_Form_Payment getPaymentFormFieldsMetadata
153 public $_paymentFields = [];
155 * Logged in user's email.
168 * Price set as an array
178 public $userDisplayName;
181 * Status message to be shown to the user.
185 protected $statusMessage = [];
188 * Status message title to be shown to the user.
190 * Generally the payment processor message title is 'Complete' and offline is 'Saved'
191 * although this might not be a good fit with the broad range of processors.
195 protected $statusMessageTitle;
200 * Max row count for soft credits. The value here is +1 the actual number of
203 public $_softCreditItemCount = 11;
206 * Explicitly declare the form context.
208 public function getDefaultContext() {
213 * Set variables up before form is built.
215 public function preProcess() {
216 // Check permission for action.
217 if (!CRM_Core_Permission
::checkActionPermission('CiviContribute', $this->_action
)) {
218 // @todo replace with throw new CRM_Core_Exception().
219 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
222 parent
::preProcess();
224 $this->_formType
= CRM_Utils_Array
::value('formType', $_GET);
227 $this->_priceSetId
= CRM_Utils_Array
::value('priceSetId', $_GET);
228 $this->set('priceSetId', $this->_priceSetId
);
229 $this->assign('priceSetId', $this->_priceSetId
);
231 // Get the pledge payment id
232 $this->_ppID
= CRM_Utils_Request
::retrieve('ppid', 'Positive', $this);
234 $this->assign('action', $this->_action
);
236 // Get the contribution id if update
237 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive');
238 if (!empty($this->_id
)) {
239 $this->assignPaymentInfoBlock();
240 $this->assign('contribID', $this->_id
);
241 $this->assign('isUsePaymentBlock', TRUE);
244 $this->_context
= CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this);
245 $this->assign('context', $this->_context
);
247 $this->_compId
= CRM_Utils_Request
::retrieve('compId', 'Positive', $this);
249 $this->_compContext
= CRM_Utils_Request
::retrieve('compContext', 'String', $this);
251 //set the contribution mode.
252 $this->_mode
= CRM_Utils_Request
::retrieve('mode', 'Alphanumeric', $this);
254 $this->assign('contributionMode', $this->_mode
);
255 if ($this->_action
& CRM_Core_Action
::DELETE
) {
259 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
261 if (in_array('CiviPledge', CRM_Core_Config
::singleton()->enableComponents
) && !$this->_formType
) {
262 $this->preProcessPledge();
266 $this->showRecordLinkMesssage($this->_id
);
270 // Current contribution id.
272 $this->assignPremiumProduct($this->_id
);
273 $this->buildValuesAndAssignOnline_Note_Type($this->_id
, $this->_values
);
276 // when custom data is included in this page
277 if (!empty($_POST['hidden_custom'])) {
278 $this->applyCustomData('Contribution', CRM_Utils_Array
::value('financial_type_id', $_POST), $this->_id
);
281 $this->_lineItems
= [];
283 if (!empty($this->_compId
) && $this->_compContext
== 'participant') {
284 $this->assign('compId', $this->_compId
);
285 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_compId
);
288 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution', 1, TRUE, TRUE);
291 empty($lineItem) ?
NULL : $this->_lineItems
[] = $lineItem;
294 $this->assign('lineItem', empty($lineItem) ?
FALSE : [$lineItem]);
297 if ($this->_mode
&& $this->_id
) {
298 $this->_payNow
= TRUE;
299 $this->assign('payNow', $this->_payNow
);
300 CRM_Utils_System
::setTitle(ts('Pay with Credit Card'));
302 elseif ($this->_mode
) {
303 $this->setPageTitle($this->_ppID ?
ts('Credit Card Pledge Payment') : ts('Credit Card Contribution'));
306 $this->setPageTitle($this->_ppID ?
ts('Pledge Payment') : ts('Contribution'));
311 * Set default values.
315 public function setDefaultValues() {
316 $defaults = $this->_values
;
318 // Set defaults for pledge payment.
320 $defaults['total_amount'] = CRM_Utils_Array
::value('scheduled_amount', $this->_pledgeValues
['pledgePayment']);
321 $defaults['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $this->_pledgeValues
);
322 $defaults['currency'] = CRM_Utils_Array
::value('currency', $this->_pledgeValues
);
323 $defaults['option_type'] = 1;
326 if ($this->_action
& CRM_Core_Action
::DELETE
) {
330 $defaults['frequency_interval'] = 1;
331 $defaults['frequency_unit'] = 'month';
333 // Set soft credit defaults.
334 CRM_Contribute_Form_SoftCredit
::setDefaultValues($defaults, $this);
337 // @todo - remove this function as the parent does it too.
338 $config = CRM_Core_Config
::singleton();
339 // Set default country from config if no country set.
340 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
341 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry
;
344 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
345 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince
;
348 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID
);
349 $defaults = array_merge($defaults, $billingDefaults);
353 $this->_contactID
= $defaults['contact_id'];
355 elseif ($this->_contactID
) {
356 $defaults['contact_id'] = $this->_contactID
;
359 // Set $newCredit variable in template to control whether link to credit card mode is included.
360 $this->assign('newCredit', CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments());
362 // Fix the display of the monetary value, CRM-4038.
363 if (isset($defaults['total_amount'])) {
364 $total_value = $defaults['total_amount'];
365 $defaults['total_amount'] = CRM_Utils_Money
::format($total_value, NULL, '%a');
366 if (!empty($defaults['tax_amount'])) {
367 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
368 if (!(CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails))) {
369 $defaults['total_amount'] = CRM_Utils_Money
::format($total_value - $defaults['tax_amount'], NULL, '%a');
374 $amountFields = ['non_deductible_amount', 'fee_amount'];
375 foreach ($amountFields as $amt) {
376 if (isset($defaults[$amt])) {
377 $defaults[$amt] = CRM_Utils_Money
::format($defaults[$amt], NULL, '%a');
381 if ($this->_contributionType
) {
382 $defaults['financial_type_id'] = $this->_contributionType
;
385 if (empty($defaults['payment_instrument_id'])) {
386 $defaults['payment_instrument_id'] = $this->getDefaultPaymentInstrumentId();
389 if (!empty($defaults['is_test'])) {
390 $this->assign('is_test', TRUE);
393 $this->assign('showOption', TRUE);
394 // For Premium section.
395 if ($this->_premiumID
) {
396 $this->assign('showOption', FALSE);
397 $options = isset($this->_options
[$this->_productDAO
->product_id
]) ?
$this->_options
[$this->_productDAO
->product_id
] : "";
399 $this->assign('showOption', TRUE);
401 $options_key = CRM_Utils_Array
::key($this->_productDAO
->product_option
, $options);
403 $defaults['product_name'] = [$this->_productDAO
->product_id
, trim($options_key)];
406 $defaults['product_name'] = [$this->_productDAO
->product_id
];
408 if ($this->_productDAO
->fulfilled_date
) {
409 $defaults['fulfilled_date'] = $this->_productDAO
->fulfilled_date
;
413 if (isset($this->userEmail
)) {
414 $this->assign('email', $this->userEmail
);
417 if (!empty($defaults['is_pay_later'])) {
418 $this->assign('is_pay_later', TRUE);
420 $this->assign('contribution_status_id', CRM_Utils_Array
::value('contribution_status_id', $defaults));
421 if (!empty($defaults['contribution_status_id']) && in_array(
422 CRM_Contribute_PseudoConstant
::contributionStatus($defaults['contribution_status_id'], 'name'),
423 // Historically not 'Cancelled' hence not using CRM_Contribute_BAO_Contribution::isContributionStatusNegative.
424 ['Refunded', 'Chargeback']
426 $defaults['refund_trxn_id'] = CRM_Core_BAO_FinancialTrxn
::getRefundTransactionTrxnID($this->_id
);
429 $defaults['refund_trxn_id'] = isset($defaults['trxn_id']) ?
$defaults['trxn_id'] : NULL;
432 if (!$this->_id
&& empty($defaults['receive_date'])) {
433 $defaults['receive_date'] = date('Y-m-d H:i:s');
436 $currency = CRM_Utils_Array
::value('currency', $defaults);
437 $this->assign('currency', $currency);
438 // Hack to get currency info to the js layer. CRM-11440.
439 CRM_Utils_Money
::format(1);
440 $this->assign('currencySymbol', CRM_Utils_Array
::value($currency, CRM_Utils_Money
::$_currencySymbols));
441 $this->assign('totalAmount', CRM_Utils_Array
::value('total_amount', $defaults));
443 // Inherit campaign from pledge.
444 if ($this->_ppID
&& !empty($this->_pledgeValues
['campaign_id'])) {
445 $defaults['campaign_id'] = $this->_pledgeValues
['campaign_id'];
448 $this->_defaults
= $defaults;
453 * Build the form object.
455 public function buildQuickForm() {
457 $this->add('hidden', 'id', $this->_id
);
460 if ($this->_action
& CRM_Core_Action
::DELETE
) {
464 'name' => ts('Delete'),
465 'spacing' => ' ',
470 'name' => ts('Cancel'),
476 // FIXME: This probably needs to be done in preprocess
477 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()
478 && $this->_action
& CRM_Core_Action
::UPDATE
479 && CRM_Utils_Array
::value('financial_type_id', $this->_values
)
481 $financialTypeID = CRM_Contribute_PseudoConstant
::financialType($this->_values
['financial_type_id']);
482 CRM_Financial_BAO_FinancialType
::checkPermissionedLineItems($this->_id
, 'edit');
483 if (!CRM_Core_Permission
::check('edit contributions of type ' . $financialTypeID)) {
484 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
489 //tax rate from financialType
490 $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant
::getTaxRates()));
491 $this->assign('currencies', json_encode(CRM_Core_OptionGroup
::values('currencies_enabled')));
493 // build price set form.
494 $buildPriceSet = FALSE;
495 $invoicing = CRM_Invoicing_Utils
::isInvoicingEnabled();
496 $this->assign('invoicing', $invoicing);
498 $buildRecurBlock = FALSE;
500 // display tax amount on edit contribution page
501 if ($invoicing && $this->_action
& CRM_Core_Action
::UPDATE
&& isset($this->_values
['tax_amount'])) {
502 $this->assign('totalTaxAmount', $this->_values
['tax_amount']);
505 if (empty($this->_lineItems
) &&
506 ($this->_priceSetId ||
!empty($_POST['price_set_id']))
508 $buildPriceSet = TRUE;
509 $getOnlyPriceSetElements = TRUE;
510 if (!$this->_priceSetId
) {
511 $this->_priceSetId
= $_POST['price_set_id'];
512 $getOnlyPriceSetElements = FALSE;
515 $this->set('priceSetId', $this->_priceSetId
);
516 CRM_Price_BAO_PriceSet
::buildPriceSet($this);
518 // get only price set form elements.
519 if ($getOnlyPriceSetElements) {
523 // use to build form during form rule.
524 $this->assign('buildPriceSet', $buildPriceSet);
526 $defaults = $this->_values
;
527 $additionalDetailFields = [
531 'non_deductible_amount',
534 foreach ($additionalDetailFields as $key) {
535 if (!empty($defaults[$key])) {
536 $defaults['hidden_AdditionalDetail'] = 1;
541 if ($this->_productDAO
) {
542 if ($this->_productDAO
->product_id
) {
543 $defaults['hidden_Premium'] = 1;
547 if ($this->_noteID
&&
548 !CRM_Utils_System
::isNull($this->_values
['note'])
550 $defaults['hidden_AdditionalDetail'] = 1;
554 if (empty($this->_payNow
)) {
555 $paneNames[ts('Additional Details')] = 'AdditionalDetail';
558 //Add Premium pane only if Premium is exists.
559 $dao = new CRM_Contribute_DAO_Product();
562 if ($dao->find(TRUE) && empty($this->_payNow
)) {
563 $paneNames[ts('Premium Information')] = 'Premium';
566 $this->payment_instrument_id
= CRM_Utils_Array
::value('payment_instrument_id', $defaults, $this->getDefaultPaymentInstrumentId());
567 if (CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, FALSE, TRUE, $this->payment_instrument_id
) == TRUE) {
568 if (!empty($this->_recurPaymentProcessors
)) {
569 $buildRecurBlock = TRUE;
571 // ppID denotes a pledge payment.
572 foreach ($this->_paymentProcessors
as $processor) {
573 if (!empty($processor['is_recur']) && !empty($processor['object']) && $processor['object']->supports('recurContributionsForPledges')) {
574 $buildRecurBlock = TRUE;
577 $buildRecurBlock = FALSE;
580 if ($buildRecurBlock) {
581 CRM_Contribute_Form_Contribution_Main
::buildRecur($this);
582 $this->setDefaults(['is_recur' => 0]);
583 $this->assign('buildRecurBlock', TRUE);
587 $this->addPaymentProcessorSelect(FALSE, $buildRecurBlock);
589 foreach ($paneNames as $name => $type) {
590 $allPanes[$name] = $this->generatePane($type, $defaults);
593 $qfKey = $this->controller
->_key
;
594 $this->assign('qfKey', $qfKey);
595 $this->assign('allPanes', $allPanes);
597 $this->addFormRule(['CRM_Contribute_Form_Contribution', 'formRule'], $this);
599 if ($this->_formType
) {
600 $this->assign('formType', $this->_formType
);
604 $this->applyFilter('__ALL__', 'trim');
606 //need to assign custom data type and subtype to the template
607 $this->assign('customDataType', 'Contribution');
608 $this->assign('customDataSubType', $this->_contributionType
);
609 $this->assign('entityID', $this->_id
);
611 $contactField = $this->addEntityRef('contact_id', ts('Contributor'), ['create' => TRUE], TRUE);
612 if ($this->_context
!= 'standalone') {
613 $contactField->freeze();
616 $attributes = CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_Contribution');
618 // Check permissions for financial type first
619 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes, $this->_action
);
620 if (empty($financialTypes)) {
621 CRM_Core_Error
::statusBounce(ts('You do not have all the permissions needed for this page.'));
623 $financialType = $this->add('select', 'financial_type_id',
624 ts('Financial Type'),
625 ['' => ts('- select -')] +
$financialTypes,
627 ['onChange' => "CRM.buildCustomData( 'Contribution', this.value );"]
630 $paymentInstrument = FALSE;
632 // payment_instrument isn't required in edit and will not be present when payment block is enabled.
633 $required = $this->_id ?
FALSE : TRUE;
634 $checkPaymentID = array_search('Check', CRM_Contribute_PseudoConstant
::paymentInstrument('name'));
635 $paymentInstrument = $this->add('select', 'payment_instrument_id',
636 ts('Payment Method'),
637 ['' => ts('- select -')] + CRM_Contribute_PseudoConstant
::paymentInstrument(),
638 $required, ['onChange' => "return showHideByValue('payment_instrument_id','{$checkPaymentID}','checkNumber','table-row','select',false);"]
642 $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), ['class' => 'twelve'] +
$attributes['trxn_id']);
644 //add receipt for offline contribution
645 $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
647 $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails
);
649 $component = 'contribution';
650 $componentDetails = [];
652 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
653 if (!empty($componentDetails['membership'])) {
654 $component = 'membership';
656 elseif (!empty($componentDetails['participant'])) {
657 $component = 'participant';
661 $component = 'pledge';
663 $status = CRM_Contribute_BAO_Contribution_Utils
::getContributionStatuses($component, $this->_id
);
665 // define the status IDs that show the cancellation info, see CRM-17589
666 $cancelInfo_show_ids = [];
667 foreach (array_keys($status) as $status_id) {
668 if (CRM_Contribute_BAO_Contribution
::isContributionStatusNegative($status_id)) {
669 $cancelInfo_show_ids[] = "'$status_id'";
672 $this->assign('cancelInfo_show_ids', implode(',', $cancelInfo_show_ids));
674 $statusElement = $this->add('select', 'contribution_status_id',
675 ts('Contribution Status'),
680 $currencyFreeze = FALSE;
681 if (!empty($this->_payNow
) && ($this->_action
& CRM_Core_Action
::UPDATE
)) {
682 $statusElement->freeze();
683 $currencyFreeze = TRUE;
684 $attributes['total_amount']['readonly'] = TRUE;
687 // CRM-16189, add Revenue Recognition Date
688 if (Civi
::settings()->get('deferred_revenue_enabled')) {
689 $revenueDate = $this->add('date', 'revenue_recognition_date', ts('Revenue Recognition Date'), CRM_Core_SelectValues
::date(NULL, 'M Y', NULL, 5));
690 if ($this->_id
&& !CRM_Contribute_BAO_Contribution
::allowUpdateRevenueRecognitionDate($this->_id
)) {
691 $revenueDate->freeze();
696 $this->addField('receive_date', ['entity' => 'contribution'], !$this->_mode
, FALSE);
697 $this->addField('receipt_date', ['entity' => 'contribution'], FALSE, FALSE);
698 $this->addField('cancel_date', ['entity' => 'contribution', 'label' => ts('Cancelled / Refunded Date')], FALSE, FALSE);
700 if ($this->_online
) {
701 $this->assign('hideCalender', TRUE);
704 $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
707 if (empty($this->_lineItems
)) {
708 $buildPriceSet = FALSE;
709 $priceSets = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute');
710 if (!empty($priceSets) && !$this->_ppID
) {
711 $buildPriceSet = TRUE;
714 // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
715 // and if we already have line items for that participant. CRM-5095
716 if ($buildPriceSet && $this->_id
) {
717 $pledgePaymentId = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
722 if ($pledgePaymentId) {
723 $buildPriceSet = FALSE;
725 if ($participantID = CRM_Utils_Array
::value('participant', $componentDetails)) {
726 $participantLI = CRM_Price_BAO_LineItem
::getLineItems($participantID);
727 if (!CRM_Utils_System
::isNull($participantLI)) {
728 $buildPriceSet = FALSE;
733 $hasPriceSets = FALSE;
734 if ($buildPriceSet) {
735 $hasPriceSets = TRUE;
736 // CRM-16451: set financial type of 'Price Set' in back office contribution
737 // instead of selecting manually
738 $financialTypeIds = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviContribute', 'financial_type_id');
739 $element = $this->add('select', 'price_set_id', ts('Choose price set'),
741 '' => ts('Choose price set'),
743 NULL, ['onchange' => "buildAmount( this.value, " . json_encode($financialTypeIds) . ");"]
745 if ($this->_online
&& !($this->_action
& CRM_Core_Action
::UPDATE
)) {
749 $this->assign('hasPriceSets', $hasPriceSets);
750 if (!($this->_action
& CRM_Core_Action
::UPDATE
)) {
751 if ($this->_online ||
$this->_ppID
) {
752 $attributes['total_amount'] = array_merge($attributes['total_amount'], [
754 'style' => "background-color:#EBECE4",
757 '1' => ts('Adjust Pledge Payment Schedule?'),
758 '2' => ts('Adjust Total Pledge Amount?'),
760 $this->addRadio('option_type',
766 $currencyFreeze = TRUE;
770 $totalAmount = $this->addMoney('total_amount',
772 ($hasPriceSets) ?
FALSE : TRUE,
773 $attributes['total_amount'],
774 TRUE, 'currency', NULL, $currencyFreeze
778 $this->add('text', 'source', ts('Source'), CRM_Utils_Array
::value('source', $attributes));
780 // CRM-7362 --add campaigns.
781 CRM_Campaign_BAO_Campaign
::addCampaign($this, CRM_Utils_Array
::value('campaign_id', $this->_values
));
783 if (empty($this->_payNow
)) {
784 CRM_Contribute_Form_SoftCredit
::buildQuickForm($this);
789 $js = ['onclick' => "return verify( );"];
792 $mailingInfo = Civi
::settings()->get('mailing_backend');
793 $this->assign('outBound_option', $mailingInfo['outBound_option']);
798 'name' => ts('Save'),
804 'name' => ts('Save and New'),
810 'name' => ts('Cancel'),
814 // if contribution is related to membership or participant freeze Financial Type, Amount
816 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
817 $isCancelledStatus = ($this->_values
['contribution_status_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Cancelled'));
819 if (!empty($componentDetails['membership']) ||
820 !empty($componentDetails['participant']) ||
821 // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
822 // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
826 $totalAmount->freeze();
827 $this->getElement('currency')->freeze();
829 if ($isCancelledStatus) {
830 $paymentInstrument->freeze();
833 $financialType->freeze();
834 $this->assign('freezeFinancialType', TRUE);
838 if ($this->_action
& CRM_Core_Action
::VIEW
) {
846 * @param array $fields
847 * The input form values.
848 * @param array $files
849 * The uploaded files if any.
853 * true if no errors, else array of errors
855 public static function formRule($fields, $files, $self) {
857 // Check for Credit Card Contribution.
859 if (empty($fields['payment_processor_id'])) {
860 $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
863 // validate payment instrument (e.g. credit card number)
864 CRM_Core_Payment_Form
::validatePaymentInstrument($fields['payment_processor_id'], $fields, $errors, NULL);
868 // Do the amount validations.
869 if (empty($fields['total_amount']) && empty($self->_lineItems
)) {
870 if ($priceSetId = CRM_Utils_Array
::value('price_set_id', $fields)) {
871 CRM_Price_BAO_PriceField
::priceSetValidation($priceSetId, $fields, $errors);
875 $softErrors = CRM_Contribute_Form_SoftCredit
::formRule($fields, $errors, $self);
877 //CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
878 CRM_Contribute_BAO_ContributionRecur
::validateRecurContribution($fields, $files, $self, $errors);
880 // Form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
881 if (($self->_action
& CRM_Core_Action
::UPDATE
)
883 && $self->_values
['contribution_status_id'] != $fields['contribution_status_id']
885 CRM_Contribute_BAO_Contribution
::checkStatusValidation($self->_values
, $fields, $errors);
887 // CRM-16015, add form-rule to restrict change of financial type if using price field of different financial type
888 if (($self->_action
& CRM_Core_Action
::UPDATE
)
890 && $self->_values
['financial_type_id'] != $fields['financial_type_id']
892 CRM_Contribute_BAO_Contribution
::checkFinancialTypeChange(NULL, $self->_id
, $errors);
894 //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
895 if (!empty($fields['fee_amount']) && !empty($fields['financial_type_id']) && $financialType = CRM_Contribute_BAO_Contribution
::validateFinancialType($fields['financial_type_id'])) {
896 $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
899 // $trxn_id must be unique CRM-13919
900 if (!empty($fields['trxn_id'])) {
901 $queryParams = [1 => [$fields['trxn_id'], 'String']];
902 $query = 'select count(*) from civicrm_contribution where trxn_id = %1';
904 $queryParams[2] = [(int) $self->_id
, 'Integer'];
905 $query .= ' and id !=%2';
907 $tCnt = CRM_Core_DAO
::singleValueQuery($query, $queryParams);
909 $errors['trxn_id'] = ts('Transaction ID\'s must be unique. Transaction \'%1\' already exists in your database.', [1 => $fields['trxn_id']]);
912 if (!empty($fields['revenue_recognition_date'])
913 && count(array_filter($fields['revenue_recognition_date'])) == 1
915 $errors['revenue_recognition_date'] = ts('Month and Year are required field for Revenue Recognition.');
919 CRM_Financial_BAO_FinancialAccount
::checkFinancialTypeHasDeferred($fields, $self->_id
, $self->_priceSet
['fields']);
921 catch (CRM_Core_Exception
$e) {
922 $errors['financial_type_id'] = ' ';
923 $errors['_qf_default'] = $e->getMessage();
925 $errors = array_merge($errors, $softErrors);
930 * Process the form submission.
932 public function postProcess() {
933 if ($this->_action
& CRM_Core_Action
::DELETE
) {
934 CRM_Contribute_BAO_Contribution
::deleteContribution($this->_id
);
935 CRM_Core_Session
::singleton()->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
936 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
940 // Get the submitted form values.
941 $submittedValues = $this->controller
->exportValues($this->_name
);
944 $contribution = $this->submit($submittedValues, $this->_action
, $this->_ppID
);
946 catch (PaymentProcessorException
$e) {
947 // Set the contribution mode.
948 $urlParams = "action=add&cid={$this->_contactID}";
950 $urlParams .= "&mode={$this->_mode}";
952 if (!empty($this->_ppID
)) {
953 $urlParams .= "&context=pledge&ppid={$this->_ppID}";
956 CRM_Core_Error
::statusBounce($e->getMessage(), $urlParams, ts('Payment Processor Error'));
958 $session = CRM_Core_Session
::singleton();
959 $buttonName = $this->controller
->getButtonName();
960 if ($this->_context
== 'standalone') {
961 if ($buttonName == $this->getButtonName('upload', 'new')) {
962 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contribute/add',
963 'reset=1&action=add&context=standalone'
967 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view',
968 "reset=1&cid={$this->_contactID}&selectedChild=contribute"
972 elseif ($this->_context
== 'contribution' && $this->_mode
&& $buttonName == $this->getButtonName('upload', 'new')) {
973 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
974 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
977 elseif ($buttonName == $this->getButtonName('upload', 'new')) {
978 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/contact/view/contribution',
979 "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
983 //store contribution ID if not yet set (on create)
984 if (empty($this->_id
) && !empty($contribution->id
)) {
985 $this->_id
= $contribution->id
;
987 if (!empty($this->_id
) && CRM_Core_Permission
::access('CiviMember')) {
988 $membershipPaymentCount = civicrm_api3('MembershipPayment', 'getCount', ['contribution_id' => $this->_id
]);
989 if ($membershipPaymentCount) {
990 $this->ajaxResponse
['updateTabs']['#tab_member'] = CRM_Contact_BAO_Contact
::getCountComponent('membership', $this->_contactID
);
993 if (!empty($this->_id
) && CRM_Core_Permission
::access('CiviEvent')) {
994 $participantPaymentCount = civicrm_api3('ParticipantPayment', 'getCount', ['contribution_id' => $this->_id
]);
995 if ($participantPaymentCount) {
996 $this->ajaxResponse
['updateTabs']['#tab_participant'] = CRM_Contact_BAO_Contact
::getCountComponent('participant', $this->_contactID
);
1002 * Process credit card payment.
1004 * @param array $submittedValues
1005 * @param array $lineItem
1007 * @param int $contactID
1010 * @return bool|\CRM_Contribute_DAO_Contribution
1012 * @throws \CRM_Core_Exception
1013 * @throws \Civi\Payment\Exception\PaymentProcessorException
1014 * @throws \CiviCRM_API3_Exception
1016 protected function processCreditCard($submittedValues, $lineItem, $contactID) {
1017 $isTest = ($this->_mode
== 'test') ?
1 : 0;
1018 // CRM-12680 set $_lineItem if its not set
1019 // @todo - I don't believe this would ever BE set. I can't find anywhere in the code.
1020 // It would be better to pass line item out to functions than $this->_lineItem as
1021 // we don't know what is being changed where.
1022 if (empty($this->_lineItem
) && !empty($lineItem)) {
1023 $this->_lineItem
= $lineItem;
1026 $this->_paymentObject
= Civi\Payment\System
::singleton()->getById($submittedValues['payment_processor_id']);
1027 $this->_paymentProcessor
= $this->_paymentObject
->getPaymentProcessor();
1029 // Set source if not set
1030 if (empty($submittedValues['source'])) {
1031 $userID = CRM_Core_Session
::singleton()->get('userID');
1032 $userSortName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1035 $submittedValues['source'] = ts('Submit Credit Card Payment by: %1', [1 => $userSortName]);
1038 $params = $submittedValues;
1039 $this->_params
= array_merge($this->_params
, $submittedValues);
1041 // Mapping requiring documentation.
1042 $this->_params
['payment_processor'] = $submittedValues['payment_processor_id'];
1044 $now = date('YmdHis');
1046 $this->_contributorEmail
= $this->userEmail
;
1047 $this->_contributorContactID
= $contactID;
1048 $this->processBillingAddress();
1049 if (!empty($params['source'])) {
1050 unset($params['source']);
1053 $this->_params
['amount'] = $this->_params
['total_amount'];
1054 // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
1055 // function to get correct amount level consistently. Remove setting of the amount level in
1056 // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
1057 // to cover all variants.
1058 $this->_params
['amount_level'] = 0;
1059 $this->_params
['description'] = ts("Contribution submitted by a staff person using contributor's credit card");
1060 $this->_params
['currencyID'] = CRM_Utils_Array
::value('currency',
1062 CRM_Core_Config
::singleton()->defaultCurrency
1065 $this->_params
['pcp_display_in_roll'] = CRM_Utils_Array
::value('pcp_display_in_roll', $params);
1066 $this->_params
['pcp_roll_nickname'] = CRM_Utils_Array
::value('pcp_roll_nickname', $params);
1067 $this->_params
['pcp_personal_note'] = CRM_Utils_Array
::value('pcp_personal_note', $params);
1069 //Add common data to formatted params
1070 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($params, $this->_params
, $this);
1072 if (empty($this->_params
['invoice_id'])) {
1073 $this->_params
['invoiceID'] = md5(uniqid(rand(), TRUE));
1076 $this->_params
['invoiceID'] = $this->_params
['invoice_id'];
1079 // At this point we've created a contact and stored its address etc
1080 // all the payment processors expect the name and address to be in the
1081 // so we copy stuff over to first_name etc.
1082 $paymentParams = $this->_params
;
1083 $paymentParams['contactID'] = $contactID;
1084 CRM_Core_Payment_Form
::mapParams($this->_bltID
, $this->_params
, $paymentParams, TRUE);
1086 $financialType = new CRM_Financial_DAO_FinancialType();
1087 $financialType->id
= $params['financial_type_id'];
1088 $financialType->find(TRUE);
1090 // Add some financial type details to the params list
1091 // if folks need to use it.
1092 $paymentParams['contributionType_name'] = $this->_params
['contributionType_name'] = $financialType->name
;
1093 $paymentParams['contributionPageID'] = NULL;
1095 if (!empty($this->_params
['is_email_receipt'])) {
1096 $paymentParams['email'] = $this->userEmail
;
1097 $paymentParams['is_email_receipt'] = 1;
1100 $paymentParams['is_email_receipt'] = 0;
1101 $this->_params
['is_email_receipt'] = 0;
1103 if (!empty($this->_params
['receive_date'])) {
1104 $paymentParams['receive_date'] = $this->_params
['receive_date'];
1107 if (!empty($this->_params
['is_email_receipt'])) {
1108 $this->_params
['receipt_date'] = $now;
1111 $this->set('params', $this->_params
);
1113 $this->assign('receive_date', $this->_params
['receive_date']);
1115 // Result has all the stuff we need
1116 // lets archive it to a financial transaction
1117 if ($financialType->is_deductible
) {
1118 $this->assign('is_deductible', TRUE);
1119 $this->set('is_deductible', TRUE);
1121 $contributionParams = [
1122 'id' => CRM_Utils_Array
::value('contribution_id', $this->_params
),
1123 'contact_id' => $contactID,
1124 'line_item' => $lineItem,
1125 'is_test' => $isTest,
1126 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $this->_params
),
1127 'contribution_page_id' => CRM_Utils_Array
::value('contribution_page_id', $this->_params
),
1128 'source' => CRM_Utils_Array
::value('source', $paymentParams, CRM_Utils_Array
::value('description', $paymentParams)),
1129 'thankyou_date' => CRM_Utils_Array
::value('thankyou_date', $this->_params
),
1131 $contributionParams['payment_instrument_id'] = $this->_paymentProcessor
['payment_instrument_id'];
1133 $contribution = CRM_Contribute_Form_Contribution_Confirm
::processFormContribution($this,
1136 $contributionParams,
1140 CRM_Utils_Array
::value('is_recur', $this->_params
)
1143 $paymentParams['contributionID'] = $contribution->id
;
1144 $paymentParams['contributionTypeID'] = $contribution->financial_type_id
;
1145 $paymentParams['contributionPageID'] = $contribution->contribution_page_id
;
1146 $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id
;
1148 if ($paymentParams['amount'] > 0.0) {
1149 // force a re-get of the payment processor in case the form changed it, CRM-7179
1150 // NOTE - I expect this is obsolete.
1151 $payment = Civi\Payment\System
::singleton()->getByProcessor($this->_paymentProcessor
);
1153 $completeStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1154 $result = $payment->doPayment($paymentParams, 'contribute');
1155 $this->assign('trxn_id', $result['trxn_id']);
1156 $contribution->trxn_id
= $result['trxn_id'];
1157 /* Our scenarios here are
1158 * 1) the payment failed & an Exception should have been thrown
1159 * 2) the payment succeeded but the payment is not immediate (for example a recurring payment
1160 * with a delayed start)
1161 * 3) the payment succeeded with an immediate payment.
1163 * The doPayment function ensures that payment_status_id is always set
1164 * as historically we have had to guess from the context - ie doDirectPayment
1165 * = error or success, unless it is a recurring contribution in which case it is pending.
1167 if ($result['payment_status_id'] == $completeStatusId) {
1169 civicrm_api3('contribution', 'completetransaction', [
1170 'id' => $contribution->id
,
1171 'trxn_id' => $result['trxn_id'],
1172 'payment_processor_id' => $this->_paymentProcessor
['id'],
1173 'is_transactional' => FALSE,
1174 'fee_amount' => CRM_Utils_Array
::value('fee_amount', $result),
1175 'card_type_id' => CRM_Utils_Array
::value('card_type_id', $paymentParams),
1176 'pan_truncation' => CRM_Utils_Array
::value('pan_truncation', $paymentParams),
1177 'is_email_receipt' => FALSE,
1179 // This has now been set to 1 in the DB - declare it here also
1180 $contribution->contribution_status_id
= 1;
1182 catch (CiviCRM_API3_Exception
$e) {
1183 if ($e->getErrorCode() != 'contribution_completed') {
1184 throw new CRM_Core_Exception('Failed to update contribution in database');
1189 // Save the trxn_id.
1190 $contribution->save();
1193 catch (PaymentProcessorException
$e) {
1194 CRM_Contribute_BAO_Contribution
::failPayment($contribution->id
, $paymentParams['contactID'], $e->getMessage());
1195 throw new PaymentProcessorException($e->getMessage());
1198 // Send receipt mail.
1199 array_unshift($this->statusMessage
, ts('The contribution record has been saved.'));
1200 if ($contribution->id
&& !empty($this->_params
['is_email_receipt'])) {
1201 $this->_params
['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $result);
1202 $this->_params
['contact_id'] = $contactID;
1203 $this->_params
['contribution_id'] = $contribution->id
;
1204 if (CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $this->_params
, TRUE)) {
1205 $this->statusMessage
[] = ts('A receipt has been emailed to the contributor.');
1209 return $contribution;
1213 * Generate the data to construct a snippet based pane.
1215 * This form also assigns the showAdditionalInfo var based on historical code.
1216 * This appears to mean 'there is a pane to show'.
1218 * @param string $type
1219 * Type of Pane - this is generally used to determine the function name used to build it
1220 * - e.g CreditCard, AdditionalDetail
1221 * @param array $defaults
1224 * We aim to further refactor & simplify this but currently
1226 * - should additional info be shown?
1228 protected function generatePane($type, $defaults) {
1229 $urlParams = "snippet=4&formType={$type}";
1231 $urlParams .= "&mode={$this->_mode}";
1235 if ($type == 'CreditCard' ||
1236 $type == 'DirectDebit'
1242 'url' => CRM_Utils_System
::url('civicrm/contact/view/contribution', $urlParams),
1247 // See if we need to include this paneName in the current form.
1248 if ($this->_formType
== $type ||
!empty($_POST["hidden_{$type}"]) ||
1249 CRM_Utils_Array
::value("hidden_{$type}", $defaults)
1251 $this->assign('showAdditionalInfo', TRUE);
1252 $pane['open'] = 'true';
1255 if ($type == 'CreditCard' ||
$type == 'DirectDebit') {
1256 // @todo would be good to align tpl name with form name...
1257 // @todo document why this hidden variable is required.
1258 $this->add('hidden', 'hidden_' . $type, 1);
1262 $additionalInfoFormFunction = 'build' . $type;
1263 CRM_Contribute_Form_AdditionalInfo
::$additionalInfoFormFunction($this);
1269 * Wrapper for unit testing the post process submit function.
1271 * (If we expose through api we can get default additions 'for free').
1273 * @param array $params
1274 * @param int $action
1275 * @param string|null $creditCardMode
1277 * @return CRM_Contribute_BAO_Contribution
1279 * @throws \CRM_Core_Exception
1280 * @throws \CiviCRM_API3_Exception
1281 * @throws \Civi\Payment\Exception\PaymentProcessorException
1283 public function testSubmit($params, $action, $creditCardMode = NULL) {
1285 'soft_credit_contact_id' => [],
1286 'receive_date' => date('Y-m-d H:i:s'),
1287 'receipt_date' => '',
1288 'cancel_date' => '',
1289 'hidden_Premium' => 1,
1292 if (!empty($params['id'])) {
1293 $existingContribution = civicrm_api3('contribution', 'getsingle', [
1294 'id' => $params['id'],
1296 $this->_id
= $params['id'];
1297 $this->_values
= $existingContribution;
1298 if (CRM_Contribute_BAO_Contribution
::checkContributeSettings('invoicing')) {
1299 $this->_values
['tax_amount'] = civicrm_api3('contribution', 'getvalue', [
1300 'id' => $params['id'],
1301 'return' => 'tax_amount',
1306 $existingContribution = [];
1309 $this->_defaults
['contribution_status_id'] = CRM_Utils_Array
::value('contribution_status_id',
1310 $existingContribution
1313 $this->_defaults
['total_amount'] = CRM_Utils_Array
::value('total_amount',
1314 $existingContribution
1317 if ($creditCardMode) {
1318 $this->_mode
= $creditCardMode;
1321 // Required because processCreditCard calls set method on this.
1322 $_SERVER['REQUEST_METHOD'] = 'GET';
1323 $this->controller
= new CRM_Core_Controller();
1325 CRM_Contribute_Form_AdditionalInfo
::buildPremium($this);
1327 $this->_fields
= [];
1328 return $this->submit(array_merge($defaults, $params), $action, CRM_Utils_Array
::value('pledge_payment_id', $params));
1333 * @param array $submittedValues
1335 * @param int $action
1337 * - CRM_Core_Action::UPDATE
1339 * @param $pledgePaymentID
1341 * @return \CRM_Contribute_BAO_Contribution
1343 * @throws \CRM_Core_Exception
1344 * @throws \CiviCRM_API3_Exception
1345 * @throws \Civi\Payment\Exception\PaymentProcessorException
1347 protected function submit($submittedValues, $action, $pledgePaymentID) {
1348 $pId = $contribution = $isRelatedId = FALSE;
1349 $this->_params
= $submittedValues;
1350 $this->beginPostProcess();
1351 // reassign submitted form values if the any information is formatted via beginPostProcess
1352 $submittedValues = $this->_params
;
1354 if (!empty($submittedValues['price_set_id']) && $action & CRM_Core_Action
::UPDATE
) {
1355 $line = CRM_Price_BAO_LineItem
::getLineItems($this->_id
, 'contribution');
1356 $lineID = key($line);
1357 $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array
::value('price_field_id', $line[$lineID]), 'price_set_id');
1358 $quickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1359 // Why do we do this? Seems like a like a wrapper for old functionality - but single line price sets & quick
1360 // config should be treated the same.
1362 CRM_Price_BAO_LineItem
::deleteLineItems($this->_id
, 'civicrm_contribution');
1366 // Process price set and get total amount and line items.
1368 $priceSetId = CRM_Utils_Array
::value('price_set_id', $submittedValues);
1369 if (empty($priceSetId) && !$this->_id
) {
1370 $this->_priceSetId
= $priceSetId = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
1371 $this->_priceSet
= current(CRM_Price_BAO_PriceSet
::getSetDetail($priceSetId));
1372 $fieldID = key($this->_priceSet
['fields']);
1373 $fieldValueId = key($this->_priceSet
['fields'][$fieldID]['options']);
1374 $this->_priceSet
['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
1375 $submittedValues['price_' . $fieldID] = 1;
1378 // Every contribution has a price-set - the only reason it shouldn't be set is if we are dealing with
1379 // quick config (very very arguably) & yet we see that this could still be quick config so this should be understood
1380 // as a point of fragility rather than a logical 'if' clause.
1382 CRM_Price_BAO_PriceSet
::processAmount($this->_priceSet
['fields'],
1383 $submittedValues, $lineItem[$priceSetId], NULL, $priceSetId);
1384 // Unset tax amount for offline 'is_quick_config' contribution.
1385 // @todo WHY - quick config was conceived as a quick way to configure contribution forms.
1386 // this is an example of 'other' functionality being hung off it.
1387 if ($this->_priceSet
['is_quick_config'] &&
1388 !array_key_exists($submittedValues['financial_type_id'], CRM_Core_PseudoConstant
::getTaxRates())
1390 unset($submittedValues['tax_amount']);
1392 $submittedValues['total_amount'] = CRM_Utils_Array
::value('amount', $submittedValues);
1396 if ($this->_compId
) {
1397 if ($this->_context
== 'participant') {
1398 $pId = $this->_compId
;
1400 elseif ($this->_context
== 'membership') {
1401 $isRelatedId = TRUE;
1404 $pId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id
, 'participant_id', 'contribution_id');
1408 $contributionDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1409 if (array_key_exists('membership', $contributionDetails)) {
1410 $isRelatedId = TRUE;
1412 elseif (array_key_exists('participant', $contributionDetails)) {
1413 $pId = $contributionDetails['participant'];
1416 if (!empty($this->_payNow
)) {
1417 $this->_params
['contribution_id'] = $this->_id
;
1421 if (!$priceSetId && !empty($submittedValues['total_amount']) && $this->_id
) {
1422 // CRM-10117 update the line items for participants.
1423 // @todo - if we are completing a contribution then the api call
1424 // civicrm_api3('Contribution', 'completetransaction') should take care of
1425 // all associated updates rather than replicating them on the form layer.
1427 $entityTable = 'participant';
1429 $isRelatedId = FALSE;
1430 $participantParams = [
1431 'fee_amount' => $submittedValues['total_amount'],
1434 CRM_Event_BAO_Participant
::add($participantParams);
1435 if (empty($this->_lineItems
)) {
1436 $this->_lineItems
[] = CRM_Price_BAO_LineItem
::getLineItems($entityID, 'participant', TRUE);
1440 $entityTable = 'contribution';
1441 $entityID = $this->_id
;
1444 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($entityID, $entityTable, FALSE, TRUE, $isRelatedId);
1445 foreach (array_keys($lineItems) as $id) {
1446 $lineItems[$id]['id'] = $id;
1448 $itemId = key($lineItems);
1449 if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1450 $this->_priceSetId
= CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1453 // @todo see above - new functionality has been inappropriately added to the quick config concept
1454 // and new functionality has been added onto the form layer rather than the BAO :-(
1455 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1456 //CRM-16833: Ensure tax is applied only once for membership conribution, when status changed.(e.g Pending to Completed).
1457 $componentDetails = CRM_Contribute_BAO_Contribution
::getComponentDetails($this->_id
);
1458 if (!(CRM_Utils_Array
::value('membership', $componentDetails) || CRM_Utils_Array
::value('participant', $componentDetails))) {
1459 if (!($this->_action
& CRM_Core_Action
::UPDATE
&& (($this->_defaults
['contribution_status_id'] != $submittedValues['contribution_status_id'])))) {
1460 $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule
::cleanMoney(CRM_Utils_Array
::value('total_amount', $submittedValues));
1464 // Update line total and total amount with tax on edit.
1465 $financialItemsId = CRM_Core_PseudoConstant
::getTaxRates();
1466 if (array_key_exists($submittedValues['financial_type_id'], $financialItemsId)) {
1467 $lineItems[$itemId]['tax_rate'] = $financialItemsId[$submittedValues['financial_type_id']];
1470 $lineItems[$itemId]['tax_rate'] = $lineItems[$itemId]['tax_amount'] = "";
1471 $submittedValues['tax_amount'] = 'null';
1473 if ($lineItems[$itemId]['tax_rate']) {
1474 $lineItems[$itemId]['tax_amount'] = ($lineItems[$itemId]['tax_rate'] / 100) * $lineItems[$itemId]['line_total'];
1475 $submittedValues['total_amount'] = $lineItems[$itemId]['line_total'] +
$lineItems[$itemId]['tax_amount'];
1476 $submittedValues['tax_amount'] = $lineItems[$itemId]['tax_amount'];
1479 // CRM-10117 update the line items for participants.
1480 if (!empty($lineItems[$itemId]['price_field_id'])) {
1481 $lineItem[$this->_priceSetId
] = $lineItems;
1486 if ($this->_priceSetId
&& CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId
, 'is_quick_config')) {
1489 //CRM-11529 for quick config back office transactions
1490 //when financial_type_id is passed in form, update the
1491 //line items with the financial type selected in form
1492 // NOTE that this IS still a legitimate use of 'quick-config' for contributions under the current DB but
1493 // we should look at having a price field per contribution type & then there would be little reason
1494 // for the back-office contribution form postProcess to know if it is a quick-config form.
1495 if ($isQuickConfig && !empty($submittedValues['financial_type_id']) && CRM_Utils_Array
::value($this->_priceSetId
, $lineItem)
1497 foreach ($lineItem[$this->_priceSetId
] as &$values) {
1498 $values['financial_type_id'] = $submittedValues['financial_type_id'];
1502 if (!isset($submittedValues['total_amount'])) {
1503 $submittedValues['total_amount'] = CRM_Utils_Array
::value('total_amount', $this->_values
);
1504 // Avoid tax amount deduction on edit form and keep it original, because this will lead to error described in CRM-20676
1506 $submittedValues['total_amount'] -= CRM_Utils_Array
::value('tax_amount', $this->_values
, 0);
1509 $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ?
$lineItem : FALSE);
1511 $isEmpty = array_keys(array_flip($submittedValues['soft_credit_contact_id']));
1512 if ($this->_id
&& count($isEmpty) == 1 && key($isEmpty) == NULL) {
1513 civicrm_api3('ContributionSoft', 'get', ['contribution_id' => $this->_id
, 'pcp_id' => NULL, 'api.ContributionSoft.delete' => 1]);
1516 // set the contact, when contact is selected
1517 if (!empty($submittedValues['contact_id'])) {
1518 $this->_contactID
= $submittedValues['contact_id'];
1521 $formValues = $submittedValues;
1523 // Credit Card Contribution.
1525 $paramsSetByPaymentProcessingSubsystem = [
1527 'payment_instrument_id',
1528 'contribution_status_id',
1532 foreach ($paramsSetByPaymentProcessingSubsystem as $key) {
1533 if (isset($formValues[$key])) {
1534 unset($formValues[$key]);
1537 $contribution = $this->processCreditCard($formValues, $lineItem, $this->_contactID
);
1538 foreach ($paramsSetByPaymentProcessingSubsystem as $key) {
1539 $formValues[$key] = $contribution->$key;
1543 // Offline Contribution.
1544 $submittedValues = $this->unsetCreditCardFields($submittedValues);
1546 // get the required field value only.
1549 'contact_id' => $this->_contactID
,
1550 'currency' => $this->getCurrency($submittedValues),
1551 'skipCleanMoney' => TRUE,
1555 //format soft-credit/pcp param first
1556 CRM_Contribute_BAO_ContributionSoft
::formatSoftCreditParams($submittedValues, $this);
1557 $params = array_merge($params, $submittedValues);
1560 'financial_type_id',
1561 'contribution_status_id',
1562 'payment_instrument_id',
1569 foreach ($fields as $f) {
1570 $params[$f] = CRM_Utils_Array
::value($f, $formValues);
1573 $params['revenue_recognition_date'] = NULL;
1574 if (!empty($formValues['revenue_recognition_date'])
1575 && count(array_filter($formValues['revenue_recognition_date'])) == 2
1577 $params['revenue_recognition_date'] = CRM_Utils_Date
::processDate(
1578 '01-' . implode('-', $formValues['revenue_recognition_date'])
1582 if (!empty($formValues['is_email_receipt'])) {
1583 $params['receipt_date'] = date("Y-m-d");
1586 if (CRM_Contribute_BAO_Contribution
::isContributionStatusNegative($params['contribution_status_id'])
1588 if (CRM_Utils_System
::isNull(CRM_Utils_Array
::value('cancel_date', $params))) {
1589 $params['cancel_date'] = date('YmdHis');
1593 $params['cancel_date'] = $params['cancel_reason'] = 'null';
1596 // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
1597 // else if contribution_status is changed to Completed is_pay_later flag is changed to 0, CRM-15041
1598 if ($params['contribution_status_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending')) {
1599 $params['is_pay_later'] = 1;
1601 elseif ($params['contribution_status_id'] == CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed')) {
1602 $params['is_pay_later'] = 0;
1605 // Add Additional common information to formatted params.
1606 CRM_Contribute_Form_AdditionalInfo
::postProcessCommon($formValues, $params, $this);
1608 $params['contribution_mode'] = 'participant';
1609 $params['participant_id'] = $pId;
1610 $params['skipLineItem'] = 1;
1612 elseif ($isRelatedId) {
1613 $params['contribution_mode'] = 'membership';
1615 $params['line_item'] = $lineItem;
1616 $params['payment_processor_id'] = $params['payment_processor'] = CRM_Utils_Array
::value('id', $this->_paymentProcessor
);
1617 $params['tax_amount'] = CRM_Utils_Array
::value('tax_amount', $submittedValues, CRM_Utils_Array
::value('tax_amount', $this->_values
));
1618 //create contribution.
1619 if ($isQuickConfig) {
1620 $params['is_quick_config'] = 1;
1622 $params['non_deductible_amount'] = $this->calculateNonDeductibleAmount($params, $formValues);
1624 // we are already handling note below, so to avoid duplicate notes against $contribution
1625 if (!empty($params['note']) && !empty($submittedValues['note'])) {
1626 unset($params['note']);
1628 $contribution = CRM_Contribute_BAO_Contribution
::create($params);
1630 // process associated membership / participant, CRM-4395
1631 if ($contribution->id
&& $action & CRM_Core_Action
::UPDATE
) {
1632 $this->statusMessage
[] = CRM_Contribute_BAO_Contribution
::transitionComponentWithReturnMessage($contribution->id
,
1633 $contribution->contribution_status_id
,
1634 CRM_Utils_Array
::value('contribution_status_id',
1637 $contribution->receive_date
1641 array_unshift($this->statusMessage
, ts('The contribution record has been saved.'));
1643 $this->invoicingPostProcessHook($submittedValues, $action, $lineItem);
1645 //send receipt mail.
1646 if ($contribution->id
&& !empty($formValues['is_email_receipt'])) {
1647 $formValues['contact_id'] = $this->_contactID
;
1648 $formValues['contribution_id'] = $contribution->id
;
1650 $formValues +
= CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($contribution->id
);
1652 // to get 'from email id' for send receipt
1653 $this->fromEmailId
= CRM_Utils_Array
::value('from_email_address', $formValues);
1654 if (CRM_Contribute_Form_AdditionalInfo
::emailReceipt($this, $formValues)) {
1655 $this->statusMessage
[] = ts('A receipt has been emailed to the contributor.');
1659 $this->statusMessageTitle
= ts('Saved');
1663 if ($contribution->id
&& isset($formValues['product_name'][0])) {
1664 CRM_Contribute_Form_AdditionalInfo
::processPremium($submittedValues, $contribution->id
,
1665 $this->_premiumID
, $this->_options
1669 if ($contribution->id
&& array_key_exists('note', $submittedValues)) {
1670 CRM_Contribute_Form_AdditionalInfo
::processNote($submittedValues, $this->_contactID
, $contribution->id
, $this->_noteID
);
1673 CRM_Core_Session
::setStatus(implode(' ', $this->statusMessage
), $this->statusMessageTitle
, 'success');
1675 CRM_Contribute_BAO_Contribution
::updateRelatedPledge(
1679 (CRM_Utils_Array
::value('option_type', $formValues) == 2) ?
TRUE : FALSE,
1680 $formValues['total_amount'],
1681 CRM_Utils_Array
::value('total_amount', $this->_defaults
),
1682 $formValues['contribution_status_id'],
1683 CRM_Utils_Array
::value('contribution_status_id', $this->_defaults
)
1685 return $contribution;
1689 * Assign tax calculations to contribution receipts.
1691 * @param array $submittedValues
1692 * @param int $action
1693 * @param array $lineItem
1695 protected function invoicingPostProcessHook($submittedValues, $action, $lineItem) {
1697 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
1698 if (empty($invoiceSettings['invoicing'])) {
1702 $getTaxDetails = FALSE;
1704 foreach ($lineItem as $key => $value) {
1705 foreach ($value as $v) {
1706 if (isset($taxRate[(string) CRM_Utils_Array
::value('tax_rate', $v)])) {
1707 $taxRate[(string) $v['tax_rate']] = $taxRate[(string) $v['tax_rate']] + CRM_Utils_Array
::value('tax_amount', $v);
1710 if (isset($v['tax_rate'])) {
1711 $taxRate[(string) $v['tax_rate']] = CRM_Utils_Array
::value('tax_amount', $v);
1712 $getTaxDetails = TRUE;
1718 if ($action & CRM_Core_Action
::UPDATE
) {
1719 if (isset($submittedValues['tax_amount'])) {
1720 $totalTaxAmount = $submittedValues['tax_amount'];
1723 $totalTaxAmount = $this->_values
['tax_amount'];
1725 $this->assign('totalTaxAmount', $totalTaxAmount);
1726 $this->assign('dataArray', $taxRate);
1729 if (!empty($submittedValues['price_set_id'])) {
1730 $this->assign('totalTaxAmount', $submittedValues['tax_amount']);
1731 $this->assign('getTaxDetails', $getTaxDetails);
1732 $this->assign('dataArray', $taxRate);
1733 $this->assign('taxTerm', CRM_Utils_Array
::value('tax_term', $invoiceSettings));
1736 $this->assign('totalTaxAmount', CRM_Utils_Array
::value('tax_amount', $submittedValues));
1742 * Calculate non deductible amount.
1745 * if non_deductible_amount exists i.e. Additional Details field set was opened [and staff typed something] -
1746 * if non_deductible_amount does NOT exist - then calculate it depending on:
1747 * $financialType->is_deductible and whether there is a product (premium).
1750 * @param $formValues
1754 protected function calculateNonDeductibleAmount($params, $formValues) {
1755 if (!empty($params['non_deductible_amount'])) {
1756 return $params['non_deductible_amount'];
1759 $priceSetId = CRM_Utils_Array
::value('price_set_id', $params);
1760 // return non-deductible amount if it is set at the price field option level
1761 if ($priceSetId && !empty($params['line_item'])) {
1762 $nonDeductibleAmount = CRM_Price_BAO_PriceSet
::getNonDeductibleAmountFromPriceSet($priceSetId, $params['line_item']);
1763 if (!empty($nonDeductibleAmount)) {
1764 return $nonDeductibleAmount;
1768 $financialType = new CRM_Financial_DAO_FinancialType();
1769 $financialType->id
= $params['financial_type_id'];
1770 $financialType->find(TRUE);
1772 if ($financialType->is_deductible
) {
1774 if (isset($formValues['product_name'][0])) {
1775 $selectProduct = $formValues['product_name'][0];
1777 // if there is a product - compare the value to the contribution amount
1778 if (isset($selectProduct)) {
1779 $productDAO = new CRM_Contribute_DAO_Product();
1780 $productDAO->id
= $selectProduct;
1781 $productDAO->find(TRUE);
1782 // product value exceeds contribution amount
1783 if ($params['total_amount'] < $productDAO->price
) {
1784 return $params['total_amount'];
1786 // product value does NOT exceed contribution amount
1788 return $productDAO->price
;
1791 // contribution is deductible - but there is no product
1796 // contribution is NOT deductible
1798 return $params['total_amount'];