Improve containers types to use iterable objects

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Yii Dependency Injection Change Log
 
-## 1.2.2 under development
+## 2.0.0 under development
 
-- no changes in this release.
+- Chg #299: Improve types to use iterable objects (@xepozz)
 
 ## 1.2.1 December 23, 2022
 

src/Container.php

@@ -9,6 +9,7 @@
 use Psr\Container\ContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
 use Throwable;
+use Traversable;
 use Yiisoft\Definitions\ArrayDefinition;
 use Yiisoft\Definitions\DefinitionStorage;
 use Yiisoft\Definitions\Exception\CircularReferenceException;
@@ -59,7 +60,7 @@ final class Container implements ContainerInterface
 
     /**
      * @var array Tagged service IDs. The structure is `['tagID' => ['service1', 'service2']]`.
-     * @psalm-var array<string, list<string>>
+     * @psalm-var array<string, iterable<string>>
      */
     private array $tags;
 
@@ -223,13 +224,14 @@ private function addDefinition(string $id, mixed $definition): void
     /**
      * Sets multiple definitions at once.
      *
-     * @param array $config Definitions indexed by their IDs.
+     * @param iterable $config Definitions indexed by their IDs.
      *
      * @throws InvalidConfigException
      */
-    private function addDefinitions(array $config): void
+    private function addDefinitions(iterable $config): void
     {
         /** @var mixed $definition */
+        /** @psalm-suppress MixedAssignment */
         foreach ($config as $id => $definition) {
             if ($this->validate && !is_string($id)) {
                 throw new InvalidConfigException(
@@ -239,8 +241,8 @@ private function addDefinitions(array $config): void
                     )
                 );
             }
-            /** @var string $id */
 
+            $id = (string) $id;
             $this->addDefinition($id, $definition);
         }
     }
@@ -251,11 +253,11 @@ private function addDefinitions(array $config): void
      * Each delegate must is a callable in format "function (ContainerInterface $container): ContainerInterface".
      * The container instance returned is used in case a service can not be found in primary container.
      *
-     * @param array $delegates
+     * @param iterable $delegates
      *
      * @throws InvalidConfigException
      */
