TNTSearchEngine::getBuilder() - Code Metrics - Inspection of "[PoC] Add GeoSearch Index and search" - teamtnt/laravel-scout-tntsearch-driver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#259)

unknown

created 2019-12-17 07:46 UTC

TNTSearchEngine::getBuilder() A

↳ Parent: TNTSearchEngine

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace TeamTNT\Scout\Engines;

use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Support\Facades\DB;
use Laravel\Scout\Builder;
use Laravel\Scout\Engines\Engine;
use TeamTNT\TNTSearch\Exceptions\IndexNotFoundException;
use TeamTNT\TNTSearch\TNTGeoSearch;
use TeamTNT\TNTSearch\TNTSearch;

class TNTSearchEngine extends Engine
{
    /**
     * @var TNTSearch
     */
    protected $tnt;

    /**
     * @var TNTGeoSearch
     */
    protected $geotnt;

    /**
     * @var Builder
     */
    protected $builder;

    /**
     * Create a new engine instance.
     *
     * @param TNTSearch $tnt
     * @param TNTGeoSearch|null $geotnt
     */
    public function __construct(TNTSearch $tnt, TNTGeoSearch $geotnt = null)
    {
        $this->tnt = $tnt;
        $this->geotnt = $geotnt;
    }

    /**
     * Update the given model in the index.
     *
     * @param Collection $models
     *
     * @return void
     */
    public function update($models)
    {
        $this->initIndex($models->first());
        $this->tnt->selectIndex("{$models->first()->searchableAs()}.index");
        $index = $this->tnt->getIndex();
        $index->setPrimaryKey($models->first()->getKeyName());

        $geoindex = null;
        if ($this->geotnt) {

            $this->geotnt->selectIndex("{$models->first()->searchableAs()}.geoindex");
            $geoindex = $this->geotnt->getIndex();
            $geoindex->setPrimaryKey($models->first()->getKeyName());
            $geoindex->indexBeginTransaction();
        }

        $index->indexBeginTransaction();
        $models->each(function ($model) use ($index, $geoindex) {
            $array = $model->toSearchableArray();

            if (empty($array)) {
                return;
            }

            if ($model->getKey()) {
                $index->update($model->getKey(), $array);
                if ($geoindex) {
                    $geoindex->delete($model->getKey());
                }
            } else {
                $index->insert($array);
            }
            if ($geoindex && !empty($array['longitude']) && !empty($array['latitude'])) {
                $array['longitude'] = (float) $array['longitude'];
                $array['latitude'] = (float) $array['latitude'];
                $geoindex->insert($array);
            }
        });
        $index->indexEndTransaction();
        if ($this->geotnt) {
            $geoindex->indexEndTransaction();
        }
    }

    /**
     * Remove the given model from the index.
     *
     * @param Collection $models
     *
     * @return void
     */
    public function delete($models)
    {
        $this->initIndex($models->first());
        $models->each(function ($model) {
            $this->tnt->selectIndex("{$model->searchableAs()}.index");
            $index = $this->tnt->getIndex();
            $index->setPrimaryKey($model->getKeyName());
            $index->delete($model->getKey());

            if ($this->geotnt) {

                $this->geotnt->selectIndex("{$model->searchableAs()}.geoindex");
                $index = $this->geotnt->getIndex();
                $index->setPrimaryKey($model->getKeyName());
                $index->delete($model->getKey());
            }
        });
    }

    /**
     * Perform the given search on the engine.
     *
     * @param Builder $builder
     *
     * @return mixed
     */
    public function search(Builder $builder)
    {
        try {
            return $this->performSearch($builder);
        } catch (IndexNotFoundException $e) {
            $this->initIndex($builder->model);
        }
    }

