CRM/Contribute/Form/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 use Civi\Payment\Exception\PaymentProcessorException;
  13
  14 /**
  15  * This class generates form components for processing a contribution.
  16  */
  17 class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditPayment {
  18   /**
  19    * The id of the contribution that we are processing.
  20    *
  21    * @var int
  22    */
  23   public $_id;
  24
  25   /**
  26    * The id of the premium that we are processing.
  27    *
  28    * @var int
  29    */
  30   public $_premiumID = NULL;
  31
  32   /**
  33    * @var CRM_Contribute_DAO_ContributionProduct
  34    */
  35   public $_productDAO = NULL;
  36
  37   /**
  38    * The id of the note.
  39    *
  40    * @var int
  41    */
  42   public $_noteID;
  43
  44   /**
  45    * The id of the contact associated with this contribution.
  46    *
  47    * @var int
  48    */
  49   public $_contactID;
  50
  51   /**
  52    * The id of the pledge payment that we are processing.
  53    *
  54    * @var int
  55    */
  56   public $_ppID;
  57
  58   /**
  59    * Is this contribution associated with an online.
  60    * financial transaction
  61    *
  62    * @var bool
  63    */
  64   public $_online = FALSE;
  65
  66   /**
  67    * Stores all product options.
  68    *
  69    * @var array
  70    */
  71   public $_options;
  72
  73   /**
  74    * Storage of parameters from form
  75    *
  76    * @var array
  77    */
  78   public $_params;
  79
  80   /**
  81    * The contribution values if an existing contribution
  82    * @var array
  83    */
  84   public $_values;
  85
  86   /**
  87    * The pledge values if this contribution is associated with pledge
  88    * @var array
  89    */
  90   public $_pledgeValues;
  91
  92   public $_contributeMode = 'direct';
  93
  94   public $_context;
  95
  96   /**
  97    * Parameter with confusing name.
  98    * @var string
  99    * @todo what is it?
 100    */
 101   public $_compContext;
 102
 103   public $_compId;
 104
 105   /**
 106    * Possible From email addresses
 107    * @var array
 108    */
 109   public $_fromEmails;
 110
 111   /**
 112    * ID of from email.
 113    *
 114    * @var int
 115    */
 116   public $fromEmailId;
 117
 118   /**
 119    * Store the line items if price set used.
 120    * @var array
 121    */
 122   public $_lineItems;
 123
 124   /**
 125    * Line item
 126    * @var array
 127    * @todo explain why we use lineItem & lineItems
 128    */
 129   public $_lineItem;
 130
 131   /**
 132    * Soft credit info.
 133    *
 134    * @var array
 135    */
 136   public $_softCreditInfo;
 137
 138   protected $_formType;
 139
 140   /**
 141    * Array of the payment fields to be displayed in the payment fieldset (pane) in billingBlock.tpl
 142    * this contains all the information to describe these fields from quickform. See CRM_Core_Form_Payment getPaymentFormFieldsMetadata
 143    *
 144    * @var array
 145    */
 146   public $_paymentFields = [];
 147   /**
 148    * Logged in user's email.
 149    * @var string
 150    */
 151   public $userEmail;
 152
 153   /**
 154    * Price set ID.
 155    *
 156    * @var int
 157    */
 158   public $_priceSetId;
 159
 160   /**
 161    * Price set as an array
 162    * @var array
 163    */
 164   public $_priceSet;
 165
 166   /**
 167    * User display name
 168    *
 169    * @var string
 170    */
 171   public $userDisplayName;
 172
 173   /**
 174    * Status message to be shown to the user.
 175    *
 176    * @var array
 177    */
 178   protected $statusMessage = [];
 179
 180   /**
 181    * Status message title to be shown to the user.
 182    *
 183    * Generally the payment processor message title is 'Complete' and offline is 'Saved'
 184    * although this might not be a good fit with the broad range of processors.
 185    *
 186    * @var string
 187    */
 188   protected $statusMessageTitle;
 189
 190   /**
 191    * @var int
 192    *
 193    * Max row count for soft credits. The value here is +1 the actual number of
 194    * rows displayed.
 195    */
 196   public $_softCreditItemCount = 11;
 197
 198   /**
 199    * Explicitly declare the form context.
 200    */
 201   public function getDefaultContext() {
 202     return 'create';
 203   }
 204
 205   /**
 206    * Set variables up before form is built.
 207    *
 208    * @throws \CRM_Core_Exception
 209    * @throws \CiviCRM_API3_Exception
 210    */
 211   public function preProcess() {
 212     // Check permission for action.
 213     if (!CRM_Core_Permission::checkActionPermission('CiviContribute', $this->_action)) {
 214       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
 215     }
 216
 217     parent::preProcess();
 218
 219     $this->_formType = $_GET['formType'] ?? NULL;
 220
 221     // Get price set id.
 222     $this->_priceSetId = $_GET['priceSetId'] ?? NULL;
 223     $this->set('priceSetId', $this->_priceSetId);
 224     $this->assign('priceSetId', $this->_priceSetId);
 225
 226     // Get the pledge payment id
 227     $this->_ppID = CRM_Utils_Request::retrieve('ppid', 'Positive', $this);
 228
 229     $this->assign('action', $this->_action);
 230
 231     // Get the contribution id if update
 232     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive');
 233     if (!empty($this->_id)) {
 234       $this->assignPaymentInfoBlock();
 235       $this->assign('contribID', $this->_id);
 236       $this->assign('isUsePaymentBlock', TRUE);
 237     }
 238
 239     $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
 240     $this->assign('context', $this->_context);
 241
 242     $this->_compId = CRM_Utils_Request::retrieve('compId', 'Positive', $this);
 243
 244     $this->_compContext = CRM_Utils_Request::retrieve('compContext', 'String', $this);
 245
 246     //set the contribution mode.
 247     $this->_mode = CRM_Utils_Request::retrieve('mode', 'Alphanumeric', $this);
 248
 249     $this->assign('contributionMode', $this->_mode);
 250     if ($this->_action & CRM_Core_Action::DELETE) {
 251       return;
 252     }
 253
 254     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
 255
 256     if (in_array('CiviPledge', CRM_Core_Config::singleton()->enableComponents) && !$this->_formType) {
 257       $this->preProcessPledge();
 258     }
 259
 260     if ($this->_id) {
 261       $this->showRecordLinkMesssage($this->_id);
 262     }
 263     $this->_values = [];
 264
 265     // Current contribution id.
 266     if ($this->_id) {
 267       $this->assignPremiumProduct($this->_id);
 268       $this->buildValuesAndAssignOnline_Note_Type($this->_id, $this->_values);
 269     }
 270
 271     // when custom data is included in this page
 272     if (!empty($_POST['hidden_custom'])) {
 273       $this->applyCustomData('Contribution', $this->getFinancialTypeID(), $this->_id);
 274     }
 275
 276     $this->_lineItems = [];
 277     if ($this->_id) {
 278       if (!empty($this->_compId) && $this->_compContext === 'participant') {
 279         $this->assign('compId', $this->_compId);
 280         $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_compId);
 281       }
 282       else {
 283         $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'contribution', 1, TRUE, TRUE);
 284       }
 285       // wtf?
 286       empty($lineItem) ? NULL : $this->_lineItems[] = $lineItem;
 287     }
 288
 289     $this->assign('lineItem', empty($lineItem) ? FALSE : [$lineItem]);
 290
 291     // Set title
 292     if ($this->_mode && $this->_id) {
 293       $this->_payNow = TRUE;
 294       $this->assign('payNow', $this->_payNow);
 295       CRM_Utils_System::setTitle(ts('Pay with Credit Card'));
 296     }
 297     elseif ($this->_mode) {
 298       $this->setPageTitle($this->_ppID ? ts('Credit Card Pledge Payment') : ts('Credit Card Contribution'));
 299     }
 300     else {
 301       $this->setPageTitle($this->_ppID ? ts('Pledge Payment') : ts('Contribution'));
 302     }
 303   }
 304
 305   /**
 306    * Set default values.
 307    *
 308    * @return array
 309    *
 310    * @throws \CRM_Core_Exception
 311    */
 312   public function setDefaultValues() {
 313     $defaults = $this->_values;
 314
 315     // Set defaults for pledge payment.
 316     if ($this->_ppID) {
 317       $defaults['total_amount'] = $this->_pledgeValues['pledgePayment']['scheduled_amount'] ?? NULL;
 318       $defaults['financial_type_id'] = $this->_pledgeValues['financial_type_id'] ?? NULL;
 319       $defaults['currency'] = $this->_pledgeValues['currency'] ?? NULL;
 320       $defaults['option_type'] = 1;
 321     }
 322
 323     if ($this->_action & CRM_Core_Action::DELETE) {
 324       return $defaults;
 325     }
 326
 327     $defaults['frequency_interval'] = 1;
 328     $defaults['frequency_unit'] = 'month';
 329
 330     // Set soft credit defaults.
 331     CRM_Contribute_Form_SoftCredit::setDefaultValues($defaults, $this);
 332
 333     if ($this->_mode) {
 334       // @todo - remove this function as the parent does it too.
 335       $config = CRM_Core_Config::singleton();
 336       // Set default country from config if no country set.
 337       if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
 338         $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
 339       }
 340
 341       if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
 342         $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
 343       }
 344
 345       $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID);
 346       $defaults = array_merge($defaults, $billingDefaults);
 347     }
 348
 349     if ($this->_id) {
 350       $this->_contactID = $defaults['contact_id'];
 351     }
 352     elseif ($this->_contactID) {
 353       $defaults['contact_id'] = $this->_contactID;
 354     }
 355
 356     // Set $newCredit variable in template to control whether link to credit card mode is included.
 357     $this->assign('newCredit', CRM_Core_Config::isEnabledBackOfficeCreditCardPayments());
 358
 359     // Fix the display of the monetary value, CRM-4038.
 360     if (isset($defaults['total_amount'])) {
 361       $total_value = $defaults['total_amount'];
 362       $defaults['total_amount'] = CRM_Utils_Money::format($total_value, NULL, '%a');
 363       if (!empty($defaults['tax_amount'])) {
 364         $componentDetails = CRM_Contribute_BAO_Contribution::getComponentDetails($this->_id);
 365         if (empty($componentDetails['membership']) && empty($componentDetails['participant'])) {
 366           $defaults['total_amount'] = CRM_Utils_Money::format($total_value - $defaults['tax_amount'], NULL, '%a');
 367         }
 368       }
 369     }
 370
 371     $amountFields = ['non_deductible_amount', 'fee_amount'];
 372     foreach ($amountFields as $amt) {
 373       if (isset($defaults[$amt])) {
 374         $defaults[$amt] = CRM_Utils_Money::format($defaults[$amt], NULL, '%a');
 375       }
 376     }
 377
 378     if (empty($defaults['payment_instrument_id'])) {
 379       $defaults['payment_instrument_id'] = $this->getDefaultPaymentInstrumentId();
 380     }
 381
 382     if (!empty($defaults['is_test'])) {
 383       $this->assign('is_test', TRUE);
 384     }
 385
 386     $this->assign('showOption', TRUE);
 387     // For Premium section.
 388     if ($this->_premiumID) {
 389       $this->assign('showOption', FALSE);
 390       $options = $this->_options[$this->_productDAO->product_id] ?? "";
 391       if (!$options) {
 392         $this->assign('showOption', TRUE);
 393       }
 394       $options_key = CRM_Utils_Array::key($this->_productDAO->product_option, $options);
 395       if ($options_key) {
 396         $defaults['product_name'] = [$this->_productDAO->product_id, trim($options_key)];
 397       }
 398       else {
 399         $defaults['product_name'] = [$this->_productDAO->product_id];
 400       }
 401       if ($this->_productDAO->fulfilled_date) {
 402         $defaults['fulfilled_date'] = $this->_productDAO->fulfilled_date;
 403       }
 404     }
 405
 406     if (isset($this->userEmail)) {
 407       $this->assign('email', $this->userEmail);
 408     }
 409
 410     if (!empty($defaults['is_pay_later'])) {
 411       $this->assign('is_pay_later', TRUE);
 412     }
 413     $this->assign('contribution_status_id', CRM_Utils_Array::value('contribution_status_id', $defaults));
 414     if (!empty($defaults['contribution_status_id']) && in_array(
 415         CRM_Contribute_PseudoConstant::contributionStatus($defaults['contribution_status_id'], 'name'),
 416         // Historically not 'Cancelled' hence not using CRM_Contribute_BAO_Contribution::isContributionStatusNegative.
 417         ['Refunded', 'Chargeback']
 418       )) {
 419       $defaults['refund_trxn_id'] = CRM_Core_BAO_FinancialTrxn::getRefundTransactionTrxnID($this->_id);
 420     }
 421     else {
 422       $defaults['refund_trxn_id'] = $defaults['trxn_id'] ?? NULL;
 423     }
 424
 425     if (!$this->_id && empty($defaults['receive_date'])) {
 426       $defaults['receive_date'] = date('Y-m-d H:i:s');
 427     }
 428
 429     $currency = $defaults['currency'] ?? NULL;
 430     $this->assign('currency', $currency);
 431     // Hack to get currency info to the js layer. CRM-11440.
 432     CRM_Utils_Money::format(1);
 433     $this->assign('currencySymbol', CRM_Utils_Array::value($currency, CRM_Utils_Money::$_currencySymbols));
 434     $this->assign('totalAmount', CRM_Utils_Array::value('total_amount', $defaults));
 435
 436     // Inherit campaign from pledge.
 437     if ($this->_ppID && !empty($this->_pledgeValues['campaign_id'])) {
 438       $defaults['campaign_id'] = $this->_pledgeValues['campaign_id'];
 439     }
 440
 441     $this->_defaults = $defaults;
 442     return $defaults;
 443   }
 444
 445   /**
 446    * Build the form object.
 447    *
 448    * @throws \CiviCRM_API3_Exception
 449    * @throws \CRM_Core_Exception
 450    */
 451   public function buildQuickForm() {
 452     if ($this->_id) {
 453       $this->add('hidden', 'id', $this->_id);
 454     }
 455
 456     if ($this->_action & CRM_Core_Action::DELETE) {
 457       $this->addButtons([
 458         [
 459           'type' => 'next',
 460           'name' => ts('Delete'),
 461           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 462           'isDefault' => TRUE,
 463         ],
 464         [
 465           'type' => 'cancel',
 466           'name' => ts('Cancel'),
 467         ],
 468       ]);
 469       return;
 470     }
 471
 472     // FIXME: This probably needs to be done in preprocess
 473     if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
 474       && $this->_action & CRM_Core_Action::UPDATE
 475       && !empty($this->_values['financial_type_id'])
 476     ) {
 477       $financialTypeID = CRM_Contribute_PseudoConstant::financialType($this->_values['financial_type_id']);
 478       CRM_Financial_BAO_FinancialType::checkPermissionedLineItems($this->_id, 'edit');
 479       if (!CRM_Core_Permission::check('edit contributions of type ' . $financialTypeID)) {
 480         CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
 481       }
 482     }
 483     $allPanes = [];
 484
 485     //tax rate from financialType
 486     $this->assign('taxRates', json_encode(CRM_Core_PseudoConstant::getTaxRates()));
 487     $this->assign('currencies', json_encode(CRM_Core_OptionGroup::values('currencies_enabled')));
 488
 489     // build price set form.
 490     $buildPriceSet = FALSE;
 491     $invoicing = CRM_Invoicing_Utils::isInvoicingEnabled();
 492     $this->assign('invoicing', $invoicing);
 493
 494     $buildRecurBlock = FALSE;
 495
 496     // display tax amount on edit contribution page
 497     if ($invoicing && $this->_action & CRM_Core_Action::UPDATE && isset($this->_values['tax_amount'])) {
 498       $this->assign('totalTaxAmount', $this->_values['tax_amount']);
 499     }
 500
 501     if (empty($this->_lineItems) &&
 502       ($this->_priceSetId || !empty($_POST['price_set_id']))
 503     ) {
 504       $buildPriceSet = TRUE;
 505       $getOnlyPriceSetElements = TRUE;
 506       if (!$this->_priceSetId) {
 507         $this->_priceSetId = $_POST['price_set_id'];
 508         $getOnlyPriceSetElements = FALSE;
 509       }
 510
 511       $this->set('priceSetId', $this->_priceSetId);
 512       CRM_Price_BAO_PriceSet::buildPriceSet($this);
 513
 514       // get only price set form elements.
 515       if ($getOnlyPriceSetElements) {
 516         return;
 517       }
 518     }
 519     // use to build form during form rule.
 520     $this->assign('buildPriceSet', $buildPriceSet);
 521
 522     $defaults = $this->_values;
 523     $additionalDetailFields = [
 524       'note',
 525       'thankyou_date',
 526       'invoice_id',
 527       'non_deductible_amount',
 528       'fee_amount',
 529     ];
 530     foreach ($additionalDetailFields as $key) {
 531       if (!empty($defaults[$key])) {
 532         $defaults['hidden_AdditionalDetail'] = 1;
 533         break;
 534       }
 535     }
 536
 537     if ($this->_productDAO) {
 538       if ($this->_productDAO->product_id) {
 539         $defaults['hidden_Premium'] = 1;
 540       }
 541     }
 542
 543     if ($this->_noteID &&
 544       !CRM_Utils_System::isNull($this->_values['note'])
 545     ) {
 546       $defaults['hidden_AdditionalDetail'] = 1;
 547     }
 548
 549     $paneNames = [];
 550     if (empty($this->_payNow)) {
 551       $paneNames[ts('Additional Details')] = 'AdditionalDetail';
 552     }
 553
 554     //Add Premium pane only if Premium is exists.
 555     $dao = new CRM_Contribute_DAO_Product();
 556     $dao->is_active = 1;
 557
 558     if ($dao->find(TRUE) && empty($this->_payNow)) {
 559       $paneNames[ts('Premium Information')] = 'Premium';
 560     }
 561
 562     $this->payment_instrument_id = CRM_Utils_Array::value('payment_instrument_id', $defaults, $this->getDefaultPaymentInstrumentId());
 563     if (CRM_Core_Payment_Form::buildPaymentForm($this, $this->_paymentProcessor, FALSE, TRUE, $this->payment_instrument_id) == TRUE) {
 564       if (!empty($this->_recurPaymentProcessors)) {
 565         $buildRecurBlock = TRUE;
 566         if ($this->_ppID) {
 567           // ppID denotes a pledge payment.
 568           foreach ($this->_paymentProcessors as $processor) {
 569             if (!empty($processor['is_recur']) && !empty($processor['object']) && $processor['object']->supports('recurContributionsForPledges')) {
 570               $buildRecurBlock = TRUE;
 571               break;
 572             }
 573             $buildRecurBlock = FALSE;
 574           }
 575         }
 576         if ($buildRecurBlock) {
 577           CRM_Contribute_Form_Contribution_Main::buildRecur($this);
 578           $this->setDefaults(['is_recur' => 0]);
 579           $this->assign('buildRecurBlock', TRUE);
 580         }
 581       }
 582     }
 583     $this->addPaymentProcessorSelect(FALSE, $buildRecurBlock);
 584
 585     foreach ($paneNames as $name => $type) {
 586       $allPanes[$name] = $this->generatePane($type, $defaults);
 587     }
 588
 589     $qfKey = $this->controller->_key;
 590     $this->assign('qfKey', $qfKey);
 591     $this->assign('allPanes', $allPanes);
 592
 593     $this->addFormRule(['CRM_Contribute_Form_Contribution', 'formRule'], $this);
 594
 595     if ($this->_formType) {
 596       $this->assign('formType', $this->_formType);
 597       return;
 598     }
 599
 600     $this->applyFilter('__ALL__', 'trim');
 601
 602     //need to assign custom data type and subtype to the template
 603     $this->assign('customDataType', 'Contribution');
 604     $this->assign('customDataSubType', $this->getFinancialTypeID());
 605     $this->assign('entityID', $this->_id);
 606
 607     $contactField = $this->addEntityRef('contact_id', ts('Contributor'), ['create' => TRUE, 'api' => ['extra' => ['email']]], TRUE);
 608     if ($this->_context !== 'standalone') {
 609       $contactField->freeze();
 610     }
 611
 612     $attributes = CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_Contribution');
 613
 614     // Check permissions for financial type first
 615     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes, $this->_action);
 616     if (empty($financialTypes)) {
 617       CRM_Core_Error::statusBounce(ts('You do not have all the permissions needed for this page.'));
 618     }
 619     $financialType = $this->add('select', 'financial_type_id',
 620       ts('Financial Type'),
 621       ['' => ts('- select -')] + $financialTypes,
 622       TRUE,
 623       ['onChange' => "CRM.buildCustomData( 'Contribution', this.value );"]
 624     );
 625
 626     $paymentInstrument = FALSE;
 627     if (!$this->_mode) {
 628       // payment_instrument isn't required in edit and will not be present when payment block is enabled.
 629       $required = !$this->_id;
 630       $checkPaymentID = array_search('Check', CRM_Contribute_PseudoConstant::paymentInstrument('name'));
 631       $paymentInstrument = $this->add('select', 'payment_instrument_id',
 632         ts('Payment Method'),
 633         ['' => ts('- select -')] + CRM_Contribute_PseudoConstant::paymentInstrument(),
 634         $required, ['onChange' => "return showHideByValue('payment_instrument_id','{$checkPaymentID}','checkNumber','table-row','select',false);"]
 635       );
 636     }
 637
 638     $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), ['class' => 'twelve'] + $attributes['trxn_id']);
 639
 640     //add receipt for offline contribution
 641     $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
 642
 643     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails);
 644
 645     $component = 'contribution';
 646     $componentDetails = [];
 647     if ($this->_id) {
 648       $componentDetails = CRM_Contribute_BAO_Contribution::getComponentDetails($this->_id);
 649       if (!empty($componentDetails['membership'])) {
 650         $component = 'membership';
 651       }
 652       elseif (!empty($componentDetails['participant'])) {
 653         $component = 'participant';
 654       }
 655     }
 656     if ($this->_ppID) {
 657       $component = 'pledge';
 658     }
 659     $status = CRM_Contribute_BAO_Contribution_Utils::getContributionStatuses($component, $this->_id);
 660
 661     // define the status IDs that show the cancellation info, see CRM-17589
 662     $cancelInfo_show_ids = [];
 663     foreach (array_keys($status) as $status_id) {
 664       if (CRM_Contribute_BAO_Contribution::isContributionStatusNegative($status_id)) {
 665         $cancelInfo_show_ids[] = "'$status_id'";
 666       }
 667     }
 668     $this->assign('cancelInfo_show_ids', implode(',', $cancelInfo_show_ids));
 669
 670     $statusElement = $this->add('select', 'contribution_status_id',
 671       ts('Contribution Status'),
 672       $status,
 673       FALSE
 674     );
 675
 676     $currencyFreeze = FALSE;
 677     if (!empty($this->_payNow) && ($this->_action & CRM_Core_Action::UPDATE)) {
 678       $statusElement->freeze();
 679       $currencyFreeze = TRUE;
 680       $attributes['total_amount']['readonly'] = TRUE;
 681     }
 682
 683     // CRM-16189, add Revenue Recognition Date
 684     if (Civi::settings()->get('deferred_revenue_enabled')) {
 685       $revenueDate = $this->add('date', 'revenue_recognition_date', ts('Revenue Recognition Date'), CRM_Core_SelectValues::date(NULL, 'M Y', NULL, 5));
 686       if ($this->_id && !CRM_Contribute_BAO_Contribution::allowUpdateRevenueRecognitionDate($this->_id)) {
 687         $revenueDate->freeze();
 688       }
 689     }
 690
 691     // add various dates
 692     $this->addField('receive_date', ['entity' => 'contribution'], !$this->_mode, FALSE);
 693     $this->addField('receipt_date', ['entity' => 'contribution'], FALSE, FALSE);
 694     $this->addField('cancel_date', ['entity' => 'contribution', 'label' => ts('Cancelled / Refunded Date')], FALSE, FALSE);
 695
 696     if ($this->_online) {
 697       $this->assign('hideCalender', TRUE);
 698     }
 699
 700     $this->add('textarea', 'cancel_reason', ts('Cancellation / Refund Reason'), $attributes['cancel_reason']);
 701
 702     $totalAmount = NULL;
 703     if (empty($this->_lineItems)) {
 704       $buildPriceSet = FALSE;
 705       $priceSets = CRM_Price_BAO_PriceSet::getAssoc(FALSE, 'CiviContribute');
 706       if (!empty($priceSets) && !$this->_ppID) {
 707         $buildPriceSet = TRUE;
 708       }
 709
 710       // don't allow price set for contribution if it is related to participant, or if it is a pledge payment
 711       // and if we already have line items for that participant. CRM-5095
 712       if ($buildPriceSet && $this->_id) {
 713         $pledgePaymentId = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
 714           $this->_id,
 715           'id',
 716           'contribution_id'
 717         );
 718         if ($pledgePaymentId) {
 719           $buildPriceSet = FALSE;
 720         }
 721         if ($participantID = CRM_Utils_Array::value('participant', $componentDetails)) {
 722           $participantLI = CRM_Price_BAO_LineItem::getLineItems($participantID);
 723           if (!CRM_Utils_System::isNull($participantLI)) {
 724             $buildPriceSet = FALSE;
 725           }
 726         }
 727       }
 728
 729       $hasPriceSets = FALSE;
 730       if ($buildPriceSet) {
 731         $hasPriceSets = TRUE;
 732         // CRM-16451: set financial type of 'Price Set' in back office contribution
 733         // instead of selecting manually
 734         $financialTypeIds = CRM_Price_BAO_PriceSet::getAssoc(FALSE, 'CiviContribute', 'financial_type_id');
 735         $element = $this->add('select', 'price_set_id', ts('Choose price set'),
 736           [
 737             '' => ts('Choose price set'),
 738           ] + $priceSets,
 739           NULL, ['onchange' => "buildAmount( this.value, " . json_encode($financialTypeIds) . ");"]
 740         );
 741         if ($this->_online && !($this->_action & CRM_Core_Action::UPDATE)) {
 742           $element->freeze();
 743         }
 744       }
 745       $this->assign('hasPriceSets', $hasPriceSets);
 746       if (!($this->_action & CRM_Core_Action::UPDATE)) {
 747         if ($this->_online || $this->_ppID) {
 748           $attributes['total_amount'] = array_merge($attributes['total_amount'], [
 749             'READONLY' => TRUE,
 750             'style' => "background-color:#EBECE4",
 751           ]);
 752           $optionTypes = [
 753             '1' => ts('Adjust Pledge Payment Schedule?'),
 754             '2' => ts('Adjust Total Pledge Amount?'),
 755           ];
 756           $this->addRadio('option_type',
 757             NULL,
 758             $optionTypes,
 759             [], '<br/>'
 760           );
 761
 762           $currencyFreeze = TRUE;
 763         }
 764       }
 765
 766       $totalAmount = $this->addMoney('total_amount',
 767         ts('Total Amount'),
 768         !$hasPriceSets,
 769         $attributes['total_amount'],
 770         TRUE, 'currency', NULL, $currencyFreeze
 771       );
 772     }
 773
 774     $this->add('text', 'source', ts('Source'), CRM_Utils_Array::value('source', $attributes));
 775
 776     // CRM-7362 --add campaigns.
 777     CRM_Campaign_BAO_Campaign::addCampaign($this, CRM_Utils_Array::value('campaign_id', $this->_values));
 778
 779     if (empty($this->_payNow)) {
 780       CRM_Contribute_Form_SoftCredit::buildQuickForm($this);
 781     }
 782
 783     $js = NULL;
 784     if (!$this->_mode) {
 785       $js = ['onclick' => "return verify( );"];
 786     }
 787
 788     $mailingInfo = Civi::settings()->get('mailing_backend');
 789     $this->assign('outBound_option', $mailingInfo['outBound_option']);
 790
 791     $this->addButtons([
 792       [
 793         'type' => 'upload',
 794         'name' => ts('Save'),
 795         'js' => $js,
 796         'isDefault' => TRUE,
 797       ],
 798       [
 799         'type' => 'upload',
 800         'name' => ts('Save and New'),
 801         'js' => $js,
 802         'subName' => 'new',
 803       ],
 804       [
 805         'type' => 'cancel',
 806         'name' => ts('Cancel'),
 807       ],
 808     ]);
 809
 810     // if contribution is related to membership or participant freeze Financial Type, Amount
 811     if ($this->_id) {
 812       $componentDetails = CRM_Contribute_BAO_Contribution::getComponentDetails($this->_id);
 813       $isCancelledStatus = ($this->_values['contribution_status_id'] == CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Cancelled'));
 814
 815       if (!empty($componentDetails['membership']) ||
 816         !empty($componentDetails['participant']) ||
 817         // if status is Cancelled freeze Amount, Payment Instrument, Check #, Financial Type,
 818         // Net and Fee Amounts are frozen in AdditionalInfo::buildAdditionalDetail
 819         $isCancelledStatus
 820       ) {
 821         if ($totalAmount) {
 822           $totalAmount->freeze();
 823           $this->getElement('currency')->freeze();
 824         }
 825         if ($isCancelledStatus) {
 826           $paymentInstrument->freeze();
 827           $trxnId->freeze();
 828         }
 829         $financialType->freeze();
 830         $this->assign('freezeFinancialType', TRUE);
 831       }
 832     }
 833
 834     if ($this->_action & CRM_Core_Action::VIEW) {
 835       $this->freeze();
 836     }
 837   }
 838
 839   /**
 840    * Global form rule.
 841    *
 842    * @param array $fields
 843    *   The input form values.
 844    * @param array $files
 845    *   The uploaded files if any.
 846    * @param $self
 847    *
 848    * @return bool|array
 849    *   true if no errors, else array of errors
 850    */
 851   public static function formRule($fields, $files, $self) {
 852     $errors = [];
 853     // Check for Credit Card Contribution.
 854     if ($self->_mode) {
 855       if (empty($fields['payment_processor_id'])) {
 856         $errors['payment_processor_id'] = ts('Payment Processor is a required field.');
 857       }
 858       else {
 859         // validate payment instrument (e.g. credit card number)
 860         CRM_Core_Payment_Form::validatePaymentInstrument($fields['payment_processor_id'], $fields, $errors, NULL);
 861       }
 862     }
 863
 864     // Do the amount validations.
 865     if (empty($fields['total_amount']) && empty($self->_lineItems)) {
 866       if ($priceSetId = CRM_Utils_Array::value('price_set_id', $fields)) {
 867         CRM_Price_BAO_PriceField::priceSetValidation($priceSetId, $fields, $errors);
 868       }
 869     }
 870
 871     $softErrors = CRM_Contribute_Form_SoftCredit::formRule($fields, $errors, $self);
 872
 873     //CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
 874     CRM_Contribute_BAO_ContributionRecur::validateRecurContribution($fields, $files, $self, $errors);
 875
 876     // Form rule for status http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
 877     if (($self->_action & CRM_Core_Action::UPDATE)
 878       && $self->_id
 879       && $self->_values['contribution_status_id'] != $fields['contribution_status_id']
 880     ) {
 881       CRM_Contribute_BAO_Contribution::checkStatusValidation($self->_values, $fields, $errors);
 882     }
 883     // CRM-16015, add form-rule to restrict change of financial type if using price field of different financial type
 884     if (($self->_action & CRM_Core_Action::UPDATE)
 885       && $self->_id
 886       && $self->_values['financial_type_id'] != $fields['financial_type_id']
 887     ) {
 888       CRM_Contribute_BAO_Contribution::checkFinancialTypeChange(NULL, $self->_id, $errors);
 889     }
 890     //FIXME FOR NEW DATA FLOW http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+4.3+Data+Flow
 891     if (!empty($fields['fee_amount']) && !empty($fields['financial_type_id']) && $financialType = CRM_Contribute_BAO_Contribution::validateFinancialType($fields['financial_type_id'])) {
 892       $errors['financial_type_id'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
 893     }
 894
 895     // $trxn_id must be unique CRM-13919
 896     if (!empty($fields['trxn_id'])) {
 897       $queryParams = [1 => [$fields['trxn_id'], 'String']];
 898       $query = 'select count(*) from civicrm_contribution where trxn_id = %1';
 899       if ($self->_id) {
 900         $queryParams[2] = [(int) $self->_id, 'Integer'];
 901         $query .= ' and id !=%2';
 902       }
 903       $tCnt = CRM_Core_DAO::singleValueQuery($query, $queryParams);
 904       if ($tCnt) {
 905         $errors['trxn_id'] = ts('Transaction ID\'s must be unique. Transaction \'%1\' already exists in your database.', [1 => $fields['trxn_id']]);
 906       }
 907     }
 908     if (!empty($fields['revenue_recognition_date'])
 909       && count(array_filter($fields['revenue_recognition_date'])) == 1
 910     ) {
 911       $errors['revenue_recognition_date'] = ts('Month and Year are required field for Revenue Recognition.');
 912     }
 913     // CRM-16189
 914     try {
 915       CRM_Financial_BAO_FinancialAccount::checkFinancialTypeHasDeferred($fields, $self->_id, $self->_priceSet['fields']);
 916     }
 917     catch (CRM_Core_Exception $e) {
 918       $errors['financial_type_id'] = ' ';
 919       $errors['_qf_default'] = $e->getMessage();
 920     }
 921     $errors = array_merge($errors, $softErrors);
 922     return $errors;
 923   }
 924
 925   /**
 926    * Process the form submission.
 927    */
 928   public function postProcess() {
 929     if ($this->_action & CRM_Core_Action::DELETE) {
 930       CRM_Contribute_BAO_Contribution::deleteContribution($this->_id);
 931       CRM_Core_Session::singleton()->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
 932         "reset=1&cid={$this->_contactID}&selectedChild=contribute"
 933       ));
 934       return;
 935     }
 936     // Get the submitted form values.
 937     $submittedValues = $this->controller->exportValues($this->_name);
 938
 939     try {
 940       $contribution = $this->submit($submittedValues, $this->_action, $this->_ppID);
 941     }
 942     catch (PaymentProcessorException $e) {
 943       // Set the contribution mode.
 944       $urlParams = "action=add&cid={$this->_contactID}";
 945       if ($this->_mode) {
 946         $urlParams .= "&mode={$this->_mode}";
 947       }
 948       if (!empty($this->_ppID)) {
 949         $urlParams .= "&context=pledge&ppid={$this->_ppID}";
 950       }
 951
 952       CRM_Core_Error::statusBounce($e->getMessage(), $urlParams, ts('Payment Processor Error'));
 953     }
 954     $this->setUserContext();
 955
 956     //store contribution ID if not yet set (on create)
 957     if (empty($this->_id) && !empty($contribution->id)) {
 958       $this->_id = $contribution->id;
 959     }
 960     if (!empty($this->_id) && CRM_Core_Permission::access('CiviMember')) {
 961       $membershipPaymentCount = civicrm_api3('MembershipPayment', 'getCount', ['contribution_id' => $this->_id]);
 962       if ($membershipPaymentCount) {
 963         $this->ajaxResponse['updateTabs']['#tab_member'] = CRM_Contact_BAO_Contact::getCountComponent('membership', $this->_contactID);
 964       }
 965     }
 966     if (!empty($this->_id) && CRM_Core_Permission::access('CiviEvent')) {
 967       $participantPaymentCount = civicrm_api3('ParticipantPayment', 'getCount', ['contribution_id' => $this->_id]);
 968       if ($participantPaymentCount) {
 969         $this->ajaxResponse['updateTabs']['#tab_participant'] = CRM_Contact_BAO_Contact::getCountComponent('participant', $this->_contactID);
 970       }
 971     }
 972   }
 973
 974   /**
 975    * Process credit card payment.
 976    *
 977    * @param array $submittedValues
 978    * @param array $lineItem
 979    *
 980    * @param int $contactID
 981    *   Contact ID
 982    *
 983    * @return bool|\CRM_Contribute_DAO_Contribution
 984    *
 985    * @throws \CRM_Core_Exception
 986    * @throws \Civi\Payment\Exception\PaymentProcessorException
 987    * @throws \CiviCRM_API3_Exception
 988    */
 989   protected function processCreditCard($submittedValues, $lineItem, $contactID) {
 990     $isTest = ($this->_mode == 'test') ? 1 : 0;
 991     // CRM-12680 set $_lineItem if its not set
 992     // @todo - I don't believe this would ever BE set. I can't find anywhere in the code.
 993     // It would be better to pass line item out to functions than $this->_lineItem as
 994     // we don't know what is being changed where.
 995     if (empty($this->_lineItem) && !empty($lineItem)) {
 996       $this->_lineItem = $lineItem;
 997     }
 998
 999     $this->_paymentObject = Civi\Payment\System::singleton()->getById($submittedValues['payment_processor_id']);
1000     $this->_paymentProcessor = $this->_paymentObject->getPaymentProcessor();
1001
1002     // Set source if not set
1003     if (empty($submittedValues['source'])) {
1004       $userID = CRM_Core_Session::singleton()->get('userID');
1005       $userSortName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $userID,
1006         'sort_name'
1007       );
1008       $submittedValues['source'] = ts('Submit Credit Card Payment by: %1', [1 => $userSortName]);
1009     }
1010
1011     $params = $submittedValues;
1012     $this->_params = array_merge($this->_params, $submittedValues);
1013
1014     // Mapping requiring documentation.
1015     $this->_params['payment_processor'] = $submittedValues['payment_processor_id'];
1016
1017     $now = date('YmdHis');
1018
1019     $this->_contributorEmail = $this->userEmail;
1020     $this->_contributorContactID = $contactID;
1021     $this->processBillingAddress();
1022     if (!empty($params['source'])) {
1023       unset($params['source']);
1024     }
1025
1026     $this->_params['amount'] = $this->_params['total_amount'];
1027     // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
1028     // function to get correct amount level consistently. Remove setting of the amount level in
1029     // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
1030     // to cover all variants.
1031     $this->_params['amount_level'] = 0;
1032     $this->_params['description'] = ts("Contribution submitted by a staff person using contributor's credit card");
1033     $this->_params['currencyID'] = CRM_Utils_Array::value('currency',
1034       $this->_params,
1035       CRM_Core_Config::singleton()->defaultCurrency
1036     );
1037
1038     $this->_params['pcp_display_in_roll'] = $params['pcp_display_in_roll'] ?? NULL;
1039     $this->_params['pcp_roll_nickname'] = $params['pcp_roll_nickname'] ?? NULL;
1040     $this->_params['pcp_personal_note'] = $params['pcp_personal_note'] ?? NULL;
1041
1042     //Add common data to formatted params
1043     CRM_Contribute_Form_AdditionalInfo::postProcessCommon($params, $this->_params, $this);
1044
1045     if (empty($this->_params['invoice_id'])) {
1046       $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
1047     }
1048     else {
1049       $this->_params['invoiceID'] = $this->_params['invoice_id'];
1050     }
1051
1052     // At this point we've created a contact and stored its address etc
1053     // all the payment processors expect the name and address to be in the
1054     // so we copy stuff over to first_name etc.
1055     $paymentParams = $this->_params;
1056     $paymentParams['contactID'] = $contactID;
1057     CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE);
1058
1059     $financialType = new CRM_Financial_DAO_FinancialType();
1060     $financialType->id = $params['financial_type_id'];
1061     $financialType->find(TRUE);
1062
1063     // Add some financial type details to the params list
1064     // if folks need to use it.
1065     $paymentParams['contributionType_name'] = $this->_params['contributionType_name'] = $financialType->name;
1066     $paymentParams['contributionPageID'] = NULL;
1067
1068     if (!empty($this->_params['is_email_receipt'])) {
1069       $paymentParams['email'] = $this->userEmail;
1070       $paymentParams['is_email_receipt'] = 1;
1071     }
1072     else {
1073       $paymentParams['is_email_receipt'] = 0;
1074       $this->_params['is_email_receipt'] = 0;
1075     }
1076     if (!empty($this->_params['receive_date'])) {
1077       $paymentParams['receive_date'] = $this->_params['receive_date'];
1078     }
1079
1080     if (!empty($this->_params['is_email_receipt'])) {
1081       $this->_params['receipt_date'] = $now;
1082     }
1083
1084     $this->set('params', $this->_params);
1085
1086     $this->assign('receive_date', $this->_params['receive_date']);
1087
1088     // Result has all the stuff we need
1089     // lets archive it to a financial transaction
1090     if ($financialType->is_deductible) {
1091       $this->assign('is_deductible', TRUE);
1092       $this->set('is_deductible', TRUE);
1093     }
1094     $contributionParams = [
1095       'id' => $this->_params['contribution_id'] ?? NULL,
1096       'contact_id' => $contactID,
1097       'line_item' => $lineItem,
1098       'is_test' => $isTest,
1099       'campaign_id' => $this->_params['campaign_id'] ?? NULL,
1100       'contribution_page_id' => $this->_params['contribution_page_id'] ?? NULL,
1101       'source' => CRM_Utils_Array::value('source', $paymentParams, CRM_Utils_Array::value('description', $paymentParams)),
1102       'thankyou_date' => $this->_params['thankyou_date'] ?? NULL,
1103     ];
1104     $contributionParams['payment_instrument_id'] = $this->_paymentProcessor['payment_instrument_id'];
1105
1106     $contribution = CRM_Contribute_Form_Contribution_Confirm::processFormContribution($this,
1107       $this->_params,
1108       NULL,
1109       $contributionParams,
1110       $financialType,
1111       FALSE,
1112       $this->_bltID,
1113       CRM_Utils_Array::value('is_recur', $this->_params)
1114     );
1115
1116     $paymentParams['contributionID'] = $contribution->id;
1117     $paymentParams['contributionTypeID'] = $contribution->financial_type_id;
1118     $paymentParams['contributionPageID'] = $contribution->contribution_page_id;
1119     $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
1120
1121     if ($paymentParams['amount'] > 0.0) {
1122       // force a re-get of the payment processor in case the form changed it, CRM-7179
1123       // NOTE - I expect this is obsolete.
1124       $payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor);
1125       try {
1126         $completeStatusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
1127         $result = $payment->doPayment($paymentParams, 'contribute');
1128         $this->assign('trxn_id', $result['trxn_id']);
1129         $contribution->trxn_id = $result['trxn_id'];
1130         /* Our scenarios here are
1131          *  1) the payment failed & an Exception should have been thrown
1132          *  2) the payment succeeded but the payment is not immediate (for example a recurring payment
1133          *     with a delayed start)
1134          *  3) the payment succeeded with an immediate payment.
1135          *
1136          * The doPayment function ensures that payment_status_id is always set
1137          * as historically we have had to guess from the context - ie doDirectPayment
1138          * = error or success, unless it is a recurring contribution in which case it is pending.
1139          */
1140         if ($result['payment_status_id'] == $completeStatusId) {
1141           try {
1142             civicrm_api3('contribution', 'completetransaction', [
1143               'id' => $contribution->id,
1144               'trxn_id' => $result['trxn_id'],
1145               'payment_processor_id' => $this->_paymentProcessor['id'],
1146               'is_transactional' => FALSE,
1147               'fee_amount' => $result['fee_amount'] ?? NULL,
1148               'card_type_id' => $paymentParams['card_type_id'] ?? NULL,
1149               'pan_truncation' => $paymentParams['pan_truncation'] ?? NULL,
1150               'is_email_receipt' => FALSE,
1151             ]);
1152             // This has now been set to 1 in the DB - declare it here also
1153             $contribution->contribution_status_id = 1;
1154           }
1155           catch (CiviCRM_API3_Exception $e) {
1156             if ($e->getErrorCode() != 'contribution_completed') {
1157               throw new CRM_Core_Exception('Failed to update contribution in database');
1158             }
1159           }
1160         }
1161         else {
1162           // Save the trxn_id.
1163           $contribution->save();
1164         }
1165       }
1166       catch (PaymentProcessorException $e) {
1167         CRM_Contribute_BAO_Contribution::failPayment($contribution->id, $paymentParams['contactID'], $e->getMessage());
1168         throw new PaymentProcessorException($e->getMessage());
1169       }
1170     }
1171     // Send receipt mail.
1172     array_unshift($this->statusMessage, ts('The contribution record has been saved.'));
1173     if ($contribution->id && !empty($this->_params['is_email_receipt'])) {
1174       $this->_params['trxn_id'] = $result['trxn_id'] ?? NULL;
1175       $this->_params['contact_id'] = $contactID;
1176       $this->_params['contribution_id'] = $contribution->id;
1177       if (CRM_Contribute_Form_AdditionalInfo::emailReceipt($this, $this->_params, TRUE)) {
1178         $this->statusMessage[] = ts('A receipt has been emailed to the contributor.');
1179       }
1180     }
1181
1182     return $contribution;
1183   }
1184
1185   /**
1186    * Generate the data to construct a snippet based pane.
1187    *
1188    * This form also assigns the showAdditionalInfo var based on historical code.
1189    * This appears to mean 'there is a pane to show'.
1190    *
1191    * @param string $type
1192    *   Type of Pane - this is generally used to determine the function name used to build it
1193    *   - e.g CreditCard, AdditionalDetail
1194    * @param array $defaults
1195    *
1196    * @return array
1197    *   We aim to further refactor & simplify this but currently
1198    *   - the panes array
1199    *   - should additional info be shown?
1200    */
1201   protected function generatePane($type, $defaults) {
1202     $urlParams = "snippet=4&formType={$type}";
1203     if ($this->_mode) {
1204       $urlParams .= "&mode={$this->_mode}";
1205     }
1206
1207     $open = 'false';
1208     if ($type == 'CreditCard' ||
1209       $type == 'DirectDebit'
1210     ) {
1211       $open = 'true';
1212     }
1213
1214     $pane = [
1215       'url' => CRM_Utils_System::url('civicrm/contact/view/contribution', $urlParams),
1216       'open' => $open,
1217       'id' => $type,
1218     ];
1219
1220     // See if we need to include this paneName in the current form.
1221     if ($this->_formType == $type || !empty($_POST["hidden_{$type}"]) ||
1222       !empty($defaults["hidden_{$type}"])
1223     ) {
1224       $this->assign('showAdditionalInfo', TRUE);
1225       $pane['open'] = 'true';
1226     }
1227
1228     if ($type == 'CreditCard' || $type == 'DirectDebit') {
1229       // @todo would be good to align tpl name with form name...
1230       // @todo document why this hidden variable is required.
1231       $this->add('hidden', 'hidden_' . $type, 1);
1232       return $pane;
1233     }
1234     else {
1235       $additionalInfoFormFunction = 'build' . $type;
1236       CRM_Contribute_Form_AdditionalInfo::$additionalInfoFormFunction($this);
1237       return $pane;
1238     }
1239   }
1240
1241   /**
1242    * Wrapper for unit testing the post process submit function.
1243    *
1244    * (If we expose through api we can get default additions 'for free').
1245    *
1246    * @param array $params
1247    * @param int $action
1248    * @param string|null $creditCardMode
1249    *
1250    * @return CRM_Contribute_BAO_Contribution
1251    *
1252    * @throws \CRM_Core_Exception
1253    * @throws \CiviCRM_API3_Exception
1254    * @throws \Civi\Payment\Exception\PaymentProcessorException
1255    */
1256   public function testSubmit($params, $action, $creditCardMode = NULL) {
1257     $defaults = [
1258       'soft_credit_contact_id' => [],
1259       'receive_date' => date('Y-m-d H:i:s'),
1260       'receipt_date' => '',
1261       'cancel_date' => '',
1262       'hidden_Premium' => 1,
1263     ];
1264     $this->_bltID = 5;
1265     if (!empty($params['id'])) {
1266       $existingContribution = civicrm_api3('contribution', 'getsingle', [
1267         'id' => $params['id'],
1268       ]);
1269       $this->_id = $params['id'];
1270       $this->_values = $existingContribution;
1271       if (CRM_Invoicing_Utils::isInvoicingEnabled()) {
1272         $this->_values['tax_amount'] = civicrm_api3('contribution', 'getvalue', [
1273           'id' => $params['id'],
1274           'return' => 'tax_amount',
1275         ]);
1276       }
1277     }
1278     else {
1279       $existingContribution = [];
1280     }
1281
1282     $this->_defaults['contribution_status_id'] = CRM_Utils_Array::value('contribution_status_id',
1283       $existingContribution
1284     );
1285
1286     $this->_defaults['total_amount'] = CRM_Utils_Array::value('total_amount',
1287       $existingContribution
1288     );
1289
1290     if ($creditCardMode) {
1291       $this->_mode = $creditCardMode;
1292     }
1293
1294     // Required because processCreditCard calls set method on this.
1295     $_SERVER['REQUEST_METHOD'] = 'GET';
1296     $this->controller = new CRM_Core_Controller();
1297
1298     CRM_Contribute_Form_AdditionalInfo::buildPremium($this);
1299
1300     $this->_fields = [];
1301     return $this->submit(array_merge($defaults, $params), $action, CRM_Utils_Array::value('pledge_payment_id', $params));
1302
1303   }
1304
1305   /**
1306    * @param array $submittedValues
1307    *
1308    * @param int $action
1309    *   Action constant
1310    *    - CRM_Core_Action::UPDATE
1311    *
1312    * @param $pledgePaymentID
1313    *
1314    * @return \CRM_Contribute_BAO_Contribution
1315    *
1316    * @throws \CRM_Core_Exception
1317    * @throws \CiviCRM_API3_Exception
1318    * @throws \Civi\Payment\Exception\PaymentProcessorException
1319    */
1320   protected function submit($submittedValues, $action, $pledgePaymentID) {
1321     $pId = $contribution = $isRelatedId = FALSE;
1322     $this->_params = $submittedValues;
1323     $this->beginPostProcess();
1324     // reassign submitted form values if the any information is formatted via beginPostProcess
1325     $submittedValues = $this->_params;
1326
1327     if (!empty($submittedValues['price_set_id']) && $action & CRM_Core_Action::UPDATE) {
1328       $line = CRM_Price_BAO_LineItem::getLineItems($this->_id, 'contribution');
1329       $lineID = key($line);
1330       $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array::value('price_field_id', $line[$lineID]), 'price_set_id');
1331       $quickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1332       // Why do we do this? Seems like a like a wrapper for old functionality - but single line price sets & quick
1333       // config should be treated the same.
1334       if ($quickConfig) {
1335         CRM_Price_BAO_LineItem::deleteLineItems($this->_id, 'civicrm_contribution');
1336       }
1337     }
1338
1339     // Process price set and get total amount and line items.
1340     $lineItem = [];
1341     $priceSetId = $submittedValues['price_set_id'] ?? NULL;
1342     if (empty($priceSetId) && !$this->_id) {
1343       $this->_priceSetId = $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
1344       $this->_priceSet = current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId));
1345       $fieldID = key($this->_priceSet['fields']);
1346       $fieldValueId = key($this->_priceSet['fields'][$fieldID]['options']);
1347       $this->_priceSet['fields'][$fieldID]['options'][$fieldValueId]['amount'] = $submittedValues['total_amount'];
1348       $submittedValues['price_' . $fieldID] = 1;
1349     }
1350
1351     // Every contribution has a price-set - the only reason it shouldn't be set is if we are dealing with
1352     // quick config (very very arguably) & yet we see that this could still be quick config so this should be understood
1353     // as a point of fragility rather than a logical 'if' clause.
1354     if ($priceSetId) {
1355       CRM_Price_BAO_PriceSet::processAmount($this->_priceSet['fields'],
1356         $submittedValues, $lineItem[$priceSetId], $priceSetId);
1357       // Unset tax amount for offline 'is_quick_config' contribution.
1358       // @todo WHY  - quick config was conceived as a quick way to configure contribution forms.
1359       // this is an example of 'other' functionality being hung off it.
1360       if ($this->_priceSet['is_quick_config'] &&
1361         !array_key_exists($submittedValues['financial_type_id'], CRM_Core_PseudoConstant::getTaxRates())
1362       ) {
1363         unset($submittedValues['tax_amount']);
1364       }
1365       $submittedValues['total_amount'] = $submittedValues['amount'] ?? NULL;
1366     }
1367
1368     if ($this->_id) {
1369       if ($this->_compId) {
1370         if ($this->_context == 'participant') {
1371           $pId = $this->_compId;
1372         }
1373         elseif ($this->_context == 'membership') {
1374           $isRelatedId = TRUE;
1375         }
1376         else {
1377           $pId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id, 'participant_id', 'contribution_id');
1378         }
1379       }
1380       else {
1381         $contributionDetails = CRM_Contribute_BAO_Contribution::getComponentDetails($this->_id);
1382         if (array_key_exists('membership', $contributionDetails)) {
1383           $isRelatedId = TRUE;
1384         }
1385         elseif (array_key_exists('participant', $contributionDetails)) {
1386           $pId = $contributionDetails['participant'];
1387         }
1388       }
1389       if (!empty($this->_payNow)) {
1390         $this->_params['contribution_id'] = $this->_id;
1391       }
1392     }
1393
1394     if (!$priceSetId && !empty($submittedValues['total_amount']) && $this->_id) {
1395       // CRM-10117 update the line items for participants.
1396       // @todo - if we are completing a contribution then the api call
1397       // civicrm_api3('Contribution', 'completetransaction') should take care of
1398       // all associated updates rather than replicating them on the form layer.
1399       if ($pId) {
1400         $entityTable = 'participant';
1401         $entityID = $pId;
1402         $isRelatedId = FALSE;
1403         $participantParams = [
1404           'fee_amount' => $submittedValues['total_amount'],
1405           'id' => $entityID,
1406         ];
1407         CRM_Event_BAO_Participant::add($participantParams);
1408         if (empty($this->_lineItems)) {
1409           $this->_lineItems[] = CRM_Price_BAO_LineItem::getLineItems($entityID, 'participant', TRUE);
1410         }
1411       }
1412       else {
1413         $entityTable = 'contribution';
1414         $entityID = $this->_id;
1415       }
1416
1417       $lineItems = CRM_Price_BAO_LineItem::getLineItems($entityID, $entityTable, FALSE, TRUE, $isRelatedId);
1418       foreach (array_keys($lineItems) as $id) {
1419         $lineItems[$id]['id'] = $id;
1420       }
1421       $itemId = key($lineItems);
1422       if ($itemId && !empty($lineItems[$itemId]['price_field_id'])) {
1423         $this->_priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItems[$itemId]['price_field_id'], 'price_set_id');
1424       }
1425
1426       // @todo see above - new functionality has been inappropriately added to the quick config concept
1427       // and new functionality has been added onto the form layer rather than the BAO :-(
1428       if ($this->_priceSetId && CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config')) {
1429         //CRM-16833: Ensure tax is applied only once for membership conribution, when status changed.(e.g Pending to Completed).
1430         $componentDetails = CRM_Contribute_BAO_Contribution::getComponentDetails($this->_id);
1431         if (empty($componentDetails['membership']) && empty($componentDetails['participant'])) {
1432           if (!($this->_action & CRM_Core_Action::UPDATE && (($this->_defaults['contribution_status_id'] != $submittedValues['contribution_status_id'])))) {
1433             $lineItems[$itemId]['unit_price'] = $lineItems[$itemId]['line_total'] = CRM_Utils_Rule::cleanMoney(CRM_Utils_Array::value('total_amount', $submittedValues));
1434           }
1435         }
1436
1437         // Update line total and total amount with tax on edit.
1438         $financialItemsId = CRM_Core_PseudoConstant::getTaxRates();
1439         if (array_key_exists($submittedValues['financial_type_id'], $financialItemsId)) {
1440           $lineItems[$itemId]['tax_rate'] = $financialItemsId[$submittedValues['financial_type_id']];
1441         }
1442         else {
1443           $lineItems[$itemId]['tax_rate'] = $lineItems[$itemId]['tax_amount'] = "";
1444           $submittedValues['tax_amount'] = 'null';
1445         }
1446         if ($lineItems[$itemId]['tax_rate']) {
1447           $lineItems[$itemId]['tax_amount'] = ($lineItems[$itemId]['tax_rate'] / 100) * $lineItems[$itemId]['line_total'];
1448           $submittedValues['total_amount'] = $lineItems[$itemId]['line_total'] + $lineItems[$itemId]['tax_amount'];
1449           $submittedValues['tax_amount'] = $lineItems[$itemId]['tax_amount'];
1450         }
1451       }
1452       // CRM-10117 update the line items for participants.
1453       if (!empty($lineItems[$itemId]['price_field_id'])) {
1454         $lineItem[$this->_priceSetId] = $lineItems;
1455       }
1456     }
1457
1458     $isQuickConfig = 0;
1459     if ($this->_priceSetId && CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config')) {
1460       $isQuickConfig = 1;
1461     }
1462     //CRM-11529 for quick config back office transactions
1463     //when financial_type_id is passed in form, update the
1464     //line items with the financial type selected in form
1465     // NOTE that this IS still a legitimate use of 'quick-config' for contributions under the current DB but
1466     // we should look at having a price field per contribution type & then there would be little reason
1467     // for the back-office contribution form postProcess to know if it is a quick-config form.
1468     if ($isQuickConfig && !empty($submittedValues['financial_type_id']) && !empty($lineItem[$this->_priceSetId])
1469     ) {
1470       foreach ($lineItem[$this->_priceSetId] as &$values) {
1471         $values['financial_type_id'] = $submittedValues['financial_type_id'];
1472       }
1473     }
1474
1475     if (!isset($submittedValues['total_amount'])) {
1476       $submittedValues['total_amount'] = $this->_values['total_amount'] ?? NULL;
1477       // Avoid tax amount deduction on edit form and keep it original, because this will lead to error described in CRM-20676
1478       if (!$this->_id) {
1479         $submittedValues['total_amount'] -= CRM_Utils_Array::value('tax_amount', $this->_values, 0);
1480       }
1481     }
1482     $this->assign('lineItem', !empty($lineItem) && !$isQuickConfig ? $lineItem : FALSE);
1483
1484     $isEmpty = array_keys(array_flip($submittedValues['soft_credit_contact_id']));
1485     if ($this->_id && count($isEmpty) == 1 && key($isEmpty) == NULL) {
1486       civicrm_api3('ContributionSoft', 'get', ['contribution_id' => $this->_id, 'pcp_id' => ['IS NULL' => 1], 'api.ContributionSoft.delete' => 1]);
1487     }
1488
1489     // set the contact, when contact is selected
1490     if (!empty($submittedValues['contact_id'])) {
1491       $this->_contactID = $submittedValues['contact_id'];
1492     }
1493
1494     $formValues = $submittedValues;
1495
1496     // Credit Card Contribution.
1497     if ($this->_mode) {
1498       $paramsSetByPaymentProcessingSubsystem = [
1499         'trxn_id',
1500         'payment_instrument_id',
1501         'contribution_status_id',
1502         'cancel_date',
1503         'cancel_reason',
1504       ];
1505       foreach ($paramsSetByPaymentProcessingSubsystem as $key) {
1506         if (isset($formValues[$key])) {
1507           unset($formValues[$key]);
1508         }
1509       }
1510       $contribution = $this->processCreditCard($formValues, $lineItem, $this->_contactID);
1511       foreach ($paramsSetByPaymentProcessingSubsystem as $key) {
1512         $formValues[$key] = $contribution->$key;
1513       }
1514     }
1515     else {
1516       // Offline Contribution.
1517       $submittedValues = $this->unsetCreditCardFields($submittedValues);
1518
1519       // get the required field value only.
1520
1521       $params = [
1522         'contact_id' => $this->_contactID,
1523         'currency' => $this->getCurrency($submittedValues),
1524         'skipCleanMoney' => TRUE,
1525         'id' => $this->_id,
1526       ];
1527
1528       //format soft-credit/pcp param first
1529       CRM_Contribute_BAO_ContributionSoft::formatSoftCreditParams($submittedValues, $this);
1530       $params = array_merge($params, $submittedValues);
1531
1532       $fields = [
1533         'financial_type_id',
1534         'contribution_status_id',
1535         'payment_instrument_id',
1536         'cancel_reason',
1537         'source',
1538         'check_number',
1539         'card_type_id',
1540         'pan_truncation',
1541       ];
1542       foreach ($fields as $f) {
1543         $params[$f] = $formValues[$f] ?? NULL;
1544       }
1545
1546       $params['revenue_recognition_date'] = NULL;
1547       if (!empty($formValues['revenue_recognition_date'])
1548         && count(array_filter($formValues['revenue_recognition_date'])) == 2
1549       ) {
1550         $params['revenue_recognition_date'] = CRM_Utils_Date::processDate(
1551           '01-' . implode('-', $formValues['revenue_recognition_date'])
1552         );
1553       }
1554
1555       if (!empty($formValues['is_email_receipt'])) {
1556         $params['receipt_date'] = date("Y-m-d");
1557       }
1558
1559       if (CRM_Contribute_BAO_Contribution::isContributionStatusNegative($params['contribution_status_id'])
1560       ) {
1561         if (CRM_Utils_System::isNull(CRM_Utils_Array::value('cancel_date', $params))) {
1562           $params['cancel_date'] = date('YmdHis');
1563         }
1564       }
1565       else {
1566         $params['cancel_date'] = $params['cancel_reason'] = 'null';
1567       }
1568
1569       // Set is_pay_later flag for back-office offline Pending status contributions CRM-8996
1570       // else if contribution_status is changed to Completed is_pay_later flag is changed to 0, CRM-15041
1571       if ($params['contribution_status_id'] == CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending')) {
1572         $params['is_pay_later'] = 1;
1573       }
1574       elseif ($params['contribution_status_id'] == CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed')) {
1575         $params['is_pay_later'] = 0;
1576       }
1577
1578       // Add Additional common information to formatted params.
1579       CRM_Contribute_Form_AdditionalInfo::postProcessCommon($formValues, $params, $this);
1580       if ($pId) {
1581         $params['contribution_mode'] = 'participant';
1582         $params['participant_id'] = $pId;
1583         $params['skipLineItem'] = 1;
1584       }
1585       elseif ($isRelatedId) {
1586         $params['contribution_mode'] = 'membership';
1587       }
1588       $params['line_item'] = $lineItem;
1589       $params['payment_processor_id'] = $params['payment_processor'] = $this->_paymentProcessor['id'] ?? NULL;
1590       $params['tax_amount'] = CRM_Utils_Array::value('tax_amount', $submittedValues, CRM_Utils_Array::value('tax_amount', $this->_values));
1591       //create contribution.
1592       if ($isQuickConfig) {
1593         $params['is_quick_config'] = 1;
1594       }
1595       $params['non_deductible_amount'] = $this->calculateNonDeductibleAmount($params, $formValues);
1596
1597       // we are already handling note below, so to avoid duplicate notes against $contribution
1598       if (!empty($params['note']) && !empty($submittedValues['note'])) {
1599         unset($params['note']);
1600       }
1601       $contribution = CRM_Contribute_BAO_Contribution::create($params);
1602
1603       // process associated membership / participant, CRM-4395
1604       if ($contribution->id && $action & CRM_Core_Action::UPDATE) {
1605         CRM_Contribute_BAO_Contribution::transitionComponents([
1606           'contribution_id' => $contribution->id,
1607           'contribution_status_id' => $contribution->contribution_status_id,
1608           'previous_contribution_status_id' => $this->_values['contribution_status_id'] ?? NULL,
1609           'receive_date' => $contribution->receive_date,
1610         ]);
1611       }
1612
1613       array_unshift($this->statusMessage, ts('The contribution record has been saved.'));
1614
1615       $this->invoicingPostProcessHook($submittedValues, $action, $lineItem);
1616
1617       //send receipt mail.
1618       if ($contribution->id && !empty($formValues['is_email_receipt'])) {
1619         $formValues['contact_id'] = $this->_contactID;
1620         $formValues['contribution_id'] = $contribution->id;
1621
1622         $formValues += CRM_Contribute_BAO_ContributionSoft::getSoftContribution($contribution->id);
1623
1624         // to get 'from email id' for send receipt
1625         $this->fromEmailId = $formValues['from_email_address'] ?? NULL;
1626         if (CRM_Contribute_Form_AdditionalInfo::emailReceipt($this, $formValues)) {
1627           $this->statusMessage[] = ts('A receipt has been emailed to the contributor.');
1628         }
1629       }
1630
1631       $this->statusMessageTitle = ts('Saved');
1632
1633     }
1634
1635     if ($contribution->id && isset($formValues['product_name'][0])) {
1636       CRM_Contribute_Form_AdditionalInfo::processPremium($submittedValues, $contribution->id,
1637         $this->_premiumID, $this->_options
1638       );
1639     }
1640
1641     if ($contribution->id && array_key_exists('note', $submittedValues)) {
1642       CRM_Contribute_Form_AdditionalInfo::processNote($submittedValues, $this->_contactID, $contribution->id, $this->_noteID);
1643     }
1644
1645     CRM_Core_Session::setStatus(implode(' ', $this->statusMessage), $this->statusMessageTitle, 'success');
1646
1647     CRM_Contribute_BAO_Contribution::updateRelatedPledge(
1648       $action,
1649       $pledgePaymentID,
1650       $contribution->id,
1651       ($formValues['option_type'] ?? 0) == 2,
1652       $formValues['total_amount'],
1653       CRM_Utils_Array::value('total_amount', $this->_defaults),
1654       $formValues['contribution_status_id'],
1655       CRM_Utils_Array::value('contribution_status_id', $this->_defaults)
1656     );
1657     return $contribution;
1658   }
1659
1660   /**
1661    * Assign tax calculations to contribution receipts.
1662    *
1663    * @param array $submittedValues
1664    * @param int $action
1665    * @param array $lineItem
1666    */
1667   protected function invoicingPostProcessHook($submittedValues, $action, $lineItem) {
1668
1669     $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
1670     if (empty($invoiceSettings['invoicing'])) {
1671       return;
1672     }
1673     $taxRate = [];
1674     $getTaxDetails = FALSE;
1675
1676     foreach ($lineItem as $key => $value) {
1677       foreach ($value as $v) {
1678         if (isset($taxRate[(string) CRM_Utils_Array::value('tax_rate', $v)])) {
1679           $taxRate[(string) $v['tax_rate']] = $taxRate[(string) $v['tax_rate']] + CRM_Utils_Array::value('tax_amount', $v);
1680         }
1681         else {
1682           if (isset($v['tax_rate'])) {
1683             $taxRate[(string) $v['tax_rate']] = $v['tax_amount'] ?? NULL;
1684             $getTaxDetails = TRUE;
1685           }
1686         }
1687       }
1688     }
1689
1690     if ($action & CRM_Core_Action::UPDATE) {
1691       if (isset($submittedValues['tax_amount'])) {
1692         $totalTaxAmount = $submittedValues['tax_amount'];
1693       }
1694       else {
1695         $totalTaxAmount = $this->_values['tax_amount'];
1696       }
1697       $this->assign('totalTaxAmount', $totalTaxAmount);
1698       $this->assign('dataArray', $taxRate);
1699     }
1700     else {
1701       if (!empty($submittedValues['price_set_id'])) {
1702         $this->assign('totalTaxAmount', $submittedValues['tax_amount']);
1703         $this->assign('getTaxDetails', $getTaxDetails);
1704         $this->assign('dataArray', $taxRate);
1705         $this->assign('taxTerm', Civi::settings()->get('tax_term'));
1706       }
1707       else {
1708         $this->assign('totalTaxAmount', CRM_Utils_Array::value('tax_amount', $submittedValues));
1709       }
1710     }
1711   }
1712
1713   /**
1714    * Calculate non deductible amount.
1715    *
1716    * @see https://issues.civicrm.org/jira/browse/CRM-11956
1717    * if non_deductible_amount exists i.e. Additional Details field set was opened [and staff typed something] -
1718    * if non_deductible_amount does NOT exist - then calculate it depending on:
1719    * $financialType->is_deductible and whether there is a product (premium).
1720    *
1721    * @param $params
1722    * @param $formValues
1723    *
1724    * @return array
1725    */
1726   protected function calculateNonDeductibleAmount($params, $formValues) {
1727     if (!empty($params['non_deductible_amount'])) {
1728       return $params['non_deductible_amount'];
1729     }
1730
1731     $priceSetId = $params['price_set_id'] ?? NULL;
1732     // return non-deductible amount if it is set at the price field option level
1733     if ($priceSetId && !empty($params['line_item'])) {
1734       $nonDeductibleAmount = CRM_Price_BAO_PriceSet::getNonDeductibleAmountFromPriceSet($priceSetId, $params['line_item']);
1735       if (!empty($nonDeductibleAmount)) {
1736         return $nonDeductibleAmount;
1737       }
1738     }
1739
1740     $financialType = new CRM_Financial_DAO_FinancialType();
1741     $financialType->id = $params['financial_type_id'];
1742     $financialType->find(TRUE);
1743
1744     if ($financialType->is_deductible) {
1745
1746       if (isset($formValues['product_name'][0])) {
1747         $selectProduct = $formValues['product_name'][0];
1748       }
1749       // if there is a product - compare the value to the contribution amount
1750       if (isset($selectProduct)) {
1751         $productDAO = new CRM_Contribute_DAO_Product();
1752         $productDAO->id = $selectProduct;
1753         $productDAO->find(TRUE);
1754         // product value exceeds contribution amount
1755         if ($params['total_amount'] < $productDAO->price) {
1756           return $params['total_amount'];
1757         }
1758         // product value does NOT exceed contribution amount
1759         else {
1760           return $productDAO->price;
1761         }
1762       }
1763       // contribution is deductible - but there is no product
1764       else {
1765         return '0.00';
1766       }
1767     }
1768     // contribution is NOT deductible
1769     else {
1770       return $params['total_amount'];
1771     }
1772
1773     return 0;
1774   }
1775
1776   /**
1777    * Get the financial Type ID for the contribution either from the submitted values or from the contribution values if possible.
1778    *
1779    * This is important for dev/core#1728 - ie ensure that if we are returned to the form for a form
1780    * error that any custom fields based on the selected financial type are loaded.
1781    *
1782    * @return int
1783    */
1784   protected function getFinancialTypeID() {
1785     if (!empty($this->_submitValues['financial_type_id'])) {
1786       return $this->_submitValues['financial_type_id'];
1787     }
1788     if (!empty($this->_values['financial_type_id'])) {
1789       return $this->_values['financial_type_id'];
1790     }
1791   }
1792
1793   /**
1794    * Set context in session
1795    */
1796   public function setUserContext(): void {
1797     $session = CRM_Core_Session::singleton();
1798     $buttonName = $this->controller->getButtonName();
1799     if ($this->_context == 'standalone') {
1800       if ($buttonName == $this->getButtonName('upload', 'new')) {
1801         $session->replaceUserContext(CRM_Utils_System::url('civicrm/contribute/add',
1802           'reset=1&action=add&context=standalone'
1803         ));
1804       }
1805       else {
1806         $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
1807           "reset=1&cid={$this->_contactID}&selectedChild=contribute"
1808         ));
1809       }
1810     }
1811     elseif ($this->_context == 'contribution' && $this->_mode && $buttonName == $this->getButtonName('upload', 'new')) {
1812       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/contribution',
1813         "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}&mode={$this->_mode}"
1814       ));
1815     }
1816     elseif ($buttonName == $this->getButtonName('upload', 'new')) {
1817       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view/contribution',
1818         "reset=1&action=add&context={$this->_context}&cid={$this->_contactID}"
1819       ));
1820     }
1821   }
1822
1823 }