[REF] Refactor adding payment processor radio section onto register a…

[seamuslee001]

…nd contribution main forms

Overview

Following the merge of https://github.com/civicrm/civicrm-core/pull/15940/files and picking up a comment in a DM from ages ago from @eileenmcnaughton i think we should try and refactor this a little

Before

Multiple places adding in the radio select option for Payment Processors

After

Single function

ping @mattwire

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[eileenmcnaughton]

@seamuslee001 I think the shared trait is a better place (avoids static functions too)

[eileenmcnaughton]

@seamuslee001 the trait I referred to is CRM_Financial_Form_FrontEndPaymentFormTrait

[seamuslee001]

@eileenmcnaughton at present on the event form is using the trait i think not contribution page

[seamuslee001]

actually take that back wrong

[eileenmcnaughton]

lol

[seamuslee001]

ok its on the trait now @eileenmcnaughton

[eileenmcnaughton]

@seamuslee001 I worked through the same extraction & came up with a slightly different function

• the main difference is not passing the output of getProcessors as there is no cost to speak of in getting that from the form variables. Other than that the function name felt misleading, the abbreviated parameters can be made into meaningful ones

  /**
   * Add the payment processor fields to the form.
   *
   *  Adds in either a set of radio buttons or hidden fields to contain the payment processors on a front end form
   */
  protected function addPaymentProcessorFieldsToForm() {
    $paymentProcessors = $this->getProcessors();
    $optAttributes = [];
    foreach (array_keys($paymentProcessors) as $key) {
      if ($key > 0) {
        $optAttributes[$key]['class'] = 'payment_processor_' . strtolower($this->_paymentProcessors[$key]['payment_processor_type']);
      }
      else {
        $optAttributes[$key]['class'] = 'payment_processor_paylater';
      }
    }
    if (count($paymentProcessors) > 1) {
      $this->addRadio('payment_processor_id', ts('Payment Method'), $paymentProcessors,
        NULL, ' ', FALSE, $optAttributes
      );
    }
    elseif (count($paymentProcessors) === 1) {
      $this->addElement('hidden', 'payment_processor_id', reset($paymentProcessors));
    }
  }

[seamuslee001]

@eileenmcnaughton just on the function name, I wanted to be clearer about the fact that it is the front end, on the back office fields it is a select field rather than radio button so as this function is only dealing with the front end adding of payment processors i wanted to be more explicit on that

[eileenmcnaughton]

Doesn't the fact it's on the FrontEndPaymentFormTrait make that obsolete?

[seamuslee001]

I guess so

[seamuslee001]

have updated it now @eileenmcnaughton

[seamuslee001]

@eileenmcnaughton is this good now?