Docs: clarify the $matched_content parameter
#2280
Merged
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
When the `$matched_content` param is passed from the `AbstractFunctionRestrictionsSniff` or, by extension, from the `AbstractFunctionParameterSniff``, it will always already be in lowercase. When the `$matched_content` param is passed from the `AbstractClassRestrictionsSniff` sniff it will be in its original case. This commit updates the docs of all involved methods to include information about the case of the content of `$matched_content` to clarify this. Includes removing two unnecessary calls to `strtolower()` in child classes. Includes overloading the `process_matched_token()` method in the `AbstractClassRestrictionsSniff`, not because the code does anything different, but only to ensure the docblock annotates correctly that in child classes of that abstract the `$matched_content` will be in its original case.
dingo-d
approved these changes
Jul 4, 2023
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.
When the
$matched_contentparam is passed from theAbstractFunctionRestrictionsSniffor, by extension, from the `AbstractFunctionParameterSniff``, it will always already be in lowercase.When the
$matched_contentparam is passed from theAbstractClassRestrictionsSniffsniff it will be in its original case.This commit updates the docs of all involved methods to include information about the case of the content of
$matched_contentto clarify this.Includes removing two unnecessary calls to
strtolower()in child classes.Includes overloading the
process_matched_token()method in theAbstractClassRestrictionsSniff, not because the code does anything different, but only to ensure the docblock annotates correctly that in child classes of that abstract the$matched_contentwill be in its original case.