esadewater/laravel-meilisearch

Package to conveniently handle search indices for MeiliSearch.

0.2.0 2024-03-11 20:56 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^10.0|^11.0
• laravel/scout: ^10.0
• meilisearch/meilisearch-php: ^1.0
• spatie/laravel-package-tools: ^1.14

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^7.0|^8.0
• nunomaduro/larastan: ^2.0
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-arch: ^2.0
• pestphp/pest-plugin-laravel: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0

MIT

• Erik Sadewater

• laravel
• esadewater
• laravel-meilisearch

README

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:

composer require esadewater/laravel-meilisearch

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:

class Food extends Model implements MeiliSearchable
{
    use IsMeiliSearchable;
    
    /**
     * @var string[] Mass-assignable attributes
     */
    protected $fillable = [
        'name',
    ];
    
    /**
     * Get attributes used for search
     */
    public function toSearchableArray(): array
    {
        return [
            'name' => $this->name,
        ];
    }
}

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:

class Recipe extends Model implements MeiliSearchable
{
    use IsMeiliSearchable;
    
    /**
     * Define the searchable attributes for the model
     */
    public static function getSearchableAttributes(): array
    {
        return [
            'name',
            'difficulty',
            'ingredient_names',
        ];
    }

    /**
     * Define the search sortable attributes for the model
     */
    public static function getSortableAttributes(): array
    {
        return [
            'name',
            'difficulty',
        ];
    }

    /**
     * Define the search filter attributes for the model
     */
    public static function getFilterableAttributes(): array
    {
        return [
            'difficulty',
        ];
    }
}

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:

php artisan meili:setup

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:

php artisan meili:create App\\Models\\Food

To sync the index setting, like searchable, sortable and filterable attributes, you can use the meili:sync-settings {model} command:

php artisan meili:sync-settings App\Models\Food

To import models into the search index, you can use the meili:import {model} command:

php artisan meili:import App\Models\Food

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Credits

• Erik Sadewater

License

The MIT License (MIT). Please see License File for more information.