[DependencyInjection] Improve array phpdoc of ContainerBuilder

Author: VincentLanglet

ContainerBuilder.php

@@ -55,37 +55,43 @@
 class ContainerBuilder extends Container implements TaggedContainerInterface
 {
     /**
-     * @var ExtensionInterface[]
+     * @var array<string, ExtensionInterface>
      */
     private $extensions = [];
 
     /**
-     * @var ExtensionInterface[]
+     * @var array<string, ExtensionInterface>
      */
     private $extensionsByNs = [];
 
     /**
-     * @var Definition[]
+     * @var array<string, Definition>
      */
     private $definitions = [];
 
     /**
-     * @var Alias[]
+     * @var array<string, Alias>
      */
     private $aliasDefinitions = [];
 
     /**
-     * @var ResourceInterface[]
+     * @var array<string, ResourceInterface>
      */
     private $resources = [];
 
+    /**
+     * @var array<string, array<array<string, mixed>>>
+     */
     private $extensionConfigs = [];
 
     /**
      * @var Compiler
      */
     private $compiler;
 
+    /**
+     * @var bool
+     */
     private $trackResources;
 
     /**
@@ -123,15 +129,24 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
      */
     private $vendors;
 
+    /**
+     * @var array<string, ChildDefinition>
+     */
     private $autoconfiguredInstanceof = [];
 
     /**
-     * @var callable[]
+     * @var array<string, callable>
      */
     private $autoconfiguredAttributes = [];
 
+    /**
+     * @var array<string, bool>
+     */
     private $removedIds = [];
 
+    /**
+     * @var array<int, bool>
+     */
     private $removedBindingIds = [];
 
     private const INTERNAL_TYPES = [
@@ -159,7 +174,7 @@ public function __construct(ParameterBagInterface $parameterBag = null)
     }
 
     /**
-     * @var \ReflectionClass[] a list of class reflectors
+     * @var array<string, \ReflectionClass>
      */
     private $classReflectors;
 
@@ -224,7 +239,7 @@ public function getExtension(string $name)
     /**
      * Returns all registered extensions.
      *
-     * @return ExtensionInterface[]
+     * @return array<string, ExtensionInterface>
      */
     public function getExtensions()
     {
@@ -272,7 +287,7 @@ public function addResource(ResourceInterface $resource)
     /**
      * Sets the resources for this configuration.
      *
-     * @param ResourceInterface[] $resources An array of resources
+     * @param array<string, ResourceInterface> $resources
      *
      * @return $this
      */
@@ -417,8 +432,8 @@ public function fileExists(string $path, $trackContents = true): bool
     /**
      * Loads the configuration for an extension.
      *
-     * @param string $extension The extension alias or namespace
-     * @param array  $values    An array of values that customizes the extension
+     * @param string                    $extension The extension alias or namespace
+     * @param array<string, mixed>|null $values    An array of values that customizes the extension
      *
      * @return $this
      *
@@ -431,13 +446,9 @@ public function loadFromExtension(string $extension, array $values = null)
             throw new BadMethodCallException('Cannot load from an extension on a compiled container.');
         }
 
-        if (\func_num_args() < 2) {
-            $values = [];
-        }
-
         $namespace = $this->getExtension($extension)->getAlias();
 
-        $this->extensionConfigs[$namespace][] = $values;
+        $this->extensionConfigs[$namespace][] = $values ?? [];
 
         return $this;
     }
@@ -684,7 +695,7 @@ public function merge(self $container)
     /**
      * Returns the configuration array for the given extension.
      *
-     * @return array
+     * @return array<array<string, mixed>>
      */
     public function getExtensionConfig(string $name)
     {
@@ -697,6 +708,8 @@ public function getExtensionConfig(string $name)
 
     /**
      * Prepends a config array to the configs of the given extension.
+     *
+     * @param array<string, mixed> $config
      */
     public function prependExtensionConfig(string $name, array $config)
     {
@@ -779,7 +792,7 @@ public function getServiceIds()
     /**
      * Gets removed service or alias ids.
      *
-     * @return array
+     * @return array<string, bool>
      */
     public function getRemovedIds()
     {
@@ -788,6 +801,8 @@ public function getRemovedIds()
 
     /**
      * Adds the service aliases.
+     *
+     * @param array<string, string|Alias> $aliases
      */
     public function addAliases(array $aliases)
     {
@@ -798,6 +813,8 @@ public function addAliases(array $aliases)
 
     /**
      * Sets the service aliases.
+     *
+     * @param array<string, string|Alias> $aliases
      */
     public function setAliases(array $aliases)
     {
@@ -854,7 +871,7 @@ public function hasAlias(string $id)
     }
 
     /**
-     * @return Alias[]
+     * @return array<string, Alias>
      */
     public function getAliases()
     {
@@ -904,7 +921,7 @@ public function autowire(string $id, string $class = null)
     /**
      * Adds the service definitions.
      *
-     * @param Definition[] $definitions An array of service definitions
+     * @param array<string, Definition> $definitions
      */
     public function addDefinitions(array $definitions)
     {
@@ -916,7 +933,7 @@ public function addDefinitions(array $definitions)
     /**
      * Sets the service definitions.
      *
-     * @param Definition[] $definitions An array of service definitions
+     * @param array<string, Definition> $definitions
      */
     public function setDefinitions(array $definitions)
     {
@@ -927,7 +944,7 @@ public function setDefinitions(array $definitions)
     /**
      * Gets all service definitions.
      *
-     * @return Definition[]
+     * @return array<string, Definition>
      */
     public function getDefinitions()
     {
@@ -1142,7 +1159,7 @@ private function createService(Definition $definition, array &$inlineServices, b
     /**
      * Replaces service references by the real service instance and evaluates expressions.
      *
-     * @param mixed $value A value
+     * @param mixed $value
      *
      * @return mixed The same value with all service references replaced by
      *               the real service instances and all expressions evaluated
@@ -1236,7 +1253,7 @@ private function doResolveServices($value, array &$inlineServices = [], bool $is
      *         }
      *     }
      *
-     * @return array An array of tags with the tagged service as key, holding a list of attribute arrays
+     * @return array<string, array> An array of tags with the tagged service as key, holding a list of attribute arrays
      */
     public function findTaggedServiceIds(string $name, bool $throwOnAbstract = false)
     {
@@ -1257,7 +1274,7 @@ public function findTaggedServiceIds(string $name, bool $throwOnAbstract = false
     /**
      * Returns all tags the defined services use.
      *
-     * @return array
+     * @return string[]
      */
     public function findTags()
     {
@@ -1346,15 +1363,15 @@ public function registerAliasForArgument(string $id, string $type, string $name
     /**
      * Returns an array of ChildDefinition[] keyed by interface.
      *
-     * @return ChildDefinition[]
+     * @return array<string, ChildDefinition>
      */
     public function getAutoconfiguredInstanceof()
     {
         return $this->autoconfiguredInstanceof;
     }
 
     /**
-     * @return callable[]
+     * @return array<string, callable>
      */
     public function getAutoconfiguredAttributes(): array
     {
@@ -1495,6 +1512,8 @@ final public static function willBeAvailable(string $package, string $class, arr
     /**
      * Gets removed binding ids.
      *
+     * @return array<int, bool>
+     *
      * @internal
      */
     public function getRemovedBindingIds(): array
@@ -1522,6 +1541,8 @@ public function removeBindings(string $id)
      *
      * @param mixed $value An array of conditionals to return
      *
+     * @return string[]
+     *
      * @internal
      */
     public static function getServiceConditionals($value): array
@@ -1544,6 +1565,8 @@ public static function getServiceConditionals($value): array
      *
      * @param mixed $value An array of conditionals to return
      *
+     * @return string[]
+     *
      * @internal
      */
     public static function getInitializedConditionals($value): array

Tests/Loader/YamlFileLoaderTest.php

@@ -357,7 +357,7 @@ public function testExtensionWithNullConfig()
         $loader->load('null_config.yml');
         $container->compile();
 
-        $this->assertSame([null], $container->getParameter('project.configs'));
+        $this->assertSame([[]], $container->getParameter('project.configs'));
     }
 
     public function testSupports()