feature #33623 [DependencyInjection] Allow binding iterable and tagged services (lyrixx)

nicolas-grekas · nicolas-grekas · commit 92ef4764870e · 2019-09-18T13:27:34.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [DependencyInjection] Allow binding iterable and tagged services | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | | License | MIT | Doc PR | This will allow: ```yaml services: _defaults: bind: iterable $rules: !tagged_iterator app.foo.rule _instanceof: App\Foo\Rule\RuleInterface: tags: ['app.foo.rule'] ``` Commits ------- 2055a55 [DependencyInjection] Allow binding iterable and tagged services
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -9,6 +9,7 @@ CHANGELOG
  * deprecated support for short factories and short configurators in Yaml
  * deprecated `tagged` in favor of `tagged_iterator`
  * deprecated passing an instance of `Symfony\Component\DependencyInjection\Parameter` as class name to `Symfony\Component\DependencyInjection\Definition`
+ * added support for binding iterable and tagged services
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveBindingsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveBindingsPass.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DependencyInjection\Compiler;
 
 use Symfony\Component\DependencyInjection\Argument\BoundArgument;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
@@ -120,8 +121,8 @@ protected function processValue($value, $isRoot = false)
                 continue;
             }
 
-            if (null !== $bindingValue && !$bindingValue instanceof Reference && !$bindingValue instanceof Definition) {
-                throw new InvalidArgumentException(sprintf('Invalid value for binding key "%s" for service "%s": expected null, an instance of %s or an instance of %s, %s given.', $key, $this->currentId, Reference::class, Definition::class, \gettype($bindingValue)));
+            if (null !== $bindingValue && !$bindingValue instanceof Reference && !$bindingValue instanceof Definition && !$bindingValue instanceof TaggedIteratorArgument) {
+                throw new InvalidArgumentException(sprintf('Invalid value for binding key "%s" for service "%s": expected null, an instance of %s or an instance of %s or an instance of %s, %s given.', $key, $this->currentId, Reference::class, Definition::class, TaggedIteratorArgument::class, \gettype($bindingValue)));
             }
         }
 
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveBindingsPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/ResolveBindingsPassTest.php
@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\Argument\BoundArgument;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\Compiler\AutowireRequiredMethodsPass;
 use Symfony\Component\DependencyInjection\Compiler\ResolveBindingsPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -31,7 +32,10 @@ public function testProcess()
     {
         $container = new ContainerBuilder();
 
-        $bindings = [CaseSensitiveClass::class => new BoundArgument(new Reference('foo'))];
+        $bindings = [
+            CaseSensitiveClass::class => new BoundArgument(new Reference('foo')),
+            'iterable $objects' => new BoundArgument(new TaggedIteratorArgument('tag.name'), true, BoundArgument::INSTANCEOF_BINDING),
+        ];
 
         $definition = $container->register(NamedArgumentsDummy::class, NamedArgumentsDummy::class);
         $definition->setArguments([1 => '123']);
@@ -44,7 +48,7 @@ public function testProcess()
         $pass = new ResolveBindingsPass();
         $pass->process($container);
 
-        $this->assertEquals([new Reference('foo'), '123'], $definition->getArguments());
+        $this->assertEquals([0 => new Reference('foo'), 1 => '123', 4 => new TaggedIteratorArgument('tag.name')], $definition->getArguments());
         $this->assertEquals([['setSensitiveClass', [new Reference('foo')]]], $definition->getMethodCalls());
     }
 
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/NamedArgumentsDummy.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/NamedArgumentsDummy.php
@@ -9,7 +9,7 @@
  */
 class NamedArgumentsDummy
 {
-    public function __construct(CaseSensitiveClass $c, $apiKey, $hostName, ContainerInterface $interface)
+    public function __construct(CaseSensitiveClass $c, $apiKey, $hostName, ContainerInterface $interface, iterable $objects)
     {
     }
 

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\DependencyInjection\Compiler;`
`13`	`13`
`14`	`14`	`use Symfony\Component\DependencyInjection\Argument\BoundArgument;`
	`15`	`+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;`
`15`	`16`	`use Symfony\Component\DependencyInjection\ContainerBuilder;`
`16`	`17`	`use Symfony\Component\DependencyInjection\Definition;`
`17`	`18`	`use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;`
`@@ -120,8 +121,8 @@ protected function processValue($value, $isRoot = false)`
`120`	`121`	`continue;`
`121`	`122`	`}`
`122`	`123`
`123`		`- if (null !== $bindingValue && !$bindingValue instanceof Reference && !$bindingValue instanceof Definition) {`
`124`		`- throw new InvalidArgumentException(sprintf('Invalid value for binding key "%s" for service "%s": expected null, an instance of %s or an instance of %s, %s given.', $key, $this->currentId, Reference::class, Definition::class, \gettype($bindingValue)));`
	`124`	`+ if (null !== $bindingValue && !$bindingValue instanceof Reference && !$bindingValue instanceof Definition && !$bindingValue instanceof TaggedIteratorArgument) {`
	`125`	`+ throw new InvalidArgumentException(sprintf('Invalid value for binding key "%s" for service "%s": expected null, an instance of %s or an instance of %s or an instance of %s, %s given.', $key, $this->currentId, Reference::class, Definition::class, TaggedIteratorArgument::class, \gettype($bindingValue)));`
`125`	`126`	`}`
`126`	`127`	`}`
`127`	`128`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`*/`
`10`	`10`	`class NamedArgumentsDummy`
`11`	`11`	`{`
`12`		`- public function __construct(CaseSensitiveClass $c, $apiKey, $hostName, ContainerInterface $interface)`
	`12`	`+ public function __construct(CaseSensitiveClass $c, $apiKey, $hostName, ContainerInterface $interface, iterable $objects)`
`13`	`13`	`{`
`14`	`14`	`}`
`15`	`15`