Elastic Scout Driver

https://github.com/babenkoivan/elastic-scout-driver
Admin
Elastic Scout Driver is an Elasticsearch driver for Laravel Scout that enables full-text search...
Tokens:27,349
Snippets:236
Trust Score:8.6
License:MIT
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Example - inspecting the registered driver

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/service-provider.md

Shows how to resolve the 'elastic' driver from the EngineManager and get an Engine instance.

```php
use Laravel\Scout\EngineManager;

$engine = resolve(EngineManager::class)->driver('elastic');
// returns an Elastic\ScoutDriver\Engine instance
```

--------------------------------

### Basic call example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/document-factory.md

Example of creating a DocumentFactory and using makeFromModels to convert a collection of models into documents, then iterating over them to output the id and content.

```php
use Elastic\ScoutDriver\Factories\DocumentFactory;

$factory   = new DocumentFactory();
$documents = $factory->makeFromModels(App\Order::where('paid', true)->get());

foreach ($documents as $document) {
    echo $document->id();      // string model scout key
    echo json_encode($document->content()); // searchable array + scout metadata
}
```

--------------------------------

### Install dependencies with Composer

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/CONTRIBUTING.md

Installs the project dependencies using Composer. Requires PHP 7.2 or higher, Composer, and Docker.

```bash
composer install
```

--------------------------------

### flush usage example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows how to call flush on an engine instance to remove all documents from the index.

```php
$engine->flush(new App\Order); // App\Order::removeAllFromSearch();
```

--------------------------------

### paginate() example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows how to call paginate() with a builder, perPage=15, and page=3, resulting in from=30 and size=15.

```php
$result = $engine->paginate(App\Order::search()->orderBy('created_at'), 15, 3);
// from = 30, size = 15
```

--------------------------------

### map usage example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows how to call map on an engine instance with a builder, result, and model instance.

```php
$models = $engine->map($builder, $result, new App\Order);
```

--------------------------------

### getTotalCount usage example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows how to call getTotalCount on an engine instance to retrieve the total count.

```php
$total = $engine->getTotalCount($result);
```

--------------------------------

### Install package and Laravel Scout via Composer

Source: https://github.com/babenkoivan/elastic-scout-driver/wiki/Lumen-Installation

Installs the elastic-scout-driver and laravel/scout packages.

```bash
composer require babenkoivan/elastic-scout-driver laravel/scout
```

--------------------------------

### Manual Engine construction example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows how to manually instantiate the Engine class with resolved dependencies and factory instances. In real applications, EngineManager resolves it automatically.

```php
use Elastic\Adapter\Documents\DocumentManager;
use Elastic\Adapter\Indices\IndexManager;
use Elastic\ScoutDriver\Engine;
use Elastic\ScoutDriver\Factories\DocumentFactory;
use Elastic\ScoutDriver\Factories\ModelFactory;
use Elastic\ScoutDriver\Factories\SearchParametersFactory;

$engine = new Engine(
    resolve(DocumentManager::class),
    new DocumentFactory(),
    new SearchParametersFactory(),
    new ModelFactory(),
    resolve(IndexManager::class)
);
```

--------------------------------

### lazyMap usage example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows how to call lazyMap on an engine instance and iterate over the returned LazyCollection.

```php
$engine->lazyMap($builder, $result, new App\Order)
    ->each(fn (App\Order $order) => $order->notify());
```

--------------------------------

### search() basic call example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows how to call search() with a Scout query and access the total count and hit document IDs.

```php
$result = $engine->search(App\Order::search('Star Trek'));

echo $result->total();            // number of hits
foreach ($result->hits() as $hit) {
    echo $hit->document()->id();  // model id
}
```

--------------------------------

### Install Elastic Scout Driver via Composer

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/README.md

Use this command to install the elastic-scout-driver package. Requires Laravel Scout to be installed beforehand.

```bash
composer require babenkoivan/elastic-scout-driver
```

--------------------------------

### Error handling example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/document-factory.md

Example of catching UnexpectedValueException when a model leaks the reserved _id key.

```php
use Elastic\ScoutDriver\Factories\DocumentFactory;
use UnexpectedValueException;

try {
    $documents = $factory->makeFromModels($orders);
} catch (UnexpectedValueException $e) {
    // Happens when a model leaks the reserved "_id" key — e.g. a MongoDB-backed
    // model whose toSearchableArray() includes _id.
    report($e);
}
```

--------------------------------

### Install Laravel Scout via Composer

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/README.md

Install Laravel Scout before using the Elastic Scout Driver, as it is a dependency.

```bash
composer require laravel/scout
```

--------------------------------

### Basic call to makeFromSearchResult

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/model-factory.md

Example of instantiating ModelFactory and calling makeFromSearchResult with a search result and a Scout search builder.

```php
use Elastic\ScoutDriver\Factories\ModelFactory;

$factory = new ModelFactory();
$models  = $factory->makeFromSearchResult($searchResult, App\Order::search('Star Trek'));
```

--------------------------------

### Zero-hit shortcut example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/model-factory.md

Shows that when the search result has a total of 0, an empty Eloquent Collection is returned without hitting the database.

```php
$empty = $factory->makeFromSearchResult(
    new SearchResult(['hits' => ['total' => ['value' => 0], 'hits' => []]]),
    App\Order::search('nothing')
);
// $empty is an empty Eloquent Collection without hitting the database
```

--------------------------------