-    private function setDelegates(array $delegates): void
+    private function setDelegates(iterable $delegates): void
     {
         $this->delegates = new CompositeContainer();
         $container = $this->get(ContainerInterface::class);
@@ -323,10 +325,12 @@ private function validateDefinition(mixed $definition, ?string $id = null): void
     /**
      * @throws InvalidConfigException
      */
-    private function validateMeta(array $meta): void
+    private function validateMeta(iterable $meta): void
     {
         /** @var mixed $value */
+        /** @psalm-suppress MixedAssignment */
         foreach ($meta as $key => $value) {
+            $key = (string)$key;
             if (!in_array($key, self::ALLOWED_META, true)) {
                 throw new InvalidConfigException(
                     sprintf(
@@ -353,10 +357,10 @@ private function validateMeta(array $meta): void
      */
     private function validateDefinitionTags(mixed $tags): void
     {
-        if (!is_array($tags)) {
+        if (!is_iterable($tags)) {
             throw new InvalidConfigException(
                 sprintf(
-                    'Invalid definition: tags should be array of strings, %s given.',
+                    'Invalid definition: tags should be either iterable or array of strings, %s given.',
                     get_debug_type($tags)
                 )
             );
@@ -387,22 +391,22 @@ private function validateDefinitionReset(mixed $reset): void
     /**
      * @throws InvalidConfigException
      */
-    private function setTags(array $tags): void
+    private function setTags(iterable $tags): void
     {
         if ($this->validate) {
             foreach ($tags as $tag => $services) {
                 if (!is_string($tag)) {
                     throw new InvalidConfigException(
                         sprintf(
                             'Invalid tags configuration: tag should be string, %s given.',
-                            $tag
+                            get_debug_type($services)
                         )
                     );
                 }
-                if (!is_array($services)) {
+                if (!is_iterable($services)) {
                     throw new InvalidConfigException(
                         sprintf(
-                            'Invalid tags configuration: tag should contain array of service IDs, %s given.',
+                            'Invalid tags configuration: tag should be either iterable or array of service IDs, %s given.',
                             get_debug_type($services)
                         )
                     );
@@ -420,18 +424,26 @@ private function setTags(array $tags): void
                 }
             }
         }
-        /** @psalm-var array<string, list<string>> $tags */
+        /** @psalm-var iterable<string, iterable<string>> $tags */
 
-        $this->tags = $tags;
+        $this->tags = $tags instanceof Traversable ? iterator_to_array($tags, true) : $tags ;
     }
 
     /**
      * @psalm-param string[] $tags
      */
-    private function setDefinitionTags(string $id, array $tags): void
+    private function setDefinitionTags(string $id, iterable $tags): void
     {
         foreach ($tags as $tag) {
-            if (!isset($this->tags[$tag]) || !in_array($id, $this->tags[$tag], true)) {
+            if (!isset($this->tags[$tag])) {
+                $this->tags[$tag] = [$id];
+                continue;
+            }
+
+            $tags = $this->tags[$tag];
+            $tags = $tags instanceof Traversable ? iterator_to_array($tags, true) : $tags;
+            if (!in_array($id, $tags, true)) {
+                /** @psalm-suppress PossiblyInvalidArrayAssignment */
                 $this->tags[$tag][] = $id;
             }
         }
@@ -537,7 +549,7 @@ private function buildInternal(string $id)
      * @throws CircularReferenceException
      * @throws InvalidConfigException
      */
-    private function addProviders(array $providers): void
+    private function addProviders(iterable $providers): void
     {
         $extensions = [];
         /** @var mixed $provider */

src/ContainerConfig.php

@@ -9,11 +9,11 @@
  */
 final class ContainerConfig implements ContainerConfigInterface
 {
-    private array $definitions = [];
-    private array $providers = [];
-    private array $tags = [];
+    private iterable $definitions = [];
+    private iterable $providers = [];
+    private iterable $tags = [];
     private bool $validate = true;
-    private array $delegates = [];
+    private iterable $delegates = [];
     private bool $useStrictMode = false;
 
     private function __construct()
@@ -26,46 +26,46 @@ public static function create(): self
     }
 
     /**
-     * @param array $definitions Definitions to put into container.
+     * @param iterable $definitions Definitions to put into container.
      */
-    public function withDefinitions(array $definitions): self
+    public function withDefinitions(iterable $definitions): self
     {
         $new = clone $this;
         $new->definitions = $definitions;
         return $new;
     }
 
-    public function getDefinitions(): array
+    public function getDefinitions(): iterable
     {
         return $this->definitions;
     }
 
     /**
-     * @param array $providers Service providers to get definitions from.
+     * @param iterable $providers Service providers to get definitions from.
      */
-    public function withProviders(array $providers): self
+    public function withProviders(iterable $providers): self
     {
         $new = clone $this;
         $new->providers = $providers;
         return $new;
     }
 
-    public function getProviders(): array
+    public function getProviders(): iterable
     {
         return $this->providers;
     }
 
     /**
-     * @param array $tags Tagged service IDs. The structure is `['tagID' => ['service1', 'service2']]`.
+     * @param iterable $tags Tagged service IDs. The structure is `['tagID' => ['service1', 'service2']]`.
      */
-    public function withTags(array $tags): self
+    public function withTags(iterable $tags): self
     {
         $new = clone $this;
         $new->tags = $tags;
         return $new;
     }
 
-    public function getTags(): array
+    public function getTags(): iterable
     {
         return $this->tags;
     }
@@ -86,18 +86,18 @@ public function shouldValidate(): bool
     }
 
     /**
-     * @param array $delegates Container delegates. Each delegate is a callable in format
+     * @param iterable $delegates Container delegates. Each delegate is a callable in format
      * `function (ContainerInterface $container): ContainerInterface`. The container instance returned is used
      * in case a service can not be found in primary container.
      */
-    public function withDelegates(array $delegates): self
+    public function withDelegates(iterable $delegates): self
     {
         $new = clone $this;
         $new->delegates = $delegates;
         return $new;
     }
 
-    public function getDelegates(): array
+    public function getDelegates(): iterable
     {
         return $this->delegates;
     }

src/ContainerConfigInterface.php

@@ -10,31 +10,31 @@
 interface ContainerConfigInterface
 {
     /**
-     * @return array Definitions to put into container.
+     * @return iterable Definitions to put into container.
      */
-    public function getDefinitions(): array;
+    public function getDefinitions(): iterable;
 
     /**
-     * @return array Service providers to get definitions from.
+     * @return iterable Service providers to get definitions from.
      */
-    public function getProviders(): array;
+    public function getProviders(): iterable;
 
     /**
-     * @return array Tagged service IDs. The structure is `['tagID' => ['service1', 'service2']]`.
+     * @return iterable Tagged service IDs. The structure is `['tagID' => ['service1', 'service2']]`.
      */
-    public function getTags(): array;
+    public function getTags(): iterable;
 
     /**
      * @return bool Whether definitions should be validated immediately.
      */
     public function shouldValidate(): bool;
 
     /**
-     * @return array Container delegates. Each delegate is a callable in format
+     * @return iterable Container delegates. Each delegate is a callable in format
      * `function (ContainerInterface $container): ContainerInterface`. The container instance returned is used
      * in case a service can not be found in primary container.
      */
-    public function getDelegates(): array;
+    public function getDelegates(): iterable;
 
     /**
      * @return bool If the automatic addition of definition when class exists and can be resolved is disabled.

src/ServiceProviderInterface.php

@@ -42,7 +42,7 @@ interface ServiceProviderInterface
      * @return array Definitions for the container. Each array key is the name of the service (usually it is
      * an interface name), and a corresponding value is a service definition.
      */
-    public function getDefinitions(): array;
+    public function getDefinitions(): iterable;
 
     /**
      * Returns an array of service extensions.
@@ -58,5 +58,5 @@ public function getDefinitions(): array;
      * @return array Extensions for the container services. Each array key is the name of the service to be modified
      * and a corresponding value is callable doing the job.
      */
-    public function getExtensions(): array;
+    public function getExtensions(): iterable;
 }

tests/Support/CarExtensionProvider.php

@@ -9,12 +9,12 @@
 
 final class CarExtensionProvider implements ServiceProviderInterface
 {
-    public function getDefinitions(): array
+    public function getDefinitions(): iterable
     {
         return [];
     }
 
-    public function getExtensions(): array
+    public function getExtensions(): iterable
     {
         return [
             Car::class => static function (ContainerInterface $container, Car $car) {

tests/Support/CarProvider.php

@@ -9,15 +9,15 @@
 
 final class CarProvider implements ServiceProviderInterface
 {
-    public function getDefinitions(): array
+    public function getDefinitions(): iterable
     {
         return [
             'car' => Car::class,
             EngineInterface::class => EngineMarkOne::class,
         ];
     }
 
-    public function getExtensions(): array
+    public function getExtensions(): iterable
     {
         return [
             Car::class => static function (ContainerInterface $container, Car $car) {

tests/Support/ContainerInterfaceExtensionProvider.php

@@ -9,12 +9,12 @@
 
 final class ContainerInterfaceExtensionProvider implements ServiceProviderInterface
 {
-    public function getDefinitions(): array
+    public function getDefinitions(): iterable
     {
         return [];
     }
 
-    public function getExtensions(): array
+    public function getExtensions(): iterable
     {
         return [
             ContainerInterface::class => static fn (ContainerInterface $container, ContainerInterface $extended) => $container,

tests/Support/NullCarExtensionProvider.php

@@ -9,13 +9,13 @@
 
 final class NullCarExtensionProvider implements ServiceProviderInterface
 {
-    public function getDefinitions(): array
+    public function getDefinitions(): iterable
     {
         return [
         ];
     }
 
-    public function getExtensions(): array
+    public function getExtensions(): iterable
     {
         return [
             Car::class => static fn (ContainerInterface $container, Car $car) => null,