Separate loadRelatedObjects params in complete/repeattransaction

[mattwire]

Overview

Separate params being passed to loadRelatedObjects from params being passed through later functions.

Before

More difficult to disentangle.

After

Easier to disentangleify.

Technical Details

• loadRelatedObjects accepts an input array and reads payment_processor_id and component from that array. For repeat/completetransaction we are not passing component.
• $input is passed through to _ipn_process_transaction and completeOrder but payment_processor_id is never used (it's filtered out in the case of repeattransaction but not in completetransaction. But code inspection shows it's not used.

Comments

@eileenmcnaughton Further simplification.

[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]

@mattwire per dm - do we even need to loadRelatedObjects anymore - we only use $contribution->_relatedObjects['paymentProcessor'] once - it's at the bottom of this snippet but I included the lines a little earlier because they relate

    $paymentProcessorId = '';
    if (isset($objects['paymentProcessor'])) {
      if (is_array($objects['paymentProcessor'])) {
        $paymentProcessorId = $objects['paymentProcessor']['id'];
      }
      else {
        $paymentProcessorId = $objects['paymentProcessor']->id;
      }
    }

....

    // If paymentProcessor is not set then the payment_instrument_id would not be correct.
    // not clear when or if this would occur if you encounter this please fix here & add a unit test.
    if (empty($contributionParams['payment_instrument_id']) && isset($contribution->_relatedObjects['paymentProcessor']['payment_instrument_id'])) {
      $contributionParams['payment_instrument_id'] = $contribution->_relatedObjects['paymentProcessor']['payment_instrument_id'];
    }

(note I did #18257 on this theme)

[eileenmcnaughton]

That gave me an idea - let's see what tests hit that line - #18259

[eileenmcnaughton]

Nice - the line has test cover! #18259 (comment) - including from the api & BaseIPN class.

[mattwire]

Superseded