Allow to choose an index for tagged collection

deguif · deguif · commit b7500771bfff · 2018-12-14T17:24:24.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/Argument/TaggedIteratorArgument.php b/src/Symfony/Component/DependencyInjection/Argument/TaggedIteratorArgument.php
@@ -19,16 +19,30 @@
 class TaggedIteratorArgument extends IteratorArgument
 {
     private $tag;
+    private $indexAttribute;
+    private $defaultIndexMethod;
 
-    public function __construct(string $tag)
+    public function __construct(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null)
     {
         parent::__construct(array());
 
         $this->tag = $tag;
+        $this->indexAttribute = $indexAttribute;
+        $this->defaultIndexMethod = $defaultIndexMethod;
     }
 
     public function getTag()
     {
         return $this->tag;
     }
+
+    public function getIndexAttribute(): ?string
+    {
+        return $this->indexAttribute;
+    }
+
+    public function getDefaultIndexMethod(): ?string
+    {
+        return $this->defaultIndexMethod;
+    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php b/src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php
@@ -12,6 +12,8 @@
 namespace Symfony\Component\DependencyInjection\Compiler;
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Reference;
 
 /**
@@ -36,13 +38,56 @@ trait PriorityTaggedServiceTrait
      *
      * @return Reference[]
      */
-    private function findAndSortTaggedServices($tagName, ContainerBuilder $container)
+    private function findAndSortTaggedServices($tagName, ContainerBuilder $container, string $indexAttribute = null, string $defaultIndexMethod = null)
     {
         $services = array();
 
+        if (null === $indexAttribute && null !== $defaultIndexMethod) {
+            throw new InvalidArgumentException('Default index method cannot be used without specifying a tag attribute.');
+        }
+
         foreach ($container->findTaggedServiceIds($tagName, true) as $serviceId => $attributes) {
             $priority = isset($attributes[0]['priority']) ? $attributes[0]['priority'] : 0;
-            $services[$priority][] = new Reference($serviceId);
+
+            if (null === $indexAttribute && null === $defaultIndexMethod) {
+                $services[$priority][] = new Reference($serviceId);
+
+                continue;
+            }
+
+            if (isset($attributes[0][$indexAttribute])) {
+                $services[$priority][$attributes[0][$indexAttribute]] = new Reference($serviceId);
+
+                continue;
+            }
+
+            if (null === $defaultIndexMethod) {
+                throw new LogicException(sprintf('Tag "%s" on service "%s" is missing "%s" attribute.', $tagName, $serviceId, $indexAttribute));
+            }
+
+            if (!$r = $container->getReflectionClass($class = $container->getDefinition($serviceId)->getClass())) {
+                throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $serviceId));
+            }
+
+            if (!$r->hasMethod($defaultIndexMethod)) {
+                throw new InvalidArgumentException(sprintf('Method "%s::%s()" not found: Tag "%s" on service "%s" is missing "%s" attribute.', $class, $defaultIndexMethod, $tagName, $serviceId, $indexAttribute));
+            }
+
+            if (!($rm = $r->getMethod($defaultIndexMethod))->isStatic()) {
+                throw new InvalidArgumentException(sprintf('Method "%s::%s()" used for service "%s" must be static.', $class, $defaultIndexMethod, $serviceId));
+            }
+
+            if (!$rm->isPublic()) {
+                throw new InvalidArgumentException(sprintf('Method "%s::%s()" used for service "%s" must be public.', $class, $defaultIndexMethod, $serviceId));
+            }
+
+            $key = $rm->invoke(null);
+
+            if (!\is_string($key)) {
+                throw new LogicException(sprintf('Return value of method "%s::%s()" used for service "%s" must be of type string.', $class, $defaultIndexMethod, $serviceId));
+            }
+
+            $services[$priority][$key] = new Reference($serviceId);
         }
 
         if ($services) {
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveTaggedIteratorArgumentPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveTaggedIteratorArgumentPass.php
@@ -31,7 +31,7 @@ protected function processValue($value, $isRoot = false)
             return parent::processValue($value, $isRoot);
         }
 
-        $value->setValues($this->findAndSortTaggedServices($value->getTag(), $this->container));
+        $value->setValues($this->findAndSortTaggedServices($value->getTag(), $this->container, $value->getIndexAttribute(), $value->getDefaultIndexMethod()));
 
         return $value;
     }
diff --git a/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php b/src/Symfony/Component/DependencyInjection/Loader/Configurator/ContainerConfigurator.php
@@ -116,9 +116,9 @@ function iterator(array $values): IteratorArgument
 /**
  * Creates a lazy iterator by tag name.
  */
