CRM/Contribute/Form/AdditionalPayment.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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 usefusul, 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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This form records additional payments needed when
  38  * event/contribution is partially paid
  39  *
  40  */
  41 class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_AbstractEditPayment {
  42   public $_contributeMode = 'direct';
  43
  44   /**
  45    * related component whose financial payment is being processed
  46    *
  47    * @var string
  48    * @public
  49    */
  50   protected $_component = NULL;
  51
  52   /**
  53    * id of the component entity
  54    */
  55   public $_id = NULL;
  56
  57   protected $_owed = NULL;
  58
  59   protected $_refund = NULL;
  60
  61   protected $_contactId = NULL;
  62
  63   protected $_contributorDisplayName = NULL;
  64
  65   protected $_contributorEmail = NULL;
  66
  67   protected $_toDoNotEmail = NULL;
  68
  69   protected $_paymentType = NULL;
  70
  71   protected $_contributionId = NULL;
  72
  73   protected $fromEmailId = NULL;
  74
  75   protected $_fromEmails = NULL;
  76
  77   protected $_view = NULL;
  78
  79   public $_action = NULL;
  80
  81   public function preProcess() {
  82     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
  83     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
  84     $this->_component = CRM_Utils_Request::retrieve('component', 'String', $this, TRUE);
  85     $this->_view = CRM_Utils_Request::retrieve('view', 'String', $this, FALSE);
  86     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE);
  87     $this->assign('component', $this->_component);
  88     $this->assign('id', $this->_id);
  89
  90     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
  91       $paymentInfo = CRM_Contribute_BAO_Contribution::getPaymentInfo($this->_id, $this->_component, TRUE);
  92       $transactionRows = $paymentInfo['transaction'];
  93       $title = ts('View Payment');
  94       if ($this->_component == 'event') {
  95         $info = CRM_Event_BAO_Participant::participantDetails($this->_id);
  96         $title .= " - {$info['title']}";
  97       }
  98       CRM_Utils_System::setTitle($title);
  99       $this->assign('transaction', TRUE);
 100       $this->assign('rows', $transactionRows);
 101       return;
 102     }
 103     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
 104     $this->_formType = CRM_Utils_Array::value('formType', $_GET);
 105
 106     $enitityType = NULL;
 107     if ($this->_component == 'event') {
 108       $enitityType = 'participant';
 109       $this->_contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id, 'contribution_id', 'participant_id');
 110     }
 111     $eventId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'event_id', 'id');
 112     $this->_fromEmails = CRM_Event_BAO_Event::getFromEmailIds($eventId);
 113
 114     $paymentInfo = CRM_Core_BAO_FinancialTrxn::getPartialPaymentWithType($this->_id, $enitityType);
 115     $paymentDetails = CRM_Contribute_BAO_Contribution::getPaymentInfo($this->_id, $this->_component, FALSE, TRUE);
 116
 117     $this->_amtPaid = $paymentDetails['paid'];
 118     $this->_amtTotal = $paymentDetails['total'];
 119
 120     if (!empty($paymentInfo['refund_due'])) {
 121       $paymentAmt = $this->_refund = $paymentInfo['refund_due'];
 122       $this->_paymentType = 'refund';
 123     }
 124     elseif (!empty($paymentInfo['amount_owed'])) {
 125       $paymentAmt = $this->_owed = $paymentInfo['amount_owed'];
 126       $this->_paymentType = 'owed';
 127     }
 128     else {
 129       CRM_Core_Error::fatal(ts('No payment information found for this record'));
 130     }
 131
 132     //set the payment mode - _mode property is defined in parent class
 133     $this->_mode = CRM_Utils_Request::retrieve('mode', 'String', $this);
 134
 135     if (!empty($this->_mode) && $this->_paymentType == 'refund') {
 136       CRM_Core_Error::fatal(ts('Credit card payment is not for Refund payments use'));
 137     }
 138
 139     list($this->_contributorDisplayName, $this->_contributorEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactId);
 140
 141     if (!$this->_refund) {
 142       $this->assignProcessors();
 143       // also check for billing information
 144       // get the billing location type
 145       $this->assignBillingType();
 146     }
 147
 148     $this->assign('contributionMode', $this->_mode);
 149     $this->assign('contactId', $this->_contactId);
 150     $this->assign('paymentType', $this->_paymentType);
 151     $this->assign('paymentAmt', abs($paymentAmt));
 152
 153     $this->_paymentProcessor = array('billing_mode' => 1);
 154
 155     $title = ($this->_refund) ? "Refund for {$this->_contributorDisplayName}" : "Payment from {$this->_contributorDisplayName}";
 156     if ($title) {
 157       CRM_Utils_System::setTitle(ts('%1', array(1 => $title)));
 158     }
 159   }
 160
 161   /**
 162    * This virtual function is used to set the default values of
 163    * various form elements
 164    *
 165    * access        public
 166    *
 167    * @return array reference to the array of default values
 168    *
 169    */
 170   /**
 171    * @return array
 172    */
 173   public function setDefaultValues() {
 174     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
 175       return;
 176     }
 177     $defaults = array( );
 178     if ($this->_mode) {
 179       $defaults = $this->_values;
 180
 181       $config = CRM_Core_Config::singleton();
 182       // set default country from config if no country set
 183       if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
 184         $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
 185       }
 186
 187       if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
 188         $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
 189       }
 190
 191       $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactId);
 192       $defaults = array_merge($defaults, $billingDefaults);
 193
 194       // now fix all state country selectors, set correct state based on country
 195       CRM_Core_BAO_Address::fixAllStateSelects($this, $defaults);
 196     }
 197
 198     if (empty($defaults['trxn_date']) && empty($defaults['trxn_date_time'])) {
 199       list($defaults['trxn_date'],
 200         $defaults['trxn_date_time']
 201       ) = CRM_Utils_Date::setDateDefaults(
 202         CRM_Utils_Array::value('register_date', $defaults), 'activityDateTime'
 203       );
 204     }
 205
 206     if ($this->_refund) {
 207       $defaults['total_amount'] = abs($this->_refund);
 208     }
 209
 210     // Set $newCredit variable in template to control whether link to credit card mode is included
 211     $this->assign('newCredit', CRM_Core_Config::isEnabledBackOfficeCreditCardPayments());
 212     return $defaults;
 213   }
 214
 215   public function buildQuickForm() {
 216     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
 217       $this->addButtons(array(
 218           array(
 219             'type' => 'cancel',
 220             'name' => ts('Done'),
 221             'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 222             'isDefault' => TRUE,
 223           ),
 224         )
 225       );
 226       return;
 227     }
 228     $ccPane = NULL;
 229     if ($this->_mode) {
 230       if (CRM_Utils_Array::value('payment_type', $this->_processors) & CRM_Core_Payment::PAYMENT_TYPE_DIRECT_DEBIT
 231       ) {
 232         $ccPane = array(ts('Direct Debit Information') => 'DirectDebit');
 233       }
 234       else {
 235         $ccPane = array(ts('Credit Card Information') => 'CreditCard');
 236       }
 237       $defaults = $this->_values;
 238       $showAdditionalInfo = FALSE;
 239
 240       foreach ($ccPane as $name => $type) {
 241         if ($this->_formType == $type || !empty($_POST["hidden_{$type}"]) ||
 242           CRM_Utils_Array::value("hidden_{$type}", $defaults)
 243         ) {
 244           $showAdditionalInfo = TRUE;
 245           $allPanes[$name]['open'] = 'true';
 246         }
 247
 248         $urlParams = "snippet=4&formType={$type}";
 249         if ($this->_mode) {
 250           $urlParams .= "&mode={$this->_mode}";
 251         }
 252         $open = 'false';
 253         if ($type == 'CreditCard' ||
 254           $type == 'DirectDebit'
 255         ) {
 256           $open = 'true';
 257         }
 258
 259         $allPanes[$name] = array(
 260           'url' => CRM_Utils_System::url('civicrm/payment/add', $urlParams),
 261           'open' => $open,
 262           'id' => $type
 263         );
 264
 265         if ($type == 'CreditCard') {
 266           $this->add('hidden', 'hidden_CreditCard', 1);
 267           CRM_Core_Payment_Form::buildCreditCard($this, TRUE);
 268         }
 269         elseif ($type == 'DirectDebit') {
 270           $this->add('hidden', 'hidden_DirectDebit', 1);
 271           CRM_Core_Payment_Form::buildDirectDebit($this, TRUE);
 272         }
 273         $qfKey = $this->controller->_key;
 274         $this->assign('qfKey', $qfKey);
 275         $this->assign('allPanes', $allPanes);
 276         $this->assign('showAdditionalInfo', $showAdditionalInfo);
 277
 278         if ($this->_formType) {
 279           $this->assign('formType', $this->_formType);
 280           return;
 281         }
 282       }
 283     }
 284     $attributes = CRM_Core_DAO::getAttribute('CRM_Financial_DAO_FinancialTrxn');
 285
 286     $this->add('select', 'payment_processor_id', ts('Payment Processor'), $this->_processors, NULL);
 287     $label = ($this->_refund) ? 'Refund Amount' : 'Payment Amount';
 288     $this->addMoney('total_amount',
 289       ts('%1', array(1 => $label)),
 290       FALSE,
 291       $attributes['total_amount'],
 292       TRUE, 'currency', NULL
 293     );
 294
 295     $this->add('select', 'payment_instrument_id',
 296       ts('Paid By'),
 297       array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(),
 298       TRUE, array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
 299     );
 300
 301     $this->add('text', 'check_number', ts('Check Number'), $attributes['financial_trxn_check_number']);
 302     $trxnId = $this->add('text', 'trxn_id', ts('Transaction ID'), $attributes['trxn_id']);
 303
 304     //add receipt for offline contribution
 305     $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
 306
 307     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails['from_email_id']);
 308
 309     $this->add('textarea', 'receipt_text', ts('Confirmation Message'));
 310
 311     // add various dates
 312     $dateLabel = ($this->_refund) ? 'Refund Date' : 'Received Date';
 313     $this->addDateTime('trxn_date', ts('%1', array(1 => $dateLabel)), FALSE, array('formatType' => 'activityDateTime'));
 314
 315     if ($this->_contactId && $this->_id) {
 316       if ($this->_component == 'event') {
 317         $eventId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'event_id', 'id');
 318         $event = CRM_Event_BAO_Event::getEvents(0, $eventId);
 319         $this->assign('eventName', $event[$eventId]);
 320       }
 321     }
 322
 323     $this->assign('displayName', $this->_contributorDisplayName);
 324     $this->assign('component', $this->_component);
 325     $this->assign('email', $this->_contributorEmail);
 326
 327     $this->add('text', 'fee_amount', ts('Fee Amount'),
 328       $attributes['fee_amount']
 329     );
 330     $this->addRule('fee_amount', ts('Please enter a valid monetary value for Fee Amount.'), 'money');
 331
 332     $this->add('text', 'net_amount', ts('Net Amount'),
 333       $attributes['net_amount']
 334     );
 335     $this->addRule('net_amount', ts('Please enter a valid monetary value for Net Amount.'), 'money');
 336
 337     $js = NULL;
 338     if (!$this->_mode) {
 339       $js = array('onclick' => "return verify( );");
 340     }
 341
 342     $buttonName = $this->_refund ? 'Record Refund' : 'Record Payment';
 343     $this->addButtons(array(
 344         array(
 345           'type' => 'upload',
 346           'name' => ts('%1', array(1 => $buttonName)),
 347           'js' => $js,
 348           'isDefault' => TRUE
 349         ),
 350         array(
 351           'type' => 'cancel',
 352           'name' => ts('Cancel')
 353         ),
 354       )
 355     );
 356
 357
 358     $mailingInfo = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
 359       'mailing_backend'
 360     );
 361     $this->assign('outBound_option', $mailingInfo['outBound_option']);
 362
 363     $this->addFormRule(array('CRM_Contribute_Form_AdditionalPayment', 'formRule'), $this);
 364   }
 365
 366   /**
 367    * @param $fields
 368    * @param $files
 369    * @param $self
 370    *
 371    * @return array
 372    */
 373   static function formRule($fields, $files, $self) {
 374     $errors = array();
 375     if ($self->_paymentType == 'owed' && $fields['total_amount'] > $self->_owed) {
 376       $errors['total_amount'] = ts('Payment amount cannot be greater than owed amount');
 377     }
 378     if ($self->_paymentType == 'refund' && $fields['total_amount'] != abs($self->_refund)) {
 379       $errors['total_amount'] = ts('Refund amount must equal refund due amount.');
 380     }
 381     $netAmt = $fields['total_amount'] - $fields['fee_amount'];
 382     if (!empty($fields['net_amount']) && $netAmt != $fields['net_amount']) {
 383       $errors['net_amount'] = ts('Net amount should be equal to the difference between payment amount and fee amount.');
 384     }
 385     return $errors;
 386   }
 387
 388   public function postProcess() {
 389     $participantId = NULL;
 390     if ($this->_component == 'event') {
 391       $participantId = $this->_id;
 392     }
 393     $submittedValues = $this->controller->exportValues($this->_name);
 394     $submittedValues['confirm_email_text'] = CRM_Utils_Array::value('receipt_text', $submittedValues);
 395
 396     $submittedValues['trxn_date'] = CRM_Utils_Date::processDate($submittedValues['trxn_date'], $submittedValues['trxn_date_time']);
 397     if ($this->_mode) {
 398       // process credit card
 399       $this->assign('contributeMode', 'direct');
 400       $this->processCreditCard($submittedValues);
 401     }
 402     else {
 403       $result = CRM_Contribute_BAO_Contribution::recordAdditionalPayment($this->_contributionId, $submittedValues, $this->_paymentType, $participantId);
 404
 405       // email sending
 406       if (!empty($result) && !empty($submittedValues['is_email_receipt'])) {
 407         $submittedValues['contact_id'] = $this->_contactId;
 408         $submittedValues['contribution_id'] = $this->_contributionId;
 409
 410         // to get 'from email id' for send receipt
 411         $this->fromEmailId = $submittedValues['from_email_address'];
 412         $sendReceipt = $this->emailReceipt($submittedValues);
 413       }
 414
 415       $statusMsg = ts('The payment record has been processed.');
 416       if (!empty($submittedValues['is_email_receipt']) && $sendReceipt) {
 417         $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
 418       }
 419
 420       CRM_Core_Session::setStatus($statusMsg, ts('Saved'), 'success');
 421
 422       $session = CRM_Core_Session::singleton();
 423       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
 424           "reset=1&cid={$this->_contactId}&selectedChild=participant"
 425         ));
 426     }
 427   }
 428
 429   /**
 430    * @param $submittedValues
 431    */
 432   public function processCreditCard($submittedValues) {
 433     $config = CRM_Core_Config::singleton();
 434     $session = CRM_Core_Session::singleton();
 435
 436     $unsetParams = array(
 437       'trxn_id',
 438       'payment_instrument_id',
 439       'contribution_status_id',
 440     );
 441     foreach ($unsetParams as $key) {
 442       if (isset($submittedValues[$key])) {
 443         unset($submittedValues[$key]);
 444       }
 445     }
 446
 447     //Get the rquire fields value only.
 448     $params = $this->_params = $submittedValues;
 449
 450     $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($this->_params['payment_processor_id'],
 451       $this->_mode
 452     );
 453
 454     //get the payment processor id as per mode.
 455     $this->_params['payment_processor'] = $params['payment_processor_id'] =
 456       $this->_params['payment_processor_id'] = $submittedValues['payment_processor_id'] = $this->_paymentProcessor['id'];
 457
 458     $now = date('YmdHis');
 459     $fields = array();
 460
 461     // we need to retrieve email address
 462     if ($this->_context == 'standalone' && !empty($submittedValues['is_email_receipt'])) {
 463       list($this->userDisplayName,
 464         $this->userEmail
 465       ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactId);
 466       $this->assign('displayName', $this->userDisplayName);
 467     }
 468
 469     //set email for primary location.
 470     $fields['email-Primary'] = 1;
 471     $params['email-Primary'] = $this->_contributorEmail;
 472
 473     // now set the values for the billing location.
 474     foreach ($this->_fields as $name => $dontCare) {
 475       $fields[$name] = 1;
 476     }
 477
 478     // also add location name to the array
 479     $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);
 480     $params["address_name-{$this->_bltID}"] = trim($params["address_name-{$this->_bltID}"]);
 481     $fields["address_name-{$this->_bltID}"] = 1;
 482
 483     $ctype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 484       $this->_contactId,
 485       'contact_type'
 486     );
 487
 488     $nameFields = array('first_name', 'middle_name', 'last_name');
 489     foreach ($nameFields as $name) {
 490       $fields[$name] = 1;
 491       if (array_key_exists("billing_$name", $params)) {
 492         $params[$name] = $params["billing_{$name}"];
 493         $params['preserveDBName'] = TRUE;
 494       }
 495     }
 496
 497     if (!empty($params['source'])) {
 498       unset($params['source']);
 499     }
 500     $contactID = CRM_Contact_BAO_Contact::createProfileContact($params, $fields,
 501       $this->_contactId,
 502       NULL, NULL,
 503       $ctype
 504     );
 505
 506     // add all the additioanl payment params we need
 507     $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}"]);
 508     $this->_params["country-{$this->_bltID}"] = $this->_params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($this->_params["billing_country_id-{$this->_bltID}"]);
 509
 510     if ($this->_paymentProcessor['payment_type'] & CRM_Core_Payment::PAYMENT_TYPE_CREDIT_CARD) {
 511       $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
 512       $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
 513     }
 514     $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
 515     $this->_params['amount'] = $this->_params['total_amount'];
 516     $this->_params['amount_level'] = 0;
 517     $this->_params['currencyID'] = CRM_Utils_Array::value('currency',
 518       $this->_params,
 519       $config->defaultCurrency
 520     );
 521     $this->_params['payment_action'] = 'Sale';
 522     if (!empty($this->_params['trxn_date'])) {
 523       $this->_params['receive_date'] = CRM_Utils_Date::processDate($this->_params['trxn_date'], $this->_params['trxn_date_time']);
 524     }
 525
 526     if (empty($this->_params['invoice_id'])) {
 527       $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
 528     }
 529     else {
 530       $this->_params['invoiceID'] = $this->_params['invoice_id'];
 531     }
 532
 533     // billing name and Address
 534     $name = CRM_Utils_Array::value('billing_first_name', $params);
 535     if (!empty($params['billing_middle_name'])) {
 536       $name .= " {$params['billing_middle_name']}";
 537     }
 538     $name .= ' ' . CRM_Utils_Array::value('billing_last_name', $params);
 539     $name = trim($name);
 540     $this->assign('billingName', $name);
 541
 542     //assign the address formatted up for display
 543     $addressParts = array(
 544       "street_address" => "billing_street_address-{$this->_bltID}",
 545       "city" => "billing_city-{$this->_bltID}",
 546       "postal_code" => "billing_postal_code-{$this->_bltID}",
 547       "state_province" => "state_province-{$this->_bltID}",
 548       "country" => "country-{$this->_bltID}",
 549     );
 550     $addressFields = array();
 551     foreach ($addressParts as $name => $field) {
 552       $addressFields[$name] = CRM_Utils_Array::value($field, $params);
 553     }
 554     $this->assign('address', CRM_Utils_Address::format($addressFields));
 555     $date = CRM_Utils_Date::format($params['credit_card_exp_date']);
 556     $date = CRM_Utils_Date::mysqlToIso($date);
 557     $this->assign('credit_card_type', CRM_Utils_Array::value('credit_card_type', $params));
 558     $this->assign('credit_card_exp_date', $date);
 559     $this->assign('credit_card_number',
 560       CRM_Utils_System::mungeCreditCard($params['credit_card_number'])
 561     );
 562
 563     //Add common data to formatted params
 564     CRM_Contribute_Form_AdditionalInfo::postProcessCommon($params, $this->_params, $this);
 565     // at this point we've created a contact and stored its address etc
 566     // all the payment processors expect the name and address to be in the
 567     // so we copy stuff over to first_name etc.
 568     $paymentParams = $this->_params;
 569     $paymentParams['contactID'] = $this->_contactId;
 570     CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE);
 571
 572     // add some financial type details to the params list
 573     // if folks need to use it
 574     $paymentParams['contributionType_name'] = $this->_params['contributionType_name'] = $contributionType->name;
 575     $paymentParams['contributionPageID'] = NULL;
 576     if (!empty($this->_params['is_email_receipt'])) {
 577       $paymentParams['email'] = $this->_contributorEmail;
 578       $paymentParams['is_email_receipt'] = 1;
 579     }
 580     else {
 581       $paymentParams['is_email_receipt'] = 0;
 582       $this->_params['is_email_receipt'] = 0;
 583     }
 584     if (!empty($this->_params['receive_date'])) {
 585       $paymentParams['receive_date'] = $this->_params['receive_date'];
 586     }
 587     if (!empty($this->_params['receive_date'])) {
 588       $paymentParams['receive_date'] = $this->_params['receive_date'];
 589     }
 590
 591     $result = NULL;
 592
 593     if ($paymentParams['amount'] > 0.0) {
 594       // force a reget of the payment processor in case the form changed it, CRM-7179
 595       $payment = CRM_Core_Payment::singleton($this->_mode, $this->_paymentProcessor, $this, TRUE);
 596       $result = $payment->doDirectPayment($paymentParams);
 597     }
 598
 599     if (is_a($result, 'CRM_Core_Error')) {
 600       //set the contribution mode.
 601       $urlParams = "action=add&cid={$this->_contactId}&id={$this->_id}&component={$this->_component}";
 602       if ($this->_mode) {
 603         $urlParams .= "&mode={$this->_mode}";
 604       }
 605       CRM_Core_Error::displaySessionError($result);
 606       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/payment/add', $urlParams));
 607     }
 608
 609     if ($result) {
 610       $this->_params = array_merge($this->_params, $result);
 611     }
 612
 613     if (empty($this->_params['receive_date'])) {
 614       $this->_params['receive_date'] = $now;
 615     }
 616
 617     $this->set('params', $this->_params);
 618
 619     // set source if not set
 620     if (empty($this->_params['source'])) {
 621       $userID = $session->get('userID');
 622       $userSortName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $userID,
 623         'sort_name'
 624       );
 625       $this->_params['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
 626     }
 627
 628     // process the additional payment
 629     $participantId = NULL;
 630     if ($this->_component == 'event') {
 631       $participantId = $this->_id;
 632     }
 633     $trxnRecord = CRM_Contribute_BAO_Contribution::recordAdditionalPayment($this->_contributionId, $submittedValues, $this->_paymentType, $participantId);
 634
 635     if ($trxnRecord->id && !empty($this->_params['is_email_receipt'])) {
 636       $sendReceipt = $this->emailReceipt($this->_params);
 637     }
 638
 639     if ($trxnRecord->id) {
 640       $statusMsg = ts('The payment record has been processed.');
 641       if (!empty($this->_params['is_email_receipt']) && $sendReceipt) {
 642         $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
 643       }
 644
 645       CRM_Core_Session::setStatus($statusMsg, ts('Complete'), 'success');
 646       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
 647           "reset=1&cid={$this->_contactId}&selectedChild=participant"
 648         ));
 649     }
 650   }
 651
 652   /**
 653    * @param $params
 654    *
 655    * @return mixed
 656    */
 657   function emailReceipt(&$params) {
 658     // email receipt sending
 659     // send message template
 660     if ($this->_component == 'event') {
 661       $eventId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'event_id', 'id');
 662
 663       $returnProperties = array('fee_label', 'start_date', 'end_date', 'is_show_location', 'title');
 664       CRM_Core_DAO::commonRetrieveAll('CRM_Event_DAO_Event', 'id', $eventId, $events, $returnProperties);
 665       $event = $events[$eventId];
 666       unset($event['start_date']);
 667       unset($event['end_date']);
 668
 669       $this->assign('event', $event);
 670       $this->assign('isShowLocation', $event['is_show_location']);
 671       if (CRM_Utils_Array::value('is_show_location', $event) == 1) {
 672         $locationParams = array(
 673           'entity_id' => $eventId,
 674           'entity_table' => 'civicrm_event',
 675         );
 676         $location = CRM_Core_BAO_Location::getValues($locationParams, TRUE);
 677         $this->assign('location', $location);
 678       }
 679     }
 680
 681     // assign payment info here
 682     $paymentConfig['confirm_email_text'] = CRM_Utils_Array::value('confirm_email_text', $params);
 683     $this->assign('paymentConfig', $paymentConfig);
 684     $isRefund = ($this->_paymentType == 'refund') ? TRUE : FALSE;
 685     $this->assign('isRefund', $isRefund);
 686     if ($isRefund) {
 687       $this->assign('totalPaid', $this->_amtPaid);
 688       $this->assign('totalAmount', $this->_amtTotal);
 689       $this->assign('refundAmount', $params['total_amount']);
 690     }
 691     else {
 692       $balance = $this->_amtTotal - ($this->_amtPaid + $params['total_amount']);
 693       $paymentsComplete = ($balance == 0) ? 1 : 0;
 694       $this->assign('amountOwed', $balance);
 695       $this->assign('totalAmount', $this->_amtTotal);
 696       $this->assign('paymentAmount', $params['total_amount']);
 697       $this->assign('paymentsComplete', $paymentsComplete);
 698     }
 699     $this->assign('contactDisplayName', $this->_contributorDisplayName);
 700
 701     // assign trxn details
 702     $this->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $params));
 703     $this->assign('receive_date', CRM_Utils_Array::value('trxn_date', $params));
 704     $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
 705     if (array_key_exists('payment_instrument_id', $params)) {
 706       $this->assign('paidBy',
 707         CRM_Utils_Array::value($params['payment_instrument_id'],
 708           $paymentInstrument
 709         )
 710       );
 711     }
 712     $this->assign('checkNumber', CRM_Utils_Array::value('check_number', $params));
 713
 714     $sendTemplateParams = array(
 715       'groupName' => 'msg_tpl_workflow_contribution',
 716       'valueName' => 'payment_or_refund_notification',
 717       'contactId' => $this->_contactId,
 718       'PDFFilename' => ts('notification').'.pdf',
 719     );
 720
 721     // try to send emails only if email id is present
 722     // and the do-not-email option is not checked for that contact
 723     if ($this->_contributorEmail && !$this->_toDoNotEmail) {
 724       if (array_key_exists($params['from_email_address'], $this->_fromEmails['from_email_id'])) {
 725         $receiptFrom = $params['from_email_address'];
 726       }
 727
 728       $sendTemplateParams['from'] = $receiptFrom;
 729       $sendTemplateParams['toName'] = $this->_contributorDisplayName;
 730       $sendTemplateParams['toEmail'] = $this->_contributorEmail;
 731       $sendTemplateParams['cc'] = CRM_Utils_Array::value('cc', $this->_fromEmails);
 732       $sendTemplateParams['bcc'] = CRM_Utils_Array::value('bcc', $this->_fromEmails);
 733     }
 734     list($mailSent, $subject, $message, $html) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
 735     return $mailSent;
 736   }
 737 }