Fix BackOffice Membership forms getPriceSetID() to be standard

[eileenmcnaughton]

Overview

Fix BackOffice Membership forms getPriceSetID() to be standard

Before

We have been encouraging people to switch from accessing 'any property or method they can find' to ones designated as supported for external use. One of these is getPriceSetID() but on the back office membership form this function is non-standard and non-public

After

The methods are standard & public

Technical Details

The function is called both from a postProcess() and from a formRule() function - we have hit a couple of gotchas sharing some between these which I have also addressed.

We now recommend the use of getSubmittedValue() and getSubmittedValues() to retrieve the data the user has submitted. These functions do a bit of extra handing around money & also permit forms in multi-form flows to access the submitted values even through the values were submitted on a different form in the flow.

However, the values aren't loaded into the QuickForm array until validate has been run - so up until that point we need to access the submitValue() function - the contents of which differ in that that they are basically raw post & not yet validated.

But all that is a lot to know - a developer calling getSubmittedValue() wants to get the value the user submitted with an appropriate level of processing without having to do something different at different points of the submission. I did add an extra purify in there cos it seemed like good practice & I'd rather remove it later than add it later but I don't see it having any real impact in the way this is currently used.

Comments

[civibot]

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...

• If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
• A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
• A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
• If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
• Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
• A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
• To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
• For more information about contributing, see CONTRIBUTING.md.

Quick links for reviewers...

• ➡️ PR Demo site (can be rebuilt with the command test this please).
• 📖 Review standards
• 🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