TermAggregationResult
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()
¶
Construct object optionally with a set of properties.
|
|
|
Readonly properties values must be set using $properties as they aren't writable anymore
after object has been created.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $name | string | - | - |
| $entries | iterable<string|int, mixed> | [] | - |
count()
¶
|
|
|
Return values
int
createForAggregation()
¶
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $aggregation | Aggregation | - | - |
| $entries | iterable<string|int, mixed> | [] | - |
Return values
self
getEntries()
¶
|
|
|
Return values
array<string|int, TermAggregationResultEntry>
getEntry()
¶
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $key | object|string|int | - | - |
Return values
TermAggregationResultEntry|null
getIterator()
¶
|
|
|
Return values
Iterator
getKeys()
¶
Returns available keys (terms).
|
|
|
Return values
iterable<string|int, object|string|int>
getName()
¶
|
|
|
Return values
string
hasEntry()
¶
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $key | object|string|int | - | - |
Return values
bool
isEmpty()
¶
|
|
|
Return values
bool
getProperties()
¶
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>