Elastica
\
Elastica
Aggregation
Bulk
Action
Cluster
Health
Connection
Strategy
Exception
Bulk
Response
Connection
Index
Multi
Node
Query
QueryBuilder
DSL
Version
Rescore
ResultSet
Script
Suggest
CandidateGenerator
Tool
Transport
Type

\Elastica\QueryIndices

Class Indices.

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

Summary

Methods
Properties
Constants
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
__construct()
setIndices()
addIndex()
setQuery()
setNoMatchQuery()
No public properties found
No constants found
_convertArrayable()
_getBaseName()
_setRawParam()
$_params
$_rawParams
N/A
No private methods found
No private properties found
N/A

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(\Elastica\Query\AbstractQuery  $query, array<mixed,mixed>  $indices)

Parameters

\Elastica\Query\AbstractQuery $query

Query which will be applied to docs in the specified indices
array<mixed,mixed> $indices

setIndices()

setIndices(array<mixed,mixed>  $indices) : $this

Set the indices on which this query should be applied.

Parameters

array<mixed,mixed> $indices

Returns

$this

addIndex()

addIndex(string|\Elastica\Index  $index) : $this

Adds one more index on which this query should be applied.

Parameters

string|\Elastica\Index $index

Returns

$this

setQuery()

setQuery(\Elastica\Query\AbstractQuery  $query) : $this

Set the query to be applied to docs in the specified indices.

Parameters

\Elastica\Query\AbstractQuery $query

Returns

$this

setNoMatchQuery()

setNoMatchQuery(\Elastica\Query\AbstractQuery  $query) : $this

Set the query to be applied to docs in indices which do not match those specified in the "indices" parameter.

Parameters

\Elastica\Query\AbstractQuery $query

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