From d8c01ab523ce44eb75f74b630cf9f692cc5444ec Mon Sep 17 00:00:00 2001
From: eileen <emcnaughton@wikimedia.org>
Date: Thu, 27 Jul 2017 21:04:48 +1200
Subject: [PATCH] CRM-20610 additional code comments.

I have added comments to some things I'd really like to see tidied up (but could
not reasonably extend the scope here to include)
---
 CRM/Financial/Form/PaymentEdit.php | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/CRM/Financial/Form/PaymentEdit.php b/CRM/Financial/Form/PaymentEdit.php
index 42bc7ff22c..64cbf31294 100644
--- a/CRM/Financial/Form/PaymentEdit.php
+++ b/CRM/Financial/Form/PaymentEdit.php
@@ -46,10 +46,17 @@ class CRM_Financial_Form_PaymentEdit extends CRM_Core_Form {
    */
   protected $_values;
 
+  /**
+   * Explicitly declare the form context.
+   */
+  public function getDefaultContext() {
+    return 'create';
+  }
   /**
    * Set variables up before form is built.
    */
   public function preProcess() {
+    $this->_action = CRM_Core_Action::UPDATE;
     parent::preProcess();
     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
     $this->assign('id', $this->_id);
@@ -68,6 +75,7 @@ class CRM_Financial_Form_PaymentEdit extends CRM_Core_Form {
   public function setDefaultValues() {
     $defaults = $this->_values;
     if (!empty($defaults['card_type_id'])) {
+      // See comments in getPaymentFields function about why this nastiness exists.
       $defaults['credit_card_type'] = CRM_Core_PseudoConstant::getName('CRM_Financial_DAO_FinancialTrxn', 'card_type_id', $defaults['card_type_id']);
     }
 
@@ -125,6 +133,7 @@ class CRM_Financial_Form_PaymentEdit extends CRM_Core_Form {
       'trxn_date' => CRM_Utils_Array::value('trxn_date', $this->_submitValues, date('YmdHis')),
     );
     if (!empty($this->_submitValues['credit_card_type'])) {
+      // See comments in getPaymentFields function about why this nastiness exists.
       $params['card_type_id'] = CRM_Core_PseudoConstant::getKey(
         'CRM_Financial_DAO_FinancialTrxn',
         'card_type_id',
@@ -152,6 +161,13 @@ class CRM_Financial_Form_PaymentEdit extends CRM_Core_Form {
       );
     }
     elseif ($paymentInstrument == 'Credit Card') {
+      // Ideally we would use $this->addField('card_type_id', array('entity' => 'FinancialTrxn'));
+      // to assign this field (& other fields on this form). However, the addCreditCardJs
+      // adds some 'pretty' to the credit card selection. The 'cost' of this is that because it
+      // was originally written to comply with front end needs (use of the word rather than the id)
+      // we have to do a lot of wrangling with our fields to make the BillingBlock.js code work.
+      // If you are reading this it means it's time to fix the BillingBlock.js to work with
+      // card_type_id and the pseudoconstant options & set this code free. No returns.
       CRM_Financial_Form_Payment::addCreditCardJs(NULL, 'payment-edit-block');
       $paymentFields['credit_card_type'] = array(
         'htmlType' => 'select',
-- 
2.25.1