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