PHP Класс Spatie\SearchIndex\SearchIndexHandlers\Elasticsearch

Наследование: implements Spatie\SearchIndex\SearchIndexHandler
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$elasticsearch Elasticsearch
$indexName string

Открытые методы

Метод Описание
__construct ( Elasticsearch\Client $elasticsearch )
clearIndex ( ) : mixed Remove everything from the index.
getClient ( ) : Elasticsearch Get the underlying client.
getResults ( array $query ) : mixed Get the results for the given query.
removeFromIndex ( Spatie\SearchIndex\Searchable $subject ) Remove the given subject from the search index.
removeFromIndexByTypeAndId ( string $type, integer $id ) Remove an item from the search index by type and id.
setIndexName ( $indexName ) Set the name of the index that should be used by default.
upsertToIndex ( Spatie\SearchIndex\Searchable | array | Traversabl\Traversable $subject ) Add or update the given searchable subject or array of subjects or Traversable object containing subjects.

Описание методов

__construct() публичный Метод

public __construct ( Elasticsearch\Client $elasticsearch )
$elasticsearch Elasticsearch\Client

clearIndex() публичный Метод

Remove everything from the index.
public clearIndex ( ) : mixed
Результат mixed

getClient() публичный Метод

Get the underlying client.
public getClient ( ) : Elasticsearch
Результат Elasticsearch

getResults() публичный Метод

Get the results for the given query.
public getResults ( array $query ) : mixed
$query array
Результат mixed

removeFromIndex() публичный Метод

Remove the given subject from the search index.
public removeFromIndex ( Spatie\SearchIndex\Searchable $subject )
$subject Spatie\SearchIndex\Searchable

removeFromIndexByTypeAndId() публичный Метод

Remove an item from the search index by type and id.
public removeFromIndexByTypeAndId ( string $type, integer $id )
$type string
$id integer

setIndexName() публичный Метод

Set the name of the index that should be used by default.
public setIndexName ( $indexName )
$indexName

upsertToIndex() публичный Метод

Add or update the given searchable subject or array of subjects or Traversable object containing subjects.
public upsertToIndex ( Spatie\SearchIndex\Searchable | array | Traversabl\Traversable $subject )
$subject Spatie\SearchIndex\Searchable | array | Traversabl\Traversable

Описание свойств

$elasticsearch защищенное свойство

protected Elasticsearch,Spatie\SearchIndex\SearchIndexHandlers $elasticsearch
Результат Elasticsearch

$indexName защищенное свойство

protected string $indexName
Результат string