CRM/Contribute/Form/AbstractEditPayment.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 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-2017
  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    *
 191    * @var bool
 192    */
 193   public $isBackOffice = TRUE;
 194
 195   protected $_formType;
 196
 197   /**
 198    * Payment instrument id for the transaction.
 199    *
 200    * @var int
 201    */
 202   public $paymentInstrumentID;
 203
 204   /**
 205    * Array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should
 206    * be all in this array in order like
 207    *  'credit_card' => array('credit_card_number' ...
 208    *  'billing_details' => array('first_name' ...
 209    *
 210    * such that both the fields and the order can be more easily altered by payment processors & other extensions
 211    * @var array
 212    */
 213   public $billingFieldSets = array();
 214
 215   /**
 216    * Pre process function with common actions.
 217    */
 218   public function preProcess() {
 219     $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 220     $this->assign('contactID', $this->_contactID);
 221     CRM_Core_Resources::singleton()->addVars('coreForm', array('contact_id' => (int) $this->_contactID));
 222     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
 223     $this->_mode = empty($this->_mode) ? CRM_Utils_Request::retrieve('mode', 'String', $this) : $this->_mode;
 224     $this->assignPaymentRelatedVariables();
 225   }
 226
 227   /**
 228    * @param int $id
 229    */
 230   public function showRecordLinkMesssage($id) {
 231     $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $id, 'contribution_status_id');
 232     if (CRM_Contribute_PseudoConstant::contributionStatus($statusId, 'name') == 'Partially paid') {
 233       if ($pid = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'participant_id', 'contribution_id')) {
 234         $recordPaymentLink = CRM_Utils_System::url('civicrm/payment',
 235           "reset=1&id={$pid}&cid={$this->_contactID}&action=add&component=event"
 236         );
 237         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');
 238       }
 239     }
 240   }
 241
 242   /**
 243    * @param int $id
 244    * @param $values
 245    */
 246   public function buildValuesAndAssignOnline_Note_Type($id, &$values) {
 247     $ids = array();
 248     $params = array('id' => $id);
 249     CRM_Contribute_BAO_Contribution::getValues($params, $values, $ids);
 250
 251     //Check if this is an online transaction (financial_trxn.payment_processor_id NOT NULL)
 252     $this->_online = FALSE;
 253     $fids = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($id);
 254     if (!empty($fids['financialTrxnId'])) {
 255       $this->_online = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $fids['financialTrxnId'], 'payment_processor_id');
 256     }
 257
 258     // Also don't allow user to update some fields for recurring contributions.
 259     if (!$this->_online) {
 260       $this->_online = CRM_Utils_Array::value('contribution_recur_id', $values);
 261     }
 262
 263     $this->assign('isOnline', $this->_online ? TRUE : FALSE);
 264
 265     //to get note id
 266     $daoNote = new CRM_Core_BAO_Note();
 267     $daoNote->entity_table = 'civicrm_contribution';
 268     $daoNote->entity_id = $id;
 269     if ($daoNote->find(TRUE)) {
 270       $this->_noteID = $daoNote->id;
 271       $values['note'] = $daoNote->note;
 272     }
 273     $this->_contributionType = $values['financial_type_id'];
 274   }
 275
 276   /**
 277    * @param string $type
 278    *   Eg 'Contribution'.
 279    * @param string $subType
 280    * @param int $entityId
 281    */
 282   public function applyCustomData($type, $subType, $entityId) {
 283     $this->set('type', $type);
 284     $this->set('subType', $subType);
 285     $this->set('entityId', $entityId);
 286
 287     CRM_Custom_Form_CustomData::preProcess($this, NULL, $subType, 1, $type, $entityId);
 288     CRM_Custom_Form_CustomData::buildQuickForm($this);
 289     CRM_Custom_Form_CustomData::setDefaultValues($this);
 290   }
 291
 292   /**
 293    * @param int $id
 294    * @todo - this function is a long way, non standard of saying $dao = new CRM_Contribute_DAO_ContributionProduct(); $dao->id = $id; $dao->find();
 295    */
 296   public function assignPremiumProduct($id) {
 297     $sql = "
 298 SELECT *
 299 FROM   civicrm_contribution_product
 300 WHERE  contribution_id = {$id}
 301 ";
 302     $dao = CRM_Core_DAO::executeQuery($sql,
 303       CRM_Core_DAO::$_nullArray
 304     );
 305     if ($dao->fetch()) {
 306       $this->_premiumID = $dao->id;
 307       $this->_productDAO = $dao;
 308     }
 309     $dao->free();
 310   }
 311
 312   /**
 313    * @return array
 314    *   Array of valid processors. The array resembles the DB table but also has 'object' as a key
 315    * @throws Exception
 316    */
 317   public function getValidProcessors() {
 318     $capabilities = array('BackOffice');
 319     if ($this->_mode) {
 320       $capabilities[] = (ucfirst($this->_mode) . 'Mode');
 321     }
 322     $processors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors($capabilities);
 323     return $processors;
 324
 325   }
 326
 327   /**
 328    * Assign $this->processors, $this->recurPaymentProcessors, and related Smarty variables
 329    */
 330   public function assignProcessors() {
 331     //ensure that processor has a valid config
 332     //only valid processors get display to user
 333     $this->assign('processorSupportsFutureStartDate', CRM_Financial_BAO_PaymentProcessor::hasPaymentProcessorSupporting(array('FutureRecurStartDate')));
 334     $this->_paymentProcessors = $this->getValidProcessors();
 335     if (!isset($this->_paymentProcessor['id'])) {
 336       // 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
 337       $this->_paymentProcessor = reset($this->_paymentProcessors);
 338     }
 339     if (!$this->_mode) {
 340       $this->_paymentProcessor = $this->_paymentProcessors[0];
 341     }
 342     elseif (empty($this->_paymentProcessors) || array_keys($this->_paymentProcessors) === array(0)) {
 343       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)));
 344     }
 345     $this->_processors = array();
 346     foreach ($this->_paymentProcessors as $id => $processor) {
 347       // @todo review this. The inclusion of this IF was to address test processors being incorrectly loaded.
 348       // However the function $this->getValidProcessors() is expected to only return the processors relevant
 349       // to the mode (using the actual id - ie. the id of the test processor for the test processor).
 350       // for some reason there was a need to filter here per commit history - but this indicates a problem
 351       // somewhere else.
 352       if ($processor['is_test'] == ($this->_mode == 'test')) {
 353         $this->_processors[$id] = ts($processor['name']);
 354         if (!empty($processor['description'])) {
 355           $this->_processors[$id] .= ' : ' . ts($processor['description']);
 356         }
 357         if ($processor['is_recur']) {
 358           $this->_recurPaymentProcessors[$id] = $this->_processors[$id];
 359         }
 360       }
 361     }
 362     CRM_Financial_Form_Payment::addCreditCardJs($id);
 363
 364     $this->assign('recurringPaymentProcessorIds',
 365       empty($this->_recurPaymentProcessors) ? '' : implode(',', array_keys($this->_recurPaymentProcessors))
 366     );
 367
 368     // this required to show billing block
 369     // @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
 370     $this->assign_by_ref('paymentProcessor', $processor);
 371   }
 372
 373   /**
 374    * Get current currency from DB or use default currency.
 375    *
 376    * @param $submittedValues
 377    *
 378    * @return mixed
 379    */
 380   public function getCurrency($submittedValues) {
 381     $config = CRM_Core_Config::singleton();
 382
 383     $currentCurrency = CRM_Utils_Array::value('currency',
 384       $this->_values,
 385       $config->defaultCurrency
 386     );
 387
 388     // use submitted currency if present else use current currency
 389     $result = CRM_Utils_Array::value('currency',
 390       $submittedValues,
 391       $currentCurrency
 392     );
 393     return $result;
 394   }
 395
 396   public function preProcessPledge() {
 397     //get the payment values associated with given pledge payment id OR check for payments due.
 398     $this->_pledgeValues = array();
 399     if ($this->_ppID) {
 400       $payParams = array('id' => $this->_ppID);
 401
 402       CRM_Pledge_BAO_PledgePayment::retrieve($payParams, $this->_pledgeValues['pledgePayment']);
 403       $this->_pledgeID = CRM_Utils_Array::value('pledge_id', $this->_pledgeValues['pledgePayment']);
 404       $paymentStatusID = CRM_Utils_Array::value('status_id', $this->_pledgeValues['pledgePayment']);
 405       $this->_id = CRM_Utils_Array::value('contribution_id', $this->_pledgeValues['pledgePayment']);
 406
 407       //get all status
 408       $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 409       if (!($paymentStatusID == array_search('Pending', $allStatus) || $paymentStatusID == array_search('Overdue', $allStatus))) {
 410         CRM_Core_Error::fatal(ts("Pledge payment status should be 'Pending' or  'Overdue'."));
 411       }
 412
 413       //get the pledge values associated with given pledge payment.
 414
 415       $ids = array();
 416       $pledgeParams = array('id' => $this->_pledgeID);
 417       CRM_Pledge_BAO_Pledge::getValues($pledgeParams, $this->_pledgeValues, $ids);
 418       $this->assign('ppID', $this->_ppID);
 419     }
 420     else {
 421       // 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
 422       if (isset($this->_contactID)) {
 423         $contactPledges = CRM_Pledge_BAO_Pledge::getContactPledges($this->_contactID);
 424
 425         if (!empty($contactPledges)) {
 426           $payments = $paymentsDue = NULL;
 427           $multipleDue = FALSE;
 428           foreach ($contactPledges as $key => $pledgeId) {
 429             $payments = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeId);
 430             if ($payments) {
 431               if ($paymentsDue) {
 432                 $multipleDue = TRUE;
 433                 break;
 434               }
 435               else {
 436                 $paymentsDue = $payments;
 437               }
 438             }
 439           }
 440           if ($multipleDue) {
 441             // Show link to pledge tab since more than one pledge has a payment due
 442             $pledgeTab = CRM_Utils_System::url('civicrm/contact/view',
 443               "reset=1&force=1&cid={$this->_contactID}&selectedChild=pledge"
 444             );
 445             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');
 446           }
 447           elseif ($paymentsDue) {
 448             // Show user link to oldest Pending or Overdue pledge payment
 449             $ppAmountDue = CRM_Utils_Money::format($payments['amount'], $payments['currency']);
 450             $ppSchedDate = CRM_Utils_Date::customFormat(CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment', $payments['id'], 'scheduled_date'));
 451             if ($this->_mode) {
 452               $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
 453                 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge&mode=live"
 454               );
 455             }
 456             else {
 457               $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
 458                 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge"
 459               );
 460             }
 461             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(
 462               1 => $ppUrl,
 463               2 => $ppAmountDue,
 464               3 => $ppSchedDate,
 465             )), ts('Notice'), 'alert');
 466           }
 467         }
 468       }
 469     }
 470   }
 471
 472   /**
 473    * @param array $submittedValues
 474    *
 475    * @return mixed
 476    */
 477   public function unsetCreditCardFields($submittedValues) {
 478     //Offline Contribution.
 479     $unsetParams = array(
 480       'payment_processor_id',
 481       "email-{$this->_bltID}",
 482       'hidden_buildCreditCard',
 483       'hidden_buildDirectDebit',
 484       'billing_first_name',
 485       'billing_middle_name',
 486       'billing_last_name',
 487       'street_address-5',
 488       "city-{$this->_bltID}",
 489       "state_province_id-{$this->_bltID}",
 490       "postal_code-{$this->_bltID}",
 491       "country_id-{$this->_bltID}",
 492       'credit_card_number',
 493       'cvv2',
 494       'credit_card_exp_date',
 495       'credit_card_type',
 496     );
 497     foreach ($unsetParams as $key) {
 498       if (isset($submittedValues[$key])) {
 499         unset($submittedValues[$key]);
 500       }
 501     }
 502     return $submittedValues;
 503   }
 504
 505   /**
 506    * Common block for setting up the parts of a form that relate to credit / debit card
 507    * @throws Exception
 508    */
 509   protected function assignPaymentRelatedVariables() {
 510     try {
 511       if ($this->_contactID) {
 512         list($this->userDisplayName, $this->userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 513         $this->assign('displayName', $this->userDisplayName);
 514       }
 515       $this->assignProcessors();
 516       $this->assignBillingType();
 517       CRM_Core_Payment_Form::setPaymentFieldsByProcessor($this, $this->_paymentProcessor, FALSE, TRUE, CRM_Utils_Request::retrieve('payment_instrument_id', 'Integer'));
 518     }
 519     catch (CRM_Core_Exception $e) {
 520       CRM_Core_Error::fatal($e->getMessage());
 521     }
 522   }
 523
 524   /**
 525    * Begin post processing.
 526    *
 527    * This function aims to start to bring together common postProcessing functions.
 528    *
 529    * Eventually these are also shared with the front end forms & may need to be moved to where they can also
 530    * access this function.
 531    */
 532   protected function beginPostProcess() {
 533     if ($this->_mode) {
 534       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment(
 535         $this->_params['payment_processor_id'],
 536         ($this->_mode == 'test')
 537       );
 538       if (in_array('credit_card_exp_date', array_keys($this->_params))) {
 539         $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
 540         $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
 541       }
 542       $this->assign('credit_card_exp_date', CRM_Utils_Date::mysqlToIso(CRM_Utils_Date::format($this->_params['credit_card_exp_date'])));
 543       $this->assign('credit_card_number',
 544         CRM_Utils_System::mungeCreditCard($this->_params['credit_card_number'])
 545       );
 546       $this->assign('credit_card_type', CRM_Utils_Array::value('credit_card_type', $this->_params));
 547     }
 548     $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
 549     if (in_array('credit_card_type', array_keys($this->_params))) {
 550       $this->_params['card_type_id'] = CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $this->_params['credit_card_type']);
 551     }
 552     if (!empty($this->_params['credit_card_number']) && empty($this->_params['pan_truncation'])) {
 553       $this->_params['pan_truncation'] = substr($this->_params['credit_card_number'], -4);
 554     }
 555
 556   }
 557
 558
 559   /**
 560    * Add the billing address to the contact who paid.
 561    *
 562    * Note that this function works based on the presence or otherwise of billing fields & can be called regardless of
 563    * whether they are 'expected' (due to assumptions about the payment processor type or the setting to collect billing
 564    * for pay later.
 565    */
 566   protected function processBillingAddress() {
 567     $fields = array();
 568
 569     $fields['email-Primary'] = 1;
 570     $this->_params['email-5'] = $this->_params['email-Primary'] = $this->_contributorEmail;
 571     // now set the values for the billing location.
 572     foreach (array_keys($this->_fields) as $name) {
 573       $fields[$name] = 1;
 574     }
 575
 576     $fields["address_name-{$this->_bltID}"] = 1;
 577
 578     //ensure we don't over-write the payer's email with the member's email
 579     if ($this->_contributorContactID == $this->_contactID) {
 580       $fields["email-{$this->_bltID}"] = 1;
 581     }
 582
 583     list($hasBillingField, $addressParams) = CRM_Contribute_BAO_Contribution::getPaymentProcessorReadyAddressParams($this->_params, $this->_bltID);
 584     $fields = $this->formatParamsForPaymentProcessor($fields);
 585
 586     if ($hasBillingField) {
 587       $addressParams = array_merge($this->_params, $addressParams);
 588       // CRM-18277 don't let this get passed in because we don't want contribution source to override contact source.
 589       // Ideally we wouldn't just randomly merge everything into addressParams but just pass in a relevant array.
 590       // Note this source field is covered by a unit test.
 591       if (isset($addressParams['source'])) {
 592         unset($addressParams['source']);
 593       }
 594       //here we are setting up the billing contact - if different from the member they are already created
 595       // but they will get billing details assigned
 596       CRM_Contact_BAO_Contact::createProfileContact($addressParams, $fields,
 597         $this->_contributorContactID, NULL, NULL,
 598         CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID, 'contact_type')
 599       );
 600     }
 601   }
 602
 603   /**
 604    * Get default values for billing fields.
 605    *
 606    * @todo this function still replicates code in several other places in the code.
 607    *
 608    * Also - the call to getProfileDefaults possibly covers the state_province & country already.
 609    *
 610    * @param $defaults
 611    *
 612    * @return array
 613    */
 614   protected function getBillingDefaults($defaults) {
 615     // set default country from config if no country set
 616     $config = CRM_Core_Config::singleton();
 617     if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
 618       $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
 619     }
 620
 621     if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
 622       $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
 623     }
 624
 625     $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID);
 626     return array_merge($defaults, $billingDefaults);
 627   }
 628
 629   /**
 630    * Get the default payment instrument id.
 631    *
 632    * @return int
 633    */
 634   protected function getDefaultPaymentInstrumentId() {
 635     $paymentInstrumentID = CRM_Utils_Request::retrieve('payment_instrument_id', 'Integer');
 636     if ($paymentInstrumentID) {
 637       return $paymentInstrumentID;
 638     }
 639     return key(CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1'));
 640   }
 641
 642 }