    /**
     * Perform the given search on the engine.
     *
     * @param Builder $builder
     * @param int     $perPage
     * @param int     $page
     *
     * @return mixed
     */
    public function paginate(Builder $builder, $perPage, $page)
    {
        $results = $this->performSearch($builder);

        if ($builder->limit) {
            $results['hits'] = $builder->limit;
        }

        $filtered = $this->discardIdsFromResultSetByConstraints($builder, $results['ids']);

        $results['hits'] = $filtered->count();

        $chunks = array_chunk($filtered->toArray(), $perPage);

        if (empty($chunks)) {
            return $results;
        }

        if (array_key_exists($page - 1, $chunks)) {
            $results['ids'] = $chunks[$page - 1];
        } else {
            $results['ids'] = [];
        }

        return $results;
    }

    /**
     * Perform the given search on the engine.
     *
     * @param Builder $builder
     *
     * @return mixed
     */
    protected function performSearch(Builder $builder, array $options = [])
    {
        $index = $builder->index ?: $builder->model->searchableAs();
        $limit = $builder->limit ?: 10000;
        $this->tnt->selectIndex("{$index}.index");
        if ($this->geotnt) {
            $this->geotnt->selectIndex("{$index}.geoindex");
        }

        $this->builder = $builder;

        if (isset($builder->model->asYouType)) {
            $this->tnt->asYouType = $builder->model->asYouType;
        }

        if ($builder->callback) {
            return call_user_func(
                $builder->callback,
                $this->tnt,
                $builder->query,
                $options
            );
        }

        if (is_array($builder->query)) {
            $location = $builder->query['location'];
            $distance = $builder->query['distance'];
            $limit = array_key_exists('limit', $builder->query) ? $builder->query['limit'] : 10;
            return $this->geotnt->findNearest($location, $distance, $limit);
        }

        if (isset($this->tnt->config['searchBoolean']) ? $this->tnt->config['searchBoolean'] : false) {
            return $this->tnt->searchBoolean($builder->query, $limit);
        } else {
            return $this->tnt->search($builder->query, $limit);
        }
    }

    /**
     * Map the given results to instances of the given model.
     *
     * @param mixed                               $results
     * @param \Illuminate\Database\Eloquent\Model $model
     *
     * @return Collection
     */
    public function map(Builder $builder, $results, $model)
    {
        if (is_null($results['ids']) || count($results['ids']) === 0) {
            return Collection::make();
        }

        $keys = collect($results['ids'])->values()->all();

        $builder = $this->getBuilder($model);

        if ($this->builder->queryCallback) {
            call_user_func($this->builder->queryCallback, $builder);
        }

        $models = $builder->whereIn(
            $model->getQualifiedKeyName(), $keys
        )->get()->keyBy($model->getKeyName());

        // sort models by user choice
        if (!empty($this->builder->orders)) {
            return $models->values();
        }

        // sort models by tnt search result set
        return collect($results['ids'])->map(function ($hit) use ($models) {
            if (isset($models[$hit])) {
                return $models[$hit];
            }
        })->filter()->values();
    }

    /**
     * Return query builder either from given constraints, or as
     * new query. Add where statements to builder when given.
     *
     * @param \Illuminate\Database\Eloquent\Model $model
     *
     * @return Builder
     */
    public function getBuilder($model)
    {
        // get query as given constraint or create a new query
        $builder = isset($this->builder->constraints) ? $this->builder->constraints : $model->newQuery();


        $builder = $this->handleSoftDeletes($builder, $model);

        $builder = $this->applyWheres($builder);

        $builder = $this->applyOrders($builder);

        return $builder;
    }

    /**
     * Pluck and return the primary keys of the given results.
     *
     * @param mixed $results
     * @return \Illuminate\Support\Collection
     */
    public function mapIds($results)
    {
        return collect($results['ids'])->values();
    }

    /**
     * Get the total count from a raw result returned by the engine.
     *
     * @param mixed $results
     *
     * @return int
     */
    public function getTotalCount($results)
    {
        return $results['hits'];
    }

