-
Couldn't load subscription status.
- Fork 17
Support constructor promotion with namespaced and union typehints #333
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
f1f9c90
Add test case for constructor property promotion with namespace type
sirbrillig 843b4d6
Simplify isConstructorPromotion and add ignore typehints
sirbrillig 922564f
Add test for union properties
sirbrillig 90cc33c
Handle unions
sirbrillig 73e498c
Style fixes
sirbrillig b29321c
Remove unused var
sirbrillig b776232
Remove unreachable return
sirbrillig 54322ac
Use union token type content rather than type
sirbrillig File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1535,62 +1535,105 @@ public static function getForLoopForIncrementVariable($stackPtr, $forLoops) | |
| */ | ||
| public static function isConstructorPromotion(File $phpcsFile, $stackPtr) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @sirbrillig Just out of curiousity: why are you not using the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Because I didn't know about Related: I really need to get around to adding phpcsutils to this package; you've done a fantastic job with its documentation! There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you didn't know about this one... you might also be interested in the And yes, PHPCSUtils has those too and improved on them further + much more. Happy to talk things through with you at some point if you think that would help. Unfortunately won't have any time in the foreseeable future to actually help you with the code changes. |
||
| { | ||
| // If we are not in a function's parameters, this is not promotion. | ||
| $functionIndex = self::getFunctionIndexForFunctionParameter($phpcsFile, $stackPtr); | ||
| if (! $functionIndex) { | ||
| return false; | ||
| } | ||
|
|
||
| $tokens = $phpcsFile->getTokens(); | ||
|
|
||
| // If the previous token is a visibility keyword, this is constructor | ||
| // promotion. eg: `public $foobar`. | ||
| $prevIndex = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($stackPtr - 1), $functionIndex, true); | ||
| if (! is_int($prevIndex)) { | ||
| // Move backwards from the token, ignoring whitespace, typehints, and the | ||
| // 'readonly' keyword, and return true if the previous token is a | ||
| // visibility keyword (eg: `public`). | ||
| for ($i = $stackPtr - 1; $i > $functionIndex; $i--) { | ||
| if (in_array($tokens[$i]['code'], Tokens::$scopeModifiers, true)) { | ||
| return true; | ||
| } | ||
| if (in_array($tokens[$i]['code'], Tokens::$emptyTokens, true)) { | ||
| continue; | ||
| } | ||
| if ($tokens[$i]['content'] === 'readonly') { | ||
| continue; | ||
| } | ||
| if (self::isTokenPartOfTypehint($phpcsFile, $i)) { | ||
| continue; | ||
| } | ||
| return false; | ||
| } | ||
| $prevToken = $tokens[$prevIndex]; | ||
| if (in_array($prevToken['code'], Tokens::$scopeModifiers, true)) { | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Return false if the token is definitely not part of a typehint | ||
| * | ||
| * @param File $phpcsFile | ||
| * @param int $stackPtr | ||
| * | ||
| * @return bool | ||
| */ | ||
| private static function isTokenPossiblyPartOfTypehint(File $phpcsFile, $stackPtr) | ||
| { | ||
| $tokens = $phpcsFile->getTokens(); | ||
| $token = $tokens[$stackPtr]; | ||
| if ($token['code'] === 'PHPCS_T_NULLABLE') { | ||
| return true; | ||
| } | ||
|
|
||
| // If the previous token is not a visibility keyword, but the one before it | ||
| // is, the previous token was probably a typehint and this is constructor | ||
| // promotion. eg: `public boolean $foobar`. | ||
| $prev2Index = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($prevIndex - 1), $functionIndex, true); | ||
| if (! is_int($prev2Index)) { | ||
| return false; | ||
| if ($token['code'] === T_NS_SEPARATOR) { | ||
| return true; | ||
| } | ||
| $prev2Token = $tokens[$prev2Index]; | ||
| // If the token that might be a visibility keyword is a nullable typehint, | ||
| // ignore it and move back one token further eg: `public ?boolean $foobar`. | ||
| if ($prev2Token['code'] === 'PHPCS_T_NULLABLE') { | ||
| $prev2Index = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($prev2Index - 1), $functionIndex, true); | ||
| if (! is_int($prev2Index)) { | ||
| return false; | ||
| } | ||
| if ($token['code'] === T_STRING) { | ||
| return true; | ||
| } | ||
| $prev2Token = $tokens[$prev2Index]; | ||
| if (in_array($prev2Token['code'], Tokens::$scopeModifiers, true)) { | ||
| if ($token['code'] === T_TRUE) { | ||
| return true; | ||
| } | ||
|
|
||
| // If the previous token is not a visibility keyword, but the one two | ||
| // before it is, and one of the tokens is `readonly`, the previous token | ||
| // was probably a typehint and this is constructor promotion. eg: `public | ||
| // readonly boolean $foobar`. | ||
| $prev3Index = $phpcsFile->findPrevious(Tokens::$emptyTokens, ($prev2Index - 1), $functionIndex, true); | ||
| if (! is_int($prev3Index)) { | ||
| return false; | ||
| if ($token['code'] === T_FALSE) { | ||
| return true; | ||
| } | ||
| $prev3Token = $tokens[$prev3Index]; | ||
| $wasPreviousReadonly = $prevToken['content'] === 'readonly' || $prev2Token['content'] === 'readonly'; | ||
| if (in_array($prev3Token['code'], Tokens::$scopeModifiers, true) && $wasPreviousReadonly) { | ||
| if ($token['code'] === T_NULL) { | ||
| return true; | ||
| } | ||
| if ($token['content'] === '|') { | ||
| return true; | ||
| } | ||
| if (in_array($token['code'], Tokens::$emptyTokens)) { | ||
| return true; | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Return true if the token is inside a typehint | ||
| * | ||
| * @param File $phpcsFile | ||
| * @param int $stackPtr | ||
| * | ||
| * @return bool | ||
| */ | ||
| public static function isTokenPartOfTypehint(File $phpcsFile, $stackPtr) | ||
| { | ||
| $tokens = $phpcsFile->getTokens(); | ||
|
|
||
| if (! self::isTokenPossiblyPartOfTypehint($phpcsFile, $stackPtr)) { | ||
| return false; | ||
| } | ||
|
|
||
| // Examine every following token, ignoring everything that might be part of | ||
| // a typehint. If we find a variable at the end, this is part of a | ||
| // typehint. | ||
| $i = $stackPtr; | ||
| while (true) { | ||
| $i += 1; | ||
| if (! isset($tokens[$i])) { | ||
| return false; | ||
| } | ||
| if (! self::isTokenPossiblyPartOfTypehint($phpcsFile, $i)) { | ||
| return ($tokens[$i]['code'] === T_VARIABLE); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Return true if the token is inside an abstract class. | ||
| * | ||
|
|
||
Oops, something went wrong.
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.