Download the PHP package esadewater/laravel-meilisearch without Composer
On this page you can find all versions of the php package esadewater/laravel-meilisearch. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download esadewater/laravel-meilisearch
More information about esadewater/laravel-meilisearch
Files in esadewater/laravel-meilisearch
Package laravel-meilisearch
Short Description Package to conveniently handle search indices for MeiliSearch.
License MIT
Homepage https://github.com/esadewater/laravel-meilisearch
Informations about the package laravel-meilisearch
Package to conveniently handle search indices for MeiliSearch.
Package to conveniently handle search index settings like sortable and filterable attributes for MeiliSearch through Laravel Scout.
Prerequisites
You need to have Laravel Scout installed and configured. If you haven't done yet, you can skip the "Configuring Filterable Data & Index Settings (Meilisearch)" -part while setting everything up.
Installation
You can install the package via composer:
Usage
Instead of the Searchable
trait of Laravel Scout, you need to use the IsMeiliSearchable
trait and in addition
implement the MeiliSearchable
interface. Replace the Searchable
trait with the IsMeiliSearchable
trait in your
models. Your models should look like this:
To make the handling of the index settings easier than with Laravel Scout, each model contains its own index settings for searchable, sortable and filterable attributes:
By default, all attributes are searchable. If you want to omit some attributes from the search, you have to define all remaining attributes in the getSearchableAttributes()
method.
Indexing
To create the search indices for all models, setup their index settings and import all existing models into the index, you can use the meili:setup
command:
If you want to execute one of the steps separately for one model, you can use the following commands:
To create the search index for one model, you can use the meili:create {model}
command:
To sync the index setting, like searchable, sortable and filterable attributes, you can use the meili:sync-settings {model}
command:
To import models into the search index, you can use the meili:import {model}
command:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-meilisearch with dependencies
illuminate/contracts Version ^10.0|^11.0
spatie/laravel-package-tools Version ^1.14
laravel/scout Version ^10.0
meilisearch/meilisearch-php Version ^1.0