### Example - overriding a factory binding

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/service-provider.md

Shows how to replace a factory implementation before the provider runs by binding the interface to a custom class in your own service provider.

```php
// In your own service provider (registered earlier):
$this->app->bind(
    Elastic\ScoutDriver\Factories\SearchParametersFactoryInterface::class,
    App\Search\MySearchParametersFactory::class
);
```

--------------------------------

### Installation commands for Elastic Scout Driver

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/index.md

Commands to install Laravel Scout and the Elastic Scout Driver, publish configuration, and set the driver. The driver is auto-registered via Composer's extra.laravel.providers hook.

```bash
composer require laravel/scout
composer require babenkoivan/elastic-scout-driver
php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
# set 'driver' => env('SCOUT_DRIVER', 'elastic') in config/scout.php
php artisan vendor:publish --provider="Elastic\ScoutDriver\ServiceProvider"
```

--------------------------------

### mapIds usage example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows how to call mapIds on an engine instance. The comment notes that Scout's ->keys() uses this method.

```php
$ids = $engine->mapIds($result); // Scout's ->keys() uses this
```

--------------------------------

### delete() example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Example of deleting expired orders using the delete() method. The comment notes that $expiredOrders->unsearchable() is an equivalent alternative. Deleting already-absent documents is idempotent because the adapter ignores 'not found' errors.

```php
$engine->delete($expiredOrders); // or $expiredOrders->unsearchable();
```

--------------------------------

### createIndex error handling example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Example of handling the InvalidArgumentException thrown when the 'primaryKey' option is set. The exception message is 'It is not possible to change the primary key name'.

```php
use InvalidArgumentException;

try {
    $engine->createIndex('orders', ['primaryKey' => 'custom_id']);
} catch (InvalidArgumentException $e) {
    // "It is not possible to change the primary key name"
}
```

--------------------------------

### Set ELASTIC_SCOUT_DRIVER_REFRESH_DOCUMENTS in .env

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/configuration.md

Example .env entry to force immediate indexing by setting the ELASTIC_SCOUT_DRIVER_REFRESH_DOCUMENTS environment variable to true. Any truthy string becomes true via the (bool) cast.

```bash
# .env — force immediate indexing (handy for testing)
ELASTIC_SCOUT_DRIVER_REFRESH_DOCUMENTS=true
```

--------------------------------

### update() basic call example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Basic usage of the update() method to index paid orders. The comment notes that $orders->searchable() is an equivalent alternative.

```php
$orders = App\Order::where('paid', true)->get();

$engine->update($orders); // or simply $orders->searchable();
```

--------------------------------

### update() error handling example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Example of handling UnexpectedValueException thrown when a model's toSearchableArray() or scoutMetadata() returns a reserved _id field. The catch block logs the error message.

```php
use UnexpectedValueException;

try {
    $engine->update(App\Order::all());
} catch (UnexpectedValueException $e) {
    // "_id is not allowed in the document content..." — a model's
    // toSearchableArray()/scoutMetadata() returned an _id field.
    Log::error('Could not index orders: ' . $e->getMessage());
}
```

--------------------------------

### Streaming large result sets with makeLazyFromSearchResult

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/model-factory.md

Example of using the lazy method to process models one at a time, which is memory-friendly for large result sets.

```php
$factory->makeLazyFromSearchResult($result, App\Order::search('*'))
    ->each(function (App\Order $order) {
        // process one model at a time — memory-friendly
    });
```

--------------------------------

### createIndex basic call example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Basic usage of createIndex to create an index named 'orders'. The comment shows the equivalent Artisan command: php artisan scout:index orders.

```php
$engine->createIndex('orders'); // or php artisan scout:index orders
```

--------------------------------

### Search with query string syntax

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/README.md

Performs a search using Elasticsearch query string mini-language syntax within a bool query. The example searches for orders with title containing 'Star' or 'Trek'.

```php
$orders = App\Order::search('title:(Star OR Trek)')->get();
```

--------------------------------

### Catching InvalidArgumentException from Engine::createIndex()

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/errors.md

Example of catching the InvalidArgumentException thrown by Engine::createIndex() when a custom primary key is provided. The catch block handles the exception and the comment shows the exception message.

```php
use Elastic\ScoutDriver\Engine;
use InvalidArgumentException;

try {
    $engine->createIndex('orders', ['primaryKey' => 'custom_id']);
} catch (InvalidArgumentException $e) {
    // "It is not possible to change the primary key name"
}
```

--------------------------------

### deleteIndex usage example

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Basic usage of deleteIndex to drop an index named 'orders'. The comment shows the equivalent Artisan command: php artisan scout:delete-index orders.

```php
$engine->deleteIndex('orders'); // or php artisan scout:delete-index orders
```

--------------------------------

### Catch UnexpectedValueException during indexing

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/errors.md

Catches the UnexpectedValueException thrown when a model's searchable content contains the reserved '_id' key. The example logs the error message, which includes the model class name (e.g., Order). Use this to handle indexing failures gracefully.

```php
use UnexpectedValueException;

try {
    $engine->update($orders);
} catch (UnexpectedValueException $e) {
    // message: "_id is not allowed in the document content. Please, make sure the
    // field is not returned by the Order::toSearchableArray or Order::scoutMetadata methods."
    Log::error('Indexing failed: ' . $e->getMessage());
}
```

--------------------------------

### boot() method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/service-provider.md

