interface SS_List implements ArrayAccess, Countable, IteratorAggregate (View source)

An interface that a class can implement to be treated as a list container.

Methods

public
array
toArray()

Returns all the items in the list in an array.

public
array
toNestedArray()

Returns the contents of the list as an array of maps.

public
add(mixed $item)

Adds an item to the list, making no guarantees about where it will appear.

public
remove(mixed $item)

Removes an item from the list.

public
mixed
first()

Returns the first item in the list.

public
mixed
last()

Returns the last item in the list.

public
Map
map(string $keyfield = 'ID', string $titlefield = 'Title')

Returns a map of a key field to a value field of all the items in the list.

public
mixed
find(string $key, mixed $value)

Returns the first item in the list where the key field is equal to the value.

public
array
column(string $colName = "ID")

Returns an array of a single field value for all items in the list.

public
$this
each(callable $callback)

Walks the list using the specified callback

Details

array toArray()

Returns all the items in the list in an array.

Return Value

array

array toNestedArray()

Returns the contents of the list as an array of maps.

Return Value

array

add(mixed $item)

Adds an item to the list, making no guarantees about where it will appear.

Parameters

mixed $item

remove(mixed $item)

Removes an item from the list.

Parameters

mixed $item

mixed first()

Returns the first item in the list.

Return Value

mixed

mixed last()

Returns the last item in the list.

Return Value

mixed

Map map(string $keyfield = 'ID', string $titlefield = 'Title')

Returns a map of a key field to a value field of all the items in the list.

Parameters

string $keyfield
string $titlefield

Return Value

Map

mixed find(string $key, mixed $value)

Returns the first item in the list where the key field is equal to the value.

Parameters

string $key
mixed $value

Return Value

mixed

array column(string $colName = "ID")

Returns an array of a single field value for all items in the list.

Parameters

string $colName

Return Value

array

$this each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

$this