Copied!

TermAggregationResult

TermAggregationResult.php : 25
Extends AggregationResult
Implements IteratorAggregate, Countable

Represents the result of a term aggregation.

Methods

public__construct()

TermAggregationResult.php : 33

Construct object optionally with a set of properties.

 
public __construct(string $name[, iterable<string|int, mixed> $entries = [] ])

Parameters

Name Type Default value Description
$name string - -
$entries iterable<string|int, mixed> [] -

publiccount()

TermAggregationResult.php : 89 
public count() : int

Return values

int

publiccreateForAggregation()

TermAggregationResult.php : 112

Creates a TermAggregationResult from an Aggregation object.

 
public static createForAggregation(Aggregation $aggregation[, iterable<string|int, mixed> $entries = [] ]) : self

Parameters

Name Type Default value Description
$aggregation Aggregation - -
$entries iterable<string|int, mixed> [] -

Return values

self

publicgetEntries()

TermAggregationResult.php : 48 
public getEntries() : iterable<string|int, mixed>

Return values

iterable<string|int, mixed>

publicgetEntry()

TermAggregationResult.php : 58 
public getEntry(mixed $key) : TermAggregationResultEntry|null

Parameters

Name Type Default value Description
$key mixed - -

Return values

TermAggregationResultEntry|null

publicgetIterator()

TermAggregationResult.php : 94 
public getIterator() : Iterator

Return values

Iterator

publicgetKeys()

TermAggregationResult.php : 82

Returns available keys (terms).

 
public getKeys() : iterable<string|int, mixed>

Return values

iterable<string|int, mixed>

publicgetName()

AggregationResult.php : 27 
public getName() : string

Return values

string

publichasEntry()

TermAggregationResult.php : 72 
public hasEntry(mixed $key) : bool

Parameters

Name Type Default value Description
$key mixed - -

Return values

bool

publicisEmpty()

TermAggregationResult.php : 40 
public isEmpty() : bool

Return values

bool

protectedgetProperties()

ValueObject.php : 53

Returns list of available properties' names.

 
protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

Override to add dynamic properties.

Parameters

Name Type Default value Description
$dynamicProperties array<int, string> []

Additional dynamic properties exposed on the object

Return values

array<int, string>

Attributes
#[Ignore]