areirei/meilisearch-laravel-scout

Laravel Scout custom engine for MeiliSearch

v0.12.6 2021-12-30 08:57 UTC

Requires

• php: ^7.3|^8.0
• http-interop/http-factory-guzzle: ^1.0
• laravel/scout: ^8.0
• meilisearch/meilisearch-php: ^0.20

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4
• guzzlehttp/guzzle: ^7.2
• mockery/mockery: ^1.3
• orchestra/testbench: ^5.0|^6.0
• phpunit/phpunit: ^8.5|^9.5

MIT

• areirei

• search
• laravel
• scout
• meilisearch

README

[DEPRECATED] MeiliSearch Laravel Scout

MeiliSearch | Documentation | Slack | Roadmap | Website | FAQ

⚡ The MeiliSearch driver for Laravel Scout

⚠️ This package is deprecated. We recommend you to use Laravel Scout that now supports MeiliSearch.

MeiliSearch Laravel Scout is a MeiliSearch driver for Laravel.

MeiliSearch is an open-source search engine. Discover what MeiliSearch is!

Table of Contents

• 📖 Documentation
• 🔧 Installation
• 🚀 Getting Started
  • Indexes
  • Search
• 🗃️ Setting
  • Displayed
  • Distinct
  • Filterable
  • Ranking
  • Searchable
  • Sortable
• 🤖 Compatibility with MeiliSearch
• 💡 Learn More
• Development Workflow and Contributing

📖 Documentation

See our Documentation or our API References.

Also, take a look at the Wiki of this repository!

🔧 Installation

Install the Plugin

composer require areirei/meilisearch-laravel-scout

Install the HTTP Client

You could use any PSR-18 compatible client to use with this SDK. No additional configurations are required.
A list of compatible HTTP clients and client adapters can be found at php-http.org.

If you use Laravel 8 you can skip this section as laravel pre-install Guzzle 7 by default.

Guzzle 7:

composer require guzzlehttp/guzzle

If you already have guzzle installed with a version < 7, don't forget to update the version inside your composer.json

"require": {
  "guzzlehttp/guzzle": "^7.0"
}

Guzzle 6:

composer require php-http/guzzle6-adapter

Symfony Http Client:

composer require symfony/http-client nyholm/psr7

Curl:

composer require php-http/curl-client nyholm/psr7

Export Configuration

php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
php artisan vendor:publish --provider="Meilisearch\Scout\MeilisearchServiceProvider" --tag="config"

Update the .env file

SCOUT_DRIVER=meilisearch
MEILISEARCH_HOST=http://127.0.0.1:7700
MEILISEARCH_KEY=masterKey

Run MeiliSearch

There are many easy ways to download and run a MeiliSearch instance.

For example, if you use Docker:

docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey

NB: you can also download MeiliSearch from Homebrew or APT.

🚀 Getting Started

Indexes

Create an Index

// Create an index
php artisan scout:index books
// Create an index and give the primary-key
php artisan scout:index books --key book_id

Add Documents

<?php

use Laravel\Scout\Searchable;

class Book extends Model
{
    use Searchable;
}

<?php

class BookController extends Controller
{
    public function store()
    {
        $book = new Book();
        $book->title = 'Pride and Prejudice';
        ...
        $book->save();
    }
}

You can also import all your table to meilisearch by using the artisan command:

php artisan scout:import "App\Book"

Search in an Index

class BookController extends Controller
{
    public function search()
    {
        // MeiliSearch is typo-tolerant:
        Book::search('harry pottre')->get();
        // Or if you want to get the result from meilisearch:
        Book::search('harry pottre')->raw();
    }
}

Delete Documents

class BookController extends Controller
{
    public function destroy($id)
    {
        // Delete one document
        Book::find($id)->delete();
        // Delete several documents
        Book::destroy([1, 42]);
        // Delete all documents /!\
        Book::query()->delete();
    }
}

or you can use the artisan command to delete all documents from an index:

php artisan scout:flush "App\Book"

Delete an Index

php artisan scout:index -d books

Search

Custom Search

All the supported options are described in the search parameters section of the documentation.

use MeiliSearch\Endpoints\Indexes;

class BookController extends Controller
{
    public function customSearch()
    {
        Book::search('prince', function (Indexes $meilisearch, $query, $options) {
            $options['filters'] = 'author="Antoine de Saint-Exupéry"';

            return $meilisearch->search($query, $options);
        })->take(3)->get();
    }
}

Pagination

class BookController extends Controller
{
    public function search()
    {
        Book::search('mustang')->paginate();
        // with a limit of items per page:
        Book::search('mustang')->paginate(5);
        // using meilisearch response:
        Book::search('mustang')->paginateRaw();
    }
}

🗃️ Setting

Displayed

Edit displayed settings

// Get displayed
php artisan scout:display books
// Edit displayed
php artisan scout:display books book_id book_name
// Reset displayed
php artisan scout:display books --reset

Distinct

Edit distinct settings

// Get distinct
php artisan scout:distinct books
// Edit distinct
php artisan scout:distinct books book_id
// Reset distinct
php artisan scout:distinct books --reset

Filterable

Edit filterable settings

// Get filterable
php artisan scout:filter books
// Edit filterable
php artisan scout:filter books book_id book_name
// Reset filterable
php artisan scout:filter books --reset

Ranking

Edit ranking rules

// Get ranking
php artisan scout:ranking books
// Edit ranking
php artisan scout:ranking books book_id book_name
// Reset ranking
php artisan scout:ranking books --reset

Searchable

Edit searchable

// Get searchable
php artisan scout:search books
// Edit searchable
php artisan scout:search books book_id book_name
// Reset searchable
php artisan scout:search books --reset

Sortable

Edit sortable

// Get sortable
php artisan scout:sort books
// Edit sortable
php artisan scout:sort books name
// Reset sortable
php artisan scout:sort books --reset

🤖 Compatibility with MeiliSearch

This package only guarantees the compatibility with the version v0.20.0 of MeiliSearch.

💡 Learn More

If you're not familiar with MeiliSerach yet, the following sections may interest you:

• Manipulate documents: see the API references or read more about documents.
• Search: see the API references or follow our guide on search parameters.
• Manage the indexes: see the API references or read more about indexes.
• Configure the index settings: see the API references or follow our guide on settings parameters. Also, the Wiki of this repository will guide you through the configuration!

💡 You can use more advance function by reading the documentation of MeiliSearch PHP Client.

👍 This package is a custom engine of Laravel Scout.

Development Workflow and Contributing

Any new contribution is more than welcome in this project!

If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!

MeiliSearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.