The boot() method publishes the config file and registers the 'elastic' engine driver.

```php
/**
 * @return void
 */
public function boot()
```

--------------------------------

### Pagination options in makeFromBuilder

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/search-parameters-factory.md

Shows how to pass pagination options to the factory to control the 'from' and 'size' parameters in the resulting query.

```php
$parameters = $factory->makeFromBuilder(
    App\Order::search('book')->take(10),
    ['page' => 3, 'perPage' => 30]
);
// produces "from": 60, "size": 30
```

--------------------------------

### Copy the configuration files

Source: https://github.com/babenkoivan/elastic-scout-driver/wiki/Lumen-Installation

Copies the Scout, Elastic Client, and Elastic Scout Driver configuration files into the config folder.

```bash
cp vendor/laravel/scout/config/scout.php config/scout.php
cp vendor/babenkoivan/elastic-client/config/elastic.client.php config/elastic.client.php
cp vendor/babenkoivan/elastic-scout-driver/config/elastic.scout_driver.php config/elastic.scout_driver.php
```

--------------------------------

### Basic usage of SearchParametersFactory

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/search-parameters-factory.md

Demonstrates how to instantiate the factory and convert a Scout builder into search parameters for the Elasticsearch client.

```php
use Elastic\ScoutDriver\Factories\SearchParametersFactory;

$factory  = new SearchParametersFactory();
$builder  = App\Order::search('title:(Star OR Trek)')
    ->where('user_id', 1)
    ->orderBy('price')
    ->take(10);

$parameters = $factory->makeFromBuilder($builder);
$client->search($parameters->toArray()); // hand off to the Elasticsearch client
```

--------------------------------

### Make the config folder

Source: https://github.com/babenkoivan/elastic-scout-driver/wiki/Lumen-Installation

Creates the config directory in the Lumen application root.

```bash
mkdir config
```

--------------------------------

### Run the test suite with make up wait test

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/CONTRIBUTING.md

Runs the test suite locally. Requires Docker and the Make targets 'up', 'wait', and 'test'.

```bash
make up wait test
```

--------------------------------

### Run static analysis with make static-analysis

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/CONTRIBUTING.md

Performs static code analysis before opening a Pull Request. Recommended to catch potential issues.

```bash
make static-analysis
```

--------------------------------

### register() method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/service-provider.md

The register() method merges the package config and binds factory implementations if not already bound.

```php
/**
 * @return void
 */
public function register()
```

--------------------------------

### Publish configuration with artisan vendor:publish

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/configuration.md

Command to publish the package's configuration file to the application's config directory. Run this to customize the 'refresh_documents' setting.

```bash
php artisan vendor:publish --provider="Elastic\ScoutDriver\ServiceProvider"
```

--------------------------------

### ServiceProvider class definition with weak bindings

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/service-provider.md

Shows the final class extending AbstractServiceProvider, with a $configPath property and an array of weak bindings mapping factory interfaces to default implementations. The constructor initializes the config path to the package's config file.

```php
final class ServiceProvider extends AbstractServiceProvider
{
    private string $configPath;

    private array $weakBindings = [
        ModelFactoryInterface::class => ModelFactory::class,
        DocumentFactoryInterface::class => DocumentFactory::class,
        SearchParametersFactoryInterface::class => SearchParametersFactory::class,
    ];

    public function __construct(Application $app)
    {
        parent::__construct($app);

        $this->configPath = dirname(__DIR__) . '/config/elastic.scout_driver.php';
    }
}
```

--------------------------------

### Engine::__construct

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Creates a new Engine instance with the required dependencies for document management, factory services, and index management.

```APIDOC
## Engine::__construct

### Description
Creates a new Engine instance with the required dependencies for document management, factory services, and index management.

### Method
Constructor

### Signature
```php
public function __construct(
    DocumentManager $documentManager,
    DocumentFactoryInterface $documentFactory,
    SearchParametersFactoryInterface $searchParametersFactory,
    ModelFactoryInterface $modelFactory,
    IndexManager $indexManager
)
```

### Parameters
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$documentManager` | `Elastic\Adapter\Documents\DocumentManager` | yes | — | Performs index/delete/search/deleteByQuery operations on documents |
| `$documentFactory` | `Elastic\ScoutDriver\Factories\DocumentFactoryInterface` | yes | — | Builds `Document` objects from model collections |
| `$searchParametersFactory` | `Elastic\ScoutDriver\Factories\SearchParametersFactoryInterface` | yes | — | Builds `SearchParameters` from a Scout `Builder` |
| `$modelFactory` | `Elastic\ScoutDriver\Factories\ModelFactoryInterface` | yes | — | Hydrates Eloquent models from a `SearchResult` |
| `$indexManager` | `Elastic\Adapter\Indices\IndexManager` | yes | — | Creates and drops indices |

### Configuration
Reads the package configuration:
```php
$this->refreshDocuments = (bool)config('elastic.scout_driver.refresh_documents');
```

### Example — manual construction
```php
use Elastic\Adapter\Documents\DocumentManager;
use Elastic\Adapter\Indices\IndexManager;
use Elastic\ScoutDriver\Engine;
use Elastic\ScoutDriver\Factories\DocumentFactory;
use Elastic\ScoutDriver\Factories\ModelFactory;
use Elastic\ScoutDriver\Factories\SearchParametersFactory;

$engine = new Engine(
    resolve(DocumentManager::class),
    new DocumentFactory(),
    new SearchParametersFactory(),
    new ModelFactory(),
    resolve(IndexManager::class)
);
```

