masterro/searchable

Simple fulltext search though Eloquent models

, _(*1)

Laravel simple FULLTEXT search through multiple Eloquent models

This is a small Laravel package allows you to make a global search though multiple Eloquent models and get ordered by relevance collection of results. It uses MATCH AGAINST MySQL queries., _(*2)

Installation

Step 1: Composer

From the command line, run:, _(*3)

composer require masterro/laravel-searchable

Step 2: Service Provider

If you do not use laravel package auto-discovery you need to register the service provider, open config/app.php and, within the providers array, append:, _(*4)

MasterRO\Searchable\SearchableServiceProvider::class

Usage

Register your search models in AppServiceProvider or create your custom one, _(*5)

Searchable::registerModels([
    Post::class,
    Article::class,
    User::class,
]);

Then you should implement MasterRO\Searchable\SearchableContract by each registered model, or it will be skipped and define searchable method, _(*6)

public static function searchable(): array
{
    return ['title', 'description'];
}

Make sure you added fulltext indicies to your tables, _(*7)

public function up()
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->id();

            $table->string('title');
            $table->longText('description');
            $table->dateTime('published_at')->nullable();

            $table->timestamps();
        });

        DB::statement('ALTER TABLE posts ADD FULLTEXT search(title, description)');
    }

Now you can make search in your controller or where you want, _(*8)

public function search(Request $request, Searchable $searchable)
{
    $query = trim($request->input('q'));

    if (mb_strlen($query) < 3) {
        return back()->withInput()->withErrors([
            'search_error' => __('messages.search_error')
        ]);
    }

    return view('search.index')->with('results', $searchable->search($query));
}

Runtime search model switching, _(*9)

$result = $this->searchable->searchModel(Post::class, 'consequatur');

$result = $this->searchable->searchModel([Article::class, Post::class], 'consequatur');

Filtering

Model filter

Search results can be filtered by adding the filterSearchResults() in your model (like Eloquent global scope), _(*10)

class User extends Model implements SearchableContract
{
    public function posts() {
        return $this->hasMany(Post::class);
    }

    public function filterSearchResults($query) {
        return $query->whereHas('posts', function ($query) {
            $query->where('is_published', true);
        });
    }
}

The example code above will filter the search results and will only return users which have published posts., _(*11)

Runtime filter

Search results can be filtered by adding custom filter callback, _(*12)

$result = $this->searchable
    ->withFilter(function (Builder $query) {
        return $query->getModel() instanceof Post
            ? $query->where('description', '!=', 'Doloremque iure sequi quos sequi consequatur.')
            : $query;
    })
    ->search('Dolorem');

Disabling model filter

Model filters can be skipped in runtime like Eloquent global scopes., _(*13)

$result = $this->searchable->withoutModelFilters()->search('quia est ipsa molestiae hic');

You can specify models to skip filters for, _(*14)

$result = $this->searchable
    ->withoutModelFilters(Post::class)
    ->search('quia est ipsa molestiae hic');

or, _(*15)

$result = $this->searchable
    ->withoutModelFilters([Article::class, Post::class])
    ->search('quia est ipsa molestiae hic');

Eager load (N+1 issue)

For preventing N+1 issue you can eager load relationships for search results, _(*16)

$result = $this->searchable
    ->with([Article::class => 'author'])
    ->search('consequatur');

$result = $this->searchable
    ->with([
        Article::class => [
            'author' => function ($query) {
                return $query->where('active', true);
            },
        ],
    ])
    ->searchModel(Article::class, 'consequatur');