CRM/Contribute/Form/AbstractEditPayment.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be 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-2015
  32  */
  33
  34 /**
  35  * This class generates form components for processing a contribution
  36  * CRM-16229 - During the event registration bulk action via search we
  37  * need to inherit CRM_Contact_Form_Task so that we can inherit functions
  38  * like getContactIds and make use of controller state. But this is not possible
  39  * because CRM_Event_Form_Participant inherits this class.
  40  * Ideal situation would be something like
  41  * CRM_Event_Form_Participant extends CRM_Contact_Form_Task,
  42  * CRM_Contribute_Form_AbstractEditPayment
  43  * However this is not possible. Currently PHP does not support multiple
  44  * inheritance. So work around solution is to extend this class with
  45  * CRM_Contact_Form_Task which further extends CRM_Core_Form.
  46  *
  47  */
  48 class CRM_Contribute_Form_AbstractEditPayment extends CRM_Contact_Form_Task {
  49   public $_mode;
  50
  51   public $_action;
  52
  53   public $_bltID;
  54
  55   public $_fields = array();
  56
  57   /**
  58    * @var array current payment processor including a copy of the object in 'object' key
  59    */
  60   public $_paymentProcessor;
  61
  62   /**
  63    * Available recurring processors.
  64    *
  65    * @var array
  66    */
  67   public $_recurPaymentProcessors = array();
  68
  69   /**
  70    * Array of processor options in the format id => array($id => $label)
  71    * WARNING it appears that the format used to differ to this and there are places in the code that
  72    * expect the old format. $this->_paymentProcessors provides the additional data which this
  73    * array seems to have provided in the past
  74    * @var array
  75    */
  76   public $_processors;
  77
  78   /**
  79    * Available payment processors with full details including the key 'object' indexed by their id
  80    * @var array
  81    */
  82   protected $_paymentProcessors = array();
  83
  84   /**
  85    * Instance of the payment processor object.
  86    *
  87    * @var CRM_Core_Payment
  88    */
  89   protected $_paymentObject;
  90
  91   /**
  92    * The id of the contribution that we are processing.
  93    *
  94    * @var int
  95    */
  96   public $_id;
  97
  98   /**
  99    * The id of the premium that we are proceessing.
 100    *
 101    * @var int
 102    */
 103   public $_premiumID = NULL;
 104
 105   /**
 106    * @var CRM_Contribute_DAO_ContributionProduct
 107    */
 108   public $_productDAO = NULL;
 109
 110   /**
 111    * The id of the note
 112    *
 113    * @var int
 114    */
 115   public $_noteID;
 116
 117   /**
 118    * The id of the contact associated with this contribution
 119    *
 120    * @var int
 121    */
 122   public $_contactID;
 123
 124   /**
 125    * The id of the pledge payment that we are processing
 126    *
 127    * @var int
 128    */
 129   public $_ppID;
 130
 131   /**
 132    * The id of the pledge that we are processing
 133    *
 134    * @var int
 135    */
 136   public $_pledgeID;
 137
 138   /**
 139    * Is this contribution associated with an online
 140    * financial transaction
 141    *
 142    * @var boolean
 143    */
 144   public $_online = FALSE;
 145
 146   /**
 147    * Stores all product option
 148    *
 149    * @var array
 150    */
 151   public $_options;
 152
 153   /**
 154    * Stores the honor id
 155    *
 156    * @var int
 157    */
 158   public $_honorID = NULL;
 159
 160   /**
 161    * Store the financial Type ID
 162    *
 163    * @var array
 164    */
 165   public $_contributionType;
 166
 167   /**
 168    * The contribution values if an existing contribution
 169    */
 170   public $_values;
 171
 172   /**
 173    * The pledge values if this contribution is associated with pledge
 174    */
 175   public $_pledgeValues;
 176
 177   public $_contributeMode = 'direct';
 178
 179   public $_context;
 180
 181   public $_compId;
 182
 183   /**
 184    * Store the line items if price set used.
 185    */
 186   public $_lineItems;
 187
 188   /**
 189    * Is this a backoffice form
 190    * (this will affect whether paypal express code is displayed)
 191    * @var bool
 192    */
 193   public $isBackOffice = TRUE;
 194
 195   protected $_formType;
 196
 197   /**
 198    * Array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should
 199    * be all in this array in order like
 200    *  'credit_card' => array('credit_card_number' ...
 201    *  'billing_details' => array('first_name' ...
 202    *
 203    * such that both the fields and the order can be more easily altered by payment processors & other extensions
 204    * @var array
 205    */
 206   public $billingFieldSets = array();
 207
 208   /**
 209    * Pre process function with common actions.
 210    */
 211   public function preProcess() {
 212     $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 213     $this->assign('contactID', $this->_contactID);
 214     CRM_Core_Resources::singleton()->addVars('coreForm', array('contact_id' => (int) $this->_contactID));
 215     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
 216   }
 217
 218   /**
 219    * @param int $id
 220    */
 221   public function showRecordLinkMesssage($id) {
 222     $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $id, 'contribution_status_id');
 223     if (CRM_Contribute_PseudoConstant::contributionStatus($statusId, 'name') == 'Partially paid') {
 224       if ($pid = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'participant_id', 'contribution_id')) {
 225         $recordPaymentLink = CRM_Utils_System::url('civicrm/payment',
 226           "reset=1&id={$pid}&cid={$this->_contactID}&action=add&component=event"
 227         );
 228         CRM_Core_Session::setStatus(ts('Please use the <a href="%1">Record Payment</a> form if you have received an additional payment for this Partially paid contribution record.', array(1 => $recordPaymentLink)), ts('Notice'), 'alert');
 229       }
 230     }
 231   }
 232
 233   /**
 234    * @param int $id
 235    * @param $values
 236    */
 237   public function buildValuesAndAssignOnline_Note_Type($id, &$values) {
 238     $ids = array();
 239     $params = array('id' => $id);
 240     CRM_Contribute_BAO_Contribution::getValues($params, $values, $ids);
 241
 242     //Check if this is an online transaction (financial_trxn.payment_processor_id NOT NULL)
 243     $this->_online = FALSE;
 244     $fids = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($id);
 245     if (!empty($fids['financialTrxnId'])) {
 246       $this->_online = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $fids['financialTrxnId'], 'payment_processor_id');
 247     }
 248
 249     // Also don't allow user to update some fields for recurring contributions.
 250     if (!$this->_online) {
 251       $this->_online = CRM_Utils_Array::value('contribution_recur_id', $values);
 252     }
 253
 254     $this->assign('isOnline', $this->_online ? TRUE : FALSE);
 255
 256     //to get note id
 257     $daoNote = new CRM_Core_BAO_Note();
 258     $daoNote->entity_table = 'civicrm_contribution';
 259     $daoNote->entity_id = $id;
 260     if ($daoNote->find(TRUE)) {
 261       $this->_noteID = $daoNote->id;
 262       $values['note'] = $daoNote->note;
 263     }
 264     $this->_contributionType = $values['financial_type_id'];
 265   }
 266
 267   /**
 268    * @param string $type
 269    *   Eg 'Contribution'.
 270    * @param string $subType
 271    * @param int $entityId
 272    */
 273   public function applyCustomData($type, $subType, $entityId) {
 274     $this->set('type', $type);
 275     $this->set('subType', $subType);
 276     $this->set('entityId', $entityId);
 277
 278     CRM_Custom_Form_CustomData::preProcess($this, NULL, $subType, 1, $type, $entityId);
 279     CRM_Custom_Form_CustomData::buildQuickForm($this);
 280     CRM_Custom_Form_CustomData::setDefaultValues($this);
 281   }
 282
 283   /**
 284    * @param int $id
 285    * @todo - this function is a long way, non standard of saying $dao = new CRM_Contribute_DAO_ContributionProduct(); $dao->id = $id; $dao->find();
 286    */
 287   public function assignPremiumProduct($id) {
 288     $sql = "
 289 SELECT *
 290 FROM   civicrm_contribution_product
 291 WHERE  contribution_id = {$id}
 292 ";
 293     $dao = CRM_Core_DAO::executeQuery($sql,
 294       CRM_Core_DAO::$_nullArray
 295     );
 296     if ($dao->fetch()) {
 297       $this->_premiumID = $dao->id;
 298       $this->_productDAO = $dao;
 299     }
 300     $dao->free();
 301   }
 302
 303   /**
 304    * This function process contribution related objects.
 305    *
 306    * @param int $contributionId
 307    * @param int $statusId
 308    * @param int|null $previousStatusId
 309    *
 310    * @return null|string
 311    */
 312   protected function updateRelatedComponent($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
 313     $statusMsg = NULL;
 314     if (!$contributionId || !$statusId) {
 315       return $statusMsg;
 316     }
 317
 318     $params = array(
 319       'contribution_id' => $contributionId,
 320       'contribution_status_id' => $statusId,
 321       'previous_contribution_status_id' => $previousStatusId,
 322       'receive_date' => $receiveDate,
 323     );
 324
 325     $updateResult = CRM_Contribute_BAO_Contribution::transitionComponents($params);
 326
 327     if (!is_array($updateResult) ||
 328       !($updatedComponents = CRM_Utils_Array::value('updatedComponents', $updateResult)) ||
 329       !is_array($updatedComponents) ||
 330       empty($updatedComponents)
 331     ) {
 332       return $statusMsg;
 333     }
 334
 335     // get the user display name.
 336     $sql = "
 337    SELECT  display_name as displayName
 338      FROM  civicrm_contact
 339 LEFT JOIN  civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
 340     WHERE  civicrm_contribution.id = {$contributionId}";
 341     $userDisplayName = CRM_Core_DAO::singleValueQuery($sql);
 342
 343     // get the status message for user.
 344     foreach ($updatedComponents as $componentName => $updatedStatusId) {
 345
 346       if ($componentName == 'CiviMember') {
 347         $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
 348           CRM_Member_PseudoConstant::membershipStatus()
 349         );
 350         if ($updatedStatusName == 'Cancelled') {
 351           $statusMsg .= "<br />" . ts("Membership for %1 has been Cancelled.", array(1 => $userDisplayName));
 352         }
 353         elseif ($updatedStatusName == 'Expired') {
 354           $statusMsg .= "<br />" . ts("Membership for %1 has been Expired.", array(1 => $userDisplayName));
 355         }
 356         else {
 357           $endDate = CRM_Utils_Array::value('membership_end_date', $updateResult);
 358           if ($endDate) {
 359             $statusMsg .= "<br />" . ts("Membership for %1 has been updated. The membership End Date is %2.",
 360                 array(
 361                   1 => $userDisplayName,
 362                   2 => $endDate,
 363                 )
 364               );
 365           }
 366         }
 367       }
 368
 369       if ($componentName == 'CiviEvent') {
 370         $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
 371           CRM_Event_PseudoConstant::participantStatus()
 372         );
 373         if ($updatedStatusName == 'Cancelled') {
 374           $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", array(1 => $userDisplayName));
 375         }
 376         elseif ($updatedStatusName == 'Registered') {
 377           $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", array(1 => $userDisplayName));
 378         }
 379       }
 380
 381       if ($componentName == 'CiviPledge') {
 382         $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
 383           CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
 384         );
 385         if ($updatedStatusName == 'Cancelled') {
 386           $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", array(1 => $userDisplayName));
 387         }
 388         elseif ($updatedStatusName == 'Failed') {
 389           $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", array(1 => $userDisplayName));
 390         }
 391         elseif ($updatedStatusName == 'Completed') {
 392           $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", array(1 => $userDisplayName));
 393         }
 394       }
 395     }
 396
 397     return $statusMsg;
 398   }
 399
 400   /**
 401    * @return array
 402    *   Array of valid processors. The array resembles the DB table but also has 'object' as a key
 403    * @throws Exception
 404    */
 405   public function getValidProcessors() {
 406     $defaultID = NULL;
 407     $capabilities = array('BackOffice');
 408     if ($this->_mode) {
 409       $capabilities[] = (ucfirst($this->_mode) . 'Mode');
 410     }
 411     $processors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors($capabilities);
 412     return $processors;
 413
 414   }
 415
 416   /**
 417    * Assign $this->processors, $this->recurPaymentProcessors, and related Smarty variables
 418    */
 419   public function assignProcessors() {
 420     //ensure that processor has a valid config
 421     //only valid processors get display to user
 422
 423     if ($this->_mode) {
 424       $this->assign('processorSupportsFutureStartDate', CRM_Financial_BAO_PaymentProcessor::hasPaymentProcessorSupporting(array('supportsFutureRecurStartDate')));
 425       $this->_paymentProcessors = $this->getValidProcessors();
 426       if (!isset($this->_paymentProcessor['id'])) {
 427         // if the payment processor isn't set yet (as indicated by the presence of an id,) we'll grab the first one which should be the default
 428         $this->_paymentProcessor = reset($this->_paymentProcessors);
 429       }
 430       if (empty($this->_paymentProcessors)) {
 431         throw new CRM_Core_Exception(ts('You will need to configure the %1 settings for your Payment Processor before you can submit a credit card transactions.', array(1 => $this->_mode)));
 432       }
 433       $this->_processors = array();
 434       foreach ($this->_paymentProcessors as $id => $processor) {
 435         $this->_processors[$id] = ts($processor['name']);
 436         if (!empty($processor['description'])) {
 437           $this->_processors[$id] .= ' : ' . ts($processor['description']);
 438         }
 439         if ($processor['is_recur']) {
 440           $this->_recurPaymentProcessors[$id] = $this->_processors[$id];
 441         }
 442       }
 443       CRM_Financial_Form_Payment::addCreditCardJs();
 444     }
 445     $this->assign('recurringPaymentProcessorIds',
 446       empty($this->_recurPaymentProcessors) ? '' : implode(',', array_keys($this->_recurPaymentProcessors))
 447     );
 448
 449     // this required to show billing block
 450     // @todo remove this assignment the billing block is now designed to be always included but will not show fieldsets unless those sets of fields are assigned
 451     $this->assign_by_ref('paymentProcessor', $processor);
 452   }
 453
 454   /**
 455    * Get current currency from DB or use default currency.
 456    *
 457    * @param $submittedValues
 458    *
 459    * @return mixed
 460    */
 461   public function getCurrency($submittedValues) {
 462     $config = CRM_Core_Config::singleton();
 463
 464     $currentCurrency = CRM_Utils_Array::value('currency',
 465       $this->_values,
 466       $config->defaultCurrency
 467     );
 468
 469     // use submitted currency if present else use current currency
 470     $result = CRM_Utils_Array::value('currency',
 471       $submittedValues,
 472       $currentCurrency
 473     );
 474     return $result;
 475   }
 476
 477   /**
 478    * @param int $financialTypeId
 479    *
 480    * @return array
 481    */
 482   public function getFinancialAccounts($financialTypeId) {
 483     $financialAccounts = array();
 484     CRM_Core_PseudoConstant::populate($financialAccounts,
 485       'CRM_Financial_DAO_EntityFinancialAccount',
 486       $all = TRUE,
 487       $retrieve = 'financial_account_id',
 488       $filter = NULL,
 489       " entity_id = {$financialTypeId} ", NULL, 'account_relationship');
 490     return $financialAccounts;
 491   }
 492
 493   /**
 494    * @param int $financialTypeId
 495    * @param int $relationTypeId
 496    *
 497    * @return mixed
 498    */
 499   public function getFinancialAccount($financialTypeId, $relationTypeId) {
 500     $financialAccounts = $this->getFinancialAccounts($financialTypeId);
 501     return CRM_Utils_Array::value($relationTypeId, $financialAccounts);
 502   }
 503
 504   public function preProcessPledge() {
 505     //get the payment values associated with given pledge payment id OR check for payments due.
 506     $this->_pledgeValues = array();
 507     if ($this->_ppID) {
 508       $payParams = array('id' => $this->_ppID);
 509
 510       CRM_Pledge_BAO_PledgePayment::retrieve($payParams, $this->_pledgeValues['pledgePayment']);
 511       $this->_pledgeID = CRM_Utils_Array::value('pledge_id', $this->_pledgeValues['pledgePayment']);
 512       $paymentStatusID = CRM_Utils_Array::value('status_id', $this->_pledgeValues['pledgePayment']);
 513       $this->_id = CRM_Utils_Array::value('contribution_id', $this->_pledgeValues['pledgePayment']);
 514
 515       //get all status
 516       $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 517       if (!($paymentStatusID == array_search('Pending', $allStatus) || $paymentStatusID == array_search('Overdue', $allStatus))) {
 518         CRM_Core_Error::fatal(ts("Pledge payment status should be 'Pending' or  'Overdue'."));
 519       }
 520
 521       //get the pledge values associated with given pledge payment.
 522
 523       $ids = array();
 524       $pledgeParams = array('id' => $this->_pledgeID);
 525       CRM_Pledge_BAO_Pledge::getValues($pledgeParams, $this->_pledgeValues, $ids);
 526       $this->assign('ppID', $this->_ppID);
 527     }
 528     else {
 529       // Not making a pledge payment, so if adding a new contribution we should check if pledge payment(s) are due for this contact so we can alert the user. CRM-5206
 530       if (isset($this->_contactID)) {
 531         $contactPledges = CRM_Pledge_BAO_Pledge::getContactPledges($this->_contactID);
 532
 533         if (!empty($contactPledges)) {
 534           $payments = $paymentsDue = NULL;
 535           $multipleDue = FALSE;
 536           foreach ($contactPledges as $key => $pledgeId) {
 537             $payments = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeId);
 538             if ($payments) {
 539               if ($paymentsDue) {
 540                 $multipleDue = TRUE;
 541                 break;
 542               }
 543               else {
 544                 $paymentsDue = $payments;
 545               }
 546             }
 547           }
 548           if ($multipleDue) {
 549             // Show link to pledge tab since more than one pledge has a payment due
 550             $pledgeTab = CRM_Utils_System::url('civicrm/contact/view',
 551               "reset=1&force=1&cid={$this->_contactID}&selectedChild=pledge"
 552             );
 553             CRM_Core_Session::setStatus(ts('This contact has pending or overdue pledge payments. <a href="%1">Click here to view their Pledges tab</a> and verify whether this contribution should be applied as a pledge payment.', array(1 => $pledgeTab)), ts('Notice'), 'alert');
 554           }
 555           elseif ($paymentsDue) {
 556             // Show user link to oldest Pending or Overdue pledge payment
 557             $ppAmountDue = CRM_Utils_Money::format($payments['amount'], $payments['currency']);
 558             $ppSchedDate = CRM_Utils_Date::customFormat(CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment', $payments['id'], 'scheduled_date'));
 559             if ($this->_mode) {
 560               $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
 561                 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge&mode=live"
 562               );
 563             }
 564             else {
 565               $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
 566                 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge"
 567               );
 568             }
 569             CRM_Core_Session::setStatus(ts('This contact has a pending or overdue pledge payment of %2 which is scheduled for %3. <a href="%1">Click here to enter a pledge payment</a>.', array(
 570               1 => $ppUrl,
 571               2 => $ppAmountDue,
 572               3 => $ppSchedDate,
 573             )), ts('Notice'), 'alert');
 574           }
 575         }
 576       }
 577     }
 578   }
 579
 580   /**
 581    * @param array $submittedValues
 582    *
 583    * @return mixed
 584    */
 585   public function unsetCreditCardFields($submittedValues) {
 586     //Offline Contribution.
 587     $unsetParams = array(
 588       'payment_processor_id',
 589       "email-{$this->_bltID}",
 590       'hidden_buildCreditCard',
 591       'hidden_buildDirectDebit',
 592       'billing_first_name',
 593       'billing_middle_name',
 594       'billing_last_name',
 595       'street_address-5',
 596       "city-{$this->_bltID}",
 597       "state_province_id-{$this->_bltID}",
 598       "postal_code-{$this->_bltID}",
 599       "country_id-{$this->_bltID}",
 600       'credit_card_number',
 601       'cvv2',
 602       'credit_card_exp_date',
 603       'credit_card_type',
 604     );
 605     foreach ($unsetParams as $key) {
 606       if (isset($submittedValues[$key])) {
 607         unset($submittedValues[$key]);
 608       }
 609     }
 610     return $submittedValues;
 611   }
 612
 613   /**
 614    * Common block for setting up the parts of a form that relate to credit / debit card
 615    * @throws Exception
 616    */
 617   protected function assignPaymentRelatedVariables() {
 618     try {
 619       if ($this->_contactID) {
 620         list($this->userDisplayName, $this->userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 621         $this->assign('displayName', $this->userDisplayName);
 622       }
 623       if ($this->_mode) {
 624         $this->assignProcessors();
 625
 626         $this->assignBillingType();
 627
 628         CRM_Core_Payment_Form::setPaymentFieldsByProcessor($this, $this->_paymentProcessor, FALSE, TRUE);
 629       }
 630     }
 631     catch (CRM_Core_Exception $e) {
 632       CRM_Core_Error::fatal($e->getMessage());
 633     }
 634   }
 635
 636   /**
 637    * Begin post processing.
 638    *
 639    * This function aims to start to bring together common postProcessing functions.
 640    *
 641    * Eventually these are also shared with the front end forms & may need to be moved to where they can also
 642    * access this function.
 643    */
 644   protected function beginPostProcess() {
 645     if (in_array('credit_card_exp_date', array_keys($this->_params))) {
 646       $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
 647       $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
 648     }
 649
 650     $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
 651   }
 652
 653
 654   /**
 655    * Add the billing address to the contact who paid.
 656    *
 657    * Note that this function works based on the presence or otherwise of billing fields & can be called regardless of
 658    * whether they are 'expected' (due to assumptions about the payment processor type or the setting to collect billing
 659    * for pay later.
 660    */
 661   protected function processBillingAddress() {
 662     $fields = array();
 663
 664     $fields['email-Primary'] = 1;
 665     $this->_params['email-5'] = $this->_params['email-Primary'] = $this->_contributorEmail;
 666     // now set the values for the billing location.
 667     foreach (array_keys($this->_fields) as $name) {
 668       $fields[$name] = 1;
 669     }
 670
 671     // also add location name to the array
 672     $this->_params["address_name-{$this->_bltID}"] = CRM_Utils_Array::value('billing_first_name', $this->_params) . ' ' . CRM_Utils_Array::value('billing_middle_name', $this->_params) . ' ' . CRM_Utils_Array::value('billing_last_name', $this->_params);
 673     $this->_params["address_name-{$this->_bltID}"] = trim($this->_params["address_name-{$this->_bltID}"]);
 674
 675     $fields["address_name-{$this->_bltID}"] = 1;
 676
 677     //ensure we don't over-write the payer's email with the member's email
 678     if ($this->_contributorContactID == $this->_contactID) {
 679       $fields["email-{$this->_bltID}"] = 1;
 680     }
 681
 682     list($hasBillingField, $addressParams) = CRM_Contribute_BAO_Contribution::getPaymentProcessorReadyAddressParams($this->_params, $this->_bltID);
 683     $nameFields = array('first_name', 'middle_name', 'last_name');
 684
 685     foreach ($nameFields as $name) {
 686       $fields[$name] = 1;
 687       if (array_key_exists("billing_$name", $this->_params)) {
 688         $this->_params[$name] = $this->_params["billing_{$name}"];
 689         $this->_params['preserveDBName'] = TRUE;
 690       }
 691     }
 692
 693     if ($hasBillingField) {
 694       $addressParams = array_merge($this->_params, $addressParams);
 695       //here we are setting up the billing contact - if different from the member they are already created
 696       // but they will get billing details assigned
 697       CRM_Contact_BAO_Contact::createProfileContact($addressParams, $fields,
 698         $this->_contributorContactID, NULL, NULL,
 699         CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID, 'contact_type')
 700       );
 701     }
 702     // Add additional parameters that the payment processors are used to receiving.
 703     if (!empty($this->_params["billing_state_province_id-{$this->_bltID}"])) {
 704       $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}"]);
 705     }
 706     if (!empty($this->_params["billing_country_id-{$this->_bltID}"])) {
 707       $this->_params["country-{$this->_bltID}"] = $this->_params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($this->_params["billing_country_id-{$this->_bltID}"]);
 708     }
 709   }
 710
 711 }