1. class
  2. Hypervel
  3. \
  4. Scout
  5. \
  6. Engines
  7. \
  8. TypesenseEngine

TypesenseEngine

class TypesenseEngine extends Engine implements DeletesByFilter

Typesense search engine implementation.

Provides full-text search using Typesense as the backend.

Properties

protected EngineOperationRunner|null $operationRunner

The operation runner assigned to this engine.

 from  Engine
protected string $operationRunnerEngineName

The configured name of this engine.

 from  Engine

Methods

void
update(Collection $models)

Update the given models in the search index.

void
delete(Collection $models)

Remove the given models from the search index.

mixed
search(Builder $builder)

Perform a search against the engine.

mixed
paginate(Builder $builder, int $perPage, int $page)

Perform a paginated search against the engine.

Collection
mapIds(mixed $results)

Pluck and return the primary keys of the given results.

Collection
map(Builder $builder, mixed $results, Model $model)

Map the given results to instances of the given model.

LazyCollection
lazyMap(Builder $builder, mixed $results, Model $model)

Map the given results to instances of the given model via a lazy collection.

int
getTotalCount(mixed $results)

Get the total count from a raw result returned by the engine.

void
flush(Model $model)

Flush all of the model's records from the engine.

mixed
createIndex(string $name, array $options = [])

Create a search index.

mixed
deleteIndex(string $name)

Delete a search index.

Engine
setOperationRunner(EngineOperationRunner $runner, string $engineName)

Assign the operation runner to this engine.

from  Engine
bool
hasObservableOperations()

Determine if this engine has operations worth observing.

from  Engine
void
runUpdate(Collection $models)

Update the given models through the operation runner.

from  Engine
void
runDelete(Collection $models)

Delete the given models through the operation runner.

from  Engine
mixed
runSearch(Builder $builder)

Search through the operation runner.

from  Engine
mixed
runPaginate(Builder $builder, int $perPage, int $page)

Paginate through the operation runner.

from  Engine
void
runFlush(Model $model)

Flush the given model through the operation runner.

from  Engine
mixed
runOperation(string $operation, Builder $builder, Closure $callback, string|null $index = null)

Run a Builder operation through the operation runner.

from  Engine
Collection
mapIdsFrom(mixed $results, string $key)

Pluck and return the primary keys of the given results using the given key name.

from  Engine
Collection
keys(Builder $builder)

Get the results of the query as a Collection of primary keys.

from  Engine
Collection
get(Builder $builder)

Get the results of the given query mapped onto models.

from  Engine
LazyCollection
cursor(Builder $builder)

Get a lazy collection for the given query mapped onto models.

from  Engine
__construct(Client $typesense, int $maxTotalResults)

Create a new TypesenseEngine instance.

Collection
importDocuments(Collection $collectionIndex, array $documents, string|null $action = null)

Import the given documents into the index.

stdClass
createImportSortingDataObject(array $document)

Create an import sorting data object for a given document.

array
deleteDocument(Collection $collectionIndex, mixed $modelId)

Delete a document from the index.

mixed
performSearch(Builder $builder, array $options = [])

Perform the given search on the engine.

array
performPaginatedSearch(Builder $builder)

Perform a paginated search on the engine.

array
buildSearchParameters(Builder $builder, int $page, int|null $perPage)

Build the search parameters for a given Scout query builder.

string
combineFilters(string $applicationFilters, string $builderFilters)

Combine application and Builder filters without changing their precedence.

string
filters(Builder $builder)

Prepare the filters for a given search query.

array|string|int|float
parseFilterValue(array|string|bool|int|float|BackedEnum $value)

Parse the given filter value.

string
parseWhereFilter(array|string|int|float $value, string $key, string $operator = '=')

Create a "where" filter string.

string
parseWhereInFilter(array $value, string $key)

Create a "where in" filter string.

string
parseWhereNotInFilter(array $value, string $key)

Create a "where not in" filter string.

string
parseOrderBy(array $orders)

Parse the order by fields for the query.

void
deleteByFilter(Builder $builder)

Delete every document matching the prepared Builder filters.

