class property naming changes for iterator classes

Author: hkulekci

src/Helper/Iterators/SearchHitIterator.php

@@ -14,9 +14,12 @@
 
 namespace Elastic\Elasticsearch\Helper\Iterators;
 
+use Countable;
+use Elastic\Elasticsearch\Exception\ClientResponseException;
+use Elastic\Elasticsearch\Exception\ServerResponseException;
 use Iterator;
 
-class SearchHitIterator implements Iterator, \Countable
+class SearchHitIterator implements Iterator, Countable
 {
 
     /**
@@ -58,6 +61,8 @@ public function __construct(SearchResponseIterator $searchResponses)
      * Rewinds the internal SearchResponseIterator and itself
      *
      * @return void
+     * @throws ClientResponseException
+     * @throws ServerResponseException
      * @see    Iterator::rewind()
      */
     public function rewind(): void
@@ -66,14 +71,14 @@ public function rewind(): void
         $this->searchResponses->rewind();
 
         // The first page may be empty. In that case, the next page is fetched.
-        $current_page = $this->searchResponses->current();
-        if ($this->searchResponses->valid() && empty($current_page['hits']['hits'])) {
+        $currentPage = $this->searchResponses->current();
+        if ($this->searchResponses->valid() && empty($currentPage['hits']['hits'])) {
             $this->searchResponses->next();
         }
 
         $this->count = 0;
-        if (isset($current_page['hits']) && isset($current_page['hits']['total'])) {
-            $this->count = $current_page['hits']['total']['value'] ?? $current_page['hits']['total'];
+        if (isset($currentPage['hits']['total']['value'], $currentPage['hits']['total'])) {
+            $this->count = $currentPage['hits']['total']['value'] ?? $currentPage['hits']['total'];
         }
 
         $this->readPageData();
@@ -85,15 +90,17 @@ public function rewind(): void
      * pointer to the first hit in the page.
      *
      * @return void
+     * @throws ClientResponseException
+     * @throws ServerResponseException
      * @see    Iterator::next()
      */
     public function next(): void
     {
         $this->currentKey++;
         $this->currentHitIndex++;
-        $current_page = $this->searchResponses->current();
-        if (isset($current_page['hits']['hits'][$this->currentHitIndex])) {
-            $this->currentHitData = $current_page['hits']['hits'][$this->currentHitIndex];
+        $currentPage = $this->searchResponses->current();
+        if (isset($currentPage['hits']['hits'][$this->currentHitIndex])) {
+            $this->currentHitData = $currentPage['hits']['hits'][$this->currentHitIndex];
         } else {
             $this->searchResponses->next();
             $this->readPageData();
@@ -141,9 +148,9 @@ public function key(): int
     private function readPageData(): void
     {
         if ($this->searchResponses->valid()) {
-            $current_page = $this->searchResponses->current();
+            $currentPage = $this->searchResponses->current();
             $this->currentHitIndex = 0;
-            $this->currentHitData = $current_page['hits']['hits'][$this->currentHitIndex];
+            $this->currentHitData = $currentPage['hits']['hits'][$this->currentHitIndex];
         } else {
             $this->currentHitData = null;
         }

src/Helper/Iterators/SearchResponseIterator.php

@@ -50,22 +50,22 @@ class SearchResponseIterator implements Iterator
     /**
      * @var string duration
      */
-    private $scroll_ttl;
+    private $scrollTtl;
 
     /**
      * Constructor
      *
      * @param ClientInterface $client
-     * @param array  $search_params Associative array of parameters
+     * @param array  $searchParams Associative array of parameters
      * @see   ClientInterface::search()
      */
-    public function __construct(ClientInterface $client, array $search_params)
+    public function __construct(ClientInterface $client, array $searchParams)
     {
         $this->client = $client;
-        $this->params = $search_params;
+        $this->params = $searchParams;
 
-        if (isset($search_params['scroll'])) {
-            $this->scroll_ttl = $search_params['scroll'];
+        if (isset($searchParams['scroll'])) {
+            $this->scrollTtl = $searchParams['scroll'];
         }
     }
 
@@ -83,12 +83,12 @@ public function __destruct()
     /**
      * Sets the time to live duration of a scroll window
      *
-     * @param  string $time_to_live
+     * @param  string $timeToLive
      * @return $this
      */
-    public function setScrollTimeout(string $time_to_live): SearchResponseIterator
+    public function setScrollTimeout(string $timeToLive): SearchResponseIterator
     {
-        $this->scroll_ttl = $time_to_live;
+        $this->scrollTtl = $timeToLive;
         return $this;
     }
 
@@ -136,6 +136,8 @@ public function rewind(): void
      * Fetches every "page" after the first one using the lastest "scroll_id"
      *
      * @return void
+     * @throws ClientResponseException
+     * @throws ServerResponseException
      * @see    Iterator::next()
      */
     public function next(): void
@@ -144,7 +146,7 @@ public function next(): void
             [
                 'body' => [
                     'scroll_id' => $this->scrollId,
-                    'scroll'    => $this->scroll_ttl
+                    'scroll'    => $this->scrollTtl
                 ]
             ]
         )->asArray();

tests/Helper/Iterators/SearchResponseIteratorTest.php

@@ -74,7 +74,7 @@ public function testWithNoResults(): void
         $this->assertCount(0, $responses);
     }
 
-    public function testWithHits()
+    public function testWithHits(): void
     {
         $search_params = [
             'scroll'      => '5m',