Make getTotalPayments return 0 instead of NULL

[mattwire]

Overview

When the sum of all payments on a contribution = 0 the function returns NULL because it's returning the result of an SQL query. But that's not much use and means we have to do extra work to coalesce NULL into 0 when coding.

Before

NULL returned if no payments made on a contribution.

After

0 returned if no payments made on a contribution.

Technical Details

NULL != 0! Especially for money. This makes the function return what you'd expect it to return.

Comments

@eileenmcnaughton Related to #16025

[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 I agree with this but changing to returning float could break any strict comparisons. I think it's only called twice outside tests so I put up this PR to explicitly cast in one to be sure. The other is the dreaded subtractCurrencies....

[eileenmcnaughton]

@mattwire - so the only other thing this feeds is subtract currencies. I'm not too sure what effect changing to a float will have there

[mattwire]

@eileenmcnaughton I've updated this slightly so that getTotalPayments() doesn't do the ? 0 check as we are now expecting a float. The subtractCurrencies function will handle either string or float as input as it checks via is_numeric before using the input parameters as floats.

If tests pass I think this is good to merge?

[eileenmcnaughton]

I haven't gotten my head around it bu @agileware-fj might have

[jitendrapurohit]

r-jira - Pass
r-test - Pass
r-code -

I think it should be fine with just

return (float) CRM_Core_DAO::singleValueQuery($sql, [
   1 => [$contributionID, 'Integer'],
   2 => [implode(',', $statusIDs), 'CommaSeparatedIntegers'],
]);

instead of assigning it to $totalAmount and then returning the variable? Thoughts @mattwire ?

r-run - Pass

Tested by calling this function at different stages of a payment (Pending, Pending refund, Partially Paid, etc). It returns the correct total amount in all the cases.

r-users - Pass
r-technical - Pass
r-maint - Pass
r-doc - Pass

[eileenmcnaughton]

@mattwire please go ahead & merge once you have considered @jitendrapurohit's feedback

[mattwire]

@jitendrapurohit Thanks for the review - you are right. Merge on pass