void
createCollectionFromModel(Model $model, string $collectionName)

Create the model's Typesense collection.

Collection
collection(string $name)

Get a detached Typesense collection handle.

bool
usesSoftDelete(Model $model)

Determine if model uses soft deletes.

Client
getTypesenseClient()

Get the underlying Typesense client.

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

Get a Scout configuration value.

mixed
__call(string $method, array $parameters)

Dynamically proxy missing methods to the Typesense client instance.

Details

at line 55
void update(Collection $models)

Update the given models in the search index.

Parameters

Collection $models

Return Value

void

Exceptions

TypesenseClientError

at line 154
void delete(Collection $models)

Remove the given models from the search index.

Parameters

Collection $models

Return Value

void

Exceptions

TypesenseClientError

Perform a search against the engine.

Parameters

Builder $builder

Return Value

mixed

Exceptions

TypesenseClientError

at line 215
mixed paginate(Builder $builder, int $perPage, int $page)

Perform a paginated search against the engine.

Parameters

Builder $builder
int $perPage
int $page

Return Value

mixed

Exceptions

TypesenseClientError

at line 494
Collection mapIds(mixed $results)

Pluck and return the primary keys of the given results.

Parameters

mixed $results

Return Value

Collection

at line 506
Collection map(Builder $builder, mixed $results, Model $model)

Map the given results to instances of the given model.

Parameters

Builder $builder
mixed $results
Model $model

Return Value

Collection

at line 544
LazyCollection lazyMap(Builder $builder, mixed $results, Model $model)

Map the given results to instances of the given model via a lazy collection.

Parameters

Builder $builder
mixed $results
Model $model

Return Value

LazyCollection

at line 573
int getTotalCount(mixed $results)

Get the total count from a raw result returned by the engine.

Parameters

mixed $results

Return Value

int

at line 583
void flush(Model $model)

Flush all of the model's records from the engine.

Parameters

Model $model

Return Value

void

Exceptions

TypesenseClientError

at line 631
mixed createIndex(string $name, array $options = [])

Create a search index.

Parameters

string $name
array $options

Return Value

mixed

Exceptions

NotSupportedException

at line 643
mixed deleteIndex(string $name)

Delete a search index.

Parameters

string $name

Return Value

mixed

Exceptions

TypesenseClientError
ObjectNotFound

in Engine at line 102
Engine setOperationRunner(EngineOperationRunner $runner, string $engineName)

Assign the operation runner to this engine.

Boot-only. The runner persists on this engine for the worker lifetime. Engines without observable operations retain no runner.

Parameters

EngineOperationRunner $runner
string $engineName

Return Value

Engine

in Engine at line 117
protected bool hasObservableOperations()

Determine if this engine has operations worth observing.

Return Value

bool

in Engine at line 127
void runUpdate(Collection $models)

Update the given models through the operation runner.

Parameters

Collection $models

Return Value

void

in Engine at line 157
void runDelete(Collection $models)

Delete the given models through the operation runner.

Parameters

Collection $models

Return Value

void

in Engine at line 185
mixed runSearch(Builder $builder)

Search through the operation runner.

Parameters

Builder $builder

Return Value

mixed

in Engine at line 205
mixed runPaginate(Builder $builder, int $perPage, int $page)

Paginate through the operation runner.

Parameters

Builder $builder
int $perPage
int $page

Return Value

mixed

in Engine at line 225
void runFlush(Model $model)

Flush the given model through the operation runner.

Parameters

Model $model

Return Value

void

in Engine at line 255
mixed runOperation(string $operation, Builder $builder, Closure $callback, string|null $index = null)

Run a Builder operation through the operation runner.

An omitted index uses the Builder's configured or searchable index. Pass an explicit index when the operation targets another dataset.

Parameters

string $operation
Builder $builder
Closure $callback
string|null $index

Return Value

mixed

in Engine at line 281
Collection mapIdsFrom(mixed $results, string $key)

Pluck and return the primary keys of the given results using the given key name.

Parameters

mixed $results
string $key

Return Value

Collection

in Engine at line 289
Collection keys(Builder $builder)

Get the results of the query as a Collection of primary keys.

