\Elastica\QueryTopChildren

Runs the child query with an estimated hits size, and out of the hit docs, aggregates it into parent docs.

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

Summary

Methods

Properties

Constants

toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
__construct()
setQuery()
setType()

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/TopChildren.php
Package: Default
Class hierarchy: \Elastica\Param

\Elastica\Query\AbstractQuery

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

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|\Elastica\Query|\Elastica\Query\AbstractQuery  $query, string  $type = null)

Construct topChildren query.

Parameters

string\|\Elastica\Query\|\Elastica\Query\AbstractQuery	$query
string	$type	Parent document type

setQuery()

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

Sets query object.

Parameters

string|\Elastica\Query|\Elastica\Query\AbstractQuery

$query

Returns

$this

setType()

setType(string  $type) : $this

Set type of the parent document.

Parameters

string

$type

Parent document type

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