feature symfony#61480 [TypeInfo] Add extra type alias support (mtarld)

fabpot · fabpot · commit 32b347f82689 · 2025-08-22T09:27:50.000+02:00
This PR was merged into the 7.4 branch. Discussion ---------- [TypeInfo] Add extra type alias support | Q | A | ------------- | --- | Branch? | 7.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | Fix symfony#61302 | License | MIT Add support for custom extra type aliases. When using Symfony as a framework, they can be defined as follows: ```yaml framework: type_info: aliases: CustomAlias: int ``` Commits ------- 2be7e06 [TypeInfo] Add extra type alias support
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
  * Allow using their name without added suffix when using `#[Target]` for custom services
  * Deprecate `Symfony\Bundle\FrameworkBundle\Console\Application::add()` in favor of `Symfony\Bundle\FrameworkBundle\Console\Application::addCommand()`
  * Add `assertEmailAddressNotContains()` to the `MailerAssertionsTrait`
+ * Add `framework.type_info.aliases` option
 
 7.3
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -1304,6 +1304,17 @@ private function addTypeInfoSection(ArrayNodeDefinition $rootNode, callable $ena
                 ->arrayNode('type_info')
                     ->info('Type info configuration')
                     ->{$enableIfStandalone('symfony/type-info', Type::class)}()
+                    ->addDefaultsIfNotSet()
+                    ->fixXmlConfig('alias', 'aliases')
+                    ->children()
+                        ->arrayNode('aliases')
+                            ->info('Additional type aliases to be used during type context creation.')
+                            ->defaultValue([])
+                            ->normalizeKeys(false)
+                            ->useAttributeAsKey('name')
+                            ->scalarPrototype()->end()
+                        ->end()
+                    ->end()
                 ->end()
             ->end()
         ;
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -469,7 +469,7 @@ public function load(array $configs, ContainerBuilder $container): void
         }
 
         if ($typeInfoEnabled = $this->readConfigEnabled('type_info', $container, $config['type_info'])) {
-            $this->registerTypeInfoConfiguration($container, $loader);
+            $this->registerTypeInfoConfiguration($config['type_info'], $container, $loader);
         }
 
         if ($propertyInfoEnabled) {
@@ -2170,7 +2170,7 @@ private function registerPropertyInfoConfiguration(array $config, ContainerBuild
         }
     }
 
-    private function registerTypeInfoConfiguration(ContainerBuilder $container, PhpFileLoader $loader): void
+    private function registerTypeInfoConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void
     {
         if (!class_exists(Type::class)) {
             throw new LogicException('TypeInfo support cannot be enabled as the TypeInfo component is not installed. Try running "composer require symfony/type-info".');
@@ -2179,7 +2179,8 @@ private function registerTypeInfoConfiguration(ContainerBuilder $container, PhpF
         $loader->load('type_info.php');
 
         if (ContainerBuilder::willBeAvailable('phpstan/phpdoc-parser', PhpDocParser::class, ['symfony/framework-bundle', 'symfony/type-info'])) {
-            $container->register('type_info.resolver.string', StringTypeResolver::class);
+            $container->register('type_info.resolver.string', StringTypeResolver::class)
+                ->setArguments([null, null, $config['aliases']]);
 
             $container->register('type_info.resolver.reflection_parameter.phpdoc_aware', PhpDocAwareReflectionTypeResolver::class)
                 ->setArguments([new Reference('type_info.resolver.reflection_parameter'), new Reference('type_info.resolver.string'), new Reference('type_info.type_context_factory')]);
@@ -2196,6 +2197,8 @@ private function registerTypeInfoConfiguration(ContainerBuilder $container, PhpF
                 \ReflectionProperty::class => new Reference('type_info.resolver.reflection_property.phpdoc_aware'),
                 \ReflectionFunctionAbstract::class => new Reference('type_info.resolver.reflection_return.phpdoc_aware'),
             ] + $resolversLocator->getValues());
+
+            $container->getDefinition('type_info.type_context_factory')->replaceArgument(1, $config['aliases']);
         }
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -382,7 +382,18 @@
     </xsd:complexType>
 
     <xsd:complexType name="type_info">
-        <xsd:attribute name="enabled" type="xsd:boolean" />
+        <xsd:sequence>
+            <xsd:element name="alias" minOccurs="0" maxOccurs="unbounded">
+                <xsd:complexType>
+                    <xsd:simpleContent>
+                        <xsd:extension base="xsd:string">
+                            <xsd:attribute name="name" type="xsd:string" use="required"/>
+                        </xsd:extension>
+                    </xsd:simpleContent>
+                </xsd:complexType>
+            </xsd:element>
+        </xsd:sequence>
+        <xsd:attribute name="enabled" type="xsd:boolean"/>
     </xsd:complexType>
 
     <xsd:complexType name="named_serializer_options">
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/type_info.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/type_info.php
@@ -23,7 +23,10 @@
     $container->services()
         // type context
         ->set('type_info.type_context_factory', TypeContextFactory::class)
-            ->args([service('type_info.resolver.string')->nullOnInvalid()])
+            ->args([
+                service('type_info.resolver.string')->nullOnInvalid(),
+                [],
+            ])
 
         // type resolvers
         ->set('type_info.resolver', TypeResolver::class)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -812,6 +812,7 @@ protected static function getBundleDefaultConfig()
             ],
             'type_info' => [
                 'enabled' => !class_exists(FullStack::class) && class_exists(Type::class),
+                'aliases' => [],
             ],
             'property_info' => [
                 'enabled' => !class_exists(FullStack::class),
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/type_info.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/type_info.php
@@ -7,5 +7,8 @@
     'php_errors' => ['log' => true],
     'type_info' => [
         'enabled' => true,
+        'aliases' => [
+            'CustomAlias' => 'int',
+        ],
     ],
 ]);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/type_info.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/type_info.xml