Parameters

Builder $builder

Return Value

Collection

in Engine at line 297
Collection get(Builder $builder)

Get the results of the given query mapped onto models.

Parameters

Builder $builder

Return Value

Collection

in Engine at line 309
LazyCollection cursor(Builder $builder)

Get a lazy collection for the given query mapped onto models.

Parameters

Builder $builder

Return Value

LazyCollection

at line 43
__construct(Client $typesense, int $maxTotalResults)

Create a new TypesenseEngine instance.

Parameters

Client $typesense
int $maxTotalResults

at line 108
protected Collection importDocuments(Collection $collectionIndex, array $documents, string|null $action = null)

Import the given documents into the index.

Parameters

Collection $collectionIndex
array $documents
string|null $action

Return Value

Collection

Exceptions

TypesenseClientError

at line 136
protected stdClass createImportSortingDataObject(array $document)

Create an import sorting data object for a given document.

Parameters

array $document

Return Value

stdClass

at line 178
protected array deleteDocument(Collection $collectionIndex, mixed $modelId)

Delete a document from the index.

Returns an empty array if the document doesn't exist (idempotent delete). Other errors (network, auth, etc.) are allowed to bubble up.

Parameters

Collection $collectionIndex
mixed $modelId

Return Value

array

Exceptions

TypesenseClientError

at line 237
protected mixed performSearch(Builder $builder, array $options = [])

Perform the given search on the engine.

Parameters

Builder $builder
array $options

Return Value

mixed

Exceptions

TypesenseClientError

at line 261
protected array performPaginatedSearch(Builder $builder)

Perform a paginated search on the engine.

Parameters

Builder $builder

Return Value

array

Exceptions

TypesenseClientError

at line 310
array buildSearchParameters(Builder $builder, int $page, int|null $perPage)

Build the search parameters for a given Scout query builder.

Parameters

Builder $builder
int $page
int|null $perPage

Return Value

array

at line 365
protected string combineFilters(string $applicationFilters, string $builderFilters)

Combine application and Builder filters without changing their precedence.

Parameters

string $applicationFilters
string $builderFilters

Return Value

string

at line 381
protected string filters(Builder $builder)

Prepare the filters for a given search query.

Parameters

Builder $builder

Return Value

string

at line 413
protected array|string|int|float parseFilterValue(array|string|bool|int|float|BackedEnum $value)

Parse the given filter value.

Parameters

array|string|bool|int|float|BackedEnum $value

Return Value

array|string|int|float

at line 435
protected string parseWhereFilter(array|string|int|float $value, string $key, string $operator = '=')

Create a "where" filter string.

Parameters

array|string|int|float $value
string $key
string $operator

Return Value

string

at line 460
protected string parseWhereInFilter(array $value, string $key)

Create a "where in" filter string.

Parameters

array $value
string $key

Return Value

string

at line 470
protected string parseWhereNotInFilter(array $value, string $key)

Create a "where not in" filter string.

Parameters

array $value
string $key

Return Value

string

at line 480
protected string parseOrderBy(array $orders)

Parse the order by fields for the query.

Parameters

array $orders

Return Value

string

at line 596
void deleteByFilter(Builder $builder)

Delete every document matching the prepared Builder filters.

Parameters

Builder $builder

Return Value

void

at line 654
protected void createCollectionFromModel(Model $model, string $collectionName)

Create the model's Typesense collection.

Parameters

Model $model
string $collectionName

Return Value

void

Exceptions

TypesenseClientError

at line 678
protected Collection collection(string $name)

Get a detached Typesense collection handle.

Parameters

string $name

Return Value

Collection

at line 690
protected bool usesSoftDelete(Model $model)

Determine if model uses soft deletes.

Parameters

Model $model

Return Value

bool

at line 698
Client getTypesenseClient()

Get the underlying Typesense client.

Return Value

Client

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

Get a Scout configuration value.

Parameters

string $key
mixed $default

Return Value

mixed

at line 716
mixed __call(string $method, array $parameters)

Dynamically proxy missing methods to the Typesense client instance.

Parameters

string $method
array $parameters

Return Value

mixed