PHP Class Sleimanx2\Plastic\DSL\SuggestionBuilder

Public Properties

Property	Type	Description
$index	string	The elastic index to query against.
$query	ONGR\ElasticsearchDSL\Search	An instance of DSL query.

Method	Description
__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.

Builder constructor.

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

Append a suggestion to query.

public append ( $suggestion )
$suggestion

Add a completion suggestion.

public completion ( $name, $text, array $parameters = [] )
$name
$text
$parameters	array

Execute the suggest query against elastic and return the raw result if model not set.

public get ( ) : array
return	array

Returns the connection instance.

public getConnection ( ) : Connection
return	Sleimanx2\Plastic\Connection

Return the current elastic index.

public getIndex ( ) : string
return	string

Set the elastic index to query against.

public index ( string $index )
$index	string

Add a term suggestion.

public term ( string $name, string $text, array $parameters = [] )
$name	string
$text	string
$parameters	array

Return the DSL query.

public toDSL ( ) : array
return	array

The elastic index to query against.

public string $index
return	string

An instance of DSL query.

public Search,ONGR\ElasticsearchDSL $query
return	ONGR\ElasticsearchDSL\Search