Fix return types for PHP 8.1

Author: derrabus

Button.php

@@ -51,6 +51,7 @@ public function __construct(FormConfigInterface $config)
      *
      * @return bool Always returns false
      */
+    #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return false;
@@ -67,6 +68,7 @@ public function offsetExists($offset)
      *
      * @throws BadMethodCallException
      */
+    #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         throw new BadMethodCallException('Buttons cannot have children.');
@@ -84,6 +86,7 @@ public function offsetGet($offset)
      *
      * @throws BadMethodCallException
      */
+    #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         throw new BadMethodCallException('Buttons cannot have children.');
@@ -100,6 +103,7 @@ public function offsetSet($offset, $value)
      *
      * @throws BadMethodCallException
      */
+    #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         throw new BadMethodCallException('Buttons cannot have children.');
@@ -436,6 +440,7 @@ public function createView(FormView $parent = null)
      *
      * @return int Always returns 0
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return 0;
@@ -446,6 +451,7 @@ public function count()
      *
      * @return \EmptyIterator Always returns an empty iterator
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new \EmptyIterator();

ButtonBuilder.php

@@ -717,6 +717,7 @@ public function getOption($name, $default = null)
      *
      * @return int Always returns 0
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return 0;
@@ -727,6 +728,7 @@ public function count()
      *
      * @return \EmptyIterator Always returns an empty iterator
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new \EmptyIterator();

ChoiceList/View/ChoiceGroupView.php

@@ -36,8 +36,9 @@ public function __construct($label, array $choices = [])
     /**
      * {@inheritdoc}
      *
-     * @return self[]|ChoiceView[]
+     * @return \Traversable<ChoiceGroupView|ChoiceView>
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new \ArrayIterator($this->choices);

Extension/Validator/ViolationMapper/ViolationPath.php

@@ -223,6 +223,7 @@ public function mapsForm($index)
      *
      * @return ViolationPathIterator
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new ViolationPathIterator($this);

Form.php

@@ -958,6 +958,7 @@ public function get($name)
      *
      * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function offsetExists($name)
     {
         return $this->has($name);
@@ -972,6 +973,7 @@ public function offsetExists($name)
      *
      * @throws OutOfBoundsException if the named child does not exist
      */
