Copied!

StatsAggregationResult

StatsAggregationResult.php : 13
Final
Extends AggregationResult

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

public $sum

StatsAggregationResult.php : 16 
public float|null $sum

Methods

public__construct()

StatsAggregationResult.php : 26

Construct object optionally with a set of properties.

 
public __construct(string $name, int|null $count, float|null $min, float|null $max, float|null $avg, float|null $sum)

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 - -

publicgetAvg()

StatsAggregationResult.php : 52 
public getAvg() : float|null

Return values

float|null

publicgetCount()

StatsAggregationResult.php : 37 
public getCount() : int|null

Return values

int|null

publicgetMax()

StatsAggregationResult.php : 47 
public getMax() : float|null

Return values

float|null

publicgetMin()

StatsAggregationResult.php : 42 
public getMin() : float|null

Return values

float|null

publicgetName()

AggregationResult.php : 27 
public getName() : string

Return values

string

publicgetSum()

StatsAggregationResult.php : 57 
public getSum() : float|null

Return values

float|null

protectedgetProperties()

ValueObject.php : 53

Returns list of available properties' names.

 
protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

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]