feature symfony#49665 [DependencyInjection] Add constructor option to #[Autoconfigure] (alexandre-daubois)

This PR was merged into the 6.3 branch.

Discussion
----------

[DependencyInjection] Add `constructor` option to `#[Autoconfigure]`

| Q             | A
| ------------- | ---
| Branch?       | 6.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | _NA_
| License       | MIT
| Doc PR        | symfony/symfony-docs#18070

Following [this discussion](https://twitter.com/nicolasgrekas/status/1634259754104025088?s=20) on Twitter, here is my try to use service factories with attributes. This PR adds the `constructor` option to the `Autoconfigure` attribute, and more generally, the `constructor` option on service definitions.

This allows to write services using a factory this way:

```php
#[Autoconfigure(constructor: 'create')]
class FactoryAttributeService
{
    public function __construct(private readonly string $bar)
    {
    }

    public function getBar(): string
    {
        return $this->bar;
    }

    public static function create(string $foo = 'foo'): static
    {
        return new self($foo);
    }
}
```

Commits
-------

8dda3f0 [DependencyInjection] Add `constructor` option to services declaration and to `#[Autoconfigure]`

Author: fabpot

src/Symfony/Component/DependencyInjection/Attribute/Autoconfigure.php

@@ -29,6 +29,7 @@ public function __construct(
         public ?bool $autowire = null,
         public ?array $properties = null,
         public array|string|null $configurator = null,
+        public string|null $constructor = null,
     ) {
     }
 }

src/Symfony/Component/DependencyInjection/CHANGELOG.md

@@ -21,6 +21,7 @@ CHANGELOG
  * Make it possible to cast callables into single-method interfaces
  * Deprecate `#[MapDecorated]`, use `#[AutowireDecorated]` instead
  * Deprecate the `@required` annotation, use the `Symfony\Contracts\Service\Attribute\Required` attribute instead
+ * Add `constructor` option to services declaration and to `#[Autoconfigure]`
 
 6.2
 ---

src/Symfony/Component/DependencyInjection/Dumper/XmlDumper.php

@@ -167,20 +167,24 @@ private function addService(Definition $definition, ?string $id, \DOMElement $pa
         $this->addMethodCalls($definition->getMethodCalls(), $service);
 
         if ($callable = $definition->getFactory()) {
-            $factory = $this->document->createElement('factory');
-
-            if (\is_array($callable) && $callable[0] instanceof Definition) {
-                $this->addService($callable[0], null, $factory);
-                $factory->setAttribute('method', $callable[1]);
-            } elseif (\is_array($callable)) {
-                if (null !== $callable[0]) {
-                    $factory->setAttribute($callable[0] instanceof Reference ? 'service' : 'class', $callable[0]);
-                }
-                $factory->setAttribute('method', $callable[1]);
+            if (\is_array($callable) && ['Closure', 'fromCallable'] !== $callable && $definition->getClass() === $callable[0]) {
+                $service->setAttribute('constructor', $callable[1]);
             } else {
-                $factory->setAttribute('function', $callable);
+                $factory = $this->document->createElement('factory');
+
+                if (\is_array($callable) && $callable[0] instanceof Definition) {
+                    $this->addService($callable[0], null, $factory);
+                    $factory->setAttribute('method', $callable[1]);
+                } elseif (\is_array($callable)) {
+                    if (null !== $callable[0]) {
+                        $factory->setAttribute($callable[0] instanceof Reference ? 'service' : 'class', $callable[0]);
+                    }
+                    $factory->setAttribute('method', $callable[1]);
+                } else {
+                    $factory->setAttribute('function', $callable);
+                }
+                $service->appendChild($factory);
             }
-            $service->appendChild($factory);
         }
 
         if ($definition->isDeprecated()) {

src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php

@@ -151,7 +151,11 @@ private function addService(string $id, Definition $definition): string
         }
 
         if ($callable = $definition->getFactory()) {
-            $code .= sprintf("        factory: %s\n", $this->dumper->dump($this->dumpCallable($callable), 0));
+            if (\is_array($callable) && ['Closure', 'fromCallable'] !== $callable && $definition->getClass() === $callable[0]) {
+                $code .= sprintf("        constructor: %s\n", $callable[1]);
+            } else {
+                $code .= sprintf("        factory: %s\n", $this->dumper->dump($this->dumpCallable($callable), 0));
+            }
         }
 
         if ($callable = $definition->getConfigurator()) {

src/Symfony/Component/DependencyInjection/Loader/Configurator/InlineServiceConfigurator.php

@@ -23,6 +23,7 @@ class InlineServiceConfigurator extends AbstractConfigurator
     use Traits\BindTrait;
     use Traits\CallTrait;
     use Traits\ConfiguratorTrait;
+    use Traits\ConstructorTrait;
     use Traits\FactoryTrait;
     use Traits\FileTrait;
     use Traits\LazyTrait;

src/Symfony/Component/DependencyInjection/Loader/Configurator/InstanceofConfigurator.php

@@ -22,6 +22,7 @@ class InstanceofConfigurator extends AbstractServiceConfigurator
     use Traits\BindTrait;
     use Traits\CallTrait;
     use Traits\ConfiguratorTrait;
+    use Traits\ConstructorTrait;
     use Traits\LazyTrait;
     use Traits\PropertyTrait;
     use Traits\PublicTrait;

src/Symfony/Component/DependencyInjection/Loader/Configurator/PrototypeConfigurator.php

@@ -26,6 +26,7 @@ class PrototypeConfigurator extends AbstractServiceConfigurator
     use Traits\BindTrait;
     use Traits\CallTrait;
     use Traits\ConfiguratorTrait;
+    use Traits\ConstructorTrait;
     use Traits\DeprecateTrait;
     use Traits\FactoryTrait;
     use Traits\LazyTrait;

src/Symfony/Component/DependencyInjection/Loader/Configurator/ServiceConfigurator.php

@@ -27,6 +27,7 @@ class ServiceConfigurator extends AbstractServiceConfigurator
     use Traits\CallTrait;
     use Traits\ClassTrait;
     use Traits\ConfiguratorTrait;
+    use Traits\ConstructorTrait;
     use Traits\DecorateTrait;
     use Traits\DeprecateTrait;
     use Traits\FactoryTrait;

src/Symfony/Component/DependencyInjection/Loader/Configurator/Traits/ConstructorTrait.php

@@ -0,0 +1,27 @@
+<?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\DependencyInjection\Loader\Configurator\Traits;
+
+trait ConstructorTrait
+{
+    /**
+     * Sets a static constructor.
+     *
+     * @return $this
+     */
+    final public function constructor(string $constructor): static
+    {
+        $this->definition->setFactory([null, $constructor]);
+
+        return $this;
+    }
+}

src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php

@@ -24,6 +24,7 @@
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
 use Symfony\Component\DependencyInjection\Reference;
@@ -314,6 +315,14 @@ private function parseDefinition(\DOMElement $service, string $file, Definition
             }
         }
 
+        if ($constructor = $service->getAttribute('constructor')) {
+            if (null !== $definition->getFactory()) {
+                throw new LogicException(sprintf('The "%s" service cannot declare a factory as well as a constructor.', $service->getAttribute('id')));
+            }
+
+            $definition->setFactory([null, $constructor]);
+        }
+
         if ($configurators = $this->getChildren($service, 'configurator')) {
             $configurator = $configurators[0];
             if ($function = $configurator->getAttribute('function')) {