### Notes
In real applications you normally never construct `Engine` yourself; `EngineManager` resolves it for you. The constructor is documented because tests and advanced integrations build it explicitly.
```

--------------------------------

### Add missing helpers in app/helpers.php

Source: https://github.com/babenkoivan/elastic-scout-driver/wiki/Lumen-Installation

Defines config_path() and resolve() functions that Lumen lacks. These are required for the package to work.

```php
<?php declare(strict_types=1);

if (!function_exists('config_path')) {
    function config_path($path = '')
    {
        return app()->basePath() . '/config' . ($path ? '/' . $path : $path);
    }
}

if (!function_exists('resolve')) {
    function resolve($name, array $parameters = [])
    {
        return app($name, $parameters);
    }
}
```

--------------------------------

### SearchParametersFactoryInterface makeFromBuilder method

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/types.md

Defines the contract for building SearchParameters from a Scout Builder. The makeFromBuilder method accepts an optional $options array (default []) that may contain 'page' and 'perPage' integers for pagination. Implemented by SearchParametersFactory and accepted by Engine's constructor.

```php
interface SearchParametersFactoryInterface
{
    public function makeFromBuilder(Builder $builder, array $options = []): SearchParameters;
}

```

--------------------------------

### Register service providers in bootstrap/app.php

Source: https://github.com/babenkoivan/elastic-scout-driver/wiki/Lumen-Installation

Registers the Scout, Elastic Client, and Elastic Scout Driver service providers.

```php
$app->register(Laravel\Scout\ScoutServiceProvider::class);
$app->register(ElasticClient\ServiceProvider::class);
$app->register(ElasticScoutDriver\ServiceProvider::class);
```

--------------------------------

### Constructor signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/service-provider.md

The constructor accepts the Laravel application container and initializes the config path.

```php
public function __construct(Application $app)
```

--------------------------------

### SearchParametersFactoryInterface::makeFromBuilder

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/types.md

Interface for building SearchParameters from a Scout Builder.

```APIDOC
## SearchParametersFactoryInterface

### Description
Interface for building SearchParameters from a Scout Builder.

### Method
makeFromBuilder

### Signature
makeFromBuilder(Builder $builder, array $options = []): SearchParameters

### Parameters
- **$builder** (Builder) - Required - The Scout builder.
- **$options** (array) - Optional - May contain `page` and `perPage` ints for pagination. Default `[]`.

### Returns
- **SearchParameters** - `Elastic\Adapter\Search\SearchParameters` built from the builder.
```

--------------------------------

### Register container bindings in bootstrap/app.php

Source: https://github.com/babenkoivan/elastic-scout-driver/wiki/Lumen-Installation

Sets the config path and enables Eloquent and facades in the Lumen application.

```php
$app->instance('path.config', app()->basePath() . '/config');

$app->withEloquent();
$app->withFacades();
```

--------------------------------

### Publish elastic-client configuration

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/configuration.md

Publishes the elastic-client configuration file (config/elastic.client.php) from the babenkoivan/elastic-client package, which provides the underlying DocumentManager/IndexManager and Elasticsearch connection settings.

```bash
php artisan vendor:publish --provider="Elastic\Client\ServiceProvider"
```

--------------------------------

### search() raw search bypassing model mapping

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows how to use search() with a builder that includes a where clause, bypassing model mapping. Checks if the total is zero.

```php
$builder = App\Order::search('title:(Star OR Trek)')->where('user_id', 1);
$result  = $engine->search($builder);

if ($result->total() === 0) {
    // no matches
}
```

--------------------------------

### Enable helpers.php autoload in composer.json

Source: https://github.com/babenkoivan/elastic-scout-driver/wiki/Lumen-Installation

Adds the helpers file to the Composer autoload files array so the functions are loaded.

```json
"autoload": {
    // ...,
    "files": [
        "app/helpers.php"
    ]
}
```

--------------------------------

### Engine class definition and constructor

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Shows the class declaration and constructor with injected dependencies: DocumentManager, DocumentFactoryInterface, SearchParametersFactoryInterface, ModelFactoryInterface, and IndexManager. The class extends AbstractEngine and includes protected properties for refreshDocuments, documentManager, documentFactory, searchParametersFactory, modelFactory, and indexManager.

```php
class Engine extends AbstractEngine
{
    protected bool $refreshDocuments;
    protected DocumentManager $documentManager;
    protected DocumentFactoryInterface $documentFactory;
    protected SearchParametersFactoryInterface $searchParametersFactory;
    protected ModelFactoryInterface $modelFactory;
    protected IndexManager $indexManager;

    public function __construct(
        DocumentManager $documentManager,
        DocumentFactoryInterface $documentFactory,
        SearchParametersFactoryInterface $searchParametersFactory,
        ModelFactoryInterface $modelFactory,
        IndexManager $indexManager
    )
}
```

--------------------------------

### Publish Laravel Scout Configuration

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/README.md

Publish the Scout configuration file using the artisan command.

```bash
php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
```

--------------------------------

### makeFromBuilder method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/search-parameters-factory.md

The primary method used to initiate the translation of a Scout builder into search parameters.

```php
public function makeFromBuilder(Builder $builder, array $options = []): SearchParameters
```

--------------------------------

### paginate(Builder $builder, $perPage, $page)

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Same as search() but adds from/size parameters for paging. This method is invoked by Scout's paginate() and simplePaginate() methods.

```APIDOC
## paginate(Builder $builder, $perPage, $page)

