\Elastica\CollapseInnerHits

Class InnerHits.

Basically identical to inner_hits on query level, but has support for a second level collapse as per https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#_second_level_of_collapsing

Collapse is part of the inner_hits construct in this case, which should be explicitly supported and not only via calling InnerHits::setParam('collapse', $collapse).

On the other hand, collapse cannot be used on query level invocations of inner_hits, which is why it may not be part of Query\InnerHits.

Summary

Methods

Properties

Constants

toArray()
setName()
setSize()
setFrom()
setSort()
setSource()
setVersion()
setExplain()
setScriptFields()
addScriptField()
setHighlight()
setFieldDataFields()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
count()
setCollapse()

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

\Elastica\Query\AbstractQuery

\Elastica\Query\InnerHits

\Elastica\Collapse\InnerHits

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

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

string

$name

Returns

$this

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

integer

$size

Returns

$this

setFrom()

setFrom(integer  $from) : $this

The offset from the first result you want to fetch.

Parameters

integer

$from

Returns

$this

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

array

$sortArgs

Returns

$this

setSource()

setSource(array|boolean  $params) : $this

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

Parameters

array|boolean

$params

Fields to be returned or false to disable source

Returns

$this

setVersion()

setVersion(boolean  $version) : $this

Returns a version for each search hit.

Parameters

boolean

$version

Returns

$this

setExplain()

setExplain(boolean  $explain) : $this

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

Parameters

boolean

$explain

Returns

$this

setScriptFields()

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

Set script fields.

Parameters

\Elastica\Script\ScriptFields

$scriptFields

Returns

$this

addScriptField()

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

Adds a Script to the aggregation.

Parameters

string	$name
\Elastica\Script\AbstractScript	$script

Returns

$this

setHighlight()

setHighlight(array  $highlightArgs) : $this

Sets highlight arguments for the results.

Parameters

array

$highlightArgs

Returns

$this

setFieldDataFields()

setFieldDataFields(array  $fields) : $this

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

Parameters

array

$fields

Returns

$this

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

count()

count() : integer

{@inheritdoc}

Returns

integer

setCollapse()

setCollapse(\Elastica\Collapse  $collapse) : $this

Parameters

\Elastica\Collapse

$collapse

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