[DI] Add "=iterator" arguments to Yaml loader

nicolas-grekas · nicolas-grekas · commit 1dbf52ad0340 · 2017-01-05T21:40:35.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -4,6 +4,8 @@ CHANGELOG
 3.3.0
 -----
 
+ * Add "iterator" argument type for lazy iteration over a set of values and services
+
  * Using the `PhpDumper` with an uncompiled `ContainerBuilder` is deprecated and
    will not be supported anymore in 4.0.
 
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php
@@ -247,7 +247,7 @@ private function dumpCallable($callable)
     private function dumpValue($value)
     {
         if ($value instanceof IteratorArgument) {
-            $value = $value->getValues();
+            $value = array('=iterator' => $value->getValues());
         }
 
         if (is_array($value)) {
diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DependencyInjection\Loader;
 
 use Symfony\Component\DependencyInjection\Alias;
+use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
@@ -455,7 +456,17 @@ private function validate($content, $file)
     private function resolveServices($value)
     {
         if (is_array($value)) {
-            $value = array_map(array($this, 'resolveServices'), $value);
+            if (array_key_exists('=iterator', $value)) {
+                if (1 !== count($value)) {
+                    throw new InvalidArgumentException('Arguments typed "=iterator" must have no sibling keys.');
+                }
+                if (!is_array($value['=iterator'])) {
+                    throw new InvalidArgumentException('Arguments typed "=iterator" must be arrays.');
+                }
+                $value = new IteratorArgument(array_map(array($this, 'resolveServices'), $value['=iterator']));
+            } else {
+                $value = array_map(array($this, 'resolveServices'), $value);
+            }
         } elseif (is_string($value) && 0 === strpos($value, '@=')) {
             return new Expression(substr($value, 2));
         } elseif (is_string($value) && 0 === strpos($value, '@')) {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/services9.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/services9.yml
@@ -109,9 +109,9 @@ services:
         factory: ['@factory_simple', getInstance]
     lazy_context:
         class: LazyContext
-        arguments: [[foo, '@foo.baz', { '%foo%': 'foo is %foo%', foobar: '%foo%' }, true, '@service_container']]
+        arguments: [{ '=iterator': [foo, '@foo.baz', { '%foo%': 'foo is %foo%', foobar: '%foo%' }, true, '@service_container'] }]
     lazy_context_ignore_invalid_ref:
         class: LazyContext
-        arguments: [['@foo.baz', '@?invalid']]
+        arguments: [{ '=iterator': ['@foo.baz', '@?invalid'] }]
     alias_for_foo: '@foo'
     alias_for_alias: '@foo'
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/XmlFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/XmlFileLoaderTest.php
@@ -258,7 +258,7 @@ public function testLoadServices()
         $this->assertEquals(array('decorated', 'decorated.pif-pouf', 5), $services['decorator_service_with_name_and_priority']->getDecoratedService());
     }
 
-    public function testParsesLazyArgument()
+    public function testParsesIteratorArgument()
     {
         $container = new ContainerBuilder();
         $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath.'/xml'));
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\DependencyInjection\Tests\Loader;
 
+use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
@@ -316,6 +317,17 @@ public function testTypes()
         $this->assertEquals(array('Foo'), $container->getDefinition('baz_service')->getAutowiringTypes());
     }
 
+    public function testParsesIteratorArgument()
+    {
+        $container = new ContainerBuilder();
+        $loader = new YamlFileLoader($container, new FileLocator(self::$fixturesPath.'/yaml'));
+        $loader->load('services9.yml');
+
+        $lazyDefinition = $container->getDefinition('lazy_context');
+
+        $this->assertEquals(array(new IteratorArgument(array('foo', new Reference('foo.baz'), array('%foo%' => 'foo is %foo%', 'foobar' => '%foo%'), true, new Reference('service_container')))), $lazyDefinition->getArguments(), '->load() parses lazy arguments');
+    }
+
     public function testAutowire()
     {
         $container = new ContainerBuilder();

Original file line number	Diff line number	Diff line change
`@@ -247,7 +247,7 @@ private function dumpCallable($callable)`
`247`	`247`	`private function dumpValue($value)`
`248`	`248`	`{`
`249`	`249`	`if ($value instanceof IteratorArgument) {`
`250`		`- $value = $value->getValues();`
	`250`	`+ $value = array('=iterator' => $value->getValues());`
`251`	`251`	`}`
`252`	`252`
`253`	`253`	`if (is_array($value)) {`
Original file line number	Diff line number	Diff line change
`@@ -258,7 +258,7 @@ public function testLoadServices()`
`258`	`258`	`$this->assertEquals(array('decorated', 'decorated.pif-pouf', 5), $services['decorator_service_with_name_and_priority']->getDecoratedService());`
`259`	`259`	`}`
`260`	`260`
`261`		`- public function testParsesLazyArgument()`
	`261`	`+ public function testParsesIteratorArgument()`
`262`	`262`	`{`
`263`	`263`	`$container = new ContainerBuilder();`
`264`	`264`	`$loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath.'/xml'));`