CRM/Contribute/Form/Contribution.php

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