AggregationResultCollection
AggregationResultCollection.php
:
17
Final
Implements
Countable, IteratorAggregate
Methods¶
__construct()
¶
AggregationResultCollection.php
:
25
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $results | array<string|int, AggregationResult> | [] | - |
count()
¶
AggregationResultCollection.php
:
110
|
|
|
Return values
int
first()
¶
AggregationResultCollection.php
:
62
Return first element of collection.
|
|
|
Return values
Tags
get()
¶
AggregationResultCollection.php
:
38
This method returns the aggregation result for the given aggregation name.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $name | string | - | - |
Return values
Tags
getIterator()
¶
AggregationResultCollection.php
:
105
|
|
|
Return values
Iterator
has()
¶
AggregationResultCollection.php
:
52
This method returns true if the aggregation result for the given aggregation name exists.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $name | string | - | - |
Return values
bool
isEmpty()
¶
AggregationResultCollection.php
:
90
Checks whether the collection is empty (contains no elements).
|
|
|
Return values
bool
TRUE if the collection is empty, FALSE otherwise.
last()
¶
AggregationResultCollection.php
:
76
Return last element of collection.
|
|
|
Return values
Tags
toArray()
¶
AggregationResultCollection.php
:
100
Gets a native PHP array representation of the collection.
|
|
|
Return values
array<string|int, FieldDefinition>