-function tagged(string $tag): TaggedIteratorArgument
+function tagged(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null): TaggedIteratorArgument
 {
-    return new TaggedIteratorArgument($tag);
+    return new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod);
 }
 
 /**
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -706,11 +706,13 @@ private function resolveServices($value, $file, $isParameter = false)
                 }
             }
             if ('tagged' === $value->getTag()) {
-                if (!\is_string($argument) || !$argument) {
-                    throw new InvalidArgumentException(sprintf('"!tagged" tag only accepts non empty string in "%s".', $file));
+                if (\is_string($argument) && $argument) {
+                    return new TaggedIteratorArgument($argument);
+                } elseif (\is_array($argument) && isset($argument['name']) && $argument['name']) {
+                    return new TaggedIteratorArgument($argument['name'], $argument['index_by'] ?? null, $argument['default_index_method'] ?? null);
+                } else {
+                    throw new InvalidArgumentException(sprintf('"!tagged" tag only accepts a non empty string or an array with a key "name" in "%s".', $file));
                 }
-
-                return new TaggedIteratorArgument($argument);
             }
             if ('service' === $value->getTag()) {
                 if ($isParameter) {

Original file line number	Diff line number	Diff line change
`@@ -19,16 +19,30 @@`
`19`	`19`	`class TaggedIteratorArgument extends IteratorArgument`
`20`	`20`	`{`
`21`	`21`	`private $tag;`
	`22`	`+ private $indexAttribute;`
	`23`	`+ private $defaultIndexMethod;`
`22`	`24`
`23`		`- public function __construct(string $tag)`
	`25`	`+ public function __construct(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null)`
`24`	`26`	`{`
`25`	`27`	`parent::__construct(array());`
`26`	`28`
`27`	`29`	`$this->tag = $tag;`
	`30`	`+ $this->indexAttribute = $indexAttribute;`
	`31`	`+ $this->defaultIndexMethod = $defaultIndexMethod;`
`28`	`32`	`}`
`29`	`33`
`30`	`34`	`public function getTag()`
`31`	`35`	`{`
`32`	`36`	`return $this->tag;`
`33`	`37`	`}`
	`38`	`+`
	`39`	`+ public function getIndexAttribute(): ?string`
	`40`	`+ {`
	`41`	`+ return $this->indexAttribute;`
	`42`	`+ }`
	`43`	`+`
	`44`	`+ public function getDefaultIndexMethod(): ?string`
	`45`	`+ {`
	`46`	`+ return $this->defaultIndexMethod;`
	`47`	`+ }`
`34`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ protected function processValue($value, $isRoot = false)`
`31`	`31`	`return parent::processValue($value, $isRoot);`
`32`	`32`	`}`
`33`	`33`
`34`		`- $value->setValues($this->findAndSortTaggedServices($value->getTag(), $this->container));`
	`34`	`+ $value->setValues($this->findAndSortTaggedServices($value->getTag(), $this->container, $value->getIndexAttribute(), $value->getDefaultIndexMethod()));`
`35`	`35`
`36`	`36`	`return $value;`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,9 +116,9 @@ function iterator(array $values): IteratorArgument`
`116`	`116`	`/**`
`117`	`117`	`* Creates a lazy iterator by tag name.`
`118`	`118`	`*/`
`119`		`-function tagged(string $tag): TaggedIteratorArgument`
	`119`	`+function tagged(string $tag, string $indexAttribute = null, string $defaultIndexMethod = null): TaggedIteratorArgument`
`120`	`120`	`{`
`121`		`- return new TaggedIteratorArgument($tag);`
	`121`	`+ return new TaggedIteratorArgument($tag, $indexAttribute, $defaultIndexMethod);`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -706,11 +706,13 @@ private function resolveServices($value, $file, $isParameter = false)`
`706`	`706`	`}`
`707`	`707`	`}`
`708`	`708`	`if ('tagged' === $value->getTag()) {`
`709`		`- if (!\is_string($argument) \|\| !$argument) {`
`710`		`- throw new InvalidArgumentException(sprintf('"!tagged" tag only accepts non empty string in "%s".', $file));`
	`709`	`+ if (\is_string($argument) && $argument) {`
	`710`	`+ return new TaggedIteratorArgument($argument);`
	`711`	`+ } elseif (\is_array($argument) && isset($argument['name']) && $argument['name']) {`
	`712`	`+ return new TaggedIteratorArgument($argument['name'], $argument['index_by'] ?? null, $argument['default_index_method'] ?? null);`
	`713`	`+ } else {`
	`714`	`+ throw new InvalidArgumentException(sprintf('"!tagged" tag only accepts a non empty string or an array with a key "name" in "%s".', $file));`
`711`	`715`	`}`
`712`		`-`
`713`		`- return new TaggedIteratorArgument($argument);`
`714`	`716`	`}`
`715`	`717`	`if ('service' === $value->getTag()) {`
`716`	`718`	`if ($isParameter) {`