    public function initIndex($model)
    {
        $indexName = $model->searchableAs();

        if (!file_exists($this->tnt->config['storage']."/{$indexName}.index")) {
            $indexer = $this->tnt->createIndex("$indexName.index");
            $indexer->setDatabaseHandle($model->getConnection()->getPdo());
            $indexer->setPrimaryKey($model->getKeyName());
        }
        if ($this->geotnt && !file_exists($this->tnt->config['storage']."/{$indexName}.geoindex")) {
            $indexer = $this->geotnt->getIndex();
            $indexer->loadConfig($this->geotnt->config);
            $indexer->createIndex("$indexName.geoindex");
            $indexer->setDatabaseHandle($model->getConnection()->getPdo());
            $indexer->setPrimaryKey($model->getKeyName());
        }
    }

    /**
     * The search index results ($results['ids']) need to be compared against our query
     * that contains the constraints.
     *
     * To get the correct results and counts for the pagination, we remove those ids
     * from the search index results that were found by the search but are not part of
     * the query ($sub) that is constrained.
     *
     * This is achieved with self joining the constrained query as subquery and selecting
     * the ids which are not matching to anything (i.e., is null).
     *
     * The constraints usually remove only a small amount of results, which is why the non
     * matching results are looked up and removed, instead of returning a collection with
     * all the valid results.
     */
    private function discardIdsFromResultSetByConstraints($builder, $searchResults)
    {
        $qualifiedKeyName    = $builder->model->getQualifiedKeyName(); // tableName.id
        $subQualifiedKeyName = 'sub.'.$builder->model->getKeyName(); // sub.id

        $sub = $this->getBuilder($builder->model)->whereIn(
            $qualifiedKeyName, $searchResults
        ); // sub query for left join

        $discardIds = $builder->model->newQuery()
            ->select($qualifiedKeyName)
            ->leftJoin(DB::raw('('.$sub->getQuery()->toSql().') as '. $builder->model->getConnection()->getTablePrefix() .'sub'), $subQualifiedKeyName, '=', $qualifiedKeyName)
            ->addBinding($sub->getQuery()->getBindings(), 'join')
            ->whereIn($qualifiedKeyName, $searchResults)
            ->whereNull($subQualifiedKeyName)
            ->pluck($builder->model->getKeyName());

        // returns values of $results['ids'] that are not part of $discardIds
        return collect($searchResults)->diff($discardIds);
    }

    /**
     * Determine if the given model uses soft deletes.
     *
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @return bool
     */
    protected function usesSoftDelete($model)
    {
        return in_array(SoftDeletes::class, class_uses_recursive($model));
    }

    /**
     * Determine if soft delete is active and depending on state return the
     * appropriate builder.
     *
     * @param  Builder  $builder
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @return Builder
     */
    private function handleSoftDeletes($builder, $model)
    {
        // remove where statement for __soft_deleted when soft delete is not active
        // does not show soft deleted items when trait is attached to model and
        // config('scout.soft_delete') is false
        if (!$this->usesSoftDelete($model) || !config('scout.soft_delete', true)) {
            unset($this->builder->wheres['__soft_deleted']);
            return $builder;
        }

        /**
         * Use standard behaviour of Laravel Scout builder class to support soft deletes.
         *
         * When no __soft_deleted statement is given return all entries
         */
        if (!in_array('__soft_deleted', $this->builder->wheres)) {
            return $builder->withTrashed();
        }

        /**
         * When __soft_deleted is 1 then return only soft deleted entries
         */
        if ($this->builder->wheres['__soft_deleted']) {
            $builder = $builder->onlyTrashed();
        }

        /**
         * Returns all undeleted entries, default behaviour
         */
        unset($this->builder->wheres['__soft_deleted']);
        return $builder;
    }

    /**
     * Apply where statements as constraints to the query builder.
     *
     * @param Builder $builder
     * @return \Illuminate\Support\Collection
     */
    private function applyWheres($builder)
    {
        // iterate over given where clauses
        return collect($this->builder->wheres)->map(function ($value, $key) {
            // for reduce function combine key and value into array
            return [$key, $value];
        })->reduce(function ($builder, $where) {
            // separate key, value again
            list($key, $value) = $where;
            return $builder->where($key, $value);
        }, $builder);
    }

