Squiz/DisallowMultipleAssignments: fix false positive when handling parameter default values #557
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
Doing this to be able to create a test with a syntax error on separate file.
There was a bug in the code used to check if a equal sign is used to set a default value for a parameter that caused a false positive when the function was missing the closing parenthesis (which can happen during live coding). This commit fixes this false positive.
4 tasks
jrfnl
reviewed
Jul 17, 2024
Comment on lines
48
to
52
| $opener = $tokens[$function]['parenthesis_opener']; | ||
| $closer = $tokens[$function]['parenthesis_closer']; | ||
| if ($opener < $stackPtr && $closer > $stackPtr) { | ||
| if ($closer === null || ($opener < $stackPtr && $closer > $stackPtr)) { | ||
| return; | ||
| } |
There was a problem hiding this comment.
The code is accessing the parenthesis_closer before this condition.
Would it make sense to move the check for a missing parenthesis closer up ?
I.e.:
Suggested change
| $opener = $tokens[$function]['parenthesis_opener']; | |
| $closer = $tokens[$function]['parenthesis_closer']; | |
| if ($opener < $stackPtr && $closer > $stackPtr) { | |
| if ($closer === null || ($opener < $stackPtr && $closer > $stackPtr)) { | |
| return; | |
| } | |
| if (isset($tokens[$function]['parenthesis_closer']) === false) { | |
| // Live coding/parse error. Bow out. | |
| return; | |
| } | |
| $opener = $tokens[$function]['parenthesis_opener']; | |
| $closer = $tokens[$function]['parenthesis_closer']; | |
| if ($opener < $stackPtr && $closer > $stackPtr) { | |
| return; | |
| } |
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.
Description
This PR fixes a bug in the code used to check if a equal sign is used to set a default value for a parameter. This bug caused a false positive when the function declaration was missing the closing parenthesis (which can happen during live coding).
Suggested changelog entry
Squiz.PHP.DisallowMultipleAssignments false positive for parameter default values when the closing parenthesis of the function declaration is missing.
Related issues/external references
Fixes #551
Types of changes
PR checklist