Fix Grant::retrieve to meet full phpcs standard

[eileenmcnaughton]

Overview

Fix Grant::retrieve to meet full phpcs standard

Before

After applying #22543 I find the changes don't meet the full drupal standard

After

The new boilerplate meets the full drupal standard

Technical Details

The reason our standard falls short of 'the full drupal' it that it was too big a lift to retrofit it all at once. We have been slowly raising the bar. Since we are basically creating new boilerplate I was concerned we were actually going backwards against 'the full drupal' so I worked through it on this file to see what a fully compliant bit of boilerplate would look like

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

[colemanw]

OK. Thanks for working through that. @eileenmcnaughton
The only thing I don't like is the verbosity considering this is a deprecated boilerplate function can we get rid of the lines describing the variables and the line describing the return value?

[eileenmcnaughton]

@colemanw those lines are part of the standard - we are likely to be stuck with the boilerplate for a long time so it's probably better to meet the standard

[colemanw]

So is the standard that every @param and every @return needs a description below it? Does that mean you need to add a description below @return in the commonRetrieve function?

[colemanw]

retest this please

[eileenmcnaughton]

test this please

[eileenmcnaughton]

@colemanw yeah I guess so - I ran coder with all of these lines removed

https://github.com/civicrm/coder/blob/8.x-2.x-civi/coder_sniffer/Drupal/ruleset.xml#L11-L71