babenkoivan / elastic-client by babenkoivan

The official PHP Elasticsearch client integrated with Laravel
724,354
32
2
Package Data
Maintainer Username: babenkoivan
Maintainer Contact: babenko.i.a@gmail.com (Ivan Babenko)
Package Create Date: 2019-10-27
Package Last Update: 2022-07-27
Home Page:
Language: PHP
License: MIT
Last Refreshed: 2022-08-04 15:00:22
Package Statistics
Total Downloads: 724,354
Monthly Downloads: 44,071
Daily Downloads: 2,039
Total Stars: 32
Total Watchers: 2
Total Forks: 5
Total Open Issues: 1

Elastic Client

Latest Stable Version Total Downloads License Tests Code style Static analysis Donate PayPal


The official PHP Elasticsearch client integrated with Laravel.

Contents

Compatibility

The current version of Elastic Client has been tested with the following configuration:

  • PHP 7.2-8.0
  • Elasticsearch 7.x

Installation

The library can be installed via Composer:

composer require babenkoivan/elastic-client

Configuration

To change the client settings you need to publish the configuration file first:

php artisan vendor:publish --provider="ElasticClient\ServiceProvider"

You can use any settings supported by \Elasticsearch\ClientBuilder::fromConfig method in the config/elastic.client.php file as this factory is used under the hood:

return [
    'hosts' => [
        env('ELASTIC_HOST', 'localhost:9200'),
    ]
];

Usage

Type hint \Elasticsearch\Client or use resolve function to retrieve the client instance in your code:

namespace App\Console\Commands;

use Elasticsearch\Client;
use Illuminate\Console\Command;

class CreateIndex extends Command
{
    protected $signature = 'create:index {name}';

    protected $description = 'Creates an index';

    public function handle(Client $client)
    {
        $client->indices()->create([
            'index' => $this->argument('name')
        ]);
    }
}