README

Laravel integration for ElasticKit — wires up the Elasticsearch client from config and bridges ElasticKit's pagination to Laravel's native paginator.

Installation

Requires PHP 8.1+, Laravel 10.x–12.x, and Elasticsearch 8.x.

composer require ykan/elastickit-laravel

ElasticKit (the framework-agnostic core) is pulled in automatically as a dependency of this package — you require only this one. The service provider is auto-discovered; no manual registration is needed.

Publish the config:

php artisan vendor:publish --tag=elastickit-config

Then set your cluster credentials (.env):

ELASTICKIT_HOST=http://localhost:9200
# Elastic Cloud / serverless:
# ELASTICKIT_CLOUD_ID=...
# ELASTICKIT_API_KEY=...
# ELASTICKIT_API_KEY_ID=...
# Traditional secured cluster:
# ELASTICKIT_USERNAME=elastic
# ELASTICKIT_PASSWORD=...

What it does

• Builds the Elasticsearch client from config('elastickit.connections') and registers each via Index::setClient($client, $name) (multi-connection supported).
• Registers a page resolver, so paginate() with no arguments reads ?page / ?per_page from the request automatically (perPage is still capped by each index's maxPerPage()).
• Registers a paginator resolver, so Results::toPaginator() returns a Laravel LengthAwarePaginator.

Usage

use ElasticKit\Index\Index;

class ProductIndex extends Index
{
    protected string $name = 'products';
}

// compound bool query, paginated → native Laravel LengthAwarePaginator
$results = ProductIndex::query()
    ->bool([
        'must'   => fn ($q) => $q->match('title', 'shoes'),
        'filter' => fn ($q) => $q
            ->range('price', [10, 100])
            ->when($status, fn ($q) => $q->term('status', $status))  // conditional clause
            ->term('status', 'published'),
    ])
    ->highlight('title')
    ->sort('price', 'asc')
    ->paginate($page, $perPage);   // or ->paginate() to read from the request

$results->total();                 // hit count
$results->toPaginator()->links();  // native Laravel pagination UI

Artisan commands

Pass an Index class FQCN, or optionally map short aliases in config/elastickit.php:

'indices' => [
    'products' => \App\Search\ProductIndex::class,
],

Index management

Zero-downtime rebuild

--clean removes the previous backing index right after the swap.

Prefer elastickit:rebuild for first-time setup if you ever want zero-downtime rebuilds: it bootstraps via an alias, while index:create makes a plain index that rebuild cannot swap.

Configuration

See config/elastickit.php after publishing. Define additional connections under connections and target one from an Index subclass:

class ArchiveIndex extends Index
{
    protected string $name = 'archive';
    protected string $connection = 'archive';
}

License

MIT