Merge pull request #13689 from eileenmcnaughton/no_record_payment
[civicrm-core.git] / CRM / Contribute / Form / AdditionalPayment.php
index 93cb1e0ee9a76e835b8635ea90bc72db39b03de6..1c37915b58032459827fece99db4e4a9dd989da2 100644 (file)
@@ -39,6 +39,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
 
   /**
    * Id of the component entity
+   * @var int
    */
   public $_id = NULL;
 
@@ -49,9 +50,8 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
   protected $_refund = NULL;
 
   /**
-   * @deprecated - use parent $this->contactID
-   *
    * @var int
+   * @deprecated - use parent $this->contactID
    */
   protected $_contactId = NULL;
 
@@ -153,6 +153,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
    * @return array
    *   reference to the array of default values
    */
+
   /**
    * @return array
    */
@@ -160,7 +161,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
       return NULL;
     }
-    $defaults = array();
+    $defaults = [];
     if ($this->_mode) {
       CRM_Core_Payment_Form::setDefaultValues($this, $this->_contactId);
       $defaults = array_merge($defaults, $this->_defaults);
@@ -187,15 +188,14 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
    */
   public function buildQuickForm() {
     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
-      $this->addButtons(array(
-          array(
-            'type' => 'cancel',
-            'name' => ts('Done'),
-            'spacing' => '         ',
-            'isDefault' => TRUE,
-          ),
-        )
-      );
+      $this->addButtons([
+        [
+          'type' => 'cancel',
+          'name' => ts('Done'),
+          'spacing' => '         ',
+          'isDefault' => TRUE,
+        ],
+      ]);
       return;
     }
 
@@ -220,7 +220,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
     $this->add('textarea', 'receipt_text', ts('Confirmation Message'));
 
     $dateLabel = ($this->_refund) ? ts('Refund Date') : ts('Date Received');
-    $this->addField('trxn_date', array('entity' => 'FinancialTrxn', 'label' => $dateLabel, 'context' => 'Contribution'), FALSE, FALSE);
+    $this->addField('trxn_date', ['entity' => 'FinancialTrxn', 'label' => $dateLabel, 'context' => 'Contribution'], FALSE, FALSE);
 
     if ($this->_contactId && $this->_id) {
       if ($this->_component == 'event') {
@@ -237,17 +237,17 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
     $js = NULL;
     // render backoffice payment fields only on offline mode
     if (!$this->_mode) {
-      $js = array('onclick' => "return verify( );");
+      $js = ['onclick' => "return verify( );"];
 
       $this->add('select', 'payment_instrument_id',
         ts('Payment Method'),
-        array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(),
+        ['' => ts('- select -')] + CRM_Contribute_PseudoConstant::paymentInstrument(),
         TRUE,
-        array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
+        ['onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);"]
       );
 
       $this->add('text', 'check_number', ts('Check Number'), $attributes['financial_trxn_check_number']);
-      $this->add('text', 'trxn_id', ts('Transaction ID'), array('class' => 'twelve') + $attributes['trxn_id']);
+      $this->add('text', 'trxn_id', ts('Transaction ID'), ['class' => 'twelve'] + $attributes['trxn_id']);
 
       $this->add('text', 'fee_amount', ts('Fee Amount'),
         $attributes['fee_amount']
@@ -261,23 +261,22 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
     }
 
     $buttonName = $this->_refund ? 'Record Refund' : 'Record Payment';
-    $this->addButtons(array(
-        array(
-          'type' => 'upload',
-          'name' => ts('%1', array(1 => $buttonName)),
-          'js' => $js,
-          'isDefault' => TRUE,
-        ),
-        array(
-          'type' => 'cancel',
-          'name' => ts('Cancel'),
-        ),
-      )
-    );
+    $this->addButtons([
+      [
+        'type' => 'upload',
+        'name' => ts('%1', [1 => $buttonName]),
+        'js' => $js,
+        'isDefault' => TRUE,
+      ],
+      [
+        'type' => 'cancel',
+        'name' => ts('Cancel'),
+      ],
+    ]);
     $mailingInfo = Civi::settings()->get('mailing_backend');
     $this->assign('outBound_option', $mailingInfo['outBound_option']);
 
-    $this->addFormRule(array('CRM_Contribute_Form_AdditionalPayment', 'formRule'), $this);
+    $this->addFormRule(['CRM_Contribute_Form_AdditionalPayment', 'formRule'], $this);
   }
 
   /**
@@ -288,7 +287,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
    * @return array
    */
   public static function formRule($fields, $files, $self) {
-    $errors = array();
+    $errors = [];
     if ($self->_paymentType == 'owed' && $fields['total_amount'] > $self->_owed) {
       $errors['total_amount'] = ts('Payment amount cannot be greater than owed amount');
     }
@@ -338,16 +337,16 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
     }
     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution',
       'contribution_status_id',
-      array('labelColumn' => 'name')
+      ['labelColumn' => 'name']
     );
     $contributionStatusID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_contributionId, 'contribution_status_id');
     if ($contributionStatuses[$contributionStatusID] == 'Pending') {
       civicrm_api3('Contribution', 'create',
-        array(
+        [
           'id' => $this->_contributionId,
           'contribution_status_id' => array_search('Partially paid', $contributionStatuses),
           'is_pay_later' => 0,
-        )
+        ]
       );
     }
 
@@ -357,25 +356,25 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
       $this->processCreditCard();
     }
 
-    $defaults = array();
-    $contribution = civicrm_api3('Contribution', 'getsingle', array(
-      'return' => array("contribution_status_id"),
+    $defaults = [];
+    $contribution = civicrm_api3('Contribution', 'getsingle', [
+      'return' => ["contribution_status_id"],
       'id' => $this->_contributionId,
-    ));
+    ]);
     $contributionStatusId = CRM_Utils_Array::value('contribution_status_id', $contribution);
     $result = CRM_Contribute_BAO_Contribution::recordAdditionalPayment($this->_contributionId, $this->_params, $this->_paymentType, $participantId);
     // Fetch the contribution & do proportional line item assignment
-    $params = array('id' => $this->_contributionId);
+    $params = ['id' => $this->_contributionId];
     $contribution = CRM_Contribute_BAO_Contribution::retrieve($params, $defaults, $params);
-    CRM_Contribute_BAO_Contribution::addPayments(array($contribution), $contributionStatusId);
+    CRM_Contribute_BAO_Contribution::addPayments([$contribution], $contributionStatusId);
     if ($this->_contributionId && CRM_Core_Permission::access('CiviMember')) {
-      $membershipPaymentCount = civicrm_api3('MembershipPayment', 'getCount', array('contribution_id' => $this->_contributionId));
+      $membershipPaymentCount = civicrm_api3('MembershipPayment', 'getCount', ['contribution_id' => $this->_contributionId]);
       if ($membershipPaymentCount) {
         $this->ajaxResponse['updateTabs']['#tab_member'] = CRM_Contact_BAO_Contact::getCountComponent('membership', $this->_contactID);
       }
     }
     if ($this->_contributionId && CRM_Core_Permission::access('CiviEvent')) {
-      $participantPaymentCount = civicrm_api3('ParticipantPayment', 'getCount', array('contribution_id' => $this->_contributionId));
+      $participantPaymentCount = civicrm_api3('ParticipantPayment', 'getCount', ['contribution_id' => $this->_contributionId]);
       if ($participantPaymentCount) {
         $this->ajaxResponse['updateTabs']['#tab_participant'] = CRM_Contact_BAO_Contact::getCountComponent('participant', $this->_contactID);
       }
@@ -398,7 +397,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
     $session = CRM_Core_Session::singleton();
 
     $now = date('YmdHis');
-    $fields = array();
+    $fields = [];
 
     // we need to retrieve email address
     if ($this->_context == 'standalone' && !empty($this->_params['is_email_receipt'])) {
@@ -491,7 +490,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
       $userSortName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $userID,
         'sort_name'
       );
-      $this->_params['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
+      $this->_params['source'] = ts('Submit Credit Card Payment by: %1', [1 => $userSortName]);
     }
   }
 
@@ -539,7 +538,7 @@ class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_Abstract
       $this->_mode = $creditCardMode;
     }
 
-    $this->_fields = array();
+    $this->_fields = [];
     $this->set('cid', $this->_contactId);
     parent::preProcess();
     $this->submit($params);