Apply search changes

.code-samples.meilisearch.yaml

@@ -272,7 +272,7 @@ search_parameter_guide_highlight_tag_1: |-
     'highlightPostTag' => '</span>'
   ]);
 search_parameter_guide_matches_1: |-
-  $client->index('movies')->search('winter feast', ['attributesToHighlight' => ['overview'], 'matches' => true]);
+  $client->index('movies')->search('winter feast', ['attributesToHighlight' => ['overview'], 'showMatchesPosition' => true]);
 settings_guide_synonyms_1: |-
   $client->index('tops')->updateSettings([
     'synonyms' => [
@@ -468,7 +468,7 @@ faceted_search_update_settings_1: |-
 faceted_search_filter_1: |-
   $client->index('movies')->search('thriller', ['filter' => [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']]);
 faceted_search_facets_distribution_1: |-
-  $client->index('movies')->search('Batman', ['facetsDistribution' => ['genres']]);
+  $client->index('movies')->search('Batman', ['facets' => ['genres']]);
 faceted_search_walkthrough_filter_1: |-
   $client->index('movies')->search('thriller', ['filter' => [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']]);
 post_dump_1: |-

README.md

@@ -207,7 +207,7 @@ $index->search(
   ],
   "offset": 0,
   "limit": 20,
-  "nbHits": 1,
+  "estimatedTotalHits": 1,
   "processingTimeMs": 0,
   "query": "wonder"
 }

docker-compose.yml

@@ -16,7 +16,7 @@ services:
       - ./:/home/package
 
   meilisearch:
-    image: getmeili/meilisearch:latest
+    image: getmeili/meilisearch:v0.28.0rc0
     ports:
       - "7700"
     environment:

src/Endpoints/Indexes.php

@@ -185,7 +185,12 @@ public function rawSearch(?string $query, array $searchParams = []): array
             $searchParams
         );
 
-        return $this->http->post(self::PATH.'/'.$this->uid.'/search', $parameters);
+        $result = $this->http->post(self::PATH.'/'.$this->uid.'/search', $parameters);
+
+        // patch to prevent breaking in laravel/scout getTotalCount method.
+        $result['nbHits'] = $result['estimativeNbHits'];
+
+        return $result;
     }
 
     // Stats

src/Search/SearchResult.php

@@ -16,25 +16,23 @@ class SearchResult implements Countable, IteratorAggregate
     private array $hits;
 
     /**
-     * `nbHits` is the attributes returned by the Meilisearch server
+     * `estimatedTotalHits` is the attributes returned by the Meilisearch server
      * and its value will not be modified by the methods in this class.
      * Please, use `hitsCount` if you want to know the real size of the `hits` array at any time.
      */
-    private int $nbHits;
+    private int $estimatedTotalHits;
 
     private int $hitsCount;
-    private bool $exhaustiveNbHits;
     private int $offset;
     private int $limit;
     private int $processingTimeMs;
 
     private string $query;
-    private ?bool $exhaustiveFacetsCount;
 
     /**
      * @var array<string, mixed>
      */
-    private array $facetsDistribution;
+    private array $facetDistribution;
 
     /**
      * @var array<string, mixed>
@@ -46,21 +44,19 @@ public function __construct(array $body)
         $this->hits = $body['hits'] ?? [];
         $this->offset = $body['offset'];
         $this->limit = $body['limit'];
-        $this->nbHits = $body['nbHits'];
+        $this->estimatedTotalHits = $body['estimatedTotalHits'];
         $this->hitsCount = \count($body['hits']);
-        $this->exhaustiveNbHits = $body['exhaustiveNbHits'] ?? false;
         $this->processingTimeMs = $body['processingTimeMs'];
         $this->query = $body['query'];
-        $this->exhaustiveFacetsCount = $body['exhaustiveFacetsCount'] ?? null;
-        $this->facetsDistribution = $body['facetsDistribution'] ?? [];
+        $this->facetDistribution = $body['facetDistribution'] ?? [];
         $this->raw = $body;
     }
 
     /**
      * Return a new {@see SearchResult} instance.
      *
      * The $options parameter is an array, and the following keys are accepted:
-     * - transformFacetsDistribution (callable)
+     * - transformFacetDistribution (callable)
      * - transformHits (callable)
      *
      * The method does NOT trigger a new search.
@@ -72,8 +68,8 @@ public function applyOptions($options): self
         if (\array_key_exists('transformHits', $options) && \is_callable($options['transformHits'])) {
             $this->transformHits($options['transformHits']);
         }
-        if (\array_key_exists('transformFacetsDistribution', $options) && \is_callable($options['transformFacetsDistribution'])) {
-            $this->transformFacetsDistribution($options['transformFacetsDistribution']);
+        if (\array_key_exists('transformFacetDistribution', $options) && \is_callable($options['transformFacetDistribution'])) {
+            $this->transformFacetDistribution($options['transformFacetDistribution']);
         }
 
         return $this;
@@ -87,9 +83,9 @@ public function transformHits(callable $callback): self
         return $this;
     }
 
-    public function transformFacetsDistribution(callable $callback): self
+    public function transformFacetDistribution(callable $callback): self
     {
-        $this->facetsDistribution = $callback($this->facetsDistribution);
+        $this->facetDistribution = $callback($this->facetDistribution);
 
         return $this;
     }
@@ -127,14 +123,9 @@ public function count(): int
         return $this->hitsCount;
     }
 
-    public function getNbHits(): int
+    public function getEstimatedTotalHits(): int
     {
-        return $this->nbHits;
-    }
-
-    public function getExhaustiveNbHits(): bool
-    {
-        return $this->exhaustiveNbHits;
+        return $this->estimatedTotalHits;
     }
 
     public function getProcessingTimeMs(): int
@@ -147,17 +138,12 @@ public function getQuery(): string
         return $this->query;
     }
 
-    public function getExhaustiveFacetsCount(): ?bool
-    {
-        return $this->exhaustiveFacetsCount;
-    }
-
     /**
      * @return array<string, mixed>
      */
-    public function getFacetsDistribution(): array
+    public function getFacetDistribution(): array
     {
-        return $this->facetsDistribution;
+        return $this->facetDistribution;
     }
 
     /**
@@ -176,13 +162,11 @@ public function toArray(): array
             'hits' => $this->hits,
             'offset' => $this->offset,
             'limit' => $this->limit,
-            'nbHits' => $this->nbHits,
+            'estimatedTotalHits' => $this->estimatedTotalHits,
             'hitsCount' => $this->hitsCount,
-            'exhaustiveNbHits' => $this->exhaustiveNbHits,
             'processingTimeMs' => $this->processingTimeMs,
             'query' => $this->query,
-            'exhaustiveFacetsCount' => $this->exhaustiveFacetsCount,
-            'facetsDistribution' => $this->facetsDistribution,
+            'facetDistribution' => $this->facetDistribution,
         ];
     }