    /**
     * Apply order by statements as constraints to the query builder.
     *
     * @param Builder $builder
     * @return \Illuminate\Support\Collection
     */
    private function applyOrders($builder)
    {
        //iterate over given orderBy clauses - should be only one
        return collect($this->builder->orders)->map(function ($value, $key) {

            // for reduce function combine key and value into array
            return [$value["column"], $value["direction"]];
        })->reduce(function ($builder, $orderBy) {
            // separate key, value again
            list($column, $direction) = $orderBy;
            return $builder->orderBy($column, $direction);
        }, $builder);
    }

    /**
     * Flush all of the model's records from the engine.
     *
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @return void
     */
    public function flush($model)
    {
        $indexName   = $model->searchableAs();
        $pathToIndex = $this->tnt->config['storage']."/{$indexName}.index";
        if (file_exists($pathToIndex)) {
            unlink($pathToIndex);
        }

        if ($this->geotnt){
            $pathToGeoIndex = $this->geotnt->config['storage']."/{$indexName}.geoindex";
            if (file_exists($pathToGeoIndex)) {
                unlink($pathToGeoIndex);
            }
        }
    }
}


1		<?php
2
3		namespace TeamTNT\Scout\Engines;
4
5		use Illuminate\Database\Eloquent\Collection;
6		use Illuminate\Database\Eloquent\SoftDeletes;
7		use Illuminate\Support\Facades\DB;
8		use Laravel\Scout\Builder;
9		use Laravel\Scout\Engines\Engine;
10		use TeamTNT\TNTSearch\Exceptions\IndexNotFoundException;
11		use TeamTNT\TNTSearch\TNTGeoSearch;
12		use TeamTNT\TNTSearch\TNTSearch;
13
14		class TNTSearchEngine extends Engine
15		{
16		/**
17		* @var TNTSearch
18		*/
19		protected $tnt;
20
21		/**
22		* @var TNTGeoSearch
23		*/
24		protected $geotnt;
25
26		/**
27		* @var Builder
28		*/
29		protected $builder;
30
31		/**
32		* Create a new engine instance.
33		*
34		* @param TNTSearch $tnt
35		* @param TNTGeoSearch\|null $geotnt
36		*/
37		public function __construct(TNTSearch $tnt, TNTGeoSearch $geotnt = null)
38		{
39		$this->tnt = $tnt;
40		$this->geotnt = $geotnt;
41		}
42
43		/**
44		* Update the given model in the index.
45		*
46		* @param Collection $models
47		*
48		* @return void
49		*/
50		public function update($models)
51		{
52		$this->initIndex($models->first());
53		$this->tnt->selectIndex("{$models->first()->searchableAs()}.index");
54		$index = $this->tnt->getIndex();
55		$index->setPrimaryKey($models->first()->getKeyName());
56
57		$geoindex = null;
58	View Code Duplication	if ($this->geotnt) {
		0 ignored issues – show Duplication introduced 2019-12-14 17:04 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
59		$this->geotnt->selectIndex("{$models->first()->searchableAs()}.geoindex");
60		$geoindex = $this->geotnt->getIndex();
61		$geoindex->setPrimaryKey($models->first()->getKeyName());
62		$geoindex->indexBeginTransaction();
63		}
64
65		$index->indexBeginTransaction();
66		$models->each(function ($model) use ($index, $geoindex) {
67		$array = $model->toSearchableArray();
68
69		if (empty($array)) {
70		return;
71		}
72
73		if ($model->getKey()) {
74		$index->update($model->getKey(), $array);
75		if ($geoindex) {
76		$geoindex->delete($model->getKey());
77		}
78		} else {
79		$index->insert($array);
80		}
81		if ($geoindex && !empty($array['longitude']) && !empty($array['latitude'])) {
82		$array['longitude'] = (float) $array['longitude'];
83		$array['latitude'] = (float) $array['latitude'];
84		$geoindex->insert($array);
85		}
86		});
87		$index->indexEndTransaction();
88		if ($this->geotnt) {
89		$geoindex->indexEndTransaction();
90		}
91		}
92
93		/**
94		* Remove the given model from the index.
95		*
96		* @param Collection $models
97		*
98		* @return void
99		*/
100		public function delete($models)
101		{
102		$this->initIndex($models->first());
103		$models->each(function ($model) {
104		$this->tnt->selectIndex("{$model->searchableAs()}.index");
105		$index = $this->tnt->getIndex();
106		$index->setPrimaryKey($model->getKeyName());
107		$index->delete($model->getKey());
108
109	View Code Duplication	if ($this->geotnt) {
		0 ignored issues – show Duplication introduced 2019-12-14 17:04 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
110		$this->geotnt->selectIndex("{$model->searchableAs()}.geoindex");
111		$index = $this->geotnt->getIndex();
112		$index->setPrimaryKey($model->getKeyName());
113		$index->delete($model->getKey());
114		}
115		});
116		}
117
118		/**
119		* Perform the given search on the engine.
120		*
121		* @param Builder $builder
122		*
123		* @return mixed
124		*/
125		public function search(Builder $builder)
126		{
127		try {
128		return $this->performSearch($builder);
129		} catch (IndexNotFoundException $e) {
130		$this->initIndex($builder->model);
131		}
132		}
133
134		/**
135		* Perform the given search on the engine.
136		*
137		* @param Builder $builder
138		* @param int $perPage
139		* @param int $page
140		*
141		* @return mixed
142		*/
143		public function paginate(Builder $builder, $perPage, $page)
144		{
145		$results = $this->performSearch($builder);
146
147		if ($builder->limit) {
148		$results['hits'] = $builder->limit;
149		}
150
151		$filtered = $this->discardIdsFromResultSetByConstraints($builder, $results['ids']);
152
153		$results['hits'] = $filtered->count();
154
155		$chunks = array_chunk($filtered->toArray(), $perPage);
156
157		if (empty($chunks)) {
158		return $results;
159		}
160
161		if (array_key_exists($page - 1, $chunks)) {
162		$results['ids'] = $chunks[$page - 1];
163		} else {
164		$results['ids'] = [];
165		}
166
167		return $results;
168		}
169
170		/**
171		* Perform the given search on the engine.
172		*
173		* @param Builder $builder
174		*
175		* @return mixed
176		*/
177		protected function performSearch(Builder $builder, array $options = [])
178		{
179		$index = $builder->index ?: $builder->model->searchableAs();
180		$limit = $builder->limit ?: 10000;
181		$this->tnt->selectIndex("{$index}.index");
182		if ($this->geotnt) {
183		$this->geotnt->selectIndex("{$index}.geoindex");
184		}
185
186		$this->builder = $builder;
187
188		if (isset($builder->model->asYouType)) {
189		$this->tnt->asYouType = $builder->model->asYouType;
190		}
191
192		if ($builder->callback) {
193		return call_user_func(
194		$builder->callback,
195		$this->tnt,
196		$builder->query,
197		$options
198		);
199		}
200
201		if (is_array($builder->query)) {
202		$location = $builder->query['location'];
203		$distance = $builder->query['distance'];
204		$limit = array_key_exists('limit', $builder->query) ? $builder->query['limit'] : 10;
205		return $this->geotnt->findNearest($location, $distance, $limit);
206		}
207
208		if (isset($this->tnt->config['searchBoolean']) ? $this->tnt->config['searchBoolean'] : false) {
209		return $this->tnt->searchBoolean($builder->query, $limit);
210		} else {
211		return $this->tnt->search($builder->query, $limit);
212		}
213		}
214
215		/**
216		* Map the given results to instances of the given model.
217		*
218		* @param mixed $results
219		* @param \Illuminate\Database\Eloquent\Model $model
220		*
221		* @return Collection
222		*/
223		public function map(Builder $builder, $results, $model)
224		{
225		if (is_null($results['ids']) \|\| count($results['ids']) === 0) {
226		return Collection::make();
227		}
228
229		$keys = collect($results['ids'])->values()->all();
230
231		$builder = $this->getBuilder($model);
232
233		if ($this->builder->queryCallback) {
234		call_user_func($this->builder->queryCallback, $builder);
235		}
236
237		$models = $builder->whereIn(
238		$model->getQualifiedKeyName(), $keys
239		)->get()->keyBy($model->getKeyName());
240
241		// sort models by user choice
242		if (!empty($this->builder->orders)) {
243		return $models->values();
244		}
245
246		// sort models by tnt search result set
247		return collect($results['ids'])->map(function ($hit) use ($models) {
248		if (isset($models[$hit])) {
249		return $models[$hit];
250		}
251		})->filter()->values();
252		}
253
254		/**
255		* Return query builder either from given constraints, or as
256		* new query. Add where statements to builder when given.
257		*
258		* @param \Illuminate\Database\Eloquent\Model $model
259		*
260		* @return Builder
261		*/
262		public function getBuilder($model)
263		{
264		// get query as given constraint or create a new query
265		$builder = isset($this->builder->constraints) ? $this->builder->constraints : $model->newQuery();
		0 ignored issues – show Bug introduced 2018-06-27 15:54 UTC by Report Bug Copy Issue Report The property `constraints` does not seem to exist in `Laravel\Scout\Builder`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
266
267		$builder = $this->handleSoftDeletes($builder, $model);
268
269		$builder = $this->applyWheres($builder);
270
271		$builder = $this->applyOrders($builder);
272
273		return $builder;
274		}
275
276		/**
277		* Pluck and return the primary keys of the given results.
278		*
279		* @param mixed $results
280		* @return \Illuminate\Support\Collection
281		*/
282		public function mapIds($results)
283		{
284		return collect($results['ids'])->values();
285		}
286
287		/**
288		* Get the total count from a raw result returned by the engine.
289		*
290		* @param mixed $results
291		*
292		* @return int
293		*/
294		public function getTotalCount($results)
295		{
296		return $results['hits'];
297		}
298
299		public function initIndex($model)
300		{
301		$indexName = $model->searchableAs();
302
303		if (!file_exists($this->tnt->config['storage']."/{$indexName}.index")) {
304		$indexer = $this->tnt->createIndex("$indexName.index");
305		$indexer->setDatabaseHandle($model->getConnection()->getPdo());
306		$indexer->setPrimaryKey($model->getKeyName());
307		}
308		if ($this->geotnt && !file_exists($this->tnt->config['storage']."/{$indexName}.geoindex")) {
309		$indexer = $this->geotnt->getIndex();
310		$indexer->loadConfig($this->geotnt->config);
311		$indexer->createIndex("$indexName.geoindex");
312		$indexer->setDatabaseHandle($model->getConnection()->getPdo());
313		$indexer->setPrimaryKey($model->getKeyName());
314		}
315		}
316
317		/**
318		* The search index results ($results['ids']) need to be compared against our query
319		* that contains the constraints.
320		*
321		* To get the correct results and counts for the pagination, we remove those ids
322		* from the search index results that were found by the search but are not part of
323		* the query ($sub) that is constrained.
324		*
325		* This is achieved with self joining the constrained query as subquery and selecting
326		* the ids which are not matching to anything (i.e., is null).
327		*
328		* The constraints usually remove only a small amount of results, which is why the non
329		* matching results are looked up and removed, instead of returning a collection with
330		* all the valid results.
331		*/
332		private function discardIdsFromResultSetByConstraints($builder, $searchResults)
333		{
334		$qualifiedKeyName = $builder->model->getQualifiedKeyName(); // tableName.id
335		$subQualifiedKeyName = 'sub.'.$builder->model->getKeyName(); // sub.id
336
337		$sub = $this->getBuilder($builder->model)->whereIn(
338		$qualifiedKeyName, $searchResults
339		); // sub query for left join
340
341		$discardIds = $builder->model->newQuery()
342		->select($qualifiedKeyName)
343		->leftJoin(DB::raw('('.$sub->getQuery()->toSql().') as '. $builder->model->getConnection()->getTablePrefix() .'sub'), $subQualifiedKeyName, '=', $qualifiedKeyName)
344		->addBinding($sub->getQuery()->getBindings(), 'join')
345		->whereIn($qualifiedKeyName, $searchResults)
346		->whereNull($subQualifiedKeyName)
347		->pluck($builder->model->getKeyName());
348
349		// returns values of $results['ids'] that are not part of $discardIds
350		return collect($searchResults)->diff($discardIds);
351		}
352
353		/**
354		* Determine if the given model uses soft deletes.
355		*
356		* @param \Illuminate\Database\Eloquent\Model $model
357		* @return bool
358		*/
359		protected function usesSoftDelete($model)
360		{
361		return in_array(SoftDeletes::class, class_uses_recursive($model));
362		}
363
364		/**
365		* Determine if soft delete is active and depending on state return the
366		* appropriate builder.
367		*
368		* @param Builder $builder
369		* @param \Illuminate\Database\Eloquent\Model $model
370		* @return Builder
371		*/
372		private function handleSoftDeletes($builder, $model)
373		{
374		// remove where statement for __soft_deleted when soft delete is not active
375		// does not show soft deleted items when trait is attached to model and
376		// config('scout.soft_delete') is false
377		if (!$this->usesSoftDelete($model) \|\| !config('scout.soft_delete', true)) {
378		unset($this->builder->wheres['__soft_deleted']);
379		return $builder;
380		}
381
382		/**
383		* Use standard behaviour of Laravel Scout builder class to support soft deletes.
384		*
385		* When no __soft_deleted statement is given return all entries
386		*/
387		if (!in_array('__soft_deleted', $this->builder->wheres)) {
388		return $builder->withTrashed();
389		}
390
391		/**
392		* When __soft_deleted is 1 then return only soft deleted entries
393		*/
394		if ($this->builder->wheres['__soft_deleted']) {
395		$builder = $builder->onlyTrashed();
396		}
397
398		/**
399		* Returns all undeleted entries, default behaviour
400		*/
401		unset($this->builder->wheres['__soft_deleted']);
402		return $builder;
403		}
404
405		/**
406		* Apply where statements as constraints to the query builder.
407		*
408		* @param Builder $builder
409		* @return \Illuminate\Support\Collection
410		*/
411		private function applyWheres($builder)
412		{
413		// iterate over given where clauses
414		return collect($this->builder->wheres)->map(function ($value, $key) {
415		// for reduce function combine key and value into array
416		return [$key, $value];
417		})->reduce(function ($builder, $where) {
418		// separate key, value again
419		list($key, $value) = $where;
420		return $builder->where($key, $value);
421		}, $builder);
422		}
423
424		/**
425		* Apply order by statements as constraints to the query builder.
426		*
427		* @param Builder $builder
428		* @return \Illuminate\Support\Collection
429		*/
430		private function applyOrders($builder)
431		{
432		//iterate over given orderBy clauses - should be only one
433		return collect($this->builder->orders)->map(function ($value, $key) {
		0 ignored issues – show Unused Code introduced 2018-09-06 12:25 UTC by Report Bug Copy Issue Report The parameter `$key` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
434		// for reduce function combine key and value into array
435		return [$value["column"], $value["direction"]];
436		})->reduce(function ($builder, $orderBy) {
437		// separate key, value again
438		list($column, $direction) = $orderBy;
439		return $builder->orderBy($column, $direction);
440		}, $builder);
441		}
442
443		/**
444		* Flush all of the model's records from the engine.
445		*
446		* @param \Illuminate\Database\Eloquent\Model $model
447		* @return void
448		*/
449		public function flush($model)
450		{
451		$indexName = $model->searchableAs();
452		$pathToIndex = $this->tnt->config['storage']."/{$indexName}.index";
453		if (file_exists($pathToIndex)) {
454		unlink($pathToIndex);
455		}
456
457		if ($this->geotnt){
458		$pathToGeoIndex = $this->geotnt->config['storage']."/{$indexName}.geoindex";
459		if (file_exists($pathToGeoIndex)) {
460		unlink($pathToGeoIndex);
461		}
462		}
463		}
464		}
465

teamtnt / laravel-scout-tntsearch-driver

Pull Request — master (#259)

TNTSearchEngine::getBuilder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like