1. class
  2. Hypervel
  3. \
  4. Scout
  5. \
  6. EngineManager

EngineManager

class EngineManager

Manages search engine instances and driver creation.

EngineManager is auto-singletoned by the container, so its instance cache is shared across coroutines for the worker lifetime.

Properties

protected Engine> $engines

The resolved engine instances.
protected Closure> $customCreators

The registered custom driver creators.

Methods

__construct(Container $container, EngineOperationRunner $operationRunner)

Create a new engine manager instance.

Engine
engine(string|null $name = null)

Get an engine instance by name.

Engine
resolve(string $name)

Resolve the given engine.

Engine
callCustomCreator(string $name)

Call a custom driver creator.

AlgoliaEngine
createAlgoliaDriver()

Create an Algolia engine instance.

void
ensureAlgoliaClientIsInstalled()

Ensure the Algolia client is installed.

MeilisearchEngine
createMeilisearchDriver()

Create a Meilisearch engine instance.

void
ensureMeilisearchClientIsInstalled()

Ensure the Meilisearch client is installed.

TypesenseEngine
createTypesenseDriver()

Create a Typesense engine instance.

void
ensureTypesenseClientIsInstalled()

Ensure the Typesense client is installed.

TurbopufferEngine
createTurbopufferDriver()

Create a Turbopuffer engine instance.

CollectionEngine
createCollectionDriver()

Create a collection engine instance.

DatabaseEngine
createDatabaseDriver()

Create a database engine instance.

NullEngine
createNullDriver()

Create a null engine instance.

EngineManager
extend(string $driver, Closure $callback)

Register a custom driver creator.

EngineManager
forgetEngines()

Forget all of the resolved engine instances.

EngineManager
forgetEngine(string $name)

Forget a specific resolved engine instance.

string
getDefaultDriver()

Get the default Scout driver name.

mixed
getConfig(string $key, mixed $default = null)

Get a Scout configuration value.

Details

at line 54
__construct(Container $container, EngineOperationRunner $operationRunner)

Create a new engine manager instance.

Parameters

Container $container
EngineOperationRunner $operationRunner

at line 63
Engine engine(string|null $name = null)

Get an engine instance by name.

Parameters

string|null $name

Return Value

Engine

at line 76
protected Engine resolve(string $name)

Resolve the given engine.

Parameters

string $name

Return Value

Engine

Exceptions

InvalidArgumentException

at line 94
protected Engine callCustomCreator(string $name)

Call a custom driver creator.

Parameters

string $name

Return Value

Engine

at line 104
AlgoliaEngine createAlgoliaDriver()

Create an Algolia engine instance.

Return Value

AlgoliaEngine

Exceptions

RuntimeException

at line 123
protected void ensureAlgoliaClientIsInstalled()

Ensure the Algolia client is installed.

Return Value

void

Exceptions

RuntimeException

at line 137
MeilisearchEngine createMeilisearchDriver()

Create a Meilisearch engine instance.

Return Value

MeilisearchEngine

at line 156
protected void ensureMeilisearchClientIsInstalled()

Ensure the Meilisearch client is installed.

Return Value

void

Exceptions

RuntimeException

at line 172
TypesenseEngine createTypesenseDriver()

Create a Typesense engine instance.

Return Value

TypesenseEngine

Exceptions

RuntimeException

at line 191
protected void ensureTypesenseClientIsInstalled()

Ensure the Typesense client is installed.

Return Value

void

Exceptions

RuntimeException

at line 205
TurbopufferEngine createTurbopufferDriver()

Create a Turbopuffer engine instance.

Return Value

TurbopufferEngine

at line 220
CollectionEngine createCollectionDriver()

Create a collection engine instance.

Return Value

CollectionEngine

at line 228
DatabaseEngine createDatabaseDriver()

Create a database engine instance.

Return Value

DatabaseEngine

at line 236
NullEngine createNullDriver()

Create a null engine instance.

Return Value

NullEngine

at line 249
EngineManager extend(string $driver, Closure $callback)

Register a custom driver creator.

The callback persists in the singleton's customCreators array for the worker lifetime and applies to every subsequent engine resolution.

Parameters

string $driver
Closure $callback

Return Value

EngineManager

at line 265
EngineManager forgetEngines()

Forget all of the resolved engine instances.

Clears the manager's engine cache; concurrent coroutines may already hold references that next resolution will not share.

Return Value

EngineManager

at line 281
EngineManager forgetEngine(string $name)

Forget a specific resolved engine instance.

Mutates the manager's engine cache; concurrent coroutines may already hold a reference to the engine and next resolution will rebuild.

Parameters

string $name

Return Value

EngineManager

at line 292
string getDefaultDriver()

Get the default Scout driver name.

Return Value

string

at line 302
protected mixed getConfig(string $key, mixed $default = null)

Get a Scout configuration value.

Parameters

string $key
mixed $default

Return Value

mixed