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
array
—
Filter array
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
setQuery()
setQuery(string $query = '') : $this
Sets the query.
Parameters
string
$query
Query
Returns
$this
setFields()
setFields(array $fields = array()) : $this
Sets Fields to be used in the query.
Parameters
array
$fields
Fields
Returns
$this
setUseDisMax()
setUseDisMax(boolean $useDisMax = true) : $this
Sets use dis max indicating to either create a dis_max query or a bool query.
If not set, defaults to true.
Parameters
boolean
$useDisMax
Returns
$this
setTieBreaker()
setTieBreaker(float $tieBreaker = 0.0) : $this
Sets tie breaker to multiplier value to balance the scores between lower and higher scoring fields.