PHP Класс Sleimanx2\Plastic\Connection

Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$elastic Elasticsearch\Client Elasticsearch client instance.
$index string Elastic Search default index.

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

Метод Описание
__construct ( array $config = [] ) Connection constructor.
bulkStatement ( array $params ) : array Execute a bulk statement on index;.
deleteStatement ( array $params ) : array Execute a update statement on index;.
existsStatement ( array $params ) : array | boolean Execute a exists statement on index.
getClient ( ) : Elasticsearch\Client Get the elastic search client instance.
getDSLQuery ( ) : DSLGrammar Get DSL grammar instance for this connection.
getDefaultIndex ( ) : string Get the default elastic index.
getMapBuilder ( ) : Builder Get map builder instance for this connection.
getMapGrammar ( ) : Builder Get map grammar instance for this connection.
indexStatement ( array $params ) : array Execute a insert statement on index;.
mapStatement ( array $mappings ) : array Execute a map statement on index;.
persist ( ) : EloquentPersistence Create a new elastic persistence handler.
search ( ) : SearchBuilder Begin a fluent search query builder.
searchStatement ( array $search ) : array Execute a map statement on index;.
setClient ( Elasticsearch\Client $client ) Set a custom elastic client.
setDefaultIndex ( $index ) : Connection Set the default index.
suggest ( ) : SuggestionBuilder Begin a fluent suggest query builder.
suggestStatement ( array $suggestions ) : array Execute a map statement on index;.
updateStatement ( array $params ) : array Execute a update statement on index;.

Приватные методы

Метод Описание
buildClient ( array $config ) : Elasticsearch\Client Create an elastic search instance.
setStatementIndex ( array $params ) : array

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

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

Connection constructor.
public __construct ( array $config = [] )
$config array

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

Execute a bulk statement on index;.
public bulkStatement ( array $params ) : array
$params array
Результат array

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

Execute a update statement on index;.
public deleteStatement ( array $params ) : array
$params array
Результат array

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

Execute a exists statement on index.
public existsStatement ( array $params ) : array | boolean
$params array
Результат array | boolean

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

Get the elastic search client instance.
public getClient ( ) : Elasticsearch\Client
Результат Elasticsearch\Client

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

Get DSL grammar instance for this connection.
public getDSLQuery ( ) : DSLGrammar
Результат DSLGrammar

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

Get the default elastic index.
public getDefaultIndex ( ) : string
Результат string

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

Get map builder instance for this connection.
public getMapBuilder ( ) : Builder
Результат Sleimanx2\Plastic\Map\Builder

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

Get map grammar instance for this connection.
public getMapGrammar ( ) : Builder
Результат Sleimanx2\Plastic\Map\Builder

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

Execute a insert statement on index;.
public indexStatement ( array $params ) : array
$params array
Результат array

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

Execute a map statement on index;.
public mapStatement ( array $mappings ) : array
$mappings array
Результат array

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

Create a new elastic persistence handler.
public persist ( ) : EloquentPersistence
Результат Sleimanx2\Plastic\Persistence\EloquentPersistence

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

Execute a map statement on index;.
public searchStatement ( array $search ) : array
$search array
Результат array

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

Set a custom elastic client.
public setClient ( Elasticsearch\Client $client )
$client Elasticsearch\Client

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

Set the default index.
public setDefaultIndex ( $index ) : Connection
$index
Результат Connection

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

Begin a fluent suggest query builder.
public suggest ( ) : SuggestionBuilder
Результат Sleimanx2\Plastic\DSL\SuggestionBuilder

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

Execute a map statement on index;.
public suggestStatement ( array $suggestions ) : array
$suggestions array
Результат array

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

Execute a update statement on index;.
public updateStatement ( array $params ) : array
$params array
Результат array

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

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

Elasticsearch client instance.
protected Client,Elasticsearch $elastic
Результат Elasticsearch\Client

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

Elastic Search default index.
protected string $index
Результат string