\Elastica\AggregationTopHits

Class TopHits.

Summary

Methods
Properties
Constants
toArray()
setSize()
setFrom()
setSort()
setSource()
setVersion()
setExplain()
setScriptFields()
addScriptField()
setHighlight()
setFieldDataFields()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

toArray()

toArray() : array

Returns

array

setSize()

setSize(integer  $size) : $this

The maximum number of top 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 top 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|string|boolean  $params) : $this

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

Parameters

array|string|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(array|\Elastica\Script\ScriptFields  $scriptFields) : $this

Set script fields.

Parameters

array|\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