RangeAggregationResult
RangeAggregationResult.php
:
18
Final
Extends AggregationResult
Implements
IteratorAggregate, Countable
The base class for all value objects and structs.
Supports read-only properties by marking them as protected.
In this case they will only be writable using constructor, and need to be documented
using @property-read <type> <$var> annotation in class doc in addition to inline property doc.
Writable properties must be public and must be documented inline.
Methods¶
__construct()
¶
RangeAggregationResult.php
:
26
Construct object optionally with a set of properties.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $name | string | - | - |
| $entries | array<string|int, RangeAggregationResultEntry> | [] | - |
count()
¶
RangeAggregationResult.php
:
74
|
|
|
Return values
int
getEntries()
¶
RangeAggregationResult.php
:
41
|
|
|
Return values
array<string|int, RangeAggregationResultEntry>
getEntry()
¶
RangeAggregationResult.php
:
46
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $key | Range | - | - |
Return values
RangeAggregationResultEntry|null
getIterator()
¶
RangeAggregationResult.php
:
79
|
|
|
Return values
Iterator
getKeys()
¶
RangeAggregationResult.php
:
67
Return available keys (ranges).
|
|
|
Return values
iterable<string|int, Range>
getName()
¶
AggregationResult.php
:
29
|
|
|
Return values
string
hasEntry()
¶
RangeAggregationResult.php
:
57
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $key | Range | - | - |
Return values
bool
isEmpty()
¶
RangeAggregationResult.php
:
33
|
|
|
Return values
bool
getProperties()
¶
ValueObject.php
:
54
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>