mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-06-28 07:29:26 +02:00
27113f82c3
In 3.0 there was some confusion about whether DataLists and ArrayLists were mutable or not. If DataLists were immutable, they'd return the result, and your code would look like $list = $list->filter(....); If DataLists were mutable, they'd operate on themselves, returning nothing, and your code would look like $list->filter(....); This makes all DataLists and ArrayList immutable for all _searching_ operations. Operations on DataList that modify the underlying SQL data store remain mutating. - These functions no longer mutate the existing object, and if you do not capture the value returned by them will have no effect: ArrayList#reverse ArrayList#sort ArrayList#filter ArrayList#exclude DataList#dataQuery (use DataList#alterDataQuery to modify dataQuery in a safe manner) DataList#where DataList#limit DataList#sort DataList#addFilter DataList#applyFilterContext DataList#innerJoin DataList#leftJoin DataList#find DataList#byIDs DataList#reverse - DataList#setDataQueryParam has been added as syntactic sugar around the most common cause of accessing the dataQuery directly - setting query parameters - RelationList#setForeignID has been removed. Always use RelationList#forForeignID when querying, and overload RelationList#foreignIDList when subclassing. - Relatedly,the protected variable RelationList->foreignID has been removed, as the ID is now stored on a query parameter. Use RelationList#getForeignID to read it.
42 lines
1.1 KiB
PHP
42 lines
1.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Additional interface for {@link SS_List} classes that are sortable.
|
|
*
|
|
* All methods in this interface are immutable - they should return new instances with the sort
|
|
* applied, rather than applying the sort in place
|
|
*
|
|
* @see SS_List, SS_Filterable, SS_Limitable
|
|
*/
|
|
interface SS_Sortable {
|
|
|
|
/**
|
|
* Returns TRUE if the list can be sorted by a field.
|
|
*
|
|
* @param string $by
|
|
* @return bool
|
|
*/
|
|
public function canSortBy($by);
|
|
|
|
/**
|
|
* Return a new instance of this list that is sorted by one or more fields. You can either pass in a single
|
|
* field name and direction, or a map of field names to sort directions.
|
|
*
|
|
* @return SS_Sortable
|
|
* @example $list = $list->sort('Name'); // default ASC sorting
|
|
* @example $list = $list->sort('Name DESC'); // DESC sorting
|
|
* @example $list = $list->sort('Name', 'ASC');
|
|
* @example $list = $list->sort(array('Name'=>'ASC,'Age'=>'DESC'));
|
|
*/
|
|
public function sort();
|
|
|
|
|
|
/**
|
|
* Return a new instance of this list based on reversing the current sort.
|
|
*
|
|
* @return SS_Sortable
|
|
* @example $list = $list->reverse();
|
|
*/
|
|
public function reverse();
|
|
}
|