[PropertyInfo] ConstructorExtractor which has higher priority than PhpDocExtractor and ReflectionExtractor #30128
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <[email protected]> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\PropertyInfo\DependencyInjection; | ||
|
|
||
| use Symfony\Component\DependencyInjection\Argument\IteratorArgument; | ||
| use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; | ||
| use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait; | ||
| use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
|
|
||
| /** | ||
| * Adds extractors to the property_info.constructor_extractor service. | ||
| * | ||
| * @author Dmitrii Poddubnyi <[email protected]> | ||
| */ | ||
| class PropertyInfoConstructorPass implements CompilerPassInterface | ||
| { | ||
| use PriorityTaggedServiceTrait; | ||
|
|
||
| private $service; | ||
| private $tag; | ||
|
|
||
| public function __construct($service = 'property_info.constructor_extractor', $tag = 'property_info.constructor_extractor') | ||
| { | ||
| $this->service = $service; | ||
| $this->tag = $tag; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function process(ContainerBuilder $container) | ||
| { | ||
| if (!$container->hasDefinition($this->service)) { | ||
| return; | ||
| } | ||
| $definition = $container->getDefinition($this->service); | ||
|
|
||
| $listExtractors = $this->findAndSortTaggedServices($this->tag, $container); | ||
| $definition->replaceArgument(0, new IteratorArgument($listExtractors)); | ||
| } | ||
| } |
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,32 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <[email protected]> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\PropertyInfo\Extractor; | ||
|
|
||
| use Symfony\Component\PropertyInfo\Type; | ||
|
|
||
| /** | ||
| * Infers the constructor argument type. | ||
| * | ||
| * @author Dmitrii Poddubnyi <[email protected]> | ||
| */ | ||
| interface ConstructorArgumentTypeExtractorInterface | ||
| { | ||
| /** | ||
| * Gets types of an argument from constructor. | ||
| * | ||
| * @param string $class | ||
| * @param string $property | ||
| * | ||
| * @return Type[]|null | ||
| */ | ||
| public function getTypesFromConstructor($class, $property); | ||
| } | ||
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,48 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <[email protected]> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\PropertyInfo\Extractor; | ||
|
|
||
| use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface; | ||
|
|
||
| /** | ||
| * Extracts the constructor argument type using ConstructorArgumentTypeExtractorInterface implementations. | ||
| * | ||
| * @author Dmitrii Poddubnyi <[email protected]> | ||
| */ | ||
| class ConstructorExtractor implements PropertyTypeExtractorInterface | ||
| { | ||
| /** @var iterable|ConstructorArgumentTypeExtractorInterface[] */ | ||
| private $extractors; | ||
|
|
||
| /** | ||
| * @param iterable|ConstructorArgumentTypeExtractorInterface[] $extractors | ||
| */ | ||
| public function __construct($extractors = []) | ||
| { | ||
| $this->extractors = $extractors; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getTypes($class, $property, array $context = []) | ||
| { | ||
| foreach ($this->extractors as $extractor) { | ||
| $value = $extractor->getTypesFromConstructor($class, $property); | ||
| if (null !== $value) { | ||
| return $value; | ||
| } | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
| } |
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 |
|---|---|---|
|
|
@@ -27,7 +27,7 @@ | |
| * | ||
| * @final | ||
| */ | ||
| class PhpDocExtractor implements PropertyDescriptionExtractorInterface, PropertyTypeExtractorInterface, ConstructorArgumentTypeExtractorInterface | ||
| { | ||
| const PROPERTY = 0; | ||
| const ACCESSOR = 1; | ||
|
|
@@ -151,6 +151,77 @@ public function getTypes($class, $property, array $context = []) | |
| return [new Type(Type::BUILTIN_TYPE_ARRAY, false, null, true, new Type(Type::BUILTIN_TYPE_INT), $types[0])]; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getTypesFromConstructor($class, $property) | ||
| { | ||
| $docBlock = $this->getDocBlockFromConstructor($class, $property); | ||
|
|
||
| if (!$docBlock) { | ||
| return; | ||
| } | ||
|
|
||
| $types = []; | ||
| /** @var DocBlock\Tags\Var_|DocBlock\Tags\Return_|DocBlock\Tags\Param $tag */ | ||
| foreach ($docBlock->getTagsByName('param') as $tag) { | ||
| if ($tag && null !== $tag->getType()) { | ||
| $types = array_merge($types, $this->phpDocTypeHelper->getTypes($tag->getType())); | ||
| } | ||
| } | ||
|
|
||
| if (!isset($types[0])) { | ||
| return; | ||
| } | ||
|
|
||
| return $types; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the DocBlock from a constructor. | ||
| * | ||
| * @param string $class | ||
| * @param string $property | ||
| * | ||
| * @return DocBlock|null | ||
| */ | ||
| private function getDocBlockFromConstructor($class, $property) | ||
| { | ||
| try { | ||
| $reflectionClass = new \ReflectionClass($class); | ||
| } catch (\ReflectionException $e) { | ||
| return null; | ||
| } | ||
| $reflectionConstructor = $reflectionClass->getConstructor(); | ||
| if (!$reflectionConstructor) { | ||
| return null; | ||
| } | ||
|
|
||
| try { | ||
| $docBlock = $this->docBlockFactory->create($reflectionConstructor, $this->contextFactory->createFromReflector($reflectionConstructor)); | ||
|
|
||
| return $this->filterDocBlockParams($docBlock, $property); | ||
| } catch (\InvalidArgumentException $e) { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param DocBlock $docBlock | ||
| * @param string $allowedParam | ||
| * | ||
| * @return DocBlock | ||
| */ | ||
| private function filterDocBlockParams(DocBlock $docBlock, $allowedParam) | ||
|
There was a problem hiding this comment. You should use type hints and return types wherever possible as this is for 4.2 and new code if I am right There was a problem hiding this comment. @OskarStark I applied the type hints in #30335 |
||
| { | ||
| $tags = array_values(array_filter($docBlock->getTagsByName('param'), function ($tag) use ($allowedParam) { | ||
| return $tag instanceof DocBlock\Tags\Param && $allowedParam === $tag->getVariableName(); | ||
| })); | ||
|
|
||
| return new DocBlock($docBlock->getSummary(), $docBlock->getDescription(), $tags, $docBlock->getContext(), | ||
| $docBlock->getLocation(), $docBlock->isTemplateStart(), $docBlock->isTemplateEnd()); | ||
| } | ||
|
|
||
| private function getDocBlock(string $class, string $property): array | ||
| { | ||
| $propertyHash = sprintf('%s::%s', $class, $property); | ||
|
|
||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you should add typehints and return type