[Ref] Clarify what parameters are passed in

[eileenmcnaughton]

Overview

[Ref] Clarify what parameters are passed in

this function is called from 2 places with 4 keys in the array always set & no others

Before

It's not clear in the function that these 3 values will always be NULL

$contactId = $params['contact_id'] ?? NULL;
$componentId = $params['component_id'] ?? NULL;
$componentName = $params['componentName'] ?? NULL;

Or that the keys will always be present for

 $contributionId = $params['contribution_id'] ?? NULL;
 $contributionStatusId = $params['contribution_status_id'] ?? NULL;
 $previousContriStatusId = $params['previous_contribution_status_id'];

which means that any changes around the assumptions for those keys will require a reviewer to do a grep.

After

By tightening the setting of values from these keys we make it so a reviewer of future cleanups won't need to look outside this function to check the values coming in.

Also assigning the name to values makes the if clauses more legible - which will make it easier to point out the chunks of this code are unreachable in follow ups :-)

Technical Details

These are the 2 places that call the function and in both places exactly the same 4 keys are set

Comments

Obviously it's a given that external code should not be calling this function - in universe I find no examples (I do find a couple of references to a function that used to exist and used to call this function & I logged an issue against the relevant extension)

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

[colemanw]

I've read the code and the refactoring makes sense.