Add return type-hint to result classes

Author: deguif

src/Paginator/HybridPartialResults.php

@@ -34,7 +34,7 @@ public function __construct(ResultSet $resultSet, ElasticaToModelTransformerInte
     /**
      * {@inheritdoc}
      */
-    public function toArray()
+    public function toArray(): array
     {
         return $this->transformer->hybridTransform($this->resultSet->getResults());
     }

src/Paginator/PartialResultsInterface.php

@@ -15,22 +15,16 @@ interface PartialResultsInterface
 {
     /**
      * Returns the paginated results.
-     *
-     * @return array
      */
-    public function toArray();
+    public function toArray(): array;
 
     /**
      * Returns the number of results.
-     *
-     * @return int The number of results
      */
-    public function getTotalHits();
+    public function getTotalHits(): int;
 
     /**
      * Returns the aggregations.
-     *
-     * @return array
      */
-    public function getAggregations();
+    public function getAggregations(): array;
 }

src/Paginator/RawPartialResults.php

@@ -29,7 +29,7 @@ public function __construct(ResultSet $resultSet)
     /**
      * {@inheritdoc}
      */
-    public function toArray()
+    public function toArray(): array
     {
         return \array_map(function (Result $result) {
             return $result->getSource();
@@ -39,32 +39,21 @@ public function toArray()
     /**
      * {@inheritdoc}
      */
-    public function getTotalHits()
+    public function getTotalHits(): int
     {
         return $this->resultSet->getTotalHits();
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getAggregations()
+    public function getAggregations(): array
     {
-        if ($this->resultSet->hasAggregations()) {
-            return $this->resultSet->getAggregations();
-        }
-
-        return;
+        return $this->resultSet->getAggregations();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getSuggests()
+    public function getSuggests(): array
     {
-        if ($this->resultSet->hasSuggests()) {
-            return $this->resultSet->getSuggests();
-        }
-
-        return;
+        return $this->resultSet->getSuggests();
     }
 }

src/Paginator/TransformedPartialResults.php

@@ -31,7 +31,7 @@ public function __construct(ResultSet $resultSet, ElasticaToModelTransformerInte
     /**
      * {@inheritdoc}
      */
-    public function toArray()
+    public function toArray(): array
     {
         return $this->transformer->transform($this->resultSet->getResults());
     }