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

Map

class Map implements ArrayAccess, Countable, IteratorAggregate

Creates a map from an SS_List by defining a key column and a value column.

Methods

__construct(SS_List $list, string $keyField = "ID", string $valueField = "Title")

Construct a new map around an SS_list.

setKeyField($keyField)

Set the key field for this map.

setValueField($valueField)

Set the value field for this map.

array
toArray()

Return an array equivalent to this map.

array
keys()

Return all the keys of this map.

array
values()

Return all the values of this map.

$this
unshift($key, $value)

Unshift an item onto the start of the map.

$this
push($key, $value)

Pushes an item onto the end of the map.

boolean
offsetExists($key)

No description

mixed
offsetGet($key)

No description

offsetSet($key, $value)

Sets a value in the map by a given key that has been set via {@link Map::push()} or {@link Map::unshift()}

offsetUnset($key)

Removes a value in the map by a given key which has been added to the map via {@link Map::push()} or {@link Map::unshift()}

Map_Iterator
getIterator()

Returns an Map_Iterator instance for iterating over the complete set of items in the map.

int
count()

Returns the count of items in the list including the additional items set through {@link Map::push()} and {@link Map::unshift}.

Details

at line 38
__construct(SS_List $list, string $keyField = "ID", string $valueField = "Title")

Construct a new map around an SS_list.

Parameters

SS_List $list The list to build a map from
string $keyField The field to use as the key of each map entry
string $valueField The field to use as the value of each map entry

at line 50
setKeyField($keyField)

Set the key field for this map.

Parameters

$keyField

at line 60
setValueField($valueField)

Set the value field for this map.

Parameters

$valueField

at line 70
array toArray()

Return an array equivalent to this map.

Return Value

array

at line 86
array keys()

Return all the keys of this map.

Return Value

array

at line 96
array values()

Return all the values of this map.

Return Value

array

at line 110
$this unshift($key, $value)

Unshift an item onto the start of the map.

Stores the value in addition to the {@link DataQuery} for the map.

Parameters

$key
$value

Return Value

$this

at line 131
$this push($key, $value)

Pushes an item onto the end of the map.

Parameters

$key
$value

Return Value

$this

at line 153
boolean offsetExists($key)

Parameters

$key

Return Value

boolean

at line 173
mixed offsetGet($key)

Parameters

$key

Return Value

mixed

at line 205
offsetSet($key, $value)

Sets a value in the map by a given key that has been set via {@link Map::push()} or {@link Map::unshift()}

Keys in the map cannot be set since these values are derived from a {@link DataQuery} instance. In this case, use {@link Map::toArray()} and manipulate the resulting array.

Parameters

$key
$value

at line 232
offsetUnset($key)

Removes a value in the map by a given key which has been added to the map via {@link Map::push()} or {@link Map::unshift()}

Keys in the map cannot be unset since these values are derived from a {@link DataQuery} instance. In this case, use {@link Map::toArray()} and manipulate the resulting array.

Parameters

$key

at line 260
Map_Iterator getIterator()

Returns an Map_Iterator instance for iterating over the complete set of items in the map.

Satisfies the IteratorAggreagte interface.

Return Value

Map_Iterator

at line 312
int count()

Returns the count of items in the list including the additional items set through {@link Map::push()} and {@link Map::unshift}.

Return Value

int