\Elastica\SuggestTerm

__construct()

__construct(string  $name, string  $field) 

Parameters

setText()

setText(string  $text) : $this

Suggest text must be set either globally or per suggestion.

Parameters

Returns

setPrefix()

setPrefix(  $prefix) : $this

Suggest prefix must be set either globally or per suggestion.

Parameters

Returns

setRegex()

setRegex(  $regex) : $this

Suggest regex must be set either globally or per suggestion.

Parameters

Returns

setRegexOptions()

setRegexOptions(array  $value) : $this

Expects one of the next params: max_determinized_states - defaults to 10000, flags are ALL (default), ANYSTRING, COMPLEMENT, EMPTY, INTERSECTION, INTERVAL, or NONE.

Parameters

Returns

setField()

setField(string  $field) : $this

Parameters

Returns

setSize()

setSize(integer  $size) : $this

Parameters

Returns

setShardSize()

setShardSize(integer  $size) : $this

Parameters

Returns

setName()

setName(string  $name) : $this

Sets the name of the suggest. It is automatically set by the constructor.

Parameters

Throws

\Elastica\Exception\InvalidException

If name is empty

Returns

getName()

getName() : string

Retrieve the name of this suggestion.

Returns

toArray()

toArray() : array

Converts the params to an array. A default implementation exist to create the an array out of the class name (last part of the class name) and the params.

Returns

Filter array

setParam()

setParam(string  $key, mixed  $value) : $this

Sets (overwrites) the value at the given key.

Parameters

Returns

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

Returns

addParam()

addParam(string  $key, mixed  $value) : $this

Adds a param to the list.

This function can be used to add an array of params

Parameters

Returns

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

Returns

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

Params

setAnalyzer()

setAnalyzer(string  $analyzer) : $this

Parameters

Returns

setSort()

setSort(string  $sort) : $this

Parameters

Returns

setSuggestMode()

setSuggestMode(string  $mode) : $this

Parameters

Returns

setLowercaseTerms()

setLowercaseTerms(boolean  $lowercase = true) : $this

If true, suggest terms will be lower cased after text analysis.

Parameters

Returns

setMaxEdits()

setMaxEdits(integer  $max) : $this

Set the maximum edit distance candidate suggestions can have in order to be considered as a suggestion.

Parameters

Returns

setPrefixLength()

setPrefixLength(integer  $length) : $this

The number of minimum prefix characters that must match in order to be a suggestion candidate.

Parameters

Returns

setMinWordLength()

setMinWordLength(integer  $length) : $this

The minimum length a suggest text term must have in order to be included.

Parameters

Returns

setMaxInspections()

setMaxInspections(integer  $max) : $this

Parameters

Returns

setMinDocFrequency()

setMinDocFrequency(integer|float  $min) : $this

Set the minimum number of documents in which a suggestion should appear.

Parameters

Returns

setMaxTermFrequency()

setMaxTermFrequency(float  $max) : $this

Set the maximum number of documents in which a suggest text token can exist in order to be included.

Parameters

Returns

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

Returns

_getBaseName()

_getBaseName() : string

Param's name Picks the last part of the class name and makes it snake_case You can override this method if you want to change the name.

Returns

name

_setRawParam()

_setRawParam(string  $key, mixed  $value) : $this

Sets params not inside params array.

Parameters

Returns