CRM_Financial_BAO_Payment

Function to process additional payment for partial and refund contributions.

This function is called via API payment.create function. All forms that add payments should use this.

Send an email confirming a payment that has been received.

Get valid from emails for payment.

Load entities related to the current payment id.

This gives us all the data we need to send an email confirmation but avoiding getting anything not tested for the confirmations. We retrieve the 'full' event as it has been traditionally assigned in full.

Filter out any untested variables.

This just serves to highlight if any variables are added without a unit test also being added.

(if hit then add a unit test for the param & add to this array).

Does this payment complete the contribution

Get the line items for the contribution.

Retrieve the line items and wrangle the following

• get the outstanding balance on a line item basis.
• determine what amount is being paid on this line item - we get the total being paid for the whole contribution and determine the ratio of the balance that is being paid and then assign apply that ratio to each line item.
• if overrides have been passed in we use those amounts instead.

Get the amount paid so far against this line item.

Reverse the entity financial transactions associated with the cancelled payment.

The reversals are linked to the new payemnt.

Create a financial items & return the ID.

Ideally this will never be called.

However, I hit a scenario in testing where 'something' had created a pending payment with no financial items and that would result in a fatal error without handling here. I failed to replicate & am not investigating via a new test methodology https://github.com/civicrm/civicrm-core/pull/15706

After this is in I will do more digging & once I feel confident new instances are not being created I will add deprecation notices into this function with a view to removing.

However, I think we want to add it in 5.20 as there is a risk of users experiencing an error if there is incorrect data & we need time to ensure that what I hit was not a 'thing. (it might be the demo site data is a bit flawed & that was the issue).