1. class
  2. SilverStripe
  3. \
  4. ORM
  5. \
  6. Map_Iterator

Map_Iterator deprecated

class Map_Iterator implements Iterator (View source)

deprecated 4.13.0 Will be removed without equivalent functionality to replace it

Builds a map iterator around an Iterator. Called by Map

Methods

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

No description

mixed
rewind()

Rewind the Iterator to the first element.

mixed
current()

Return the current element.

string
key()

Return the key of the current element.

mixed
next()

Move forward to next element.

bool
valid()

Checks if current position is valid.

Details

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

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
array $firstItems

An optional map of items to show first
array $lastItems

An optional map of items to show last

at line 73
mixed rewind()

Rewind the Iterator to the first element.

Return Value

mixed

at line 101
mixed current()

Return the current element.

Return Value

mixed

at line 141
string key()

Return the key of the current element.

Return Value

string

at line 160
mixed next()

Move forward to next element.

Return Value

mixed

at line 201
bool valid()

Checks if current position is valid.

Return Value

bool