tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

NEW Defining byID functions in SS_Filterable

Browse Source
This commit is contained in:
Daniel Hensby 2015-08-28 16:55:23 +01:00 committed by Damian Mooyman
parent 4a22c2bd78
commit 53ffc1a0db
2 changed files with 41 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ORM/DataList.php
View File

@ -895,7 +895,7 @@ class DataList extends ViewableData implements SS_List, SS_Filterable, SS_Sortab
* @param array $ids Array of integers * @param array $ids Array of integers
* @return DataList * @return DataList
*/ */
public function byIDs(array $ids) { public function byIDs($ids) {
return $this->filter('ID', $ids); return $this->filter('ID', $ids);
} }

40
ORM/Filterable.php
View File

@ -35,6 +35,30 @@ interface SS_Filterable extends SS_List {
*/ */
public function filter(); public function filter();
/**
* Return a copy of this list which contains items matching any of these charactaristics.
*
* @example // only bob in the list
* $list = $list->filterAny('Name', 'bob');
* // SQL: WHERE "Name" = 'bob'
* @example // azis or bob in the list
* $list = $list->filterAny('Name', array('aziz', 'bob');
* // SQL: WHERE ("Name" IN ('aziz','bob'))
* @example // bob or anyone aged 21 in the list
* $list = $list->filterAny(array('Name'=>'bob, 'Age'=>21));
* // SQL: WHERE ("Name" = 'bob' OR "Age" = '21')
* @example // 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'))
* @example // 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'))
*
* @param string|array See {@link filter()}
* @return DataList
*/
public function filterAny();
/** /**
* Return a new instance of this list that excludes any items with these charactaristics * Return a new instance of this list that excludes any items with these charactaristics
* *
@ -57,4 +81,20 @@ interface SS_Filterable extends SS_List {
* @return SS_Filterable * @return SS_Filterable
*/ */
public function filterByCallback($callback); public function filterByCallback($callback);
/**
* Return the first item with the given ID
*
* @param int $id
* @return mixed
*/
public function byID($id);
/**
* Filter this list to only contain the given Primary IDs
*
* @param array $ids Array of integers
* @return SS_List
*/
public function byIDs($ids);
} }