PHP 8.1 > internal_method_return_types

https://wiki.php.net/rfc/internal_method_return_types

PHP 8.0 added return type for abstract methods on Iterator, ArrayAccess, Countable, IteratorAggregate
PHP 8.1 made non implementation as a Deprecated Warning
PHP 9.0 (no release date at this moment) will drop the support.

Temporary Fix : adding this Attribute
#[\ReturnTypeWillChange]
Will drop the Deprecated warning.

Adding return type will break compatibility before PHP 7.4,
Return type has been added on PHP 7.0, but "mixed" special type is required, and it has been added on PHP 7.4.
In order to be compatible with future PHP 9.0, once it will be release, we will have to drop the support to PHP Version before 7.4

Currently a lot of Unix distribution in LTS are running a PHP Version older than 7.4 so moving to the final solution of "add return type" should break a lot of setup for the moment.

Add missing Annotation

Author: Tybaze

lib/Doctrine/Access.php

@@ -89,6 +89,7 @@ public function __isset($name)
      * @param   string $name
      * @return  void
      */
+    #[\ReturnTypeWillChange]
     public function __unset($name)
     {
         return $this->remove($name);
@@ -100,6 +101,7 @@ public function __unset($name)
      * @param   mixed $offset
      * @return  boolean Whether or not this object contains $offset
      */
+    #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return $this->contains($offset);
@@ -112,6 +114,7 @@ public function offsetExists($offset)
      * @param   mixed $offset
      * @return  mixed
      */
+    #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         // array notation with no index was causing 'undefined variable: $offset' notices in php7,
@@ -131,6 +134,7 @@ public function offsetGet($offset)
      * @param   mixed $value
      * @return  void
      */
+    #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         if ( ! isset($offset)) {
@@ -146,6 +150,7 @@ public function offsetSet($offset, $value)
      * @see   set, offsetSet, __set
      * @param mixed $offset
      */
+    #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         return $this->remove($offset);

lib/Doctrine/Collection.php

@@ -456,6 +456,7 @@ public function getKeys()
      *
      * @return integer
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return count($this->data);
@@ -1060,6 +1061,7 @@ public function free($deep = false)
      *
      * @return Iterator
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         $data = $this->data;

lib/Doctrine/Connection.php

@@ -1178,6 +1178,7 @@ public function getTables()
      *
      * @return ArrayIterator        SPL ArrayIterator object
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new ArrayIterator($this->tables);
@@ -1188,6 +1189,7 @@ public function getIterator()
      *
      * @return integer
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return $this->_count;

lib/Doctrine/Connection/Profiler.php

@@ -68,8 +68,8 @@ public function __construct() {
      * @return boolean
      */
     public function setFilterQueryType() {
-                                             
-    }                                         
+
+    }
     /**
      * method overloader
      * this method is used for invoking different listeners, for the full
@@ -109,7 +109,7 @@ public function __call($m, $a)
      * @param mixed $key
      * @return Doctrine_Event
      */
-    public function get($key) 
+    public function get($key)
     {
         if (isset($this->events[$key])) {
             return $this->events[$key];
@@ -123,7 +123,7 @@ public function get($key)
      *
      * @return array        all events in an array
      */
-    public function getAll() 
+    public function getAll()
     {
         return $this->events;
     }
@@ -134,17 +134,19 @@ public function getAll()
      *
      * @return ArrayIterator
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new ArrayIterator($this->events);
     }
 
     /**
      * count
-     * 
+     *
      * @return integer
      */
-    public function count() 
+    #[\ReturnTypeWillChange]
+    public function count()
     {
         return count($this->events);
     }
@@ -154,7 +156,7 @@ public function count()
      *
      * @return Doctrine_Event
      */
-    public function pop() 
+    public function pop()
     {
         $event = array_pop($this->events);
         if ($event !== null)

lib/Doctrine/Manager.php

@@ -638,6 +638,7 @@ public function contains($key)
      *
      * @return integer
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return count($this->_connections);
@@ -648,6 +649,7 @@ public function count()
      *
      * @return ArrayIterator
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new ArrayIterator($this->_connections);

lib/Doctrine/Query.php

@@ -2134,6 +2134,7 @@ public function getCountSqlQuery()
      * @param array $params        an array of prepared statement parameters
      * @return integer             the count of this query
      */
+    #[\ReturnTypeWillChange]
     public function count($params = array())
     {
         $q = $this->getCountSqlQuery();

lib/Doctrine/Record.php

@@ -1886,6 +1886,7 @@ public function getPrepared(array $array = array())
      *
      * @return integer          the number of columns in this record
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return count($this->_data);
@@ -2183,6 +2184,7 @@ public function hasRelation($fieldName)
      * implements IteratorAggregate interface
      * @return Doctrine_Record_Iterator     iterator through data
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new Doctrine_Record_Iterator($this);

lib/Doctrine/Record/Iterator.php

@@ -68,6 +68,7 @@ public static function initNullObject(Doctrine_Null $null)
      *
      * @return mixed
      */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         $value = parent::current();

lib/Doctrine/Relation.php

@@ -169,11 +169,13 @@ public function isEqual()
         return $this->definition['equal'];
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return isset($this->definition[$offset]);
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         if (isset($this->definition[$offset])) {
@@ -183,13 +185,15 @@ public function offsetGet($offset)
         return null;
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         if (isset($this->definition[$offset])) {
             $this->definition[$offset] = $value;
         }
     }
 
+    #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         $this->definition[$offset] = false;

lib/Doctrine/Table.php

@@ -1982,6 +1982,7 @@ final public function applyInheritance($where)
      *
      * @return integer number of records in the table
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return $this->createQuery()->count();