Copied!

RangeAggregationResult

RangeAggregationResult.php : 18
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

public__construct()

RangeAggregationResult.php : 26

Construct object optionally with a set of properties.

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

Parameters

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

publiccount()

RangeAggregationResult.php : 74
public count() : int

Return values

int

publicgetEntries()

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

Return values

array<string|int, RangeAggregationResultEntry>

publicgetEntry()

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

Parameters

Name Type Default value Description
$key Range - -

Return values

RangeAggregationResultEntry|null

publicgetIterator()

RangeAggregationResult.php : 79
public getIterator() : Iterator

Return values

Iterator

publicgetKeys()

RangeAggregationResult.php : 67

Return available keys (ranges).

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

Return values

iterable<string|int, Range>

publicgetName()

AggregationResult.php : 29
public getName() : string

Return values

string

publichasEntry()

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

Parameters

Name Type Default value Description
$key Range - -

Return values

bool

publicisEmpty()

RangeAggregationResult.php : 33
public isEmpty() : bool

Return values

bool

protectedgetProperties()

ValueObject.php : 54

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>

Tags
Serializerignore

()