\Elastica\SuggestPhrase

__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() 

{@inheritdoc}

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

setGramSize()

setGramSize(integer  $size) : $this

Set the max size of the n-grams (shingles) in the field.

Parameters

Returns

setRealWordErrorLikelihood()

setRealWordErrorLikelihood(float  $likelihood) : $this

Set the likelihood of a term being misspelled even if the term exists in the dictionary.

Parameters

Returns

setConfidence()

setConfidence(float  $confidence) : $this

Set the factor applied to the input phrases score to be used as a threshold for other suggestion candidates.

Only candidates which score higher than this threshold will be included in the result.

Parameters

Returns

setMaxErrors()

setMaxErrors(float  $max) : $this

Set the maximum percentage of the terms considered to be misspellings in order to form a correction.

Parameters

Returns

setSeparator()

setSeparator(string  $separator) : $this

Parameters

Returns

setHighlight()

setHighlight(string  $preTag, string  $postTag) : $this

Set suggestion highlighting.

Parameters

Returns

setStupidBackoffSmoothing()

setStupidBackoffSmoothing(float  $discount = 0.4) : $this

Parameters

Returns

setLaplaceSmoothing()

setLaplaceSmoothing(float  $alpha = 0.5) : $this

Parameters

Returns

setLinearInterpolationSmoothing()

setLinearInterpolationSmoothing(float  $trigramLambda, float  $bigramLambda, float  $unigramLambda) : $this

Parameters

Returns

setSmoothingModel()

setSmoothingModel(string  $model, array  $params) : $this

Parameters

Returns

addCandidateGenerator()

addCandidateGenerator(\Elastica\Suggest\CandidateGenerator\AbstractCandidateGenerator  $generator) : $this

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