project searchlight

naph/searchlight

Search query language for Laravel supporting Eloquent and Elasticsearch

Searchlight

An Elasticsearch search query language for Laravel featuring multi-model search, _(*1)

public function search(Search $search, Comment $comments, Post $posts)
{
    return $search->in($comments, $posts)
        ->match('Searchlight')
        ->get();
}

and built-in qualifier reducers., _(*2)

$driver->qualifier('/#(\w+)/', function (Search $search, $fragment) {
    $search->filter(['tags' => $fragment]);
});

Install

Using composer, _(*3)

composer require naph/searchlight

Register the service provider, _(*4)

Naph\Searchlight\SearchlightServiceProvider;

Publish vendor files containing driver and host configuration. Lumen users should copy the file instead., _(*5)

php artisan vendor:publish --tag searchlight

Setup models by implementing the contract/trait pair and overriding getSearchableFields. The trait binds events to saved and deleted so indices are kept in sync with your database., _(*6)

use Illuminate\Database\Eloquent\Model;
use Naph\Searchlight\Model\SearchlightContract;
use Naph\Searchlight\Model\SearchlightTrait;

class Topic extends Model implements SearchlightContract
{
    use SearchlightTrait;

    public function getSearchableFields(): array
    {
        return [
            'title' => 1,
            'description' => 0.5,
            'content' => 0.1
        ];
    }
}

Storing this model's fully qualified classname in searchlight.repositories config ensures their indices are built when running:, _(*7)

php artisan searchlight:rebuild

This command destroys all existing indexed documents in the process., _(*8)

Requirements

Currently only supports PHP7 and latest versions of Laravel and Lumen., _(*9)

License

Searchlight is an open-sourced software licensed under the MIT license., _(*10)