### Description
Same as `search()` but adds `from`/`size` parameters for paging. This is invoked by Scout's `paginate()`/`simplePaginate()`.

### Method
paginate

### Parameters
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$builder` | `Laravel\Scout\Builder` | yes | — | Scout query builder |
| `$perPage` | `int` | yes | — | Number of results per page (cast to `int`) |
| `$page` | `int` | yes | — | 1-based page number (cast to `int`) |

### Behavior
- Options passed to the factory: `['perPage' => (int)$perPage, 'page' => (int)$page]`.
- The factory computes `from = (page - 1) * perPage` and `size = perPage`.

### Return
`Elastic\Adapter\Search\SearchResult`.

### Example
```php
$result = $engine->paginate(App\Order::search()->orderBy('created_at'), 15, 3);
// from = 30, size = 15
```
```

--------------------------------

### paginate() method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Declares the paginate() method that accepts a Builder, perPage, and page parameters, returning a SearchResult.

```php
/**
 * @param int $perPage
 * @param int $page
 *
 * @return SearchResult
 */
public function paginate(Builder $builder, $perPage, $page)
```

--------------------------------

### Run style check with make style-check

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/CONTRIBUTING.md

Checks that code follows PSR-2 coding style standards using the Make target 'style-check'.

```bash
make style-check
```

--------------------------------

### search() method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Declares the search() method that accepts a Scout Builder and returns a SearchResult. The method is part of the engine class.

```php
/**
 * @return SearchResult
 */
public function search(Builder $builder)
```

--------------------------------

### makeFromModels method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/document-factory.md

Shows the public method signature for makeFromModels.

```php
public function makeFromModels(Collection $models): Collection
```

--------------------------------

### Engine constructor signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Defines the constructor for the Engine class, requiring a DocumentManager, DocumentFactoryInterface, SearchParametersFactoryInterface, ModelFactoryInterface, and IndexManager.

```php
public function __construct(
    DocumentManager $documentManager,
    DocumentFactoryInterface $documentFactory,
    SearchParametersFactoryInterface $searchParametersFactory,
    ModelFactoryInterface $modelFactory,
    IndexManager $indexManager
)
```

--------------------------------

### ModelFactory class signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/model-factory.md

Shows the public methods of the ModelFactory class: makeFromSearchResult and makeLazyFromSearchResult, both accepting a SearchResult and a Builder.

```php
class ModelFactory implements ModelFactoryInterface
{
    public function makeFromSearchResult(
        SearchResult $searchResult,
        Builder $builder
    ): Collection;

    public function makeLazyFromSearchResult(
        SearchResult $searchResult,
        Builder $builder
    ): LazyCollection;
}
```

--------------------------------

### Set Scout Driver to Elastic

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/README.md

Change the 'driver' option in config/scout.php to 'elastic' to use the Elastic Scout Driver.

```php
// config/scout.php

'driver' => env('SCOUT_DRIVER', 'elastic'),
```

--------------------------------

### ModelFactoryInterface

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/types.md

Defines the contract for creating models from search results, with both eager and lazy (streamed) hydration. Implemented by ModelFactory and accepted by the Engine constructor.

```php
interface ModelFactoryInterface
{
    public function makeFromSearchResult(SearchResult $searchResult, Builder $builder): Collection;

    public function makeLazyFromSearchResult(SearchResult $searchResult, Builder $builder): LazyCollection;
}

```

--------------------------------

### Package configuration file config/elastic.scout_driver.php

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/configuration.md

Package-owned configuration file that defines the 'refresh_documents' option, defaulting to false and overridable via the ELASTIC_SCOUT_DRIVER_REFRESH_DOCUMENTS environment variable. This file is merged into the application config under the key 'elastic.scout_driver' and can be published to the application's config directory.

```php
<?php declare(strict_types=1);

return [
    'refresh_documents' => env('ELASTIC_SCOUT_DRIVER_REFRESH_DOCUMENTS', false),
];
```

--------------------------------

### Configure Laravel Scout driver to elastic

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/configuration.md

Activates the Elastic Scout Driver by setting the Laravel Scout driver to 'elastic'. The value is matched against the driver registered by ServiceProvider::boot() via EngineManager::extend('elastic', ...).

```php
// config/scout.php
'driver' => env('SCOUT_DRIVER', 'elastic'),
```

--------------------------------

### Raw search returns SearchResult instance

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/README.md

Calling raw() on a search query returns an instance of the SearchResult class from the Elastic Adapter, not a collection of models. This is different from other Scout drivers.

```php
$searchResult = App\Order::search('Star Trek')->raw();
```

--------------------------------

### makeFromBuilder(Builder $builder, array $options = []): SearchParameters

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/search-parameters-factory.md

Builds a SearchParameters object from a Laravel Scout Builder, applying pagination options and returning the parameters ready for the Elasticsearch client.

