[DependencyInjection] add #[AsFactory] attribute for declaring factory services

santysisi · santysisi · commit 5b8b26d54abb · 2025-06-18T20:03:09.000-03:00
diff --git a/src/Symfony/Component/DependencyInjection/Attribute/Autoconfigure.php b/src/Symfony/Component/DependencyInjection/Attribute/Autoconfigure.php
@@ -30,6 +30,7 @@ class Autoconfigure
      * @param array<string, mixed>|null                               $properties   The properties to define when creating the service
      * @param array{string, string}|string|null                       $configurator A PHP function, reference or an array containing a class/reference and a method to call after the service is fully initialized
      * @param string|null                                             $constructor  The public static method to use to instantiate the service
+     * @param array<string|null, string|null>|string|null             $factory      The factory that defines how to create the service
      */
     public function __construct(
         public ?array $tags = null,
@@ -42,6 +43,7 @@ public function __construct(
         public ?array $properties = null,
         public array|string|null $configurator = null,
         public ?string $constructor = null,
+        public array|string|null $factory = null,
     ) {
     }
 }
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Allow `#[AsAlias]` to be extended
+ * Add `factory` argument to the `#[Autoconfigure]` attribute to define how the service should be instantiated using a factory
 
 7.3
 ---
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -100,6 +100,7 @@ class YamlFileLoader extends FileLoader
         'autowire' => 'autowire',
         'bind' => 'bind',
         'constructor' => 'constructor',
+        'factory' => 'factory',
     ];
 
     private const DEFAULTS_KEYWORDS = [
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterAutoconfigureAttributesPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterAutoconfigureAttributesPassTest.php
@@ -26,6 +26,12 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfigureRepeatedOverwrite;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfigureRepeatedProperties;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfigureRepeatedTag;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfigureWithExpressionFactory;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfigureWithInstanceExternalFactory;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfigureWithInvokableFactory;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfigureWithStaticExternalFactory;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\AutoconfigureWithStaticSelfFactory;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\FactoryDummy;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\LazyAutoconfigured;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\LazyLoaded;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\MultipleAutoconfigureAttributed;
@@ -208,6 +214,88 @@ public function testStaticConstructor()
         $this->assertEquals([StaticConstructorAutoconfigure::class => $expected], $container->getAutoconfiguredInstanceof());
     }
 
