PrefixAllGlobals + ValidFunctionName: ignore deprecated methods by design #1806
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
This new function: * Tries to find a function docblock, if it exists. * If found, checks if the docblock contains at least one `@deprecated` tag. Returns boolean true/false. Note: this method is `static` to allow the `ValidFunctionName` sniff which extends an upstream sniff to use the method as well.
Check the function docblock for a `@deprecated` tag and if found, bow out. Includes unit tests. Fixes 1797
dingo-d
reviewed
Oct 4, 2019
dingo-d
reviewed
Oct 4, 2019
jrfnl
force-pushed
the
feature/1797-ignore-deprecated-functions-for-namechecks
branch
from
677171a
to
d5640f8
Compare
Check the function docblock for a `@deprecated` tag and if found, bow out. Includes unit tests. Fixes 1797 Note: the same should probably also be done for classes/interfaces/traits/constants marked as deprecated, but that's for another PR.
dingo-d
deleted the
feature/1797-ignore-deprecated-functions-for-namechecks
branch
This was referenced Oct 15, 2019
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.
Sniff: add new
is_function_deprecated()utility functionThis new function:
@deprecatedtag.Returns boolean true/false.
Note: this method is
staticto allow theValidFunctionNamesniff which extends an upstream sniff to use the method as well.ValidFunctionName: ignore deprecated functions
Check the function docblock for a
@deprecatedtag and if found, bow out.Includes unit tests.
PrefixAllGlobals: ignore deprecated functions
Check the function docblock for a
@deprecatedtag and if found, bow out.Includes unit tests.
Note: the same should probably also be done for classes/interfaces/traits/constants marked as deprecated, but that's for another PR.
Fixes #1797