✨ New ObjectDeclarations::getDeclared*() utility methods #592
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
jrfnl
force-pushed
the
objectdeclarations/new-getmethods-utility
branch
from
88735be
to
3c70445
Compare
jrfnl
changed the base branch from
develop
to
feature/add-more-defensive-coding-typeerrors
jrfnl
force-pushed
the
feature/add-more-defensive-coding-typeerrors
branch
from
68e4394
to
38ec4cb
Compare
jrfnl
force-pushed
the
objectdeclarations/new-getmethods-utility
branch
from
3c70445
to
d3dc01a
Compare
jrfnl
force-pushed
the
feature/add-more-defensive-coding-typeerrors
branch
2 times, most recently
from
b03bf36
to
da71d5a
Compare
jrfnl
force-pushed
the
objectdeclarations/new-getmethods-utility
branch
from
d3dc01a
to
284714b
Compare
jrfnl
force-pushed
the
feature/add-more-defensive-coding-typeerrors
branch
2 times, most recently
from
c15cf06
to
33541ff
Compare
Base automatically changed from
feature/add-more-defensive-coding-typeerrors
to
develop
May 20, 2024 19:13
This commit adds a new set of utility methods to the `ObjectDeclarations` class: * `getDeclaredConstants(File $phpcsFile, int $stackPtr): array` * `getDeclaredEnumCases(File $phpcsFile, int $stackPtr): array` * `getDeclaredProperties(File $phpcsFile, int $stackPtr): array` * `getDeclaredMethods(File $phpcsFile, int $stackPtr): array` * (`private`) `analyzeOOStructure(File $phpcsFile, int $stackPtr): array` These methods allow for retrieving an array with the names of all constants, enum cases, properties and methods as the keys and the stack pointer to the relevant `T_CONST`, `T_ENUM_CASE`, `T_VARIABLE` or `T_FUNCTION` token as the value. As these methods all used the same `analyzeOOStructure()` method under the hood and the results of that method are cached, the method are highly optimized for performance. If a sniff needs to search for a named constant/enum case/property/method in an OO structure, in most cases, these methods should be the recommended way for finding the declaration, instead of the sniff attempting to do this itself. Includes extensive unit tests.
|
Rebased without changes, other than squashing the "use new exceptions" commit into the base commit. |
jrfnl
force-pushed
the
objectdeclarations/new-getmethods-utility
branch
from
284714b
to
c16c199
Compare
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.
This commit adds a new set of utility methods to the
ObjectDeclarationsclass:getDeclaredConstants(File $phpcsFile, int $stackPtr): arraygetDeclaredEnumCases(File $phpcsFile, int $stackPtr): arraygetDeclaredProperties(File $phpcsFile, int $stackPtr): arraygetDeclaredMethods(File $phpcsFile, int $stackPtr): arrayprivate)analyzeOOStructure(File $phpcsFile, int $stackPtr): arrayThese methods allow for retrieving an array with the names of all constants, enum cases, properties and methods as the keys and the stack pointer to the relevant
T_CONST,T_ENUM_CASE,T_VARIABLEorT_FUNCTIONtoken as the value.As these methods all used the same
analyzeOOStructure()method under the hood and the results of that method are cached, the method are highly optimized for performance.If a sniff needs to search for a named constant/enum case/property/method in an OO structure, in most cases, these methods should be the recommended way for finding the declaration, instead of the sniff attempting to do this itself.
Includes extensive unit tests.
Closes #124