Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

toArray()

toArray() 

setParam()

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

Sets (overwrites) the value at the given key.

Parameters

string $key

Key to set

mixed $value

Key Value

Returns

$this

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

array $params

Parameter list

Returns

$this

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

string $key

Param key

mixed $value

Value to set

Returns

$this

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

string $key

Key to return

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

mixed —

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

string $key

Key to test

Returns

boolean —

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

array —

Params

setFields()

setFields(array  $fields) : \Elastica\Query\MoreLikeThis

Set fields to which to restrict the mlt query.

Parameters

array $fields

Field names

Returns

\Elastica\Query\MoreLikeThis

Current object

setLike()

setLike(string|\Elastica\Document  $like) : $this

Set the "like" value.

Parameters

string|\Elastica\Document $like

Returns

$this

setBoost()

setBoost(float  $boost) : $this

Set boost.

Parameters

float $boost

Boost value

Returns

$this

setMaxQueryTerms()

setMaxQueryTerms(integer  $maxQueryTerms) : $this

Set max_query_terms.

Parameters

integer $maxQueryTerms

Max query terms value

Returns

$this

setMinTermFrequency()

setMinTermFrequency(integer  $minTermFreq) : $this

Set min term frequency.

Parameters

integer $minTermFreq

Returns

$this

setMinDocFrequency()

setMinDocFrequency(integer  $minDocFreq) : $this

set min document frequency.

Parameters

integer $minDocFreq

Returns

$this

setMaxDocFrequency()

setMaxDocFrequency(integer  $maxDocFreq) : $this

set max document frequency.

Parameters

integer $maxDocFreq

Returns

$this

setMinWordLength()

setMinWordLength(integer  $minWordLength) : $this

Set min word length.

Parameters

integer $minWordLength

Returns

$this

setMaxWordLength()

setMaxWordLength(integer  $maxWordLength) : $this

Set max word length.

Parameters

integer $maxWordLength

Returns

$this

setBoostTerms()

setBoostTerms(boolean  $boostTerms) : $this

Set boost terms.

Parameters

boolean $boostTerms

Returns

$this

setAnalyzer()

setAnalyzer(string  $analyzer) : $this

Set analyzer.

Parameters

string $analyzer

Returns

$this

setStopWords()

setStopWords(array  $stopWords) : $this

Set stop words.

Parameters

array $stopWords

Returns

$this

setMinimumShouldMatch()

setMinimumShouldMatch(integer|string  $minimumShouldMatch) : $this

Set minimum_should_match option.

Parameters

integer|string $minimumShouldMatch

Returns

$this

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

array $array

Returns

array

_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

string —

name

_setRawParam()

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

Sets params not inside params array.

Parameters

string $key
mixed $value

Returns

$this