\Elastica\AggregationTopHits

Class TopHits.

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

Summary

Methods

Properties

Constants

__construct()
setName()
getName()
getAggs()
addAggregation()
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
setSize()
setFrom()
setSort()
setSource()
setVersion()
setExplain()
setScriptFields()
addScriptField()
setHighlight()
setFieldDataFields()

No public properties found

No constants found

_convertArrayable()
_getBaseName()
_setRawParam()

$_name
$_aggs
$_params
$_rawParams

N/A

No private methods found

No private properties found

N/A

Properties

$_name

$_name : string

Type

string — The name of this aggregation

$_aggs

$_aggs : array

Type

array — Subaggregations belonging to this aggregation

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

__construct()

__construct(string  $name)

Parameters

string

$name

the name of this aggregation

setName()

setName(string  $name) : $this

Set the name of this aggregation.

Parameters

string

$name

Returns

$this

getName()

getName() : string

Retrieve the name of this aggregation.

Returns

string

getAggs()

getAggs() : array

Retrieve all subaggregations belonging to this aggregation.

Returns

array

addAggregation()

addAggregation(\Elastica\Aggregation\AbstractAggregation  $aggregation) : $this

Add a sub-aggregation.

Parameters

\Elastica\Aggregation\AbstractAggregation

$aggregation

Throws

\Elastica\Exception\InvalidException

Returns

$this

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

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

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|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(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

_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