babenkoivan/elastic-client

The official PHP Elasticsearch client integrated with Laravel

v3.0.0 2024-06-18 06:53 UTC

Requires

• php: ^8.2
• elasticsearch/elasticsearch: ^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.14
• orchestra/testbench: ^9.0
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^11.0

MIT

• Ivan Babenko

• php
• client
• elasticsearch
• laravel
• elastic

README

The official PHP Elasticsearch client integrated with Laravel.

Contents

• Compatibility
• Installation
• Configuration
• Usage

Compatibility

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

• PHP 8.2
• Elasticsearch 8.x
• Laravel 11.x

If your project uses older Laravel (or PHP) version check the previous major version of the package.

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="Elastic\Client\ServiceProvider"

In the newly created config/elastic.client.php file you can define the default connection name and describe multiple connections using configuration hashes. You can read more about building the client from a configuration hash here.

return [
    'default' => env('ELASTIC_CONNECTION', 'default'),
    'connections' => [
        'default' => [
            'hosts' => [
                env('ELASTIC_HOST', 'localhost:9200'),
            ],
            // configure basic authentication
            'basicAuthentication' => [
                env('ELASTIC_USERNAME'),
                env('ELASTIC_PASSWORD'),
            ],
            // configure HTTP client (Guzzle by default)
            'httpClientOptions' => [
                'timeout' => 2,
            ],
        ],
    ],
];

If you need more control over the client creation, you can create your own client builder:

use Elastic\Elasticsearch\ClientInterface;
use Elastic\Client\ClientBuilderInterface;

class MyClientBuilder implements ClientBuilderInterface
{
    public function default(): ClientInterface
    {
        // should return a client instance for the default connection 
    }
    
    public function connection(string $name): ClientInterface
    {
        // should return a client instance for the connection with the given name 
    }
}

Do not forget to register the builder in your application service provider:

class MyAppServiceProvider extends Illuminate\Support\ServiceProvider
{
    public function register()
    {
        $this->app->singleton(ClientBuilderInterface::class, MyClientBuilder::class);
    }
}

Usage

Use Elastic\Client\ClientBuilderInterface to get access to the client instance:

namespace App\Console\Commands;

use Elastic\Elasticsearch\ClientInterface;
use Elastic\Client\ClientBuilderInterface;
use Illuminate\Console\Command;

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

    protected $description = 'Creates an index';

    public function handle(ClientBuilderInterface $clientBuilder)
    {
        // get a client for the default connection
        $client = $clientBuilder->default();
        // get a client for the connection with name "write"
        $client = $clientBuilder->connection('write');
    
        $client->indices()->create([
            'index' => $this->argument('name')
        ]);
    }
}