Move printing functions related functionality to dedicated PrintingFunctionsTrait
#2250
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…unctionsTrait` The printing function list is only used by a small set of sniffs, so are better placed in a dedicated trait. The choice for a `trait` over a `class` is due to the `public` property allowing for adding additional functions to the list. Moving both the base function list + the `public` property to the same trait will allow us to encapsulate all the functionality related to the use of this list in one place. The `$printingFunctions` property, containing the base lists, has also been made `private`. Checking whether or not something is a printing function should now be done by calling the `PrintingFunctionsTrait::is_printing_function()` method. Related to 1465
dingo-d
approved these changes
Jun 15, 2023
|
Just checking @dingo-d @GaryJones: What with you both approving, can this be merged ? |
Merged
GaryJones
added a commit
to Automattic/VIP-Coding-Standards
that referenced
this pull request
Jun 20, 2023
WPCS moved it to a new trait: WordPress/WordPress-Coding-Standards#2250
GaryJones
added a commit
to Automattic/VIP-Coding-Standards
that referenced
this pull request
Jun 22, 2023
WPCS moved it to a new trait: WordPress/WordPress-Coding-Standards#2250
GaryJones
added a commit
to Automattic/VIP-Coding-Standards
that referenced
this pull request
Jun 22, 2023
WPCS moved it to a new trait: WordPress/WordPress-Coding-Standards#2250
GaryJones
added a commit
to Automattic/VIP-Coding-Standards
that referenced
this pull request
Jun 22, 2023
WPCS moved it to a new trait: WordPress/WordPress-Coding-Standards#2250
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The printing function list is only used by a small set of sniffs, so are better placed in a dedicated trait.
The choice for a
traitover aclassis due to thepublicproperty allowing for adding additional functions to the list.Moving both the base function list + the
publicproperty to the same trait will allow us to encapsulate all the functionality related to the use of this list in one place.The
$printingFunctionsproperty, containing the base lists, has also been madeprivate.Checking whether or not something is a printing function should now be done by calling the
PrintingFunctionsTrait::is_printing_function()method.Related to #1465