Add generic types to traversable implementations

Author: derrabus

HeaderBag.php

@@ -15,12 +15,17 @@
  * HeaderBag is a container for HTTP headers.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @implements \IteratorAggregate<string, array<int, string|null>>
  */
 class HeaderBag implements \IteratorAggregate, \Countable
 {
     protected const UPPER = '_ABCDEFGHIJKLMNOPQRSTUVWXYZ';
     protected const LOWER = '-abcdefghijklmnopqrstuvwxyz';
 
+    /**
+     * @var array<string, array<int, string|null>>
+     */
     protected $headers = [];
     protected $cacheControl = [];
 
@@ -60,7 +65,7 @@ public function __toString()
      *
      * @param string|null $key The name of the headers to return or null to get them all
      *
-     * @return array
+     * @return array<string, array<int, string|null>>|array<int, string|null>
      */
     public function all(string $key = null)
     {
@@ -74,7 +79,7 @@ public function all(string $key = null)
     /**
      * Returns the parameter keys.
      *
-     * @return array
+     * @return string[]
      */
     public function keys()
     {
@@ -250,7 +255,7 @@ public function removeCacheControlDirective(string $key)
     /**
      * Returns an iterator for headers.
      *
-     * @return \ArrayIterator
+     * @return \ArrayIterator<string, array<int, string|null>>
      */
     #[\ReturnTypeWillChange]
     public function getIterator()

ParameterBag.php

@@ -17,6 +17,8 @@
  * ParameterBag is a container for key/value pairs.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @implements \IteratorAggregate<string, mixed>
  */
 class ParameterBag implements \IteratorAggregate, \Countable
 {
@@ -205,7 +207,7 @@ public function filter(string $key, $default = null, int $filter = \FILTER_DEFAU
     /**
      * Returns an iterator for parameters.
      *
-     * @return \ArrayIterator
+     * @return \ArrayIterator<string, mixed>
      */
     #[\ReturnTypeWillChange]
     public function getIterator()

Session/Attribute/AttributeBag.php

@@ -13,6 +13,8 @@
 
 /**
  * This class relates to session attribute storage.
+ *
+ * @implements \IteratorAggregate<string, mixed>
  */
 class AttributeBag implements AttributeBagInterface, \IteratorAggregate, \Countable
 {
@@ -129,7 +131,7 @@ public function clear()
     /**
      * Returns an iterator for attributes.
      *
-     * @return \ArrayIterator
+     * @return \ArrayIterator<string, mixed>
      */
     #[\ReturnTypeWillChange]
     public function getIterator()

Session/Attribute/AttributeBagInterface.php

@@ -46,7 +46,7 @@ public function set(string $name, $value);
     /**
      * Returns attributes.
      *
-     * @return array
+     * @return array<string, mixed>
      */
     public function all();
 

Session/Session.php

@@ -26,6 +26,8 @@ class_exists(SessionBagProxy::class);
 /**
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Drak <drak@zikula.org>
+ *
+ * @implements \IteratorAggregate<string, mixed>
  */
 class Session implements SessionInterface, \IteratorAggregate, \Countable
 {
@@ -126,7 +128,7 @@ public function isStarted()
     /**
      * Returns an iterator for attributes.
      *
-     * @return \ArrayIterator
+     * @return \ArrayIterator<string, mixed>
      */
     #[\ReturnTypeWillChange]
     public function getIterator()