NFC Clarify what CRM_Price_BAO_Priceset::getMembershipCount does #18426
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Partial from #18398
This updates the docblock and variable name to clarify what the
CRM_Price_BAO_Priceset::getMembershipCount()
function actually does. It is called from a few places in the membership/contribution code and could probably be replaced. But first step is to make it clear what it actually does.For example, reading the code you might easily make the assumption that the param
$ids
is an array of IDs.. But it's not.. It's actually a comma separated string of IDs.Before
Difficult to understand what function is doing and expected params.
After
Easier to understand what function is doing and expected params.
Technical Details
Comments