```APIDOC
## makeFromBuilder(Builder $builder, array $options = []): SearchParameters

### Description
Translates a Laravel Scout `Builder` (query string, filters, sorts, limits, pagination) into an `Elastic\Adapter\Search\SearchParameters` object, which becomes the Elasticsearch request body.

### Method
makeFromBuilder

### Endpoint
N/A (PHP method)

### Parameters
#### Method Parameters
- **$builder** (Laravel\Scout\Builder) - Required - Scout query builder from `Model::search()`
- **$options** (array) - Optional - Pagination options; keys `page` and `perPage` (ints)

### Behavior
Builds a `SearchParameters` object by setting, in order:
1. **indices** — `[$this->makeIndex($builder)]` (single index).
2. **query** — `$this->makeQuery($builder)` (bool query).
3. **sort** — only if `makeSort()` returns a non-empty array.
4. **from** — only if `makeFrom($options)` returns a truthy value.
5. **size** — only if `makeSize($builder, $options)` returns a truthy value.

### Return
`Elastic\Adapter\Search\SearchParameters` — serializable to the request body via `toArray()`. The shape is:

```json
{
  "index": "clients",
  "body": {
    "query": { "bool": { "must": [...], "filter": [...] } },
    "sort": [...],
    "from": 30,
    "size": 30
  }
}
```

### Example — basic call

```php
use Elastic\ScoutDriver\Factories\SearchParametersFactory;

$factory  = new SearchParametersFactory();
$builder  = App\Order::search('title:(Star OR Trek)')
    ->where('user_id', 1)
    ->orderBy('price')
    ->take(10);

$parameters = $factory->makeFromBuilder($builder);
$client->search($parameters->toArray()); // hand off to the Elasticsearch client
```

### Example — pagination options

```php
$parameters = $factory->makeFromBuilder(
    App\Order::search('book')->take(10),
    ['page' => 3, 'perPage' => 30]
);
// produces "from": 60, "size": 30
```
```

--------------------------------

### createIndex($name, array $options = [])

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Creates an empty Elasticsearch index. Used by Scout's Artisan index commands. Throws an InvalidArgumentException if the primaryKey option is set.

```APIDOC
## createIndex($name, array $options = [])

### Description
Creates an empty Elasticsearch index. Used by Scout's `Artisan` index commands.

### Method
PHP method

### Signature
```php
public function createIndex($name, array $options = [])
```

### Parameters
- `$name` (string) - Required - Index name
- `$options` (array) - Optional - Accepted keys: `primaryKey`. If `primaryKey` is set, an exception is thrown

### Return
`void`.

### Throws
- `InvalidArgumentException` - If `$options['primaryKey']` is set — message: `It is not possible to change the primary key name`

### Example — basic call
```php
$engine->createIndex('orders'); // or php artisan scout:index orders
```

### Example — error handling
```php
use InvalidArgumentException;

try {
    $engine->createIndex('orders', ['primaryKey' => 'custom_id']);
} catch (InvalidArgumentException $e) {
    // "It is not possible to change the primary key name"
}
```
```

--------------------------------

### Published config file content

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/service-provider.md

The default configuration file content after publishing, containing the refresh_documents setting.

```php
return [
    'refresh_documents' => env('ELASTIC_SCOUT_DRIVER_REFRESH_DOCUMENTS', false),
];
```

--------------------------------

### DocumentFactoryInterface

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/types.md

Defines the contract for creating documents from a collection of models. Implemented by DocumentFactory and accepted by the Engine constructor.

```php
interface DocumentFactoryInterface
{
    public function makeFromModels(Collection $models): Collection;
}

```

--------------------------------

### search(Builder $builder)

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Runs a search using the provided Scout builder and returns the raw Elasticsearch search result. This method is used to execute a search query and access the raw response.

```APIDOC
## search(Builder $builder)

### Description
Runs a search and returns the raw Elasticsearch response.

### Method
search

### Parameters
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$builder` | `Laravel\Scout\Builder` | yes | — | Scout query builder produced by `Model::search()` |

### Behavior
- Builds `SearchParameters` via `$this->searchParametersFactory->makeFromBuilder($builder)`.
- Delegates to `$this->documentManager->search($searchParameters)`.

### Return
`Elastic\Adapter\Search\SearchResult` — the raw search response. Access hits with `->hits()`, the total count with `->total()`.

### Example — basic call
```php
$result = $engine->search(App\Order::search('Star Trek'));

echo $result->total();            // number of hits
foreach ($result->hits() as $hit) {
    echo $hit->document()->id();  // model id
}
```

### Example — raw search bypassing model mapping
```php
$builder = App\Order::search('title:(Star OR Trek)')->where('user_id', 1);
$result  = $engine->search($builder);

if ($result->total() === 0) {
    // no matches
}
```
```

--------------------------------

### SearchParametersFactory class definition

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/search-parameters-factory.md

The class implements the SearchParametersFactoryInterface and provides the makeFromBuilder method for query translation.

```php
class SearchParametersFactory implements SearchParametersFactoryInterface
{
    public function makeFromBuilder(Builder $builder, array $options = []): SearchParameters
}
```

--------------------------------

### makeLazyFromSearchResult method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/model-factory.md

Signature of the lazy counterpart method that returns a LazyCollection.

```php
public function makeLazyFromSearchResult(
    SearchResult $searchResult,
    Builder $builder
): LazyCollection
```

--------------------------------

### Search with match all query

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/README.md

Performs a search without a query string, which uses the match all query, and applies a where clause to filter results by user_id.

```php
$orders = App\Order::search()->where('user_id', 1)->get();
```

--------------------------------

### InvalidArgumentException — custom primary key

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/errors.md

Documentation for the InvalidArgumentException thrown by Engine::createIndex() when a custom primary key is provided.

```APIDOC
## InvalidArgumentException — custom primary key