@@ -8,6 +8,8 @@
     <framework:config http-method-override="false" handle-all-throwables="true">
         <framework:annotations enabled="false" />
         <framework:php-errors log="true" />
-        <framework:type-info enabled="true" />
+        <framework:type-info enabled="true">
+            <framework:alias name="CustomAlias">int</framework:alias>
+        </framework:type-info>
     </framework:config>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/type_info.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/type_info.yml
@@ -6,3 +6,5 @@ framework:
         log: true
     type_info:
         enabled: true
+        aliases:
+            CustomAlias: int
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/TypeInfoTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/TypeInfoTest.php
@@ -13,6 +13,7 @@
 
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use Symfony\Bundle\FrameworkBundle\Tests\Functional\app\TypeInfo\Dummy;
+use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\TypeInfo\Type;
 
 class TypeInfoTest extends AbstractWebTestCase
@@ -28,5 +29,10 @@ public function testComponent()
         }
 
         $this->assertEquals(Type::int(), static::getContainer()->get('type_info.resolver')->resolve('int'));
+
+        if (Kernel::VERSION_ID >= 70400) {
+            $this->assertEquals(Type::int(), static::getContainer()->get('type_info.resolver')->resolve(new \ReflectionProperty(Dummy::class, 'customAlias')));
+            $this->assertEquals(Type::int(), static::getContainer()->get('type_info.resolver')->resolve('CustomAlias'));
+        }
     }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/TypeInfo/Dummy.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/TypeInfo/Dummy.php
@@ -18,4 +18,9 @@
 class Dummy
 {
     public string $name;
+
+    /**
+     * @var CustomAlias
+     */
+    public mixed $customAlias;
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/TypeInfo/config.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/TypeInfo/config.yml
@@ -3,7 +3,9 @@ imports:
 
 framework:
     http_method_override: false
-    type_info: true
+    type_info:
+        aliases:
+            CustomAlias: int
 
 services:
     type_info.resolver.alias:
diff --git a/src/Symfony/Component/TypeInfo/CHANGELOG.md b/src/Symfony/Component/TypeInfo/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.4
+---
+
+ * Add extra type alias support in `TypeContext` and `StringTypeResolver`
+
 7.3
 ---
 
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeContext/TypeContextFactoryTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeContext/TypeContextFactoryTest.php
@@ -186,6 +186,31 @@ public function testCollectTypeAliases()
         ], $this->typeContextFactory->createFromReflection(new \ReflectionClass(DummyWithImportedOnlyTypeAliases::class))->typeAliases);
     }
 
