interface Filterable implements SS_List (View source)

Additional interface for {@link SS_List} classes that are filterable.

All methods in this interface are immutable - they should return new instances with the filter applied, rather than applying the filter in place

Methods

array
toArray()

Returns all the items in the list in an array.

from  SS_List
array
toNestedArray()

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

from  SS_List
add(mixed $item)

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

from  SS_List
remove(mixed $item)

Removes an item from the list.

from  SS_List
mixed
first()

Returns the first item in the list.

from  SS_List
mixed
last()

Returns the last item in the list.

from  SS_List
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.

from  SS_List
mixed
find(string $key, mixed $value)

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

from  SS_List
array
column(string $colName = "ID")

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

from  SS_List
$this
each(callable $callback)

Walks the list using the specified callback

from  SS_List
bool
canFilterBy(string $by)

Returns TRUE if the list can be filtered by a given field expression.

Filterable
filter()

Return a new instance of this list that only includes items with these characteristics

filterAny()

Return a copy of this list which contains items matching any of these characteristics.

Filterable
exclude()

Return a new instance of this list that excludes any items with these characteristics

Filterable
filterByCallback(callable $callback)

Return a new instance of this list that excludes any items with these characteristics Filter this List by a callback function. The function will be passed each record of the List in turn, and must return true for the record to be included. Returns the filtered list.

mixed
byID(int $id)

Return the first item with the given ID

SS_List
byIDs(array $ids)

Filter this list to only contain the given Primary IDs

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

bool canFilterBy(string $by)

Returns TRUE if the list can be filtered by a given field expression.

Parameters

string $by

Return Value

bool

Filterable filter()

Return a new instance of this list that only includes items with these characteristics

Return Value

Filterable

Filterable filterAny()

Return a copy of this list which contains items matching any of these characteristics.

Return Value

Filterable

Filterable exclude()

Return a new instance of this list that excludes any items with these characteristics

Return Value

Filterable

Filterable filterByCallback(callable $callback)

Return a new instance of this list that excludes any items with these characteristics Filter this List by a callback function. The function will be passed each record of the List in turn, and must return true for the record to be included. Returns the filtered list.

Parameters

callable $callback

Return Value

Filterable

mixed byID(int $id)

Return the first item with the given ID

Parameters

int $id

Return Value

mixed

SS_List byIDs(array $ids)

Filter this list to only contain the given Primary IDs

Parameters

array $ids Array of integers

Return Value

SS_List