CursorSubset<T>

A wrapper around a Traversable that includes the total count of the superset.

class CursorSubset<T> extends IteratorIterator<T> implements JsonSerializable
Copyright
2015-2016 Appertly
License
Apache-2.0

Constructors / Destructors

Public
ReturnsSignature and Description
void
__construct(Traversable<T> $iterable, int $total)

Create a new CursorSubset.

Instance Methods

Public
ReturnsSignature and Description
int
getTotal()

Gets the superset total.

mixed
jsonSerialize()

Return data which can be serialized with json_encode.

array<T>
toArray()

Converts this thing into an array.

Method Details

__construct

public function __construct(Traversable<T> $iterable, int $total)

Create a new CursorSubset.

Parameters
NameTypeDescription
$iterableTraversable<T>

The traversable to wrap

$totalint

The total number of items in the superset

Throws
TypeConditions
RangeException

if the total is negative

getTotal

public function getTotal()

Gets the superset total.

Returns
TypeDescription
int

The total number of items in the superset (never negative).

jsonSerialize

public function jsonSerialize()

Return data which can be serialized with json_encode.

Returns
TypeDescription
mixed

toArray

public function toArray()

Converts this thing into an array.

Returns
TypeDescription
array<T>

The array version of this thing