+    public function testCollectTypeAliasesWithExtraTypeAliases()
+    {
+        $typeContextFactory = new TypeContextFactory(new StringTypeResolver(), [
+            'Custom' => Type::int(),
+            'CustomArray' => Type::list(Type::bool()), // will be overridden by the resolved type alias
+        ]);
+
+        $this->assertEquals([
+            'Custom' => Type::int(),
+            'CustomArray' => Type::list(Type::bool()),
+        ], $typeContextFactory->createFromClassName(Dummy::class)->typeAliases);
+
+        $this->assertEquals([
+            'Custom' => Type::int(),
+            'CustomString' => Type::string(),
+            'CustomInt' => Type::int(),
+            'CustomArray' => Type::arrayShape([0 => Type::int(), 1 => Type::string(), 2 => Type::bool()]),
+            'AliasedCustomInt' => Type::int(),
+            'PsalmCustomString' => Type::string(),
+            'PsalmCustomInt' => Type::int(),
+            'PsalmCustomArray' => Type::arrayShape([0 => Type::int(), 1 => Type::string(), 2 => Type::bool()]),
+            'PsalmAliasedCustomInt' => Type::int(),
+        ], $typeContextFactory->createFromClassName(DummyWithTypeAliases::class)->typeAliases);
+    }
+
     public function testDoNotCollectTypeAliasesWhenToStringTypeResolver()
     {
         $typeContextFactory = new TypeContextFactory();
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php
@@ -201,6 +201,13 @@ public static function resolveDataProvider(): iterable
         yield [Type::string(), 'CustomString', $typeContextFactory->createFromClassName(DummyWithTypeAliases::class)];
     }
 
