SS_Map_Iterator

class SS_Map_Iterator implements Iterator (View source)

Builds a map iterator around an Iterator. Called by SS_Map

Properties

protected $items
protected $keyField
protected $titleField
protected $firstItemIdx
protected $endItemIdx
protected $firstItems
protected $lastItems
protected $excludedItems

Methods

public
__construct(Iterator $items, string $keyField, string $titleField, $firstItems = null, array $lastItems = null)

No description

public
mixed
rewind()

Rewind the Iterator to the first element.

public
mixed
current()

Return the current element.

public
string
key()

Return the key of the current element.

public
mixed
next()

Move forward to next element.

public
bool
valid()

Checks if current position is valid.

Details

at line 292
__construct(Iterator $items, string $keyField, string $titleField, $firstItems = null, array $lastItems = null)

No description

Parameters

Iterator $items

The iterator to build this map from
string $keyField

The field to use for the keys
string $titleField

The field to use for the values
$firstItems
array $lastItems

An optional map of items to show last

at line 319
mixed rewind()

Rewind the Iterator to the first element.

Return Value

mixed

at line 347
mixed current()

Return the current element.

Return Value

mixed

at line 366
string key()

Return the key of the current element.

Return Value

string

at line 381
mixed next()

Move forward to next element.

Return Value

mixed

at line 420
bool valid()

Checks if current position is valid.

Return Value

bool