CRM/Contribute/Form/AbstractEditPayment.php

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