1. interface
  2. SilverStripe
  3. \
  4. ORM
  5. \
  6. Filterable

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

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
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
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
$this
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
Filterable
filter()

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

public
Filterable
filterAny()

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

public
Filterable
exclude()

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

public
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.

public
mixed
byID(int $id)

Return the first item with the given ID

public
SS_List
byIDs(array $ids)

Filter this list to only contain the given Primary IDs

Details

in SS_List at line 20
array toArray()

Returns all the items in the list in an array.

Return Value

array

in SS_List at line 27
array toNestedArray()

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

Return Value

array

in SS_List at line 35
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 42
remove(mixed $item)

Removes an item from the list.

Parameters

mixed $item

in SS_List at line 49
mixed first()

Returns the first item in the list.

Return Value

mixed

in SS_List at line 56
mixed last()

Returns the last item in the list.

Return Value

mixed

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

in SS_List at line 76
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 84
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 92
$this each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

$this

at line 24
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 37
Filterable filter()

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

Return Value

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 61
Filterable filterAny()

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

Return Value

Filterable

Examples

// only bob in the list
$list = $list->filterAny('Name', 'bob');
// SQL: WHERE "Name" = 'bob'
 
// azis or bob in the list
$list = $list->filterAny('Name', array('aziz', 'bob');
// SQL: WHERE ("Name" IN ('aziz','bob'))
 
// bob or anyone aged 21 in the list
$list = $list->filterAny(array('Name'=>'bob, 'Age'=>21));
// SQL: WHERE ("Name" = 'bob' OR "Age" = '21')
 
// bob or anyone aged 21 or 43 in the list
$list = $list->filterAny(array('Name'=>'bob, 'Age'=>array(21, 43)));
// SQL: WHERE ("Name" = 'bob' OR ("Age" IN ('21', '43'))
 
// all bobs, phils or anyone aged 21 or 43 in the list
$list = $list->filterAny(array('Name'=>array('bob','phil'), 'Age'=>array(21, 43)));
// SQL: WHERE (("Name" IN ('bob', 'phil')) OR ("Age" IN ('21', '43'))

at line 74
Filterable exclude()

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

Return Value

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 85
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

Examples

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

at line 93
mixed byID(int $id)

Return the first item with the given ID

Parameters

int $id

Return Value

mixed

at line 101
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