Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dwarfhq/laravel-meilitools
Additional tools for Laravel Scout 9+ integration with MeiliSearch
https://github.com/dwarfhq/laravel-meilitools
laravel meilisearch scout
Last synced: 28 days ago
JSON representation
Additional tools for Laravel Scout 9+ integration with MeiliSearch
- Host: GitHub
- URL: https://github.com/dwarfhq/laravel-meilitools
- Owner: dwarfhq
- License: mit
- Created: 2022-04-26T09:24:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-04T07:40:57.000Z (over 1 year ago)
- Last Synced: 2024-08-09T15:18:53.749Z (4 months ago)
- Topics: laravel, meilisearch, scout
- Language: PHP
- Homepage:
- Size: 128 KB
- Stars: 98
- Watchers: 6
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-meilisearch - Laravel MeiliTools - Additional tools for Laravel Scout 9+ integration (Tools / Community Tools)
README
# Laravel MeiliTools
[](https://packagist.org/packages/dwarfdk/laravel-meilitools)
[](https://packagist.org/packages/dwarfdk/laravel-meilitools)
[](https://packagist.org/packages/dwarfdk/laravel-meilitools)
[](LICENSE)
[](https://github.com/dwarfhq/laravel-meilitools/actions)
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.
## Table of Contents
- [Compatibility](#compatibility)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Model Settings](#model-settings)
- [Commands](#commands)
- [Examples](#examples)
- [Testing](#testing)
- [License](#license)
## Compatibility
| 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 |
| v0.30.x | | | X |
## Installation
Install this package via Composer:
```bash
$ composer require dwarfdk/laravel-meilitools
```
## Configuration
Publish config using Artisan command:
```bash
$ php artisan vendor:publish --provider="Dwarf\MeiliTools\MeiliToolsServiceProvider"
```
Change configuration through `config/meilitools.php`.
## Usage
This package provides commands and helpers to ease the use of configuring MeiliSearch indexes.
### Model Settings
Setup index settings for a model by implementing the method provided by the contract.
```php
use Dwarf\MeiliTools\Contracts\Indexes\MeiliSettings;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Laravel\Scout\Searchable;
class Article extends Model implements MeiliSettings
{
use Searchable;
use SoftDeletes;
/**
* {@inheritdoc}
*/
public function meiliSettings(): array
{
// When using soft deletes '__soft_deleted' will automatically be added to filterable attributes.
return ['filterableAttributes' => ['status']];
}
}
```
A full list of available index settings can be found [here](https://docs.meilisearch.com/learn/configuration/settings.html).
### Commands
The following commands are available:
#### `meili:index:create` - Create a new MeiliSearch index
**Arguments:**
- `index` : Index name
**Options:**
- `--force` : Force the operation to run
#### `meili:index:delete` - Delete a MeiliSearch index
**Arguments:**
- `index` : Index name
#### `meili:index:details` - Get details for a MeiliSearch index
**Arguments:**
- `index` : Index name
#### `meili:index:reset` - Reset settings for a MeiliSearch index
**Arguments:**
- `index` : Index name
**Options:**
- `--pretend` : Only shows what changes would have been done to the index
#### `meili:index:view` - Get base information about a MeiliSearch index
**Arguments:**
- `index` : Index name
**Options:**
- `--stats` : Whether to include index stats
#### `meili:indexes:list` - List all MeiliSearch indexes
**Options:**
- `--stats` : Whether to include index stats
#### `meili:model:details` - Get details for a MeiliSearch model index
**Arguments:**
- `model` : Model class
#### `meili:model:reset` - Reset settings for a MeiliSearch model index
**Arguments:**
- `model` : Model class
**Options:**
- `--pretend` : Only shows what changes would have been done to the index
#### `meili:model:synchronize` - Synchronize settings for a MeiliSearch model index
**Arguments:**
- `model` : Model class
#### `meili:model:view` - Get base information about a MeiliSearch model index
**Arguments:**
- `model` : Model class
**Options:**
- `--stats` : Whether to include index stats
**Options:**
- `--pretend` : Only shows what changes would have been done to the index
#### `meili:models:synchronize` - Synchronize all models implementing MeiliSearch index settings
**Options:**
- `--pretend` : Only shows what changes would have been done to the indexes
- `--force` : Force the operation to run when in production
## Examples
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
```
## Testing
Running tests can be done either through composer, or directly calling the PHPUnit binary.
```bash
$ composer test
```
To run tests with code coverage, please make sure that `phpdbg` exists and is executable.
```bash
$ composer test:coverage
$ open tests/_reports/index.html
```
## Career
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](https://dwarf.dk/career/php-developer) for job openings.
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.