TermAggregationResult
TermAggregationResult.php
:
25
Extends AggregationResult
Implements
IteratorAggregate, Countable
Represents the result of a term aggregation.
Methods¶
__construct()
¶
TermAggregationResult.php
:
33
Construct object optionally with a set of properties.
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$name | string | - | - |
$entries | iterable<string|int, mixed> | [] | - |
count()
¶
TermAggregationResult.php
:
89
|
|
Return values
int
createForAggregation()
¶
TermAggregationResult.php
:
112
Creates a TermAggregationResult from an Aggregation object.
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$aggregation | Aggregation | - | - |
$entries | iterable<string|int, mixed> | [] | - |
Return values
self
getEntries()
¶
TermAggregationResult.php
:
48
|
|
Return values
iterable<string|int, mixed>
getEntry()
¶
TermAggregationResult.php
:
58
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$key | mixed | - | - |
Return values
TermAggregationResultEntry|null
getIterator()
¶
TermAggregationResult.php
:
94
|
|
Return values
Iterator
getKeys()
¶
TermAggregationResult.php
:
82
Returns available keys (terms).
|
|
Return values
iterable<string|int, mixed>
getName()
¶
AggregationResult.php
:
27
|
|
Return values
string
hasEntry()
¶
TermAggregationResult.php
:
72
|
|
Parameters
Name | Type | Default value | Description |
---|---|---|---|
$key | mixed | - | - |
Return values
bool
isEmpty()
¶
TermAggregationResult.php
:
40
|
|
Return values
bool
getProperties()
¶
ValueObject.php
:
53
Returns list of available properties' names.
|
|
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]