+    public function testAutoconfigureWithStaticSelfFactory()
+    {
+        $container = new ContainerBuilder();
+        $container->register('foo', AutoconfigureWithStaticSelfFactory::class)
+            ->setAutoconfigured(true);
+
+        $argument = new BoundArgument('foo', false, BoundArgument::INSTANCEOF_BINDING, realpath(__DIR__.'/../Fixtures/AutoconfigureWithStaticSelfFactory.php'));
+
+        (new RegisterAutoconfigureAttributesPass())->process($container);
+
+        $expected = (new ChildDefinition(''))
+            ->setFactory([null, 'create'])
+            ->setBindings(['$foo' => $argument])
+        ;
+        $this->assertEquals([AutoconfigureWithStaticSelfFactory::class => $expected], $container->getAutoconfiguredInstanceof());
+    }
+
+    public function testAutoconfigureWithStaticExternalFactory()
+    {
+        $container = new ContainerBuilder();
+        $container->register('foo', AutoconfigureWithStaticExternalFactory::class)
+            ->setAutoconfigured(true);
+
+        $argument = new BoundArgument('foo', false, BoundArgument::INSTANCEOF_BINDING, realpath(__DIR__.'/../Fixtures/AutoconfigureWithStaticExternalFactory.php'));
+
+        (new RegisterAutoconfigureAttributesPass())->process($container);
+
+        $expected = (new ChildDefinition(''))
+            ->setFactory([FactoryDummy::class, 'create'])
+            ->setBindings(['$foo' => $argument])
+        ;
+        $this->assertEquals([AutoconfigureWithStaticExternalFactory::class => $expected], $container->getAutoconfiguredInstanceof());
+    }
+
+    public function testAutoconfigureWithInstanceExternalFactory()
+    {
+        $container = new ContainerBuilder();
+        $container->register('foo', AutoconfigureWithInstanceExternalFactory::class)
+            ->setAutoconfigured(true);
+
+        $argument = new BoundArgument('foo', false, BoundArgument::INSTANCEOF_BINDING, realpath(__DIR__.'/../Fixtures/AutoconfigureWithInstanceExternalFactory.php'));
+
+        (new RegisterAutoconfigureAttributesPass())->process($container);
+
+        $expected = (new ChildDefinition(''))
+            ->setFactory([new Reference('factory_for_autoconfigure'), 'createStatic'])
+            ->setBindings(['$foo' => $argument])
+        ;
+        $this->assertEquals([AutoconfigureWithInstanceExternalFactory::class => $expected], $container->getAutoconfiguredInstanceof());
+    }
+
+    public function testAutoconfigureWithInvokableFactory()
+    {
+        $container = new ContainerBuilder();
+        $container->register('foo', AutoconfigureWithInvokableFactory::class)
+            ->setAutoconfigured(true);
+
+        $argument = new BoundArgument('foo', false, BoundArgument::INSTANCEOF_BINDING, realpath(__DIR__.'/../Fixtures/AutoconfigureWithInvokableFactory.php'));
+
+        (new RegisterAutoconfigureAttributesPass())->process($container);
+
+        $expected = (new ChildDefinition(''))
+            ->setFactory([new Reference('factory_for_autoconfigure'), '__invoke'])
+            ->setBindings(['$foo' => $argument])
+        ;
+        $this->assertEquals([AutoconfigureWithInvokableFactory::class => $expected], $container->getAutoconfiguredInstanceof());
+    }
+
+    public function testAutoconfigureWithExpressionFactory()
+    {
+        $container = new ContainerBuilder();
+        $container->register('foo', AutoconfigureWithExpressionFactory::class)
+            ->setAutoconfigured(true);
+
+        (new RegisterAutoconfigureAttributesPass())->process($container);
+
+        $expected = (new ChildDefinition(''))
+            ->setFactory('@=service("factory_for_autoconfigure").create()')
+        ;
+        $this->assertEquals([AutoconfigureWithExpressionFactory::class => $expected], $container->getAutoconfiguredInstanceof());
+    }
+
     public function testLazyServiceAttribute()
     {
         $container = new ContainerBuilder();
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithExpressionFactory.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithExpressionFactory.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
+
+use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
+
+#[Autoconfigure(factory: '@=service("factory_for_autoconfigure").create()')]
+class AutoconfigureWithExpressionFactory
+{
+    public function __construct(public readonly string $foo)
+    {
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithInstanceExternalFactory.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithInstanceExternalFactory.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
+
+use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
+
+#[Autoconfigure(bind: ['$foo' => 'foo'], factory: ['@factory_for_autoconfigure', 'createStatic'])]
+class AutoconfigureWithInstanceExternalFactory
+{
+    public function __construct(public readonly string $foo)
+    {
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithInvokableFactory.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithInvokableFactory.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
+
+use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
+
+#[Autoconfigure(bind: ['$foo' => 'foo'], factory: '@factory_for_autoconfigure')]
+class AutoconfigureWithInvokableFactory
+{
+    public function __construct(public readonly string $foo)
+    {
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithStaticExternalFactory.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithStaticExternalFactory.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
+
+use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
+
+#[Autoconfigure(bind: ['$foo' => 'foo'], factory: [FactoryDummy::class, 'create'])]
+class AutoconfigureWithStaticExternalFactory
+{
+    public function __construct(public readonly string $foo)
+    {
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithStaticSelfFactory.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/AutoconfigureWithStaticSelfFactory.php
@@ -0,0 +1,27 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\DependencyInjection\Tests\Fixtures;
+
+use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
+
+#[Autoconfigure(bind: ['$foo' => 'foo'], factory: [null, 'create'])]
+class AutoconfigureWithStaticSelfFactory
+{
+    public function __construct(public readonly string $foo)
+    {
+    }
+
+    public static function create(string $foo): static
+    {
+        return new self($foo);
+    }
+}