+    public function testResolveWithExtraTypeAlias()
+    {
+        $resolver = new StringTypeResolver(null, null, ['CustomAlias' => 'int']);
+
+        $this->assertEquals(Type::int(), $resolver->resolve('CustomAlias'));
+    }
+
     public function testCannotResolveNonStringType()
     {
         $this->expectException(UnsupportedException::class);
diff --git a/src/Symfony/Component/TypeInfo/TypeContext/TypeContextFactory.php b/src/Symfony/Component/TypeInfo/TypeContext/TypeContextFactory.php
@@ -44,8 +44,12 @@ final class TypeContextFactory
     private ?Lexer $phpstanLexer = null;
     private ?PhpDocParser $phpstanParser = null;
 
+    /**
+     * @param array<string, string> $extraTypeAliases
+     */
     public function __construct(
         private readonly ?StringTypeResolver $stringTypeResolver = null,
+        private readonly array $extraTypeAliases = [],
     ) {
     }
 
@@ -194,8 +198,10 @@ private function collectTypeAliases(\ReflectionClass $reflection, TypeContext $t
             return [];
         }
 
+        $extraAliases = array_map($this->stringTypeResolver->resolve(...), $this->extraTypeAliases);
+
         if (!$rawDocNode = $reflection->getDocComment()) {
-            return [];
+            return $extraAliases;
         }
 
         $aliases = [];
@@ -229,7 +235,7 @@ private function collectTypeAliases(\ReflectionClass $reflection, TypeContext $t
             $aliases[$tag->value->alias] = (string) $tag->value->type;
         }
 
-        return $this->resolveTypeAliases($aliases, $resolvedAliases, $typeContext);
+        return $this->resolveTypeAliases($aliases, $resolvedAliases, $typeContext) + $extraAliases;
     }
 
     /**
diff --git a/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php b/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php
@@ -62,8 +62,14 @@ final class StringTypeResolver implements TypeResolverInterface
     private readonly Lexer $lexer;
     private readonly TypeParser $parser;
 
-    public function __construct(?Lexer $lexer = null, ?TypeParser $parser = null)
-    {
+    /**
+     * @param array<string, string> $extraTypeAliases
+     */
+    public function __construct(
+        ?Lexer $lexer = null,
+        ?TypeParser $parser = null,
+        private readonly array $extraTypeAliases = [],
+    ) {
         if (class_exists(ParserConfig::class)) {
             $this->lexer = $lexer ?? new Lexer(new ParserConfig([]));
             $this->parser = $parser ?? new TypeParser($config = new ParserConfig([]), new ConstExprParser($config));
@@ -339,6 +345,10 @@ private function resolveCustomIdentifier(string $identifier, ?TypeContext $typeC
             return $typeContext->typeAliases[$identifier];
         }
 
+        if (isset($this->extraTypeAliases[$identifier])) {
+            return $this->resolve($this->extraTypeAliases[$identifier]);
+        }
+
         throw new \DomainException(\sprintf('Unhandled "%s" identifier.', $identifier));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -469,7 +469,7 @@ public function load(array $configs, ContainerBuilder $container): void`
`469`	`469`	`}`
`470`	`470`
`471`	`471`	`if ($typeInfoEnabled = $this->readConfigEnabled('type_info', $container, $config['type_info'])) {`
`472`		`- $this->registerTypeInfoConfiguration($container, $loader);`
	`472`	`+ $this->registerTypeInfoConfiguration($config['type_info'], $container, $loader);`
`473`	`473`	`}`
`474`	`474`
`475`	`475`	`if ($propertyInfoEnabled) {`
`@@ -2170,7 +2170,7 @@ private function registerPropertyInfoConfiguration(array $config, ContainerBuild`
`2170`	`2170`	`}`
`2171`	`2171`	`}`
`2172`	`2172`
`2173`		`- private function registerTypeInfoConfiguration(ContainerBuilder $container, PhpFileLoader $loader): void`
	`2173`	`+ private function registerTypeInfoConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void`
`2174`	`2174`	`{`
`2175`	`2175`	`if (!class_exists(Type::class)) {`
`2176`	`2176`	`throw new LogicException('TypeInfo support cannot be enabled as the TypeInfo component is not installed. Try running "composer require symfony/type-info".');`
`@@ -2179,7 +2179,8 @@ private function registerTypeInfoConfiguration(ContainerBuilder $container, PhpF`
`2179`	`2179`	`$loader->load('type_info.php');`
`2180`	`2180`
`2181`	`2181`	`if (ContainerBuilder::willBeAvailable('phpstan/phpdoc-parser', PhpDocParser::class, ['symfony/framework-bundle', 'symfony/type-info'])) {`
`2182`		`- $container->register('type_info.resolver.string', StringTypeResolver::class);`
	`2182`	`+ $container->register('type_info.resolver.string', StringTypeResolver::class)`
	`2183`	`+ ->setArguments([null, null, $config['aliases']]);`
`2183`	`2184`
`2184`	`2185`	`$container->register('type_info.resolver.reflection_parameter.phpdoc_aware', PhpDocAwareReflectionTypeResolver::class)`
`2185`	`2186`	`->setArguments([new Reference('type_info.resolver.reflection_parameter'), new Reference('type_info.resolver.string'), new Reference('type_info.type_context_factory')]);`
`@@ -2196,6 +2197,8 @@ private function registerTypeInfoConfiguration(ContainerBuilder $container, PhpF`
`2196`	`2197`	`\ReflectionProperty::class => new Reference('type_info.resolver.reflection_property.phpdoc_aware'),`
`2197`	`2198`	`\ReflectionFunctionAbstract::class => new Reference('type_info.resolver.reflection_return.phpdoc_aware'),`
`2198`	`2199`	`] + $resolversLocator->getValues());`
	`2200`	`+`
	`2201`	`+ $container->getDefinition('type_info.type_context_factory')->replaceArgument(1, $config['aliases']);`
`2199`	`2202`	`}`
`2200`	`2203`	`}`
`2201`	`2204`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`use PHPStan\PhpDocParser\Parser\PhpDocParser;`
`15`	`15`	`use Symfony\Bundle\FrameworkBundle\Tests\Functional\app\TypeInfo\Dummy;`
	`16`	`+use Symfony\Component\HttpKernel\Kernel;`
`16`	`17`	`use Symfony\Component\TypeInfo\Type;`
`17`	`18`
`18`	`19`	`class TypeInfoTest extends AbstractWebTestCase`
`@@ -28,5 +29,10 @@ public function testComponent()`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`$this->assertEquals(Type::int(), static::getContainer()->get('type_info.resolver')->resolve('int'));`
	`32`	`+`
	`33`	`+ if (Kernel::VERSION_ID >= 70400) {`
	`34`	`+ $this->assertEquals(Type::int(), static::getContainer()->get('type_info.resolver')->resolve(new \ReflectionProperty(Dummy::class, 'customAlias')));`
	`35`	`+ $this->assertEquals(Type::int(), static::getContainer()->get('type_info.resolver')->resolve('CustomAlias'));`
	`36`	`+ }`
`31`	`37`	`}`
`32`	`38`	`}`