BCFile/FunctionDeclarations::get[Method]Properties(): skip over closure use statements #573
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
changed the title
jrfnl
force-pushed
the
feature/getmethodproperties-bugfix-closure-use-vs-return-type
branch
from
9f63afb
to
4e2bbe3
Compare
|
As per PHPCSStandards/PHP_CodeSniffer#421 (comment):
|
jrfnl
force-pushed
the
feature/getmethodproperties-bugfix-closure-use-vs-return-type
branch
from
4e2bbe3
to
f777405
Compare
…over closure use statements Sister-PR to upstream PR PHPCSStandards/PHP_CodeSniffer 421 This PR improves performance of the `BCFile::getMethodProperties()` and the `FunctionDeclarations::getProperties()` methods and prevents incorrect return type information for closure `use` clauses containing invalid variable imports in the `use` clause (defensive coding). Closure `use` statements can only import plain variables, not properties or other more complex variables. As things were, when such "illegal" variables were imported in a closure `use`, the information for the return type could get mangled. While this would be a parse error, for the purposes of static analysis, the `BCFile::getMethodProperties()` method and the `FunctionDeclarations::getProperties()` method should still handle this correctly. This commit updates both methods to always skip over the complete `use` clause, which prevents the issue and improves performance as the same time (less token walking). Includes unit tests.
jrfnl
force-pushed
the
feature/getmethodproperties-bugfix-closure-use-vs-return-type
branch
from
f777405
to
7e01385
Compare
|
Upstream PR has been merged and will be included in PHPCS 3.9.2. |
jrfnl
deleted the
feature/getmethodproperties-bugfix-closure-use-vs-return-type
branch
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Sister-PR to upstream PR PHPCSStandards/PHP_CodeSniffer#421
This PR improves performance of the
BCFile::getMethodProperties()and theFunctionDeclarations::getProperties()methods and prevents incorrect return type information for closuresuseclauses containing invalid variable imports in theuseclause (defensive coding).Closure
usestatements can only import plain variables, not properties or other more complex variables.As things were, when such "illegal" variables were imported in a closure
use, the information for the return type could get mangled.While this would be a parse error, for the purposes of static analysis, the
BCFile::getMethodProperties()method and theFunctionDeclarations::getProperties()method should still handle this correctly.This commit updates both methods to always skip over the complete
useclause, which prevents the issue and improves performance as the same time (less token walking).Includes unit tests.