Refactor api3 Payment.Get API to support options + most fields in civicrm_financial_trxn

[eileenmcnaughton]

Overview

Alternative to #16603 for fix ups on Payment.get

Before

See #16603

After

See #16603

Technical Details

@mattwire I took a look at #16603 & came to the conclusion that Payment.get is basically FinancialTrxn.get with 3 extras

1. enforced is_payment = 1
2. support for passing in contribution_id
3. contribution_id added to results array.

Given that I was able to reach a similar but slightly different result. Note that I concluded it's not logical to pass in any entity_table other than contribution, so I made that a non-parameter.

Also I removed 'In Progress' from the test as that's not a status we support for contributions (it got into contribution statuses from pledge statuses but there is no core meaning for it - I switched to Pending'

Comments

[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).

[mattwire]

@eileenmcnaughton We need to add limit=0 to the call to EntityFinancialTrxn like this otherwise only the first 25 results have contribution IDs:

-    $entityFinancialTrxns = civicrm_api3('EntityFinancialTrxn', 'get', ['financial_trxn_id' => ['IN' => array_keys($financialTrxn)], 'entity_table' => 'civicrm_contribution'])['values'];
+    $entityFinancialTrxnParams = [
+      'financial_trxn_id' => ['IN' => array_keys($financialTrxn)],
+      'entity_table' => 'civicrm_contribution',
+      'options' => ['limit' => 0],
+    ];
+    $entityFinancialTrxns = civicrm_api3('EntityFinancialTrxn', 'get', $entityFinancialTrxnParams)['values'];

(this was also broken in my PR #16603)

Once that change is made and tests are passing on this PR it is ok to merge

[eileenmcnaughton]

@mattwire - I've updated it with the fix you pointed out. Going forwards I'm starting to use apiv4 rather than v3 calls - even within v3 api - so we have to switch from remembering limit to checkPermissions :-)