+    #[\ReturnTypeWillChange]
     public function offsetGet($name)
     {
         return $this->get($name);
@@ -990,6 +992,7 @@ public function offsetGet($name)
      *
      * @see self::add()
      */
+    #[\ReturnTypeWillChange]
     public function offsetSet($name, $child)
     {
         $this->add($child);
@@ -1004,6 +1007,7 @@ public function offsetSet($name, $child)
      *
      * @throws AlreadySubmittedException if the form has already been submitted
      */
+    #[\ReturnTypeWillChange]
     public function offsetUnset($name)
     {
         $this->remove($name);
@@ -1014,6 +1018,7 @@ public function offsetUnset($name)
      *
      * @return \Traversable<FormInterface>
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return $this->children;
@@ -1024,6 +1029,7 @@ public function getIterator()
      *
      * @return int The number of embedded form children
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return \count($this->children);

FormBuilder.php

@@ -161,6 +161,7 @@ public function all()
     /**
      * @return int
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         if ($this->locked) {
@@ -215,6 +216,7 @@ public function getForm()
      *
      * @return FormBuilderInterface[]|\Traversable
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         if ($this->locked) {

FormErrorIterator.php

@@ -93,6 +93,7 @@ public function getForm()
      *
      * @return FormError|self An error or an iterator containing nested errors
      */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return current($this->errors);
@@ -101,6 +102,7 @@ public function current()
     /**
      * Advances the iterator to the next position.
      */
+    #[\ReturnTypeWillChange]
     public function next()
     {
         next($this->errors);
@@ -111,6 +113,7 @@ public function next()
      *
      * @return int The 0-indexed position
      */
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return key($this->errors);
@@ -121,6 +124,7 @@ public function key()
      *
      * @return bool Whether the iterator is valid
      */
+    #[\ReturnTypeWillChange]
     public function valid()
     {
         return null !== key($this->errors);
@@ -132,6 +136,7 @@ public function valid()
      * This method detects if errors have been added to the form since the
      * construction of the iterator.
      */
+    #[\ReturnTypeWillChange]
     public function rewind()
     {
         reset($this->errors);
@@ -144,6 +149,7 @@ public function rewind()
      *
      * @return bool Whether that position exists
      */
+    #[\ReturnTypeWillChange]
     public function offsetExists($position)
     {
         return isset($this->errors[$position]);
@@ -158,6 +164,7 @@ public function offsetExists($position)
      *
      * @throws OutOfBoundsException If the given position does not exist
      */
+    #[\ReturnTypeWillChange]
     public function offsetGet($position)
     {
         if (!isset($this->errors[$position])) {
@@ -174,6 +181,7 @@ public function offsetGet($position)
      *
      * @throws BadMethodCallException
      */
+    #[\ReturnTypeWillChange]
     public function offsetSet($position, $value)
     {
         throw new BadMethodCallException('The iterator doesn\'t support modification of elements.');
@@ -186,6 +194,7 @@ public function offsetSet($position, $value)
      *
      * @throws BadMethodCallException
      */
+    #[\ReturnTypeWillChange]
     public function offsetUnset($position)
     {
         throw new BadMethodCallException('The iterator doesn\'t support modification of elements.');
@@ -197,6 +206,7 @@ public function offsetUnset($position)
      *
      * @return bool Whether the current element is an instance of this class
      */
+    #[\ReturnTypeWillChange]
     public function hasChildren()
     {
         return current($this->errors) instanceof self;
@@ -207,6 +217,7 @@ public function hasChildren()
      *
      * @return self
      */
+    #[\ReturnTypeWillChange]
     public function getChildren()
     {
         return current($this->errors);
@@ -229,6 +240,7 @@ public function getChildren()
      *
      * @return int The number of iterated elements
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return \count($this->errors);
@@ -243,6 +255,7 @@ public function count()
      *
      * @throws OutOfBoundsException If the position is invalid
      */
+    #[\ReturnTypeWillChange]
     public function seek($position)
     {
         if (!isset($this->errors[$position])) {

FormView.php

@@ -108,6 +108,7 @@ public function setMethodRendered()
      *
      * @return self The child view
      */
+    #[\ReturnTypeWillChange]
     public function offsetGet($name)
     {
         return $this->children[$name];
@@ -120,6 +121,7 @@ public function offsetGet($name)
      *
      * @return bool Whether the child view exists
      */
+    #[\ReturnTypeWillChange]
     public function offsetExists($name)
     {
         return isset($this->children[$name]);
@@ -132,6 +134,7 @@ public function offsetExists($name)
      *
      * @throws BadMethodCallException always as setting a child by name is not allowed
      */
+    #[\ReturnTypeWillChange]
     public function offsetSet($name, $value)
     {
         throw new BadMethodCallException('Not supported.');
@@ -144,6 +147,7 @@ public function offsetSet($name, $value)
      *
      * @return void
      */
+    #[\ReturnTypeWillChange]
     public function offsetUnset($name)
     {
         unset($this->children[$name]);
@@ -154,6 +158,7 @@ public function offsetUnset($name)
      *
      * @return \ArrayIterator<string, FormView> The iterator
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new \ArrayIterator($this->children);
@@ -164,6 +169,7 @@ public function getIterator()
      *
      * @return int The number of children views
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return \count($this->children);

Tests/Fixtures/CustomArrayObject.php

@@ -29,12 +29,17 @@ public function offsetExists($offset): bool
         return \array_key_exists($offset, $this->array);
     }
 
+    /**
+     * @param mixed $offset
+     * @return mixed
+     */
+    #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         return $this->array[$offset];
     }
 
-    public function offsetSet($offset, $value)
+    public function offsetSet($offset, $value): void
     {
         if (null === $offset) {
             $this->array[] = $value;
@@ -43,7 +48,7 @@ public function offsetSet($offset, $value)
         }
     }
 
-    public function offsetUnset($offset)
+    public function offsetUnset($offset): void
     {
         unset($this->array[$offset]);
     }
@@ -73,7 +78,7 @@ public function __unserialize(array $data): void
         $this->array = $data;
     }
 
-    public function unserialize($serialized)
+    public function unserialize($serialized): void
     {
         $this->__unserialize((array) unserialize((string) $serialized));
     }

Util/InheritDataAwareIterator.php

@@ -30,6 +30,7 @@ class InheritDataAwareIterator extends \IteratorIterator implements \RecursiveIt
      *
      * @return static
      */
+    #[\ReturnTypeWillChange]
     public function getChildren()
     {
         return new static($this->current());
@@ -38,6 +39,7 @@ public function getChildren()
     /**
      * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function hasChildren()
     {
         return (bool) $this->current()->getConfig()->getInheritData();