\Elastica\QueryIds

Ids Query.

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

Summary

Methods

Properties

Constants

toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
__construct()
addId()
addType()
setType()
setIds()

No public properties found

No constants found

_convertArrayable()
_getBaseName()
_setRawParam()

$_params
$_rawParams

N/A

No private methods found

No private properties found

N/A

File: Query/Ids.php
Package: Default
Class hierarchy: \Elastica\Param

\Elastica\Query\AbstractQuery

\Elastica\Query\Ids
See also: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-query.html

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

toArray()

toArray() : array

Converts filter to array.

Returns

array —

Query 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|\Elastica\Type  $type = null, array  $ids = array())

Creates filter object.

Parameters

string\|\Elastica\Type	$type	Type to filter on
array	$ids	List of ids

addId()

addId(string  $id) : $this

Adds one more filter to the and filter.

Parameters

string

$id

Adds id to filter

Returns

$this

addType()

addType(string|\Elastica\Type  $type) : $this

Adds one more type to query.

Parameters

string|\Elastica\Type

$type

Type name or object

Returns

$this

setType()

setType(array|string|\Elastica\Type  $type) : $this

Set type.

Parameters

array|string|\Elastica\Type

$type

Type name or object

Returns

$this

setIds()

setIds(array|string  $ids) : $this

Sets the ids to filter.

Parameters

array|string

$ids

List of ids

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