Move escaping functions related functionality to dedicated EscapingFunctionsTrait
#2249
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 escaping function lists are 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` properties allowing for adding additional functions to these lists. Moving both the base function lists + the `public` properties to the same trait will allow us to encapsulate all the functionality related to the use of these lists in one place. The `$escapingFunctions` and the `$autoEscapedFunctions` properties, containing the base lists, have also been made `private`. Checking whether or not something is an escaping function should now be done by calling the `EscapingFunctionsTrait::is_escaping_function()` and/or the `EscapingFunctionsTrait::is_auto_escaped_function()` methods. Related to 1465
dingo-d
approved these changes
Jun 15, 2023
Merged
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.
Move escaping functions related functionality to dedicated
EscapingFunctionsTraitThe escaping function lists are only used by a small set of sniffs, so are better placed in a dedicated trait.
The choice for a
traitover aclassis due to thepublicproperties allowing for adding additional functions to these lists.Moving both the base function lists + the
publicproperties to the same trait will allow us to encapsulate all the functionality related to the use of these lists in one place.The
$escapingFunctionsand the$autoEscapedFunctionsproperties, containing the base lists, have also been madeprivate.Checking whether or not something is an escaping function should now be done by calling the
EscapingFunctionsTrait::is_escaping_function()and/or theEscapingFunctionsTrait::is_auto_escaped_function()methods.Related to #1465