Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
336a3d4
commit e1fbd78
Showing
6 changed files
with
658 additions
and
13 deletions.
There are no files selected for viewing
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 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 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
215 changes: 215 additions & 0 deletions
215
src/Fixer/FunctionNotation/PhpdocToPropertyTypeFixer.php
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,215 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of PHP CS Fixer. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * Dariusz Rumiński <dariusz.ruminski@gmail.com> | ||
| * | ||
| * This source file is subject to the MIT license that is bundled | ||
| * with this source code in the file LICENSE. | ||
| */ | ||
|
|
||
| namespace PhpCsFixer\Fixer\FunctionNotation; | ||
|
|
||
| use PhpCsFixer\AbstractPhpdocToTypeDeclarationFixer; | ||
| use PhpCsFixer\DocBlock\Annotation; | ||
| use PhpCsFixer\FixerDefinition\FixerDefinition; | ||
| use PhpCsFixer\FixerDefinition\VersionSpecification; | ||
| use PhpCsFixer\FixerDefinition\VersionSpecificCodeSample; | ||
| use PhpCsFixer\Tokenizer\Token; | ||
| use PhpCsFixer\Tokenizer\Tokens; | ||
|
|
||
| final class PhpdocToPropertyTypeFixer extends AbstractPhpdocToTypeDeclarationFixer | ||
| { | ||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getDefinition() | ||
| { | ||
| return new FixerDefinition( | ||
| 'EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4.', | ||
| [ | ||
| new VersionSpecificCodeSample( | ||
| '<?php | ||
| class Foo { | ||
| /** @var int */ | ||
| private $foo; | ||
| /** @var \Traversable */ | ||
| private $bar; | ||
| } | ||
| ', | ||
| new VersionSpecification(70400) | ||
| ), | ||
| new VersionSpecificCodeSample( | ||
| '<?php | ||
| class Foo { | ||
| /** @var int */ | ||
| private $foo; | ||
| /** @var \Traversable */ | ||
| private $bar; | ||
| } | ||
| ', | ||
| new VersionSpecification(70400), | ||
| ['scalar_types' => false] | ||
| ), | ||
| ], | ||
| null, | ||
| '[1] This rule is EXPERIMENTAL and is not covered with backward compatibility promise. [2] `@var` annotation is mandatory for the fixer to make changes, signatures of properties without it (no docblock, inheritdocs) will not be fixed. [3] Manual actions are required if inherited signatures are not properly documented. [4] `@inheritdocs` support is under construction.' | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function isCandidate(Tokens $tokens) | ||
| { | ||
| return \PHP_VERSION_ID >= 70400 && $tokens->isTokenKindFound(T_DOC_COMMENT); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function applyFix(\SplFileInfo $file, Tokens $tokens) | ||
| { | ||
| for ($index = $tokens->count() - 1; 0 < $index; --$index) { | ||
| if ($tokens[$index]->isGivenKind([T_CLASS, T_TRAIT])) { | ||
| $this->fixClass($tokens, $index); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param int $index | ||
| */ | ||
| private function fixClass(Tokens $tokens, $index) | ||
| { | ||
| $index = $tokens->getNextTokenOfKind($index, ['{']); | ||
| $classEndIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $index); | ||
|
|
||
| for (; $index < $classEndIndex; ++$index) { | ||
| if ($tokens[$index]->isGivenKind(T_FUNCTION)) { | ||
| $index = $tokens->getNextTokenOfKind($index, ['{']); | ||
| $index = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $index); | ||
|
|
||
| continue; | ||
| } | ||
|
|
||
| if (!$tokens[$index]->isGivenKind(T_DOC_COMMENT)) { | ||
| continue; | ||
| } | ||
|
|
||
| $docCommentIndex = $index; | ||
| $propertyIndexes = $this->findNextUntypedPropertiesDeclaration($tokens, $docCommentIndex); | ||
|
|
||
| if ([] === $propertyIndexes) { | ||
| continue; | ||
| } | ||
|
|
||
| $typeInfo = $this->resolveAppliableType( | ||
| $propertyIndexes, | ||
| $this->getAnnotationsFromDocComment('var', $tokens, $docCommentIndex) | ||
| ); | ||
|
|
||
| if (null === $typeInfo) { | ||
| continue; | ||
| } | ||
|
|
||
| list($propertyType, $isNullable) = $typeInfo; | ||
|
|
||
| if (\in_array($propertyType, ['void', 'callable'], true)) { | ||
| continue; | ||
| } | ||
|
|
||
| $newTokens = array_merge( | ||
| $this->createTypeDeclarationTokens($propertyType, $isNullable), | ||
| [new Token([T_WHITESPACE, ' '])] | ||
| ); | ||
|
|
||
| $tokens->insertAt(current($propertyIndexes), $newTokens); | ||
|
|
||
| $index = max($propertyIndexes) + \count($newTokens) + 1; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param int $index | ||
| * | ||
| * @return array<string, int> | ||
| */ | ||
| private function findNextUntypedPropertiesDeclaration(Tokens $tokens, $index) | ||
| { | ||
| do { | ||
| $index = $tokens->getNextMeaningfulToken($index); | ||
| } while ($tokens[$index]->isGivenKind([ | ||
| T_PRIVATE, | ||
| T_PROTECTED, | ||
| T_PUBLIC, | ||
| T_STATIC, | ||
| T_VAR, | ||
| ])); | ||
|
|
||
| if (!$tokens[$index]->isGivenKind(T_VARIABLE)) { | ||
| return []; | ||
| } | ||
|
|
||
| $properties = []; | ||
| while (!$tokens[$index]->equals(';')) { | ||
| if ($tokens[$index]->isGivenKind(T_VARIABLE)) { | ||
| $properties[$tokens[$index]->getContent()] = $index; | ||
| } | ||
|
|
||
| $index = $tokens->getNextMeaningfulToken($index); | ||
| } | ||
|
|
||
| return $properties; | ||
| } | ||
|
|
||
| /** | ||
| * @param array<string, int> $propertyIndexes | ||
| * @param Annotation[] $annotations | ||
| */ | ||
| private function resolveAppliableType(array $propertyIndexes, array $annotations) | ||
| { | ||
| $propertyTypes = []; | ||
|
|
||
| foreach ($annotations as $annotation) { | ||
| $propertyName = $annotation->getVariableName(); | ||
|
|
||
| if (null === $propertyName) { | ||
| if (1 !== \count($propertyIndexes)) { | ||
| continue; | ||
| } | ||
|
|
||
| $propertyName = key($propertyIndexes); | ||
| } | ||
|
|
||
| if (!isset($propertyIndexes[$propertyName])) { | ||
| continue; | ||
| } | ||
|
|
||
| $typeInfo = $this->getCommonTypeFromAnnotation($annotation); | ||
|
|
||
| if (!isset($propertyTypes[$propertyName])) { | ||
| $propertyTypes[$propertyName] = []; | ||
| } elseif ($typeInfo !== $propertyTypes[$propertyName]) { | ||
| return null; | ||
| } | ||
|
|
||
| $propertyTypes[$propertyName] = $typeInfo; | ||
| } | ||
|
|
||
| if (\count($propertyTypes) !== \count($propertyIndexes)) { | ||
| return null; | ||
| } | ||
|
|
||
| $type = array_shift($propertyTypes); | ||
| foreach ($propertyTypes as $propertyType) { | ||
| if ($propertyType !== $type) { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| return $type; | ||
| } | ||
| } |
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
Oops, something went wrong.