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.
Properties¶
$sum
¶
StatsAggregationResult.php
:
16
|
|
|
Methods¶
__construct()
¶
StatsAggregationResult.php
:
30
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 | - | - |
| $count | int|null | - | - |
| $min | float|null | - | - |
| $max | float|null | - | - |
| $avg | float|null | - | - |
| $sum | float|null | - | - |
getAvg()
¶
StatsAggregationResult.php
:
56
|
|
|
Return values
float|null
getCount()
¶
StatsAggregationResult.php
:
41
|
|
|
Return values
int|null
getMax()
¶
StatsAggregationResult.php
:
51
|
|
|
Return values
float|null
getMin()
¶
StatsAggregationResult.php
:
46
|
|
|
Return values
float|null
getName()
¶
AggregationResult.php
:
29
|
|
|
Return values
string
getSum()
¶
StatsAggregationResult.php
:
61
|
|
|
Return values
float|null
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>