class SS_Map implements ArrayAccess, Countable, IteratorAggregate (View source)

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

Methods

__construct(SS_List $list, $keyField = "ID", $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.

unshift($key, $value)

Unshift an item onto the start of the map.

push($key, $value)

Pushes an item onto the end of the map.

bool
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 SS_Map::push()} or {@link SS_Map::unshift()}

offsetUnset($key)

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

getIterator()

Returns an SS_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 SS_Map::push()} and {@link SS_Map::unshift}.

Details

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

Construct a new map around an SS_list.

Parameters

SS_List $list

The list to build a map from

$keyField

The field to use as the key of each map entry

$valueField

The field to use as the value of each map entry

setKeyField($keyField)

Set the key field for this map.

Parameters

$keyField

setValueField($valueField)

Set the value field for this map.

Parameters

$valueField

array toArray()

Return an array equivalent to this map.

Return Value

array

array keys()

Return all the keys of this map.

Return Value

array

array values()

Return all the values of this map.

Return Value

array

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

push($key, $value)

Pushes an item onto the end of the map.

Parameters

$key
$value

bool offsetExists($key)

Parameters

$key

Return Value

bool

mixed offsetGet($key)

Parameters

$key

Return Value

mixed

offsetSet($key, $value)

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

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

Parameters

$key
$value

offsetUnset($key)

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

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

Parameters

$key

SS_Map_Iterator getIterator()

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

Satisfies the IteratorAggreagte interface.

Return Value

SS_Map_Iterator

int count()

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

Return Value

int