SS_Filterable

interface SS_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

public
array
toArray()

Returns all the items in the list in an array.

from  SS_List
public
array
toNestedArray()

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

from  SS_List
public
add(mixed $item)

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

from  SS_List
public
remove(mixed $item)

Removes an item from the list.

from  SS_List
public
mixed
first()

Returns the first item in the list.

from  SS_List
public
mixed
last()

Returns the last item in the list.

from  SS_List
public
array
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
public
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
public
array
column(string $colName = "ID")

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

from  SS_List
public
mixed
each(callable $callback)

Walks the list using the specified callback

from  SS_List
public
bool
canFilterBy(string $by)

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

public
SS_Filterable
filter()

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

public
SS_Filterable
exclude()

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

public
SS_Filterable
filterByCallback($callback)

Return a new instance of this list that excludes any items with these charactaristics 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

in SS_List at line 15
array toArray()

Returns all the items in the list in an array.

Return Value

array

in SS_List at line 22
array toNestedArray()

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

Return Value

array

in SS_List at line 30
add(mixed $item)

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

Parameters

mixed $item

in SS_List at line 37
remove(mixed $item)

Removes an item from the list.

Parameters

mixed $item

in SS_List at line 44
mixed first()

Returns the first item in the list.

Return Value

mixed

in SS_List at line 51
mixed last()

Returns the last item in the list.

Return Value

mixed

in SS_List at line 61
array 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

array

in SS_List at line 71
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

in SS_List at line 79
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

in SS_List at line 87
mixed each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

mixed

at line 21
bool canFilterBy(string $by)

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

Parameters

string $by

Return Value

bool

at line 34
SS_Filterable filter()

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

Return Value

SS_Filterable

Examples

$list = $list->filter('Name', 'bob'); // only bob in the list
 
$list = $list->filter('Name', array('aziz', 'bob'); // aziz and bob in list
 
$list = $list->filter(array('Name'=>'bob, 'Age'=>21)); // bob with the age 21
 
$list = $list->filter(array('Name'=>'bob, 'Age'=>array(21, 43))); // bob with the Age 21 or 43
 
$list = $list->filter(array('Name'=>array('aziz','bob'), 'Age'=>array(21, 43)));
// aziz with the age 21 or 43 and bob with the Age 21 or 43

at line 47
SS_Filterable exclude()

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

Return Value

SS_Filterable

Examples

$list = $list->exclude('Name', 'bob'); // exclude bob from list
 
$list = $list->exclude('Name', array('aziz', 'bob'); // exclude aziz and bob from list
 
$list = $list->exclude(array('Name'=>'bob, 'Age'=>21)); // exclude bob that has Age 21
 
$list = $list->exclude(array('Name'=>'bob, 'Age'=>array(21, 43))); // exclude bob with Age 21 or 43
 
$list = $list->exclude(array('Name'=>array('bob','phil'), 'Age'=>array(21, 43)));
// bob age 21 or 43, phil age 21 or 43 would be excluded

at line 57
SS_Filterable filterByCallback($callback)

Return a new instance of this list that excludes any items with these charactaristics 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

$callback

Return Value

SS_Filterable

Examples

$list = $list->filterByCallback(function($item, $list) { return $item->Age == 9; })