fix: add #[\ReturnTypeWillChange] when needed (#697)

Author: damcou

src/Iterators/AbstractAlgoliaIterator.php

@@ -68,6 +68,7 @@ public function __construct($indexName, ApiWrapper $api, $requestOptions = [])
      *
      * @return array
      */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         $hit = $this->response['hits'][$this->batchKey];
@@ -78,6 +79,7 @@ public function current()
     /**
      * Move forward to next element.
      */
+    #[\ReturnTypeWillChange]
     public function next()
     {
         $this->key++;
@@ -94,6 +96,7 @@ public function next()
      *
      * @return int
      */
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->key;
@@ -107,6 +110,7 @@ public function key()
      * @return bool the return value will be casted to boolean and then evaluated.
      *              Returns true on success or false on failure
      */
+    #[\ReturnTypeWillChange]
     public function valid()
     {
         return isset($this->response['hits'][$this->batchKey]);
@@ -115,6 +119,7 @@ public function valid()
     /**
      * Rewind the Iterator to the first element.
      */
+    #[\ReturnTypeWillChange]
     public function rewind()
     {
         if (0 !== $this->key) {

src/Response/AbstractResponse.php

@@ -22,6 +22,7 @@ public function getBody()
     /**
      * {@inheritdoc}
      */
+    #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
         return isset($this->apiResponse[$offset]);
@@ -30,6 +31,7 @@ public function offsetExists($offset)
     /**
      * {@inheritdoc}
      */
+    #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
         return $this->apiResponse[$offset];
@@ -38,6 +40,7 @@ public function offsetGet($offset)
     /**
      * {@inheritdoc}
      */
+    #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
         $this->apiResponse[$offset] = $value;
@@ -46,6 +49,7 @@ public function offsetSet($offset, $value)
     /**
      * {@inheritdoc}
      */
+    #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         unset($this->apiResponse[$offset]);

src/Response/BatchIndexingResponse.php

@@ -41,31 +41,37 @@ public function wait($requestOptions = [])
      *
      * @return number of response from the API (number of batches sent)
      */
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return count($this->apiResponse);
     }
 
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return $this->apiResponse[$this->key];
     }
 
+    #[\ReturnTypeWillChange]
     public function next()
     {
         $this->key++;
     }
 
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->key;
     }
 
+    #[\ReturnTypeWillChange]
     public function valid()
     {
         return isset($this->apiResponse[$this->key]);
     }
 
+    #[\ReturnTypeWillChange]
     public function rewind()
     {
         $this->key = 0;

src/Response/MultiResponse.php

@@ -20,31 +20,37 @@ public function wait($requestOptions = [])
         return $this;
     }
 
+    #[\ReturnTypeWillChange]
     public function count()
     {
         return count($this->apiResponse);
     }
 
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return $this->apiResponse[$this->key];
     }
 
+    #[\ReturnTypeWillChange]
     public function next()
     {
         $this->key++;
     }
 
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->key;
     }
 
+    #[\ReturnTypeWillChange]
     public function valid()
     {
         return isset($this->apiResponse[$this->key]);
     }
 
+    #[\ReturnTypeWillChange]
     public function rewind()
     {
         $this->key = 0;