\Elastica\QueryInnerHits

toArray()

toArray() 

{@inheritdoc}

setParam()

setParam(string  $key, mixed  $value) : $this

Sets (overwrites) the value at the given key.

Parameters

Returns

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

Returns

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

Returns

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

Returns

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

Params

count()

count() : integer

{@inheritdoc}

Returns

setName()

setName(string  $name) : $this

The name to be used for the particular inner hit definition in the response.

Useful when multiple inner hits have been defined in a single search request.

Parameters

Returns

setSize()

setSize(integer  $size = 3) : $this

The maximum number of inner matching hits to return per bucket. By default the top three matching hits are returned.

Parameters

Returns

setFrom()

setFrom(integer  $from) : $this

The offset from the first result you want to fetch.

Parameters

Returns

setSort()

setSort(array  $sortArgs) : $this

How the inner matching hits should be sorted. By default the hits are sorted by the score of the main query.

Parameters

Returns

setSource()

setSource(array|boolean  $params) : $this

Allows to control how the _source field is returned with every hit.

Parameters

Returns

setVersion()

setVersion(boolean  $version) : $this

Returns a version for each search hit.

Parameters

Returns

setExplain()

setExplain(boolean  $explain) : $this

Enables explanation for each hit on how its score was computed.

Parameters

Returns

setScriptFields()

setScriptFields(\Elastica\Script\ScriptFields  $scriptFields) : $this

Set script fields.

Parameters

Returns

addScriptField()

addScriptField(string  $name, \Elastica\Script\AbstractScript  $script) : $this

Adds a Script to the aggregation.

Parameters

Returns

setHighlight()

setHighlight(array  $highlightArgs) : $this

Sets highlight arguments for the results.

Parameters

Returns

setFieldDataFields()

setFieldDataFields(array  $fields) : $this

Allows to return the field data representation of a field for each hit.

Parameters

Returns

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

Returns

_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

name

_setRawParam()

_setRawParam(string  $key, mixed  $value) : $this

Sets params not inside params array.

Parameters

Returns