[TypeInfo] Add extra type alias support

Author: mtarld

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
 ---

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()
         ;

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']);
         }
     }
 

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">

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)

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),

Tests/DependencyInjection/Fixtures/php/type_info.php

@@ -7,5 +7,8 @@
     'php_errors' => ['log' => true],
     'type_info' => [
         'enabled' => true,
+        'aliases' => [
+            'CustomAlias' => 'int',
+        ],
     ],
 ]);

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>

Tests/DependencyInjection/Fixtures/yml/type_info.yml

@@ -6,3 +6,5 @@ framework:
         log: true
     type_info:
         enabled: true
+        aliases:
+            CustomAlias: int

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'));
+        }
     }
 }