Merge pull request #277 from derrabus/bugfix/return-type-will-change

Add ReturnTypeWillChange where necessary
doctrine · Aug 4, 2021 · a382560 · a382560
2 parents 6a9fc01 + 36bd638
commit a382560
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 3 deletions.
diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml
@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.4"
+          - "8.0"
 
     steps:
       - name: "Checkout"

diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.4"
+          - "8.0"
 
     steps:
       - name: "Checkout code"
@@ -44,7 +44,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.4"
+          - "8.0"
 
     steps:
       - name: "Checkout code"

diff --git a/lib/Doctrine/Common/Collections/AbstractLazyCollection.php b/lib/Doctrine/Common/Collections/AbstractLazyCollection.php
@@ -3,6 +3,7 @@
 namespace Doctrine\Common\Collections;
 
 use Closure;
+use ReturnTypeWillChange;
 use Traversable;
 
 /**
@@ -30,6 +31,7 @@ abstract class AbstractLazyCollection implements Collection
      *
      * @return int
      */
+    #[ReturnTypeWillChange]
     public function count()
     {
         $this->initialize();
@@ -281,6 +283,7 @@ public function slice($offset, $length = null)
      * @return Traversable<int|string, mixed>
      * @psalm-return Traversable<TKey,T>
      */
+    #[ReturnTypeWillChange]
     public function getIterator()
     {
         $this->initialize();
@@ -295,6 +298,7 @@ public function getIterator()
      *
      * @return bool
      */
+    #[ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         $this->initialize();
@@ -310,6 +314,7 @@ public function offsetExists($offset)
      *
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         $this->initialize();
@@ -323,6 +328,7 @@ public function offsetGet($offset)
      * @param mixed $value
      * @psalm-param TKey $offset
      */
+    #[ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         $this->initialize();
@@ -334,6 +340,7 @@ public function offsetSet($offset, $value)
      *
      * @psalm-param TKey $offset
      */
+    #[ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         $this->initialize();

diff --git a/lib/Doctrine/Common/Collections/ArrayCollection.php b/lib/Doctrine/Common/Collections/ArrayCollection.php
@@ -5,6 +5,7 @@
 use ArrayIterator;
 use Closure;
 use Doctrine\Common\Collections\Expr\ClosureExpressionVisitor;
+use ReturnTypeWillChange;
 use Traversable;
 
 use function array_filter;
@@ -170,6 +171,7 @@ public function removeElement($element)
      *
      * @return bool
      */
+    #[ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return $this->containsKey($offset);
@@ -182,6 +184,7 @@ public function offsetExists($offset)
      *
      * @psalm-param TKey $offset
      */
+    #[ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         return $this->get($offset);
@@ -192,6 +195,7 @@ public function offsetGet($offset)
      *
      * {@inheritDoc}
      */
+    #[ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         if (! isset($offset)) {
@@ -210,6 +214,7 @@ public function offsetSet($offset, $value)
      *
      * @psalm-param TKey $offset
      */
+    #[ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         $this->remove($offset);
@@ -282,6 +287,7 @@ public function getValues()
      *
      * @return int
      */
+    #[ReturnTypeWillChange]
     public function count()
     {
         return count($this->elements);
@@ -324,6 +330,7 @@ public function isEmpty()
      * @return Traversable<int|string, mixed>
      * @psalm-return Traversable<TKey,T>
      */
+    #[ReturnTypeWillChange]
     public function getIterator()
     {
         return new ArrayIterator($this->elements);

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -12,3 +12,6 @@ parameters:
         -
             message: '~Array \(array\<TKey of \(int\|string\), T\>\) does not accept key int\.~'
             path: 'lib/Doctrine/Common/Collections/ArrayCollection.php'
+
+        # This class is new in PHP 8.1 and PHPStan does not know it yet.
+        - '/Attribute class ReturnTypeWillChange does not exist./'
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -54,5 +54,12 @@
                 <file name="lib/Doctrine/Common/Collections/ArrayCollection.php"/>
             </errorLevel>
         </UnsafeGenericInstantiation>
+
+        <UndefinedAttributeClass>
+            <errorLevel type="suppress">
+                <!-- This class is new in PHP 8.1 and Psalm does not know it yet. -->
+                <referencedClass name="ReturnTypeWillChange"/>
+            </errorLevel>
+        </UndefinedAttributeClass>
     </issueHandlers>
 </psalm>