The purpose of this package is to ease the configuration of indexes for MeiliSearch, so it's possible to use advanced filtering and sorting through Laravel Scout, without having to meddle with their API manually.
Engine | 0.1.x | 0.2.x | 0.3.x |
---|---|---|---|
v0.26.x | X | X | |
v0.27.x | X | X | |
v0.28.x | X | ||
v0.29.x | X |
Install this package via Composer:
$ composer require dwarfdk/laravel-meilitools
Publish config using Artisan command:
$ php artisan vendor:publish --provider="Dwarf\MeiliTools\MeiliToolsServiceProvider"
Change configuration through config/meilitools.php
.
This package provides commands and helpers to ease the use of configuring MeiliSearch indexes.
Setup index settings for a model by implementing the method provided by the contract.
use Dwarf\MeiliTools\Contracts\Indexes\MeiliSettings;
use Illuminate\Database\Eloquent\Model;
use Laravel\Scout\Searchable;
class Article extends Model implements MeiliSettings
{
use Searchable;
/**
* {@inheritdoc}
*/
public function meiliSettings(): array
{
return ['filterableAttributes' => ['status']];
}
}
A full list of available index settings can be found here.
The following commands are available:
Arguments:
index
: Index name
Arguments:
index
: Index name
Options:
--pretend
: Only shows what changes would have been done to the index
Arguments:
index
: Index name
Options:
--stats
: Whether to include index stats
Options:
--stats
: Whether to include index stats
Arguments:
model
: Model class
Arguments:
model
: Model class
Options:
--pretend
: Only shows what changes would have been done to the index
Arguments:
model
: Model class
Arguments:
model
: Model class
Options:
--stats
: Whether to include index stats
Options:
--pretend
: Only shows what changes would have been done to the index
Options:
--pretend
: Only shows what changes would have been done to the indexes--force
: Force the operation to run when in production
Model commands can take both full class name and base name, with the latter being completed using the configured paths.
$ php artisan meili:model:details App\\Models\\Article
$ php artisan meili:model:details Article
$ php artisan meili:model:reset App\\Models\\Article
$ php artisan meili:model:reset Article
$ php artisan meili:model:synchronize App\\Models\\Article
$ php artisan meili:model:synchronize Article
$ php artisan meili:model:view App\\Models\\Article
$ php artisan meili:model:view Article
Running tests can be done either through composer, or directly calling the PHPUnit binary.
$ composer test
To run tests with code coverage, please make sure that phpdbg
exists and is executable.
$ composer test:coverage
$ open tests/_reports/index.html
Dwarf A/S is a digital agency based in Copenhagen (Denmark) and established January 1st 2000.
We're always looking for new talent, so have a look at our website for job openings.
The MIT License (MIT). Please see License File for more information.