alhoqbani / laravel-scout-elasticsearch

src/ScoutElasticEngine.php

<?php

namespace Alhoqbani\Elastic;

use Elasticsearch\Client;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Support\Arr;
use Laravel\Scout\Builder;
use Laravel\Scout\Engines\Engine;

class ScoutElasticEngine extends Engine
{

    /**
     * The Elasticsearch client.
     *
     * @var \Elasticsearch\Client
     */
    private $client;

    /**
     * ElasticSearchScoutEngine constructor.
     *
     * @param \Elasticsearch\Client $client
     */
    public function __construct(Client $client)
    {
        $this->client = $client;
    }

    /**
     * Update the given model in the index.
     *
     * @param  \Illuminate\Database\Eloquent\Collection $models
     *
     * @return void
     */
    public function update($models)
    {
        $index = $models->first()->searchableAs();

        $params = ['body' => []];
        foreach ($models as $model) {
            $array = $model->toSearchableArray();

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

            $params['body'][] = [
                'index' => [
                    '_index' => $index,
                    '_type'  => $index,
                    '_id'    => $model->getKey(),
                ],
            ];
            $params['body'][] = $array;
        }

        $this->client->bulk($params);
    }

    /**
     * Remove the given model from the index.
     *
     * @param  \Illuminate\Database\Eloquent\Collection $models
     *
     * @return void
     */
    public function delete($models)
    {
        $index = $models->first()->searchableAs();

        $params = ['body' => []];
        foreach ($models as $model) {
            $params['body'][] = [
                'delete' => [
                    '_index' => $index,
                    '_type'  => $index,
                    '_id'    => $model->getKey(),
                ],
            ];
        }

        $this->client->bulk($params);
    }

    /**
     * Perform the given search on the engine.
     *
     * @param  \Laravel\Scout\Builder $builder
     *
     * @return mixed
     */
    public function search(Builder $builder)
    {
        $params = $this->prepareParams($builder);

        return $this->client->search($params);
    }

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

        $params['size'] = $perPage;
        $params['from'] = ($page - 1) * $perPage;
        unset($params['body']['size'], $params['body']['from']);

        return $this->client->search($params);
    }

    /**
     * Pluck and return the primary keys of the given results.
     *
     * @param  mixed $results
     *
     * @return \Illuminate\Support\Collection
     */
    public function mapIds($results)
    {
        return collect($results['hits']['hits'])->pluck('_id')->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($results, $model)
    {
        if ($results['hits']['total'] === 0) {
            return Collection::make();
        }

        $keys = collect($results['hits']['hits'])
            ->pluck('_id')->values()->all();

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

        return Collection::make($results['hits']['hits'])->map(function ($hit) use ($model, $models) {
            $key = $hit['_id'];

            if (isset($models[$key])) {
                return $models[$key];
            }
        })->filter()->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']['total'];
    }

    /**
     * Parse and prepare the params to send to Elasticsearch client
     *
     * @param \Laravel\Scout\Builder $builder
     *
     * @return array
     */
    protected function prepareParams(Builder $builder)
    {
        $params = [
            'index' => $builder->index ?? $builder->model->searchableAs(),
//            'type'  => $builder->index ?? $builder->model->searchableAs(),

60% of this comment could be valid code. Did you maybe forget this after debugging?

            'size'  => $builder->limit ?? $builder->model->getPerPage(),
            'body'  => [
                'query' => [
                    'multi_match' => [
                        'query'  => $builder->query,
                        'fields' => '_all',
                    ],
                ],
            ],
        ];

        if ($builder->callback) {
            $params = array_merge($params,
                call_user_func(
                    $builder->callback,
                    $this->client,
                    $builder->query
                ));
        }

        return $params;
    }
}