Copied!

RangeAggregationResult

RangeAggregationResult.php : 21
Final
Extends AggregationResult
Implements IteratorAggregate, Countable

The base class for all value objects and structs.

Methods

public__construct()

RangeAggregationResult.php : 29

Construct object optionally with a set of properties.

 
public __construct(string $name[, array<string|int, RangeAggregationResultEntry<string|int, TValue>> $entries = [] ])

Parameters

Name Type Default value Description
$name string - -
$entries array<string|int, RangeAggregationResultEntry<string|int, TValue>> [] -

publiccount()

RangeAggregationResult.php : 85 
public count() : int

Return values

int

publicgetEntries()

RangeAggregationResult.php : 44 
public getEntries() : array<string|int, RangeAggregationResultEntry<string|int, TValue>>

Return values

array<string|int, RangeAggregationResultEntry<string|int, TValue>>

publicgetEntry()

RangeAggregationResult.php : 54 
public getEntry(Range $key) : RangeAggregationResultEntry|null

Parameters

Name Type Default value Description
$key Range - -

Return values

RangeAggregationResultEntry|null

publicgetIterator()

RangeAggregationResult.php : 93 
public getIterator() : Iterator<Range<string|int, TValue>, int>

Return values

Iterator<Range<string|int, TValue>, int>

publicgetKeys()

RangeAggregationResult.php : 78

Return available keys (ranges).

 
public getKeys() : iterable<string|int, Range<string|int, TValue>>

Return values

iterable<string|int, Range<string|int, TValue>>

publicgetName()

AggregationResult.php : 27 
public getName() : string

Return values

string

publichasEntry()

RangeAggregationResult.php : 68 
public hasEntry(Range $key) : bool

Parameters

Name Type Default value Description
$key Range - -

Return values

bool

publicisEmpty()

RangeAggregationResult.php : 36 
public isEmpty() : bool

Return values

bool

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]