CRM/Contribute/Form/AbstractEditPayment.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This class generates form components for processing a contribution
  20  * CRM-16229 - During the event registration bulk action via search we
  21  * need to inherit CRM_Contact_Form_Task so that we can inherit functions
  22  * like getContactIds and make use of controller state. But this is not possible
  23  * because CRM_Event_Form_Participant inherits this class.
  24  * Ideal situation would be something like
  25  * CRM_Event_Form_Participant extends CRM_Contact_Form_Task,
  26  * CRM_Contribute_Form_AbstractEditPayment
  27  * However this is not possible. Currently PHP does not support multiple
  28  * inheritance. So work around solution is to extend this class with
  29  * CRM_Contact_Form_Task which further extends CRM_Core_Form.
  30  *
  31  */
  32 class CRM_Contribute_Form_AbstractEditPayment extends CRM_Contact_Form_Task {
  33
  34   use CRM_Financial_Form_SalesTaxTrait;
  35
  36   public $_mode;
  37
  38   public $_action;
  39
  40   public $_bltID;
  41
  42   public $_fields = [];
  43
  44   /**
  45    * Current payment processor including a copy of the object in 'object' key.
  46    *
  47    * @var array
  48    */
  49   public $_paymentProcessor;
  50
  51   /**
  52    * Available recurring processors.
  53    *
  54    * @var array
  55    */
  56   public $_recurPaymentProcessors = [];
  57
  58   /**
  59    * Array of processor options in the format id => array($id => $label)
  60    * WARNING it appears that the format used to differ to this and there are places in the code that
  61    * expect the old format. $this->_paymentProcessors provides the additional data which this
  62    * array seems to have provided in the past
  63    * @var array
  64    */
  65   public $_processors;
  66
  67   /**
  68    * Available payment processors with full details including the key 'object' indexed by their id
  69    * @var array
  70    */
  71   protected $_paymentProcessors = [];
  72
  73   /**
  74    * Instance of the payment processor object.
  75    *
  76    * @var CRM_Core_Payment
  77    */
  78   protected $_paymentObject;
  79
  80   /**
  81    * Entity that $this->_id relates to.
  82    *
  83    * If set the contact id is not required in the url.
  84    *
  85    * @var string
  86    */
  87   protected $entity;
  88
  89   /**
  90    * The id of the premium that we are proceessing.
  91    *
  92    * @var int
  93    */
  94   public $_premiumID = NULL;
  95
  96   /**
  97    * @var CRM_Contribute_DAO_ContributionProduct
  98    */
  99   public $_productDAO = NULL;
 100
 101   /**
 102    * The id of the note
 103    *
 104    * @var int
 105    */
 106   public $_noteID;
 107
 108   /**
 109    * The id of the contact associated with this contribution
 110    *
 111    * @var int
 112    */
 113   public $_contactID;
 114
 115   /**
 116    * The id of the pledge payment that we are processing
 117    *
 118    * @var int
 119    */
 120   public $_ppID;
 121
 122   /**
 123    * The id of the pledge that we are processing
 124    *
 125    * @var int
 126    */
 127   public $_pledgeID;
 128
 129   /**
 130    * Is this contribution associated with an online
 131    * financial transaction
 132    *
 133    * @var bool
 134    */
 135   public $_online = FALSE;
 136
 137   /**
 138    * Stores all product option
 139    *
 140    * @var array
 141    */
 142   public $_options;
 143
 144   /**
 145    * Stores the honor id
 146    *
 147    * @var int
 148    */
 149   public $_honorID = NULL;
 150
 151   /**
 152    * The contribution values if an existing contribution
 153    * @var array
 154    */
 155   public $_values;
 156
 157   /**
 158    * The pledge values if this contribution is associated with pledge
 159    * @var array
 160    */
 161   public $_pledgeValues;
 162
 163   public $_contributeMode = 'direct';
 164
 165   public $_context;
 166
 167   public $_compId;
 168
 169   /**
 170    * Store the line items if price set used.
 171    * @var array
 172    */
 173   public $_lineItems;
 174
 175   /**
 176    * Is this a backoffice form
 177    *
 178    * @var bool
 179    */
 180   public $isBackOffice = TRUE;
 181
 182   protected $_formType;
 183
 184   /**
 185    * Payment instrument id for the transaction.
 186    *
 187    * @var int
 188    */
 189   public $paymentInstrumentID;
 190
 191   /**
 192    * Component - event, membership or contribution.
 193    *
 194    * @var string
 195    */
 196   protected $_component;
 197
 198   /**
 199    * Array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should
 200    * be all in this array in order like
 201    *  'credit_card' => array('credit_card_number' ...
 202    *  'billing_details' => array('first_name' ...
 203    *
 204    * such that both the fields and the order can be more easily altered by payment processors & other extensions
 205    * @var array
 206    */
 207   public $billingFieldSets = [];
 208
 209   /**
 210    * Monetary fields that may be submitted.
 211    *
 212    * These should get a standardised format in the beginPostProcess function.
 213    *
 214    * These fields are common to many forms. Some may override this.
 215    * @var array
 216    */
 217   protected $submittableMoneyFields = ['total_amount', 'net_amount', 'non_deductible_amount', 'fee_amount'];
 218
 219   /**
 220    * Pre process function with common actions.
 221    *
 222    * @throws \CRM_Core_Exception
 223    * @throws \CiviCRM_API3_Exception
 224    */
 225   public function preProcess() {
 226     $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
 227     if (empty($this->_contactID) && !empty($this->_id) && $this->entity) {
 228       $this->_contactID = civicrm_api3($this->entity, 'getvalue', ['id' => $this->_id, 'return' => 'contact_id']);
 229     }
 230     $this->assign('contactID', $this->_contactID);
 231     CRM_Core_Resources::singleton()->addVars('coreForm', ['contact_id' => (int) $this->_contactID]);
 232     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
 233     $this->_mode = empty($this->_mode) ? CRM_Utils_Request::retrieve('mode', 'Alphanumeric', $this) : $this->_mode;
 234     $this->assign('isBackOffice', $this->isBackOffice);
 235     $this->assignContactEmailDetails();
 236     $this->assignPaymentRelatedVariables();
 237   }
 238
 239   /**
 240    * @param int $id
 241    */
 242   public function showRecordLinkMesssage($id) {
 243     $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $id, 'contribution_status_id');
 244     if (CRM_Contribute_PseudoConstant::contributionStatus($statusId, 'name') == 'Partially paid') {
 245       if ($pid = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'participant_id', 'contribution_id')) {
 246         $recordPaymentLink = CRM_Utils_System::url('civicrm/payment',
 247           "reset=1&id={$pid}&cid={$this->_contactID}&action=add&component=event"
 248         );
 249         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.', [1 => $recordPaymentLink]), ts('Notice'), 'alert');
 250       }
 251     }
 252   }
 253
 254   /**
 255    * @param int $id
 256    * @param $values
 257    */
 258   public function buildValuesAndAssignOnline_Note_Type($id, &$values) {
 259     $ids = [];
 260     $params = ['id' => $id];
 261     CRM_Contribute_BAO_Contribution::getValues($params, $values, $ids);
 262
 263     //Check if this is an online transaction (financial_trxn.payment_processor_id NOT NULL)
 264     $this->_online = FALSE;
 265     $fids = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($id);
 266     if (!empty($fids['financialTrxnId'])) {
 267       $this->_online = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $fids['financialTrxnId'], 'payment_processor_id');
 268     }
 269
 270     // Also don't allow user to update some fields for recurring contributions.
 271     if (!$this->_online) {
 272       $this->_online = $values['contribution_recur_id'] ?? NULL;
 273     }
 274
 275     $this->assign('isOnline', (bool) $this->_online);
 276
 277     //to get note id
 278     $daoNote = new CRM_Core_BAO_Note();
 279     $daoNote->entity_table = 'civicrm_contribution';
 280     $daoNote->entity_id = $id;
 281     if ($daoNote->find(TRUE)) {
 282       $this->_noteID = $daoNote->id;
 283       $values['note'] = $daoNote->note;
 284     }
 285   }
 286
 287   /**
 288    * @param string $type
 289    *   Eg 'Contribution'.
 290    * @param string $subType
 291    * @param int $entityId
 292    */
 293   public function applyCustomData($type, $subType, $entityId) {
 294     $this->set('type', $type);
 295     $this->set('subType', $subType);
 296     $this->set('entityId', $entityId);
 297
 298     CRM_Custom_Form_CustomData::preProcess($this, NULL, $subType, 1, $type, $entityId);
 299     CRM_Custom_Form_CustomData::buildQuickForm($this);
 300     CRM_Custom_Form_CustomData::setDefaultValues($this);
 301   }
 302
 303   /**
 304    * @param int $id
 305    * @todo - this function is a long way, non standard of saying $dao = new CRM_Contribute_DAO_ContributionProduct(); $dao->id = $id; $dao->find();
 306    */
 307   public function assignPremiumProduct($id) {
 308     $sql = "
 309 SELECT *
 310 FROM   civicrm_contribution_product
 311 WHERE  contribution_id = {$id}
 312 ";
 313     $dao = CRM_Core_DAO::executeQuery($sql);
 314     if ($dao->fetch()) {
 315       $this->_premiumID = $dao->id;
 316       $this->_productDAO = $dao;
 317     }
 318   }
 319
 320   /**
 321    * @return array
 322    *   Array of valid processors. The array resembles the DB table but also has 'object' as a key
 323    * @throws Exception
 324    */
 325   public function getValidProcessors() {
 326     $capabilities = ['BackOffice'];
 327     if ($this->_mode) {
 328       $capabilities[] = (ucfirst($this->_mode) . 'Mode');
 329     }
 330     $processors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors($capabilities);
 331     return $processors;
 332
 333   }
 334
 335   /**
 336    * Assign $this->processors, $this->recurPaymentProcessors, and related Smarty variables
 337    */
 338   public function assignProcessors() {
 339     //ensure that processor has a valid config
 340     //only valid processors get display to user
 341     $this->assign('processorSupportsFutureStartDate', CRM_Financial_BAO_PaymentProcessor::hasPaymentProcessorSupporting(['FutureRecurStartDate']));
 342     $this->_paymentProcessors = $this->getValidProcessors();
 343     if (!isset($this->_paymentProcessor['id'])) {
 344       // 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
 345       $this->_paymentProcessor = reset($this->_paymentProcessors);
 346     }
 347     if (!$this->_mode) {
 348       $this->_paymentProcessor = $this->_paymentProcessors[0];
 349     }
 350     elseif (empty($this->_paymentProcessors) || array_keys($this->_paymentProcessors) === [0]) {
 351       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.', [1 => $this->_mode]));
 352     }
 353     //Assign submitted processor value if it is different from the loaded one.
 354     if (!empty($this->_submitValues['payment_processor_id'])
 355       && $this->_paymentProcessor['id'] != $this->_submitValues['payment_processor_id']) {
 356       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($this->_submitValues['payment_processor_id']);
 357     }
 358     $this->_processors = [];
 359     foreach ($this->_paymentProcessors as $id => $processor) {
 360       $this->_processors[$id] = $processor['name'];
 361       if (!empty($processor['description'])) {
 362         $this->_processors[$id] .= ' : ' . $processor['description'];
 363       }
 364       if ($this->_paymentProcessors[$id]['object']->supportsRecurring()) {
 365         $this->_recurPaymentProcessors[$id] = $this->_processors[$id];
 366       }
 367     }
 368     // CRM-21002: pass the default payment processor ID whose credit card type icons should be populated first
 369     CRM_Financial_Form_Payment::addCreditCardJs($this->_paymentProcessor['id']);
 370
 371     $this->assign('recurringPaymentProcessorIds',
 372       empty($this->_recurPaymentProcessors) ? '' : implode(',', array_keys($this->_recurPaymentProcessors))
 373     );
 374
 375     // this required to show billing block
 376     // @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
 377     $this->assign_by_ref('paymentProcessor', $this->_paymentProcessor);
 378   }
 379
 380   /**
 381    * Get current currency from DB or use default currency.
 382    *
 383    * @param array $submittedValues
 384    *
 385    * @return string
 386    */
 387   public function getCurrency($submittedValues = []) {
 388     $config = CRM_Core_Config::singleton();
 389
 390     $currentCurrency = CRM_Utils_Array::value('currency',
 391       $this->_values,
 392       $config->defaultCurrency
 393     );
 394
 395     // use submitted currency if present else use current currency
 396     $result = CRM_Utils_Array::value('currency',
 397       $submittedValues,
 398       $currentCurrency
 399     );
 400     return $result;
 401   }
 402
 403   public function preProcessPledge() {
 404     //get the payment values associated with given pledge payment id OR check for payments due.
 405     $this->_pledgeValues = [];
 406     if ($this->_ppID) {
 407       $payParams = ['id' => $this->_ppID];
 408
 409       CRM_Pledge_BAO_PledgePayment::retrieve($payParams, $this->_pledgeValues['pledgePayment']);
 410       $this->_pledgeID = $this->_pledgeValues['pledgePayment']['pledge_id'] ?? NULL;
 411       $paymentStatusID = $this->_pledgeValues['pledgePayment']['status_id'] ?? NULL;
 412       $this->_id = $this->_pledgeValues['pledgePayment']['contribution_id'] ?? NULL;
 413
 414       //get all status
 415       $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 416       if (!($paymentStatusID == array_search('Pending', $allStatus) || $paymentStatusID == array_search('Overdue', $allStatus))) {
 417         CRM_Core_Error::statusBounce(ts("Pledge payment status should be 'Pending' or  'Overdue'."));
 418       }
 419
 420       //get the pledge values associated with given pledge payment.
 421
 422       $ids = [];
 423       $pledgeParams = ['id' => $this->_pledgeID];
 424       CRM_Pledge_BAO_Pledge::getValues($pledgeParams, $this->_pledgeValues, $ids);
 425       $this->assign('ppID', $this->_ppID);
 426     }
 427     else {
 428       // 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
 429       if (isset($this->_contactID)) {
 430         $contactPledges = CRM_Pledge_BAO_Pledge::getContactPledges($this->_contactID);
 431
 432         if (!empty($contactPledges)) {
 433           $payments = $paymentsDue = NULL;
 434           $multipleDue = FALSE;
 435           foreach ($contactPledges as $key => $pledgeId) {
 436             $payments = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeId);
 437             if ($payments) {
 438               if ($paymentsDue) {
 439                 $multipleDue = TRUE;
 440                 break;
 441               }
 442               else {
 443                 $paymentsDue = $payments;
 444               }
 445             }
 446           }
 447           if ($multipleDue) {
 448             // Show link to pledge tab since more than one pledge has a payment due
 449             $pledgeTab = CRM_Utils_System::url('civicrm/contact/view',
 450               "reset=1&force=1&cid={$this->_contactID}&selectedChild=pledge"
 451             );
 452             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.', [1 => $pledgeTab]), ts('Notice'), 'alert');
 453           }
 454           elseif ($paymentsDue) {
 455             // Show user link to oldest Pending or Overdue pledge payment
 456             $ppAmountDue = CRM_Utils_Money::format($payments['amount'], $payments['currency']);
 457             $ppSchedDate = CRM_Utils_Date::customFormat(CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment', $payments['id'], 'scheduled_date'));
 458             if ($this->_mode) {
 459               $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
 460                 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge&mode=live"
 461               );
 462             }
 463             else {
 464               $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
 465                 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge"
 466               );
 467             }
 468             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>.', [
 469               1 => $ppUrl,
 470               2 => $ppAmountDue,
 471               3 => $ppSchedDate,
 472             ]), ts('Notice'), 'alert');
 473           }
 474         }
 475       }
 476     }
 477   }
 478
 479   /**
 480    * @param array $submittedValues
 481    *
 482    * @return mixed
 483    */
 484   public function unsetCreditCardFields($submittedValues) {
 485     //Offline Contribution.
 486     $unsetParams = [
 487       'payment_processor_id',
 488       "email-{$this->_bltID}",
 489       'hidden_buildCreditCard',
 490       'hidden_buildDirectDebit',
 491       'billing_first_name',
 492       'billing_middle_name',
 493       'billing_last_name',
 494       'street_address-5',
 495       "city-{$this->_bltID}",
 496       "state_province_id-{$this->_bltID}",
 497       "postal_code-{$this->_bltID}",
 498       "country_id-{$this->_bltID}",
 499       'credit_card_number',
 500       'cvv2',
 501       'credit_card_exp_date',
 502       'credit_card_type',
 503     ];
 504     foreach ($unsetParams as $key) {
 505       if (isset($submittedValues[$key])) {
 506         unset($submittedValues[$key]);
 507       }
 508     }
 509     return $submittedValues;
 510   }
 511
 512   /**
 513    * Common block for setting up the parts of a form that relate to credit / debit card
 514    */
 515   protected function assignPaymentRelatedVariables() {
 516     try {
 517       $this->assignProcessors();
 518       $this->assignBillingType();
 519       CRM_Core_Payment_Form::setPaymentFieldsByProcessor($this, $this->_paymentProcessor, FALSE, TRUE, CRM_Utils_Request::retrieve('payment_instrument_id', 'Integer', $this));
 520     }
 521     catch (CRM_Core_Exception $e) {
 522       CRM_Core_Error::statusBounce($e->getMessage());
 523     }
 524   }
 525
 526   /**
 527    * Begin post processing.
 528    *
 529    * This function aims to start to bring together common postProcessing functions.
 530    *
 531    * Eventually these are also shared with the front end forms & may need to be moved to where they can also
 532    * access this function.
 533    */
 534   protected function beginPostProcess() {
 535     if ($this->_mode) {
 536       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment(
 537         $this->_params['payment_processor_id'],
 538         ($this->_mode == 'test')
 539       );
 540     }
 541     $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
 542
 543     $valuesForForm = self::formatCreditCardDetails($this->_params);
 544     $this->assignVariables($valuesForForm, ['credit_card_exp_date', 'credit_card_type', 'credit_card_number']);
 545
 546     foreach ($this->submittableMoneyFields as $moneyField) {
 547       if (isset($this->_params[$moneyField])) {
 548         $this->_params[$moneyField] = CRM_Utils_Rule::cleanMoney($this->_params[$moneyField]);
 549       }
 550     }
 551     if (!empty($this->_params['contact_id']) && empty($this->_contactID)) {
 552       // Contact ID has been set in the standalone form.
 553       $this->_contactID = $this->_params['contact_id'];
 554       $this->assignContactEmailDetails();
 555     }
 556   }
 557
 558   /**
 559    * Format credit card details like:
 560    *  1. Retrieve last 4 digit from credit card number as pan_truncation
 561    *  2. Retrieve credit card type id from name
 562    *
 563    * @param array $params
 564    *
 565    * @return array An array of params suitable for assigning to the form/tpl
 566    */
 567   public static function formatCreditCardDetails(&$params) {
 568     if (!empty($params['credit_card_exp_date'])) {
 569       $params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($params);
 570       $params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($params);
 571     }
 572     if (!empty($params['credit_card_type'])) {
 573       $params['card_type_id'] = CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $params['credit_card_type']);
 574     }
 575     if (!empty($params['credit_card_number']) && empty($params['pan_truncation'])) {
 576       $params['pan_truncation'] = substr($params['credit_card_number'], -4);
 577     }
 578     if (!empty($params['credit_card_exp_date'])) {
 579       $params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($params);
 580       $params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($params);
 581     }
 582
 583     $tplParams['credit_card_exp_date'] = isset($params['credit_card_exp_date']) ? CRM_Utils_Date::mysqlToIso(CRM_Utils_Date::format($params['credit_card_exp_date'])) : NULL;
 584     $tplParams['credit_card_type'] = CRM_Utils_Array::value('credit_card_type', $params);
 585     $tplParams['credit_card_number'] = CRM_Utils_System::mungeCreditCard(CRM_Utils_Array::value('credit_card_number', $params));
 586     return $tplParams;
 587   }
 588
 589   /**
 590    * Add the billing address to the contact who paid.
 591    *
 592    * Note that this function works based on the presence or otherwise of billing fields & can be called regardless of
 593    * whether they are 'expected' (due to assumptions about the payment processor type or the setting to collect billing
 594    * for pay later.
 595    */
 596   protected function processBillingAddress() {
 597     $fields = [];
 598
 599     $fields['email-Primary'] = 1;
 600     $this->_params['email-5'] = $this->_params['email-Primary'] = $this->_contributorEmail;
 601     // now set the values for the billing location.
 602     foreach (array_keys($this->_fields) as $name) {
 603       $fields[$name] = 1;
 604     }
 605
 606     $fields["address_name-{$this->_bltID}"] = 1;
 607
 608     //ensure we don't over-write the payer's email with the member's email
 609     if ($this->_contributorContactID == $this->_contactID) {
 610       $fields["email-{$this->_bltID}"] = 1;
 611     }
 612
 613     list($hasBillingField, $addressParams) = CRM_Contribute_BAO_Contribution::getPaymentProcessorReadyAddressParams($this->_params, $this->_bltID);
 614     $fields = $this->formatParamsForPaymentProcessor($fields);
 615
 616     if ($hasBillingField) {
 617       $addressParams = array_merge($this->_params, $addressParams);
 618       // CRM-18277 don't let this get passed in because we don't want contribution source to override contact source.
 619       // Ideally we wouldn't just randomly merge everything into addressParams but just pass in a relevant array.
 620       // Note this source field is covered by a unit test.
 621       if (isset($addressParams['source'])) {
 622         unset($addressParams['source']);
 623       }
 624       //here we are setting up the billing contact - if different from the member they are already created
 625       // but they will get billing details assigned
 626       CRM_Contact_BAO_Contact::createProfileContact($addressParams, $fields,
 627         $this->_contributorContactID, NULL, NULL,
 628         CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID, 'contact_type')
 629       );
 630     }
 631
 632     $this->assignBillingName($this->_params);
 633   }
 634
 635   /**
 636    * Get default values for billing fields.
 637    *
 638    * @todo this function still replicates code in several other places in the code.
 639    *
 640    * Also - the call to getProfileDefaults possibly covers the state_province & country already.
 641    *
 642    * @param $defaults
 643    *
 644    * @return array
 645    */
 646   protected function getBillingDefaults($defaults) {
 647     // set default country from config if no country set
 648     $config = CRM_Core_Config::singleton();
 649     if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
 650       $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
 651     }
 652
 653     if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
 654       $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
 655     }
 656
 657     $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID);
 658     return array_merge($defaults, $billingDefaults);
 659   }
 660
 661   /**
 662    * Get the default payment instrument id.
 663    *
 664    * This priortises the submitted value, if any and falls back on the processor.
 665    *
 666    * @return int
 667    *
 668    * @throws \CRM_Core_Exception
 669    */
 670   protected function getDefaultPaymentInstrumentId() {
 671     $paymentInstrumentID = CRM_Utils_Request::retrieve('payment_instrument_id', 'Integer');
 672     return (int) ($paymentInstrumentID ?? $this->_paymentProcessor['payment_instrument_id']);
 673   }
 674
 675   /**
 676    * Add the payment processor select to the form.
 677    *
 678    * @param bool $isRequired
 679    *   Is it a mandatory field.
 680    * @param bool $isBuildRecurBlock
 681    *   True if we want to build recur on change
 682    * @param bool $isBuildAutoRenewBlock
 683    *   True if we want to build autorenew on change.
 684    */
 685   protected function addPaymentProcessorSelect($isRequired, $isBuildRecurBlock = FALSE, $isBuildAutoRenewBlock = FALSE) {
 686     if (!$this->_mode) {
 687       return;
 688     }
 689     $js = ($isBuildRecurBlock ? ['onChange' => "buildRecurBlock( this.value ); return false;"] : NULL);
 690     if ($isBuildAutoRenewBlock) {
 691       $js = ['onChange' => "buildAutoRenew( null, this.value, '{$this->_mode}');"];
 692     }
 693     $element = $this->add('select',
 694       'payment_processor_id',
 695       ts('Payment Processor'),
 696       array_diff_key($this->_processors, [0 => 1]),
 697       $isRequired,
 698       $js
 699     );
 700     // The concept of _online is not really explained & the code is old
 701     // @todo figure out & document.
 702     if ($this->_online) {
 703       $element->freeze();
 704     }
 705   }
 706
 707   /**
 708    * Assign the values to build the payment info block.
 709    *
 710    * @return string
 711    *   Block title.
 712    */
 713   protected function assignPaymentInfoBlock() {
 714     $paymentInfo = CRM_Contribute_BAO_Contribution::getPaymentInfo($this->_id, $this->_component, TRUE);
 715     $title = ts('View Payment');
 716     if (!empty($this->_component) && $this->_component == 'event') {
 717       $info = CRM_Event_BAO_Participant::participantDetails($this->_id);
 718       $title .= " - {$info['title']}";
 719     }
 720     $this->assign('transaction', TRUE);
 721     $this->assign('payments', $paymentInfo['transaction'] ?? NULL);
 722     $this->assign('paymentLinks', $paymentInfo['payment_links']);
 723     return $title;
 724   }
 725
 726   protected function assignContactEmailDetails() {
 727     if ($this->_contactID) {
 728       list($this->userDisplayName, $this->userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 729       if (empty($this->userDisplayName)) {
 730         $this->userDisplayName = civicrm_api3('contact', 'getvalue', ['id' => $this->_contactID, 'return' => 'display_name']);
 731       }
 732       $this->assign('displayName', $this->userDisplayName);
 733     }
 734   }
 735
 736 }