This repository has been archived by the owner on May 13, 2021. It is now read-only.
/
MeilisearchEngine.php
244 lines (213 loc) · 6.15 KB
/
MeilisearchEngine.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<?php
namespace Meilisearch\Scout\Engines;
use Laravel\Scout\Builder;
use Laravel\Scout\Engines\Engine;
use MeiliSearch\Client as Meilisearch;
use MeiliSearch\Search\SearchResult;
class MeilisearchEngine extends Engine
{
/**
* The Meilisearch client.
*
* @var Meilisearch
*/
protected $meilisearch;
/**
* Determines if soft deletes for Scout are enabled or not.
*
* @var bool
*/
protected $softDelete;
public function __construct(Meilisearch $meilisearch, bool $softDelete = false)
{
$this->meilisearch = $meilisearch;
$this->softDelete = $softDelete;
}
/**
* Update the given model in the index.
*
* @param \Illuminate\Database\Eloquent\Collection $models
*
* @return void
*
* @throws \MeiliSearch\Exceptions\ApiException
*/
public function update($models)
{
if ($models->isEmpty()) {
return;
}
$index = $this->meilisearch->index($models->first()->searchableAs());
if ($this->usesSoftDelete($models->first()) && $this->softDelete) {
$models->each->pushSoftDeleteMetadata();
}
$objects = $models->map(function ($model) {
if (empty($searchableData = $model->toSearchableArray())) {
return;
}
return array_merge($searchableData, $model->scoutMetadata());
})->filter()->values()->all();
if (!empty($objects)) {
$index->addDocuments($objects, $models->first()->getKeyName());
}
}
/**
* Remove the given model from the index.
*
* @param \Illuminate\Database\Eloquent\Collection $models
*
* @return void
*/
public function delete($models)
{
$index = $this->meilisearch->index($models->first()->searchableAs());
$index->deleteDocuments(
$models->map->getScoutKey()
->values()
->all()
);
}
/**
* Perform the given search on the engine.
*
* @return mixed
*/
public function search(Builder $builder)
{
return $this->performSearch($builder, array_filter([
'filters' => $this->filters($builder),
'limit' => $builder->limit,
]));
}
/**
* Perform the given search on the engine.
*
* @param int $perPage
* @param int $page
*
* @return mixed
*/
public function paginate(Builder $builder, $perPage, $page)
{
return $this->performSearch($builder, array_filter([
'filters' => $this->filters($builder),
'limit' => (int) $perPage,
'offset' => ($page - 1) * $perPage,
]));
}
/**
* Perform the given search on the engine.
*
* @return mixed
*/
protected function performSearch(Builder $builder, array $searchParams = [])
{
$meilisearch = $this->meilisearch->index($builder->index ?: $builder->model->searchableAs());
if ($builder->callback) {
$result = call_user_func(
$builder->callback,
$meilisearch,
$builder->query,
$searchParams
);
return $result instanceof SearchResult ? $result->getRaw() : $result;
}
return $meilisearch->rawSearch($builder->query, $searchParams);
}
/**
* Get the filter array for the query.
*
* @return string
*/
protected function filters(Builder $builder)
{
return collect($builder->wheres)->map(function ($value, $key) {
return sprintf('%s="%s"', $key, $value);
})->values()->implode(' AND ');
}
/**
* Pluck and return the primary keys of the given results.
*
* @param mixed $results
*
* @return \Illuminate\Support\Collection
*/
public function mapIds($results)
{
if (0 === count($results['hits'])) {
return collect();
}
$hits = collect($results['hits']);
$key = key($hits->first());
return $hits->pluck($key)->values();
}
/**
* Map the given results to instances of the given model.
*
* @param mixed $results
* @param \Illuminate\Database\Eloquent\Model $model
*
* @return \Illuminate\Database\Eloquent\Collection
*/
public function map(Builder $builder, $results, $model)
{
if (is_null($results) || 0 === count($results['hits'])) {
return $model->newCollection();
}
$objectIds = collect($results['hits'])->pluck($model->getKeyName())->values()->all();
$objectIdPositions = array_flip($objectIds);
return $model->getScoutModelsByIds(
$builder, $objectIds
)->filter(function ($model) use ($objectIds) {
return in_array($model->getScoutKey(), $objectIds);
})->sortBy(function ($model) use ($objectIdPositions) {
return $objectIdPositions[$model->getScoutKey()];
})->values();
}
/**
* Get the total count from a raw result returned by the engine.
*
* @param mixed $results
*
* @return int
*/
public function getTotalCount($results)
{
return $results['nbHits'];
}
/**
* Flush all of the model's records from the engine.
*
* @param \Illuminate\Database\Eloquent\Model $model
*
* @return void
*/
public function flush($model)
{
$index = $this->meilisearch->index($model->searchableAs());
$index->deleteAllDocuments();
}
/**
* Determine if the given model uses soft deletes.
*
* @param \Illuminate\Database\Eloquent\Model $model
*
* @return bool
*/
protected function usesSoftDelete($model)
{
return in_array(\Illuminate\Database\Eloquent\SoftDeletes::class, class_uses_recursive($model));
}
/**
* Dynamically call the MeiliSearch client instance.
*
* @param string $method
* @param array $parameters
*
* @return mixed
*/
public function __call($method, $parameters)
{
return $this->meilisearch->$method(...$parameters);
}
}