[DependencyInjection] Make ServiceLocator iterable

kbond · kbond · commit ca47fd092d30 · 2023-12-20T16:35:18.000-05:00
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add argument `$prepend` to `ContainerConfigurator::extension()` to prepend the configuration instead of appending it
+ * Make `ServiceLocator` iterable
 
 7.0
 ---
diff --git a/src/Symfony/Component/DependencyInjection/ServiceCollectionInterface.php b/src/Symfony/Component/DependencyInjection/ServiceCollectionInterface.php
@@ -0,0 +1,25 @@
+<?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;
+
+use Psr\Container\ContainerInterface as PsrContainerInterface;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ *
+ * @template-covariant T of mixed
+ *
+ * @extends \IteratorAggregate<string, T>
+ */
+interface ServiceCollectionInterface extends PsrContainerInterface, \IteratorAggregate, \Countable
+{
+}
diff --git a/src/Symfony/Component/DependencyInjection/ServiceLocator.php b/src/Symfony/Component/DependencyInjection/ServiceLocator.php
@@ -27,8 +27,9 @@
  * @template-covariant T of mixed
  *
  * @implements ServiceProviderInterface<T>
+ * @implements \IteratorAggregate<string, T>
  */
-class ServiceLocator implements ServiceProviderInterface, \Countable
+class ServiceLocator implements ServiceProviderInterface, \IteratorAggregate, \Countable
 {
     use ServiceLocatorTrait {
         get as private doGet;
@@ -82,6 +83,13 @@ public function count(): int
         return \count($this->getProvidedServices());
     }
 
+    public function getIterator(): \Traversable
+    {
+        foreach (array_keys($this->getProvidedServices()) as $id) {
+            yield $id => $this->get($id);
+        }
+    }
+
     private function createNotFoundException(string $id): NotFoundExceptionInterface
     {
         if ($this->loading) {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ServiceLocatorTest.php b/src/Symfony/Component/DependencyInjection/Tests/ServiceLocatorTest.php
@@ -101,6 +101,17 @@ public function testProvidesServicesInformation()
             'baz' => '?string',
         ]);
     }
+
+    public function testIsCountableAndIterable()
+    {
+        $locator = $this->getServiceLocator([
+            'foo' => fn () => 'bar',
+            'bar' => fn () => 'baz',
+        ]);
+
+        $this->assertCount(2, $locator);
+        $this->assertSame(['foo' => 'bar', 'bar' => 'baz'], iterator_to_array($locator));
+    }
 }
 
 class SomeServiceSubscriber implements ServiceSubscriberInterface

Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,9 @@`
`27`	`27`	`* @template-covariant T of mixed`
`28`	`28`	`*`
`29`	`29`	`* @implements ServiceProviderInterface<T>`
	`30`	`+ * @implements \IteratorAggregate<string, T>`
`30`	`31`	`*/`
`31`		`-class ServiceLocator implements ServiceProviderInterface, \Countable`
	`32`	`+class ServiceLocator implements ServiceProviderInterface, \IteratorAggregate, \Countable`
`32`	`33`	`{`
`33`	`34`	`use ServiceLocatorTrait {`
`34`	`35`	`get as private doGet;`
`@@ -82,6 +83,13 @@ public function count(): int`
`82`	`83`	`return \count($this->getProvidedServices());`
`83`	`84`	`}`
`84`	`85`
	`86`	`+ public function getIterator(): \Traversable`
	`87`	`+ {`
	`88`	`+ foreach (array_keys($this->getProvidedServices()) as $id) {`
	`89`	`+ yield $id => $this->get($id);`
	`90`	`+ }`
	`91`	`+ }`
	`92`	`+`
`85`	`93`	`private function createNotFoundException(string $id): NotFoundExceptionInterface`
`86`	`94`	`{`
`87`	`95`	`if ($this->loading) {`