Fix return types for PHP 8.1

Signed-off-by: Alexander M. Turek <[email protected]>
doctrine · Aug 7, 2021 · dc960d7 · dc960d7
1 parent 7736429
commit dc960d7
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 12 deletions.
diff --git a/lib/Doctrine/ORM/Internal/Hydration/IterableResult.php b/lib/Doctrine/ORM/Internal/Hydration/IterableResult.php
@@ -21,6 +21,7 @@
 namespace Doctrine\ORM\Internal\Hydration;
 
 use Iterator;
+use ReturnTypeWillChange;
 
 /**
  * Represents a result structure that can be iterated over, hydrating row-by-row
@@ -55,6 +56,7 @@ public function __construct($hydrator)
      *
      * @throws HydrationException
      */
+    #[ReturnTypeWillChange]
     public function rewind()
     {
         if ($this->_rewinded === true) {
@@ -70,6 +72,7 @@ public function rewind()
      *
      * @return mixed[]|false
      */
+    #[ReturnTypeWillChange]
     public function next()
     {
         $this->_current = $this->_hydrator->hydrateRow();
@@ -81,6 +84,7 @@ public function next()
     /**
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function current()
     {
         return $this->_current;
@@ -89,6 +93,7 @@ public function current()
     /**
      * @return int
      */
+    #[ReturnTypeWillChange]
     public function key()
     {
         return $this->_key;
@@ -97,6 +102,7 @@ public function key()
     /**
      * @return bool
      */
+    #[ReturnTypeWillChange]
     public function valid()
     {
         return $this->_current !== false;

diff --git a/lib/Doctrine/ORM/Query/TreeWalkerChainIterator.php b/lib/Doctrine/ORM/Query/TreeWalkerChainIterator.php
@@ -23,6 +23,7 @@
 use ArrayAccess;
 use Doctrine\ORM\AbstractQuery;
 use Iterator;
+use ReturnTypeWillChange;
 
 use function key;
 use function next;
@@ -58,6 +59,7 @@ public function __construct(TreeWalkerChain $treeWalkerChain, $query, $parserRes
      * @return string|false
      * @psalm-return class-string<TreeWalker>|false
      */
+    #[ReturnTypeWillChange]
     public function rewind()
     {
         return reset($this->walkers);
@@ -66,6 +68,7 @@ public function rewind()
     /**
      * @return TreeWalker|null
      */
+    #[ReturnTypeWillChange]
     public function current()
     {
         return $this->offsetGet(key($this->walkers));
@@ -74,6 +77,7 @@ public function current()
     /**
      * @return int
      */
+    #[ReturnTypeWillChange]
     public function key()
     {
         return key($this->walkers);
@@ -82,6 +86,7 @@ public function key()
     /**
      * @return TreeWalker|null
      */
+    #[ReturnTypeWillChange]
     public function next()
     {
         next($this->walkers);
@@ -92,6 +97,7 @@ public function next()
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function valid()
     {
         return key($this->walkers) !== null;
@@ -100,6 +106,7 @@ public function valid()
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return isset($this->walkers[$offset]);
@@ -111,6 +118,7 @@ public function offsetExists($offset)
      *
      * @return TreeWalker|null
      */
+    #[ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         if ($this->offsetExists($offset)) {
@@ -130,6 +138,7 @@ public function offsetGet($offset)
      * @param string $value
      * @psalm-param array-key|null $offset
      */
+    #[ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         if ($offset === null) {
@@ -142,6 +151,7 @@ public function offsetSet($offset, $value)
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         if ($this->offsetExists($offset)) {

diff --git a/lib/Doctrine/ORM/Tools/Console/MetadataFilter.php b/lib/Doctrine/ORM/Tools/Console/MetadataFilter.php
@@ -24,6 +24,7 @@
 use Countable;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use FilterIterator;
+use ReturnTypeWillChange;
 use RuntimeException;
 
 use function assert;
@@ -70,6 +71,7 @@ public function __construct(ArrayIterator $metadata, $filter)
     /**
      * @return bool
      */
+    #[ReturnTypeWillChange]
     public function accept()
     {
         if (count($this->filter) === 0) {
@@ -99,6 +101,7 @@ public function accept()
     /**
      * @return ArrayIterator<int, ClassMetadata>
      */
+    #[ReturnTypeWillChange]
     public function getInnerIterator()
     {
         $innerIterator = parent::getInnerIterator();
@@ -111,6 +114,7 @@ public function getInnerIterator()
     /**
      * @return int
      */
+    #[ReturnTypeWillChange]
     public function count()
     {
         return count($this->getInnerIterator());

diff --git a/lib/Doctrine/ORM/Tools/Pagination/Paginator.php b/lib/Doctrine/ORM/Tools/Pagination/Paginator.php
@@ -30,6 +30,7 @@
 use Doctrine\ORM\Query\ResultSetMapping;
 use Doctrine\ORM\QueryBuilder;
 use IteratorAggregate;
+use ReturnTypeWillChange;
 
 use function array_key_exists;
 use function array_map;
@@ -117,6 +118,7 @@ public function setUseOutputWalkers($useOutputWalkers)
     /**
      * {@inheritdoc}
      */
+    #[ReturnTypeWillChange]
     public function count()
     {
         if ($this->count === null) {
@@ -135,6 +137,7 @@ public function count()
      *
      * @psalm-return ArrayIterator<array-key, T>
      */
+    #[ReturnTypeWillChange]
     public function getIterator()
     {
         $offset = $this->query->getFirstResult();

diff --git a/tests/Doctrine/Tests/Mocks/HydratorMockStatement.php b/tests/Doctrine/Tests/Mocks/HydratorMockStatement.php
@@ -4,9 +4,11 @@
 
 namespace Doctrine\Tests\Mocks;
 
+use ArrayIterator;
 use Doctrine\DBAL\Driver\Statement;
 use IteratorAggregate;
 use PDO;
+use Traversable;
 
 use function array_shift;
 use function current;
@@ -127,12 +129,9 @@ public function rowCount()
     {
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getIterator()
+    public function getIterator(): Traversable
     {
-        return $this->_resultSet;
+        return new ArrayIterator($this->_resultSet);
     }
 
     /**

diff --git a/tests/Doctrine/Tests/Mocks/StatementArrayMock.php b/tests/Doctrine/Tests/Mocks/StatementArrayMock.php
@@ -6,6 +6,7 @@
 
 use ArrayIterator;
 use PDO;
+use Traversable;
 
 use function count;
 use function current;
@@ -32,7 +33,7 @@ public function __construct(array $result)
     /**
      * @psalm-return ArrayIterator<int, mixed>
      */
-    public function getIterator(): ArrayIterator
+    public function getIterator(): Traversable
     {
         return new ArrayIterator($this->_result);
     }

diff --git a/tests/Doctrine/Tests/Mocks/StatementMock.php b/tests/Doctrine/Tests/Mocks/StatementMock.php
@@ -5,8 +5,10 @@
 namespace Doctrine\Tests\Mocks;
 
 use Doctrine\DBAL\Driver\Statement;
+use EmptyIterator;
 use IteratorAggregate;
 use PDO;
+use Traversable;
 
 /**
  * This class is a mock of the Statement interface.
@@ -97,10 +99,8 @@ public function fetchColumn($columnIndex = 0)
     {
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getIterator()
+    public function getIterator(): Traversable
     {
+        return new EmptyIterator();
     }
 }
diff --git a/tests/Doctrine/Tests/Models/CMS/CmsGroup.php b/tests/Doctrine/Tests/Models/CMS/CmsGroup.php
@@ -66,9 +66,9 @@ public function getUsers(): Collection
     }
 
     /**
-     * @return ArrayCollection|Traversable
+     * @return Collection<int, CmsUser>
      */
-    public function getIterator()
+    public function getIterator(): Collection
     {
         return $this->getUsers();
     }