\Elastica\QuerySimpleQueryString

Class SimpleQueryString.

This function can be used to handle params for queries, filter

Summary

Methods

Properties

Constants

toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
__construct()
setQuery()
setFields()
setDefaultOperator()
setAnalyzer()
setMinimumShouldMatch()

No public properties found

OPERATOR_AND
OPERATOR_OR

_convertArrayable()
_getBaseName()
_setRawParam()

$_params
$_rawParams

N/A

No private methods found

No private properties found

N/A

Constants

OPERATOR_AND

OPERATOR_AND

OPERATOR_OR

OPERATOR_OR

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

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

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

__construct()

__construct(string  $query, array  $fields = array())

Parameters

string	$query
array	$fields

setQuery()

setQuery(string  $query) : $this

Set the querystring for this query.

Parameters

string

$query

see ES documentation for querystring syntax

Returns

$this

setFields()

setFields(array<mixed,string>  $fields) : $this

Parameters

array<mixed,string>

$fields

the fields on which to perform this query. Defaults to index.query.default_field.

Returns

$this

setDefaultOperator()

setDefaultOperator(string  $operator) : $this

Set the default operator to use if no explicit operator is defined in the query string.

Parameters

string

$operator

see OPERATOR_* constants for options

Returns

$this

setAnalyzer()

setAnalyzer(string  $analyzer) : $this

Set the analyzer used to analyze each term of the query.

Parameters

string

$analyzer

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