CRM/Contribute/Form/Contribution.php

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