### Description
Thrown when `Engine::createIndex()` is called with a `primaryKey` option, as changing the primary key name is not supported.

### Error Type
`InvalidArgumentException` (SPL)

### Source
`src/Engine.php` — `Engine::createIndex()`, lines 164–176

### Message
`It is not possible to change the primary key name`

### Trigger
Calling `createIndex($name, ['primaryKey' => ...])` with the `primaryKey` option set to any value.

### Method Signature
```php
public function createIndex($name, array $options = [])
```

### Parameters
- **$name** (string) - Required - The name of the index to create.
- **$options** (array) - Optional - An array of options. If it contains a `primaryKey` key, an exception is thrown.

### Throws
- **InvalidArgumentException** - When `$options['primaryKey']` is set.

### Example
```php
use Elastic\ScoutDriver\Engine;
use InvalidArgumentException;

try {
    $engine->createIndex('orders', ['primaryKey' => 'custom_id']);
} catch (InvalidArgumentException $e) {
    // "It is not possible to change the primary key name"
}
```
```

--------------------------------

### DocumentFactory class declaration

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/document-factory.md

Declares the DocumentFactory class implementing DocumentFactoryInterface with the makeFromModels method.

```php
class DocumentFactory implements DocumentFactoryInterface
{
    public function makeFromModels(Collection $models): Collection
}
```

--------------------------------

### makeFromSearchResult method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/model-factory.md

Signature of the makeFromSearchResult method that returns an Eloquent Collection.

```php
public function makeFromSearchResult(
    SearchResult $searchResult,
    Builder $builder
): Collection
```

--------------------------------

### map(Builder $builder, $results, $model)

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Hydrates Eloquent models from a search result, filtered to only the returned document IDs and re-sorted to the search-hit order.

```APIDOC
## map(Builder $builder, $results, $model)

### Description
Hydrates Eloquent models from a search result, filtered to only the returned document IDs and re-sorted to the search-hit order.

### Method
map

### Parameters
- `$builder` (Laravel\Scout\Builder) - Required - Original Scout builder (used for `getScoutModelsByIds`)
- `$results` (Elastic\Adapter\Search\SearchResult) - Required - Search response
- `$model` (Illuminate\Database\Eloquent\Model) - Required - Model type; unused directly, delegate receives the builder

### Return
Illuminate\Database\Eloquent\Collection.

### Example
```php
$models = $engine->map($builder, $result, new App\Order);
```
```

--------------------------------

### map method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Declares the map method that hydrates Eloquent models from a search result. It takes a Builder, SearchResult, and Model, and returns an EloquentCollection.

```php
/**
 * @param SearchResult $results
 * @param Model        $model
 *
 * @return EloquentCollection
 */
public function map(Builder $builder, $results, $model)
```

--------------------------------

### update() method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Signature of the update() method, which indexes a collection of models into the searchable index. It accepts a non-empty EloquentCollection of Searchable models and returns void.

```php
/**
 * @param EloquentCollection $models
 *
 * @return void
 */
public function update($models)
```

--------------------------------

### makeLazyFromSearchResult(SearchResult $searchResult, Builder $builder): LazyCollection

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/model-factory.md

Lazy counterpart used by Scout's cursor(). Same pipeline as makeFromSearchResult, but models are fetched with queryScoutModelsByIds()->cursor() and returned as a LazyCollection for streaming.

```APIDOC
## makeLazyFromSearchResult(SearchResult $searchResult, Builder $builder): LazyCollection

### Description
Lazy counterpart used by Scout's `cursor()`. Same pipeline, but models are fetched with `$builder->model->queryScoutModelsByIds($builder, $documentIds)->cursor()` and returned as a `LazyCollection` (so the underlying query is streamed, not collected).

### Method
makeLazyFromSearchResult

### Signature
public function makeLazyFromSearchResult(SearchResult $searchResult, Builder $builder): LazyCollection

### Parameters
- **$searchResult** (Elastic\Adapter\Search\SearchResult) - Required - Search response
- **$builder** (Laravel\Scout\Builder) - Required - Original Scout builder

### Behavior
Same steps as `makeFromSearchResult`, but:
- Empty total returns `LazyCollection::make($builder->model->newCollection())`.
- Models come from `queryScoutModelsByIds(...)->cursor()`.
- Filtering and sorting use the same `filterModels`/`sortModels` helpers (they are generic, templated over the collection type).

### Return
`Illuminate\Support\LazyCollection`.

### Example — streaming large result sets
```php
$factory->makeLazyFromSearchResult($result, App\Order::search('*'))
    ->each(function (App\Order $order) {
        // process one model at a time — memory-friendly
    });
```
```

--------------------------------

### makeFromModels(Collection $models): Collection

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/document-factory.md

Converts a collection of Eloquent models into a collection of Elasticsearch Document objects. It injects Scout metadata, enforces soft-delete support, and throws an exception if a reserved '_id' key is present in the content.

```APIDOC
## makeFromModels(Collection $models): Collection

### Description
Converts a collection of Eloquent models into a collection of Elasticsearch `Document` objects (id + content), injecting Scout metadata and enforcing soft-delete support.

### Method
makeFromModels

