Add #[ReturnTypeWillChange] and related @return (#855)

Author: nicolas-grekas

src/ChangeStream.php

@@ -24,6 +24,7 @@
 use MongoDB\Driver\Exception\ServerException;
 use MongoDB\Exception\ResumeTokenException;
 use MongoDB\Model\ChangeStreamIterator;
+use ReturnTypeWillChange;
 
 use function call_user_func;
 use function in_array;
@@ -102,6 +103,7 @@ public function __construct(ChangeStreamIterator $iterator, callable $resumeCall
      * @see http://php.net/iterator.current
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function current()
     {
         return $this->iterator->current();
@@ -133,6 +135,7 @@ public function getResumeToken()
      * @see http://php.net/iterator.key
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function key()
     {
         if ($this->valid()) {
@@ -147,6 +150,7 @@ public function key()
      * @return void
      * @throws ResumeTokenException
      */
+    #[ReturnTypeWillChange]
     public function next()
     {
         try {
@@ -162,6 +166,7 @@ public function next()
      * @return void
      * @throws ResumeTokenException
      */
+    #[ReturnTypeWillChange]
     public function rewind()
     {
         try {
@@ -179,6 +184,7 @@ public function rewind()
      * @see http://php.net/iterator.valid
      * @return boolean
      */
+    #[ReturnTypeWillChange]
     public function valid()
     {
         return $this->iterator->valid();

src/MapReduceResult.php

@@ -18,6 +18,7 @@
 namespace MongoDB;
 
 use IteratorAggregate;
+use ReturnTypeWillChange;
 use stdClass;
 use Traversable;
 
@@ -87,6 +88,7 @@ public function getExecutionTimeMS()
      * @see http://php.net/iteratoraggregate.getiterator
      * @return Traversable
      */
+    #[ReturnTypeWillChange]
     public function getIterator()
     {
         return call_user_func($this->getIterator);

src/Model/BSONArray.php

@@ -21,6 +21,7 @@
 use JsonSerializable;
 use MongoDB\BSON\Serializable;
 use MongoDB\BSON\Unserializable;
+use ReturnTypeWillChange;
 
 use function array_values;
 use function MongoDB\recursive_copy;
@@ -95,6 +96,7 @@ public function bsonUnserialize(array $data)
      * @see http://php.net/jsonserializable.jsonserialize
      * @return array
      */
+    #[ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return array_values($this->getArrayCopy());

src/Model/BSONDocument.php

@@ -21,6 +21,7 @@
 use JsonSerializable;
 use MongoDB\BSON\Serializable;
 use MongoDB\BSON\Unserializable;
+use ReturnTypeWillChange;
 
 use function MongoDB\recursive_copy;
 
@@ -102,6 +103,7 @@ public function bsonUnserialize(array $data)
      * @see http://php.net/jsonserializable.jsonserialize
      * @return object
      */
+    #[ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return (object) $this->getArrayCopy();

src/Model/BSONIterator.php

@@ -20,6 +20,7 @@
 use Iterator;
 use MongoDB\Exception\InvalidArgumentException;
 use MongoDB\Exception\UnexpectedValueException;
+use ReturnTypeWillChange;
 
 use function is_array;
 use function MongoDB\BSON\toPHP;
@@ -86,6 +87,7 @@ public function __construct($data, array $options = [])
      * @see http://php.net/iterator.current
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function current()
     {
         return $this->current;
@@ -95,6 +97,7 @@ public function current()
      * @see http://php.net/iterator.key
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function key()
     {
         return $this->key;
@@ -104,6 +107,7 @@ public function key()
      * @see http://php.net/iterator.next
      * @return void
      */
+    #[ReturnTypeWillChange]
     public function next()
     {
         $this->key++;
@@ -115,6 +119,7 @@ public function next()
      * @see http://php.net/iterator.rewind
      * @return void
      */
+    #[ReturnTypeWillChange]
     public function rewind()
     {
         $this->key = 0;
@@ -127,6 +132,7 @@ public function rewind()
      * @see http://php.net/iterator.valid
      * @return boolean
      */
+    #[ReturnTypeWillChange]
     public function valid()
     {
         return $this->current !== null;

src/Model/CachingIterator.php

@@ -20,6 +20,7 @@
 use Countable;
 use Iterator;
 use IteratorIterator;
+use ReturnTypeWillChange;
 use Traversable;
 
 use function count;
@@ -71,6 +72,7 @@ public function __construct(Traversable $traversable)
      * @see http://php.net/countable.count
      * @return integer
      */
+    #[ReturnTypeWillChange]
     public function count()
     {
         $this->exhaustIterator();
@@ -82,6 +84,7 @@ public function count()
      * @see http://php.net/iterator.current
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function current()
     {
         return current($this->items);
@@ -91,6 +94,7 @@ public function current()
      * @see http://php.net/iterator.key
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function key()
     {
         return key($this->items);
@@ -100,6 +104,7 @@ public function key()
      * @see http://php.net/iterator.next
      * @return void
      */
+    #[ReturnTypeWillChange]
     public function next()
     {
         if (! $this->iteratorExhausted) {
@@ -118,6 +123,7 @@ public function next()
      * @see http://php.net/iterator.rewind
      * @return void
      */
+    #[ReturnTypeWillChange]
     public function rewind()
     {
         /* If the iterator has advanced, exhaust it now so that future iteration
@@ -134,6 +140,7 @@ public function rewind()
      * @see http://php.net/iterator.valid
      * @return boolean
      */
+    #[ReturnTypeWillChange]
     public function valid()
     {
         return $this->key() !== null;

src/Model/CallbackIterator.php

@@ -20,6 +20,7 @@
 use Closure;
 use Iterator;
 use IteratorIterator;
+use ReturnTypeWillChange;
 use Traversable;
 
 /**
@@ -45,6 +46,7 @@ public function __construct(Traversable $traversable, Closure $callback)
      * @see http://php.net/iterator.current
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function current()
     {
         return ($this->callback)($this->iterator->current());
@@ -54,6 +56,7 @@ public function current()
      * @see http://php.net/iterator.key
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function key()
     {
         return $this->iterator->key();
@@ -63,6 +66,7 @@ public function key()
      * @see http://php.net/iterator.next
      * @return void
      */
+    #[ReturnTypeWillChange]
     public function next()
     {
         $this->iterator->next();
@@ -72,6 +76,7 @@ public function next()
      * @see http://php.net/iterator.rewind
      * @return void
      */
+    #[ReturnTypeWillChange]
     public function rewind()
     {
         $this->iterator->rewind();
@@ -81,6 +86,7 @@ public function rewind()
      * @see http://php.net/iterator.valid
      * @return boolean
      */
+    #[ReturnTypeWillChange]
     public function valid()
     {
         return $this->iterator->valid();

src/Model/ChangeStreamIterator.php

@@ -28,6 +28,7 @@
 use MongoDB\Exception\InvalidArgumentException;
 use MongoDB\Exception\ResumeTokenException;
 use MongoDB\Exception\UnexpectedValueException;
+use ReturnTypeWillChange;
 
 use function count;
 use function is_array;
@@ -139,6 +140,7 @@ final public function commandSucceeded(CommandSucceededEvent $event)
      * @see https://php.net/iteratoriterator.current
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function current()
     {
         return $this->isValid ? parent::current() : null;
@@ -170,6 +172,7 @@ public function getServer(): Server
      * @see https://php.net/iteratoriterator.key
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function key()
     {
         return $this->isValid ? parent::key() : null;
@@ -179,6 +182,7 @@ public function key()
      * @see https://php.net/iteratoriterator.rewind
      * @return void
      */
+    #[ReturnTypeWillChange]
     public function next()
     {
         /* Determine if advancing the iterator will execute a getMore command
@@ -206,6 +210,7 @@ public function next()
      * @see https://php.net/iteratoriterator.rewind
      * @return void
      */
+    #[ReturnTypeWillChange]
     public function rewind()
     {
         if ($this->isRewindNop) {
@@ -220,6 +225,7 @@ public function rewind()
      * @see https://php.net/iteratoriterator.valid
      * @return boolean
      */
+    #[ReturnTypeWillChange]
     public function valid()
     {
         return $this->isValid;

src/Model/CollectionInfo.php

@@ -19,6 +19,7 @@
 
 use ArrayAccess;
 use MongoDB\Exception\BadMethodCallException;
+use ReturnTypeWillChange;
 
 use function array_key_exists;
 
@@ -156,6 +157,7 @@ public function isCapped()
      * @param mixed $key
      * @return boolean
      */
+    #[ReturnTypeWillChange]
     public function offsetExists($key)
     {
         return array_key_exists($key, $this->info);
@@ -168,6 +170,7 @@ public function offsetExists($key)
      * @param mixed $key
      * @return mixed
      */
+    #[ReturnTypeWillChange]
     public function offsetGet($key)
     {
         return $this->info[$key];
@@ -180,7 +183,9 @@ public function offsetGet($key)
      * @param mixed $key
      * @param mixed $value
      * @throws BadMethodCallException
+     * @return void
      */
+    #[ReturnTypeWillChange]
     public function offsetSet($key, $value)
     {
         throw BadMethodCallException::classIsImmutable(self::class);
@@ -192,7 +197,9 @@ public function offsetSet($key, $value)
      * @see http://php.net/arrayaccess.offsetunset
      * @param mixed $key
      * @throws BadMethodCallException
+     * @return void
      */
+    #[ReturnTypeWillChange]
     public function offsetUnset($key)
     {
         throw BadMethodCallException::classIsImmutable(self::class);

src/Model/CollectionInfoIterator.php

@@ -18,6 +18,7 @@
 namespace MongoDB\Model;
 
 use Iterator;
+use ReturnTypeWillChange;
 
 /**
  * CollectionInfoIterator interface.
@@ -34,5 +35,6 @@ interface CollectionInfoIterator extends Iterator
      *
      * @return CollectionInfo
      */
+    #[ReturnTypeWillChange]
     public function current();
 }