-
Notifications
You must be signed in to change notification settings - Fork 95
Support for TreeBuilder::getRootNode() #126
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
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
56 changes: 56 additions & 0 deletions
src/Type/Symfony/TreeBuilderDynamicReturnTypeExtension.php
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 |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Type\Symfony; | ||
|
|
||
| use PhpParser\Node\Expr\StaticCall; | ||
| use PhpParser\Node\Name; | ||
| use PHPStan\Analyser\Scope; | ||
| use PHPStan\Reflection\MethodReflection; | ||
| use PHPStan\Type\DynamicStaticMethodReturnTypeExtension; | ||
| use PHPStan\Type\Type; | ||
| use PHPStan\Type\TypeUtils; | ||
|
|
||
| final class TreeBuilderDynamicReturnTypeExtension implements DynamicStaticMethodReturnTypeExtension | ||
| { | ||
|
|
||
| private const MAPPING = [ | ||
| 'variable' => 'Symfony\Component\Config\Definition\Builder\VariableNodeDefinition', | ||
| 'scalar' => 'Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition', | ||
| 'boolean' => 'Symfony\Component\Config\Definition\Builder\BooleanNodeDefinition', | ||
| 'integer' => 'Symfony\Component\Config\Definition\Builder\IntegerNodeDefinition', | ||
| 'float' => 'Symfony\Component\Config\Definition\Builder\FloatNodeDefinition', | ||
| 'array' => 'Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition', | ||
| 'enum' => 'Symfony\Component\Config\Definition\Builder\EnumNodeDefinition', | ||
| ]; | ||
|
|
||
| public function getClass(): string | ||
| { | ||
| return 'Symfony\Component\Config\Definition\Builder\TreeBuilder'; | ||
| } | ||
|
|
||
| public function isStaticMethodSupported(MethodReflection $methodReflection): bool | ||
| { | ||
| return $methodReflection->getName() === '__construct'; | ||
| } | ||
|
|
||
| public function getTypeFromStaticMethodCall(MethodReflection $methodReflection, StaticCall $methodCall, Scope $scope): Type | ||
| { | ||
| if (!$methodCall->class instanceof Name) { | ||
| throw new \PHPStan\ShouldNotHappenException(); | ||
| } | ||
|
|
||
| $className = $scope->resolveName($methodCall->class); | ||
|
|
||
| $type = 'array'; | ||
|
|
||
| if (isset($methodCall->args[1])) { | ||
| $argStrings = TypeUtils::getConstantStrings($scope->getType($methodCall->args[1]->value)); | ||
| if (count($argStrings) === 1 && isset(self::MAPPING[$argStrings[0]->getValue()])) { | ||
| $type = $argStrings[0]->getValue(); | ||
| } | ||
| } | ||
|
|
||
| return new TreeBuilderType($className, self::MAPPING[$type]); | ||
| } | ||
|
|
||
| } |
39 changes: 39 additions & 0 deletions
src/Type/Symfony/TreeBuilderGetRootNodeDynamicReturnTypeExtension.php
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 |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Type\Symfony; | ||
|
|
||
| use PhpParser\Node\Expr\MethodCall; | ||
| use PHPStan\Analyser\Scope; | ||
| use PHPStan\Reflection\MethodReflection; | ||
| use PHPStan\Type\DynamicMethodReturnTypeExtension; | ||
| use PHPStan\Type\ObjectType; | ||
| use PHPStan\Type\Type; | ||
|
|
||
| final class TreeBuilderGetRootNodeDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension | ||
| { | ||
|
|
||
| public function getClass(): string | ||
| { | ||
| return 'Symfony\Component\Config\Definition\Builder\TreeBuilder'; | ||
| } | ||
|
|
||
| public function isMethodSupported(MethodReflection $methodReflection): bool | ||
| { | ||
| return $methodReflection->getName() === 'getRootNode'; | ||
| } | ||
|
|
||
| public function getTypeFromMethodCall( | ||
| MethodReflection $methodReflection, | ||
| MethodCall $methodCall, | ||
| Scope $scope | ||
| ): Type | ||
| { | ||
| $calledOnType = $scope->getType($methodCall->var); | ||
| if ($calledOnType instanceof TreeBuilderType) { | ||
| return new ObjectType($calledOnType->getRootNodeClassName()); | ||
| } | ||
|
|
||
| return $methodReflection->getVariants()[0]->getReturnType(); | ||
| } | ||
|
|
||
| } |
25 changes: 25 additions & 0 deletions
src/Type/Symfony/TreeBuilderType.php
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 |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Type\Symfony; | ||
|
|
||
| use PHPStan\Type\ObjectType; | ||
|
|
||
| class TreeBuilderType extends ObjectType | ||
| { | ||
|
|
||
| /** @var string */ | ||
| private $rootNodeClassName; | ||
|
|
||
| public function __construct(string $className, string $rootNodeClassName) | ||
| { | ||
| parent::__construct($className); | ||
|
|
||
| $this->rootNodeClassName = $rootNodeClassName; | ||
| } | ||
|
|
||
| public function getRootNodeClassName(): string | ||
| { | ||
| return $this->rootNodeClassName; | ||
| } | ||
|
|
||
| } |
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
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
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
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
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
39 changes: 39 additions & 0 deletions
tests/Type/Symfony/TreeBuilderDynamicReturnTypeExtensionTest.php
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 |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Type\Symfony; | ||
|
|
||
| use Iterator; | ||
|
|
||
| final class TreeBuilderDynamicReturnTypeExtensionTest extends ExtensionTestCase | ||
| { | ||
|
|
||
| /** | ||
| * @dataProvider getProvider | ||
| */ | ||
| public function testGet(string $expression, string $type): void | ||
| { | ||
| $this->processFile( | ||
| __DIR__ . '/tree_builder.php', | ||
| $expression, | ||
| $type, | ||
| [new TreeBuilderGetRootNodeDynamicReturnTypeExtension()], | ||
| [new TreeBuilderDynamicReturnTypeExtension()] | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @return \Iterator<array{string, string}> | ||
| */ | ||
| public function getProvider(): Iterator | ||
| { | ||
| yield ['$treeRootNode', 'Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition']; | ||
| yield ['$variableRootNode', 'Symfony\Component\Config\Definition\Builder\VariableNodeDefinition']; | ||
| yield ['$scalarRootNode', 'Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition']; | ||
| yield ['$booleanRootNode', 'Symfony\Component\Config\Definition\Builder\BooleanNodeDefinition']; | ||
| yield ['$integerRootNode', 'Symfony\Component\Config\Definition\Builder\IntegerNodeDefinition']; | ||
| yield ['$floatRootNode', 'Symfony\Component\Config\Definition\Builder\FloatNodeDefinition']; | ||
| yield ['$arrayRootNode', 'Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition']; | ||
| yield ['$enumRootNode', 'Symfony\Component\Config\Definition\Builder\EnumNodeDefinition']; | ||
| } | ||
|
|
||
| } |
29 changes: 29 additions & 0 deletions
tests/Type/Symfony/tree_builder.php
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 |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| use Symfony\Component\Config\Definition\Builder\TreeBuilder; | ||
|
|
||
| $treeBuilder = new TreeBuilder('my_tree'); | ||
| $treeRootNode = $treeBuilder->getRootNode(); | ||
|
|
||
| $variableTreeBuilder = new TreeBuilder('my_tree', 'variable'); | ||
| $variableRootNode = $variableTreeBuilder->getRootNode(); | ||
|
|
||
| $scalarTreeBuilder = new TreeBuilder('my_tree', 'scalar'); | ||
| $scalarRootNode = $scalarTreeBuilder->getRootNode(); | ||
|
|
||
| $booleanTreeBuilder = new TreeBuilder('my_tree', 'boolean'); | ||
| $booleanRootNode = $booleanTreeBuilder->getRootNode(); | ||
|
|
||
| $integerTreeBuilder = new TreeBuilder('my_tree', 'integer'); | ||
| $integerRootNode = $integerTreeBuilder->getRootNode(); | ||
|
|
||
| $floatTreeBuilder = new TreeBuilder('my_tree', 'float'); | ||
| $floatRootNode = $floatTreeBuilder->getRootNode(); | ||
|
|
||
| $arrayTreeBuilder = new TreeBuilder('my_tree', 'array'); | ||
| $arrayRootNode = $arrayTreeBuilder->getRootNode(); | ||
|
|
||
| $enumTreeBuilder = new TreeBuilder('my_tree', 'enum'); | ||
| $enumRootNode = $enumTreeBuilder->getRootNode(); | ||
|
|
||
| die; |
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.