PHP 클래스 Sleimanx2\Plastic\DSL\SuggestionBuilder

파일 보기 프로젝트 열기: sleimanx2/plastic

공개 프로퍼티들

프로퍼티 타입 설명
$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