allow query callback

src/Builder.php

@@ -161,6 +161,19 @@ public function orderBy($column, $direction = 'asc')
         return $this;
     }
 
+    /**
+     * Set the callback that should have an opportunity to modify the database query.
+     *
+     * @param  callable  $callback
+     * @return $this
+     */
+    public function query($callback)
+    {
+        $this->queryCallback = $queryCallback;
+
+        return $this;
+    }
+
     /**
      * Get the raw results of the search.
      *
@@ -218,7 +231,7 @@ public function paginate($perPage = null, $pageName = 'page', $page = null)
         $perPage = $perPage ?: $this->model->getPerPage();
 
         $results = Collection::make($engine->map(
-            $rawResults = $engine->paginate($this, $perPage, $page), $this->model
+            $this, $rawResults = $engine->paginate($this, $perPage, $page), $this->model
         ));
 
         $paginator = (new LengthAwarePaginator($results, $engine->getTotalCount($rawResults), $perPage, $page, [
@@ -245,7 +258,7 @@ public function paginateRaw($perPage = null, $pageName = 'page', $page = null)
 
         $perPage = $perPage ?: $this->model->getPerPage();
 
-        $results =  $engine->paginate($this, $perPage, $page);
+        $results = $engine->paginate($this, $perPage, $page);
 
         $paginator = (new LengthAwarePaginator($results, $engine->getTotalCount($results), $perPage, $page, [
             'path' => Paginator::resolveCurrentPath(),

src/Engines/AlgoliaEngine.php

@@ -159,18 +159,19 @@ public function mapIds($results)
     /**
      * Map the given results to instances of the given model.
      *
+     * @param  \Laravel\Scout\Builder  $builder
      * @param  mixed  $results
      * @param  \Illuminate\Database\Eloquent\Model  $model
      * @return \Illuminate\Database\Eloquent\Collection
      */
-    public function map($results, $model)
+    public function map(Builder $builder, $results, $model)
     {
         if (count($results['hits']) === 0) {
             return Collection::make();
         }
 
         $models = $model->getScoutModelsByIds(
-            collect($results['hits'])->pluck('objectID')->values()->all()
+            $builder, collect($results['hits'])->pluck('objectID')->values()->all()
         )->keyBy(function ($model) {
             return $model->getScoutKey();
         });

src/Engines/Engine.php

@@ -52,11 +52,12 @@ abstract public function mapIds($results);
     /**
      * Map the given results to instances of the given model.
      *
+     * @param  \Laravel\Scout\Builder  $builder
      * @param  mixed  $results
      * @param  \Illuminate\Database\Eloquent\Model  $model
      * @return \Illuminate\Database\Eloquent\Collection
      */
-    abstract public function map($results, $model);
+    abstract public function map(Builder $builder, $results, $model);
 
     /**
      * Get the total count from a raw result returned by the engine.
@@ -86,7 +87,7 @@ public function keys(Builder $builder)
     public function get(Builder $builder)
     {
         return Collection::make($this->map(
-            $this->search($builder), $builder->model
+            $builder, $this->search($builder), $builder->model
         ));
     }
 }

src/Searchable.php

@@ -2,6 +2,7 @@
 
 namespace Laravel\Scout;
 
+use Laravel\Scout\Builder;
 use Laravel\Scout\Jobs\MakeSearchable;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\SoftDeletes;
@@ -165,15 +166,20 @@ public function unsearchable()
     /**
      * Get the requested models from an array of object IDs;
      *
+     * @param  \Laravel\Scout\Builder  $builder
      * @param  array  $ids
      * @return mixed
      */
-    public function getScoutModelsByIds(array $ids)
+    public function getScoutModelsByIds(Builder $builder, array $ids)
     {
-        $builder = in_array(SoftDeletes::class, class_uses_recursive($this))
-                            ? $this->withTrashed() : $this->newQuery();
+        $query = in_array(SoftDeletes::class, class_uses_recursive($this))
+                        ? $this->withTrashed() : $this->newQuery();
 
-        return $builder->whereIn(
+        if ($builder->queryCallback) {
+            call_user_func($builder->queryCallback, $query);
+        }
+
+        return $query->whereIn(
             $this->getScoutKeyName(), $ids
         )->get();
     }

tests/AlgoliaEngineTest.php

@@ -58,7 +58,9 @@ public function test_map_correctly_maps_results_to_models()
         $model->shouldReceive('getKeyName')->andReturn('id');
         $model->shouldReceive('getScoutModelsByIds')->andReturn(Collection::make([new AlgoliaEngineTestModel]));
 
-        $results = $engine->map(['nbHits' => 1, 'hits' => [
+        $builder = Mockery::mock(Builder::class);
+
+        $results = $engine->map($builder, ['nbHits' => 1, 'hits' => [
             ['objectID' => 1, 'id' => 1],
         ]], $model);