Filterable
interface Filterable implements SS_List (View source)
Additional interface for 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
Adds an item to the list, making no guarantees about where it will appear.
Returns a map of a key field to a value field of all the items in the list.
Returns the first item in the list where the key field is equal to the value.
Returns an array of a single field value for all items in the list.
Returns TRUE if the list can be filtered by a given field expression.
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.
Details
T[]
toArray()
Returns all the items in the list in an array.
array
toNestedArray()
Returns the contents of the list as an array of maps.
add(mixed $item)
Adds an item to the list, making no guarantees about where it will appear.
remove(mixed $item)
Removes an item from the list.
T|null
first()
Returns the first item in the list.
T|null
last()
Returns the last item in the 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.
T|null
find(string $key, mixed $value)
Returns the first item in the list where the key field is equal to the value.
array
column(string $colName = "ID")
Returns an array of a single field value for all items in the list.
each($callback)
No description
bool
canFilterBy(string $by)
Returns TRUE if the list can be filtered by a given field expression.
filter()
No description
filterAny()
No description
exclude()
No description
T>
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.
T|null
byID(int $id)
Return the first item with the given ID
byIDs($ids)
No description