\Elastica\AggregationSignificantTerms

Class SignificantTerms.

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

Summary

Methods

Properties

Constants

setMinimumDocumentCount()
setInclude()
setExclude()
setSize()
setShardSize()
setExecutionHint()
setField()
setScript()
toArray()
__construct()
setName()
getName()
getAggs()
addAggregation()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
setBackgroundFilter()

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

setMinimumDocumentCount()

setMinimumDocumentCount(integer  $count) : $this

Set the minimum number of documents in which a term must appear in order to be returned in a bucket.

Parameters

integer

$count

Returns

$this

setInclude()

setInclude(string  $pattern, string  $flags = null) : $this

Filter documents to include based on a regular expression.

Parameters

string	$pattern	a regular expression
string	$flags	Java Pattern flags

Returns

$this

setExclude()

setExclude(string  $pattern, string  $flags = null) : $this

Filter documents to exclude based on a regular expression.

Parameters

string	$pattern	a regular expression
string	$flags	Java Pattern flags

Returns

$this

setSize()

setSize(integer  $size) : $this

Sets the amount of terms to be returned.

Parameters

integer

$size

The amount of terms to be returned.

Returns

$this

setShardSize()

setShardSize(integer  $shard_size) : $this

Sets how many terms the coordinating node will request from each shard.

Parameters

integer

$shard_size

The amount of terms to be returned.

Returns

$this

setExecutionHint()

setExecutionHint(string  $hint) : $this

Instruct Elasticsearch to use direct field data or ordinals of the field values to execute this aggregation.

The execution hint will be ignored if it is not applicable.

Parameters

string

$hint

map or ordinals

Returns

$this

setField()

setField(string  $field) : $this

Set the field for this aggregation.

Parameters

string

$field

the name of the document field on which to perform this aggregation

Returns

$this

setScript()

setScript(string|\Elastica\Script\AbstractScript  $script) : $this

Set a script for this aggregation.

Parameters

string|\Elastica\Script\AbstractScript

$script

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 —

Filter array

__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

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

setBackgroundFilter()

setBackgroundFilter(\Elastica\Query\AbstractQuery  $filter) : $this

The default source of statistical information for background term frequencies is the entire index and this scope can be narrowed through the use of a background_filter to focus in on significant terms within a narrower context.

Parameters

\Elastica\Query\AbstractQuery

$filter

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