[NFC] Extract getUserCheckSum function

[eileenmcnaughton]

Overview

Minor code cleanup to improve usability & to make checksum info more available to child classes (I have some further cleanup in progress to leverage that)

Before

Code less readable

After

Code more readable

Technical Details

Comments

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

[seamuslee001]

Agree this is just a straight forward extraction and is NFC, Merging

[totten]

Agree this looks like a valid extraction, but... a process thing about "NFC"...

It feels like there's been a miscommunication -- e.g. when coining "NFC", I personally expected that it would not include refactorings like "extract method" because refactoring changes how the code executes. There are several kinds of subtle issues that can happen in refactoring (e.g. typos, inverted conditionals, or unrecognized naming-conflicts in the class-hieararchy) which would break functionality. As a reader/potential-reviewer, I look for very different things in the following two examples:

• Fix a grammatical issue in a docblock or help screen
• Extract a function or move a function to a parent class

Even though they are different, I can see how genuine refactorings (when done correctly) are still simpler/safer than other changes, and it does seem useful to have a short-hand for them.

@seamuslee001 @eileenmcnaughton @colemanw @mattwire -- could we add another abbreviation to our lexicon? Like one of these?

• "(REF) Refactor" -- https://github.com/civicrm/civicrm-dev-docs/compare/master...totten:master-ref?expand=1
• Alternatively: "(SFC) Small Functional Change"
• Alternatively: (UTH) Under-the-Hood Change"

[eileenmcnaughton]

ok - let's go with REF - hopefully that will also keep them out of the 'features' part of the release notes

[colemanw]

Thanks for the clarification @totten. I also like REF.