Merge pull request #1773 from deguif/master

Add return type-hint to result classes

Author: XWB

CHANGELOG-6.0.md

@@ -18,6 +18,7 @@ in 6.0 versions.
 * **[BC break]** Marked all events final and introduced several abstract classes.
 * **[BC break]** Signature of `FantaPaginatorAdapter::getNbResults()` has changed.
 * **[BC break]** Signature of `FantaPaginatorAdapter::getSlice()` has changed.
+* **[BC break]** Signature of `PartialResultsInterface::toArray()`, `PartialResultsInterface::getTotalHits()` and `PartialResultsInterface::getAggregations()` have changed.
 
 ### 6.0.0-BETA3 (2020-09-28)
 

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());
     }

tests/Unit/Paginator/HybridPartialResultsTest.php

@@ -20,6 +20,11 @@ class HybridPartialResultsTest extends UnitTestHelper
     public function testToArray()
     {
         $transformer = $this->mockElasticaToModelTransformer();
+        $transformer
+            ->expects($this->once())
+            ->method('hybridTransform')
+            ->willReturn([])
+        ;
 
         $resultSet = $this->mockResultSet();