Add generic types to traversable implementations

Author: derrabus

Button.php

@@ -18,6 +18,8 @@
  * A form button.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements \IteratorAggregate<string, FormInterface>
  */
 class Button implements \IteratorAggregate, FormInterface
 {
@@ -64,7 +66,7 @@ public function offsetExists($offset)
      *
      * @param mixed $offset
      *
-     * @return mixed
+     * @return FormInterface
      *
      * @throws BadMethodCallException
      */

ButtonBuilder.php

@@ -19,6 +19,8 @@
  * A builder for {@link Button} instances.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements \IteratorAggregate<string, FormBuilderInterface>
  */
 class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
 {

ChoiceList/View/ChoiceGroupView.php

@@ -15,6 +15,8 @@
  * Represents a group of choices in templates.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements \IteratorAggregate<array-key, ChoiceGroupView|ChoiceView>
  */
 class ChoiceGroupView implements \IteratorAggregate
 {
@@ -24,7 +26,7 @@ class ChoiceGroupView implements \IteratorAggregate
     /**
      * Creates a new choice group view.
      *
-     * @param ChoiceGroupView[]|ChoiceView[] $choices the choice views in the group
+     * @param array<array-key, ChoiceGroupView|ChoiceView> $choices the choice views in the group
      */
     public function __construct(string $label, array $choices = [])
     {
@@ -35,7 +37,7 @@ public function __construct(string $label, array $choices = [])
     /**
      * {@inheritdoc}
      *
-     * @return \Traversable<ChoiceGroupView|ChoiceView>
+     * @return \Traversable<array-key, ChoiceGroupView|ChoiceView>
      */
     #[\ReturnTypeWillChange]
     public function getIterator()

Extension/Validator/Constraints/FormValidator.php

@@ -24,6 +24,9 @@
  */
 class FormValidator extends ConstraintValidator
 {
+    /**
+     * @var \SplObjectStorage<FormInterface, array<int, string|string[]|GroupSequence>>
+     */
     private $resolvedGroups;
 
     /**

Extension/Validator/ViolationMapper/ViolationPath.php

@@ -21,7 +21,7 @@
 class ViolationPath implements \IteratorAggregate, PropertyPathInterface
 {
     /**
-     * @var array
+     * @var string[]
      */
     private $elements = [];
 

Form.php

@@ -66,6 +66,8 @@
  *
  * @author Fabien Potencier <[email protected]>
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements \IteratorAggregate<string, FormInterface>
  */
 class Form implements \IteratorAggregate, FormInterface, ClearableErrorsInterface
 {
@@ -82,7 +84,7 @@ class Form implements \IteratorAggregate, FormInterface, ClearableErrorsInterfac
     /**
      * A map of FormInterface instances.
      *
-     * @var FormInterface[]|OrderedHashMap
+     * @var OrderedHashMap<string, FormInterface>
      */
     private $children;
 
@@ -1021,7 +1023,7 @@ public function offsetUnset($name)
     /**
      * Returns the iterator for this group.
      *
-     * @return \Traversable<FormInterface>
+     * @return \Traversable<string, FormInterface>
      */
     #[\ReturnTypeWillChange]
     public function getIterator()

FormBuilder.php

@@ -21,6 +21,8 @@
  * A builder for creating {@link Form} instances.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements \IteratorAggregate<string, FormBuilderInterface>
  */
 class FormBuilder extends FormConfigBuilder implements \IteratorAggregate, FormBuilderInterface
 {
@@ -214,7 +216,7 @@ public function getForm()
     /**
      * {@inheritdoc}
      *
-     * @return FormBuilderInterface[]|\Traversable
+     * @return \Traversable<string, FormBuilderInterface>
      */
     #[\ReturnTypeWillChange]
     public function getIterator()

FormErrorIterator.php

@@ -28,6 +28,10 @@
  * flatten the recursive structure into a flat list of errors.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements \ArrayAccess<int, FormError|FormErrorIterator>
+ * @implements \RecursiveIterator<int, FormError>
+ * @implements \SeekableIterator<int, FormError>
  */
 class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \ArrayAccess, \Countable
 {
@@ -40,8 +44,7 @@ class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \Array
     private $errors;
 
     /**
-     * @param FormError[]|self[] $errors An array of form errors and instances
-     *                                   of FormErrorIterator
+     * @param array<int, FormError|self> $errors
      *
      * @throws InvalidArgumentException If the errors are invalid
      */

FormInterface.php

@@ -17,6 +17,9 @@
  * A form group bundling multiple forms in a hierarchical structure.
  *
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @extends \ArrayAccess<string, FormInterface>
+ * @extends \Traversable<string, FormInterface>
  */
 interface FormInterface extends \ArrayAccess, \Traversable, \Countable
 {

FormView.php

@@ -15,6 +15,9 @@
 
 /**
  * @author Bernhard Schussek <[email protected]>
+ *
+ * @implements \ArrayAccess<string, FormView>
+ * @implements \IteratorAggregate<string, FormView>
  */
 class FormView implements \ArrayAccess, \IteratorAggregate, \Countable
 {