[DependencyInjection] Autoconfigurable attributes on methods

ruudk · ruudk · commit 1b06b143a7e2 · 2021-07-09T12:57:31.000+02:00
Based on the implementation of symfony#39897 I made it possible to autoconfigure method attributes.
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.4
+---
+
+ * Add support for autoconfigurable attributes on methods
+
 5.3
 ---
 
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AttributeAutoconfigurationPass.php b/src/Symfony/Component/DependencyInjection/Compiler/AttributeAutoconfigurationPass.php
@@ -48,6 +48,13 @@ protected function processValue($value, bool $isRoot = false)
                 $configurator($conditionals, $attribute->newInstance(), $reflector);
             }
         }
+        foreach ($reflector->getMethods() as $method) {
+            foreach ($method->getAttributes() as $attribute) {
+                if ($configurator = $autoconfiguredAttributes[$attribute->getName()] ?? null) {
+                    $configurator($conditionals, $attribute->newInstance(), $method);
+                }
+            }
+        }
         if (!isset($instanceof[$reflector->getName()]) && new ChildDefinition('') != $conditionals) {
             $instanceof[$reflector->getName()] = $conditionals;
             $value->setInstanceofConditionals($instanceof);
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -1309,7 +1309,7 @@ public function registerForAutoconfiguration(string $interface)
     /**
      * Registers an attribute that will be used for autoconfiguring annotated classes.
      *
-     * The configurator will receive a ChildDefinition instance, an instance of the attribute and the corresponding \ReflectionClass, in that order.
+     * The configurator will receive a ChildDefinition instance, an instance of the attribute and the corresponding \ReflectionClass or \ReflectionMethod, in that order.
      */
     public function registerAttributeForAutoconfiguration(string $attributeClass, callable $configurator): void
     {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/IntegrationTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/IntegrationTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DependencyInjection\Tests\Compiler;
 
 use PHPUnit\Framework\TestCase;
+use ReflectionMethod;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
@@ -24,6 +25,7 @@
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\ServiceLocator;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\Attribute\CustomAutoconfiguration;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\Attribute\CustomMethodAttribute;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\BarTagClass;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\FooBarTaggedClass;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\FooBarTaggedForDefaultPriorityClass;
@@ -36,6 +38,7 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\TaggedService2;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\TaggedService3;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\TaggedService3Configurator;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\TaggedService4;
 use Symfony\Contracts\Service\ServiceProviderInterface;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
 
@@ -699,6 +702,39 @@ static function (Definition $definition, CustomAutoconfiguration $attribute) {
         ], $collector->collectedTags);
     }
 
+    /**
+     * @requires PHP 8
+     */
+    public function testTagsViaAttributeOnMethods()
+    {
+        $container = new ContainerBuilder();
+        $container->registerAttributeForAutoconfiguration(
+            CustomMethodAttribute::class,
+            static function (ChildDefinition $definition, CustomMethodAttribute $attribute, ReflectionMethod $reflector) {
+                $tagAttributes = get_object_vars($attribute);
+                $tagAttributes['method'] = $reflector->getName();
+
+                $definition->addTag('app.custom_tag', $tagAttributes);
+            }
+        );
+
+        $container->register(TaggedService4::class)
+            ->setPublic(true)
+            ->setAutoconfigured(true);
+
+        $collector = new TagCollector();
+        $container->addCompilerPass($collector);
+
+        $container->compile();
+
+        self::assertSame([
+            TaggedService4::class => [
+                ['someAttribute' => 'baz', 'priority' => 0, 'method' => 'fooAction'],
+                ['someAttribute' => 'foo', 'priority' => 0, 'method' => 'barAction'],
+            ],
+        ], $collector->collectedTags);
+    }
+
     /**
      * @requires PHP 8
      */
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/Attribute/CustomMethodAttribute.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/Attribute/CustomMethodAttribute.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\Attribute;
+
+#[\Attribute(\Attribute::TARGET_METHOD)]
+final class CustomMethodAttribute
+{
+    public function __construct(
+        public string $someAttribute,
+        public int $priority = 0,
+    ) {
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/TaggedService4.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/TaggedService4.php
@@ -0,0 +1,26 @@
+<?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\Tests\Fixtures\Attribute\CustomAutoconfiguration;
+use Symfony\Component\DependencyInjection\Tests\Fixtures\Attribute\CustomMethodAttribute;
+
+final class TaggedService4
+{
+    #[CustomMethodAttribute(someAttribute: 'baz')]
+    public function fooAction() {}
+
+    #[CustomMethodAttribute(someAttribute: 'foo')]
+    public function barAction() {}
+
+    public function someOtherMethod() {}
+}

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,13 @@ protected function processValue($value, bool $isRoot = false)`
`48`	`48`	`$configurator($conditionals, $attribute->newInstance(), $reflector);`
`49`	`49`	`}`
`50`	`50`	`}`
	`51`	`+ foreach ($reflector->getMethods() as $method) {`
	`52`	`+ foreach ($method->getAttributes() as $attribute) {`
	`53`	`+ if ($configurator = $autoconfiguredAttributes[$attribute->getName()] ?? null) {`
	`54`	`+ $configurator($conditionals, $attribute->newInstance(), $method);`
	`55`	`+ }`
	`56`	`+ }`
	`57`	`+ }`
`51`	`58`	`if (!isset($instanceof[$reflector->getName()]) && new ChildDefinition('') != $conditionals) {`
`52`	`59`	`$instanceof[$reflector->getName()] = $conditionals;`
`53`	`60`	`$value->setInstanceofConditionals($instanceof);`
Original file line number	Diff line number	Diff line change
`@@ -1309,7 +1309,7 @@ public function registerForAutoconfiguration(string $interface)`
`1309`	`1309`	`/**`
`1310`	`1310`	`* Registers an attribute that will be used for autoconfiguring annotated classes.`
`1311`	`1311`	`*`
`1312`		`- * The configurator will receive a ChildDefinition instance, an instance of the attribute and the corresponding \ReflectionClass, in that order.`
	`1312`	`+ * The configurator will receive a ChildDefinition instance, an instance of the attribute and the corresponding \ReflectionClass or \ReflectionMethod, in that order.`
`1313`	`1313`	`*/`
`1314`	`1314`	`public function registerAttributeForAutoconfiguration(string $attributeClass, callable $configurator): void`
`1315`	`1315`	`{`