PHP Класс Sleimanx2\Plastic\DSL\SuggestionBuilder

Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$index string The elastic index to query against.
$query ONGR\ElasticsearchDSL\Search An instance of DSL query.

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

Метод Описание
__construct ( Connection $connection, ONGR\ElasticsearchDSL\Search $query = null ) Builder constructor.
append ( $suggestion ) Append a suggestion to query.
completion ( $name, $text, array $parameters = [] ) Add a completion suggestion.
get ( ) : array Execute the suggest query against elastic and return the raw result if model not set.
getConnection ( ) : Connection Returns the connection instance.
getIndex ( ) : string Return the current elastic index.
index ( string $index ) Set the elastic index to query against.
term ( string $name, string $text, array $parameters = [] ) Add a term suggestion.
toDSL ( ) : array Return the DSL query.

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

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

Builder constructor.
public __construct ( Connection $connection, ONGR\ElasticsearchDSL\Search $query = null )
$connection Sleimanx2\Plastic\Connection
$query ONGR\ElasticsearchDSL\Search

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

Append a suggestion to query.
public append ( $suggestion )
$suggestion

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

Add a completion suggestion.
public completion ( $name, $text, array $parameters = [] )
$name
$text
$parameters array

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

Execute the suggest query against elastic and return the raw result if model not set.
public get ( ) : array
Результат array

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

Returns the connection instance.
public getConnection ( ) : Connection
Результат Sleimanx2\Plastic\Connection

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

Return the current elastic index.
public getIndex ( ) : string
Результат string

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

Set the elastic index to query against.
public index ( string $index )
$index string

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

Add a term suggestion.
public term ( string $name, string $text, array $parameters = [] )
$name string
$text string
$parameters array

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

Return the DSL query.
public toDSL ( ) : array
Результат array

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

$index публичное свойство

The elastic index to query against.
public string $index
Результат string

$query публичное свойство

An instance of DSL query.
public Search,ONGR\ElasticsearchDSL $query
Результат ONGR\ElasticsearchDSL\Search