### Endpoint
N/A (PHP method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **$models** (Illuminate\Support\Collection) - Required - Collection of `Laravel\Scout\Searchable` Eloquent models

### Request Example
```php
use Elastic\ScoutDriver\Factories\DocumentFactory;

$factory   = new DocumentFactory();
$documents = $factory->makeFromModels(App\Order::where('paid', true)->get());
```

### Response
#### Success Response (200)
- **Collection** (Illuminate\Support\Collection) - Collection of `Elastic\Adapter\Documents\Document` objects, one per model, in the same order.

#### Response Example
```php
foreach ($documents as $document) {
    echo $document->id();      // string model scout key
    echo json_encode($document->content()); // searchable array + scout metadata
}
```

### Throws
- **UnexpectedValueException** - If a model's `toSearchableArray()` or `scoutMetadata()` returned an `_id` field. Message: `_id is not allowed in the document content. Please, make sure the field is not returned by the {Class}::toSearchableArray or {Class}::scoutMetadata methods.` where `{Class}` is `class_basename($model)`

### Behavior
1. If `config('scout.soft_delete', false)` is truthy and the model uses the `SoftDeletes` trait, it calls `$model->pushSoftDeleteMetadata()`.
2. Builds the document id: `(string)$model->getScoutKey()`.
3. Merges content: `array_merge($model->scoutMetadata(), $model->toSearchableArray())`.
4. If the merged content contains a reserved `_id` key, throws an `UnexpectedValueException`.
5. Returns `new Document($documentId, $documentContent)`.

### Resulting Document Structure
Each returned `Elastic\Adapter\Documents\Document` carries:
- **id** (string) - `(string)$model->getScoutKey()`
- **content** (array) - `array_merge($model->scoutMetadata(), $model->toSearchableArray())` (plus soft-delete metadata when enabled)

### Soft-delete Behavior
When `scout.soft_delete` is enabled and the model uses `SoftDeletes`, the content is augmented by `$model->pushSoftDeleteMetadata()` before merging. `config('scout.soft_delete')` defaults to `false`.
```

--------------------------------

### Handle soft deletes with scout.soft_delete config

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/configuration.md

Reads the 'scout.soft_delete' config key in src/Factories/DocumentFactory.php:21. When true and the model uses the SoftDeletes trait, pushSoftDeleteMetadata() is called before building the document, so soft-deleted models carry their delete metadata into the index.

```php
if (
    config('scout.soft_delete', false) &&
    in_array(SoftDeletes::class, class_uses_recursive(get_class($model)), true)
) {
    $model->pushSoftDeleteMetadata();
}
```

--------------------------------

### Read refresh_documents config in Engine

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/configuration.md

Reads the 'refresh_documents' configuration value from the 'elastic.scout_driver' config key and casts it to boolean. This is used in the Engine constructor to determine whether documents are indexed/deleted immediately.

```php
$this->refreshDocuments = (bool)config('elastic.scout_driver.refresh_documents');
```

--------------------------------

### createIndex method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Signature of the createIndex method. It creates an empty Elasticsearch index and is used by Scout's Artisan index commands. The $options array accepts a 'primaryKey' key, but setting it throws an InvalidArgumentException.

```php
/**
 * @param string $name
 *
 * @return void
 */
public function createIndex($name, array $options = [])
```

--------------------------------

### lazyMap method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Declares the lazyMap method that hydrates models lazily via queryScoutModelsByIds(...)->cursor().

```php
/**
 * @param SearchResult $results
 * @param Model        $model
 *
 * @return LazyCollection
 */
public function lazyMap(Builder $builder, $results, $model)
```

--------------------------------

### delete() method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Signature of the delete() method, which deletes the given models from the searchable index by their Scout key. It accepts a collection of models and returns void.

```php
/**
 * @param EloquentCollection $models
 *
 * @return void
 */
public function delete($models)
```

--------------------------------

### update($models)

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Indexes a collection of models into the searchable index. Returns immediately if the collection is empty.

```APIDOC
## update($models)

### Description
Indexes a collection of models into the searchable index.

### Method
update

### Parameters
- `$models` (Illuminate\Database\Eloquent\Collection) - Required - Non-empty collection of Searchable models

### Behavior
- If `$models->isEmpty()` the method returns immediately and does nothing.
- The target index is `$models->first()->searchableAs()`.
- Documents are built by `$this->documentFactory->makeFromModels($models)`.
- Delegates to `$this->documentManager->index($index, $documents, $this->refreshDocuments)`.

### Return
`void`.

### Throws
- `UnexpectedValueException` - Propagated from `DocumentFactory::makeFromModels` if a document contains a reserved `_id` field

### Example — basic call
```php
$orders = App\Order::where('paid', true)->get();

$engine->update($orders); // or simply $orders->searchable();
```

### Example — error handling
```php
use UnexpectedValueException;

try {
    $engine->update(App\Order::all());
} catch (UnexpectedValueException $e) {
    // "_id is not allowed in the document content..." — a model's
    // toSearchableArray()/scoutMetadata() returned an _id field.
    Log::error('Could not index orders: ' . $e->getMessage());
}
```
```

--------------------------------

### getTotalCount method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Declares the getTotalCount method that returns the total hit count from a search result.

```php
/**
 * @param SearchResult $results
 *
 * @return int|null
 */
public function getTotalCount($results)
```

--------------------------------

### flush method signature

Source: https://github.com/babenkoivan/elastic-scout-driver/blob/master/_autodocs/api-reference/engine.md

Declares the flush method that deletes all documents of a model's index.

```php
/**
 * @param Model $model
 */
public function flush($model)
```
Tokens:
Raw