CRM/Contribute/Form/AdditionalPayment.php

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