2016-08-19 10:51:35 +12:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace SilverStripe\Forms\GridField;
|
|
|
|
|
|
|
|
use SilverStripe\ORM\SS_List;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Can modify the data list.
|
|
|
|
*
|
|
|
|
* For example, a paginating component can apply a limit, or a sorting
|
|
|
|
* component can apply a sort.
|
|
|
|
*
|
|
|
|
* Generally, the data manipulator will make use of to {@link GridState}
|
2018-10-11 12:06:21 +13:00
|
|
|
* variables to decide how to modify the {@link SS_List}.
|
2016-08-19 10:51:35 +12:00
|
|
|
*/
|
|
|
|
interface GridField_DataManipulator extends GridFieldComponent
|
|
|
|
{
|
|
|
|
|
2016-11-29 12:31:16 +13:00
|
|
|
/**
|
2018-10-11 12:06:21 +13:00
|
|
|
* Manipulate the {@link SS_List} as needed by this grid modifier.
|
2016-11-29 12:31:16 +13:00
|
|
|
*
|
|
|
|
* @param GridField $gridField
|
|
|
|
* @param SS_List $dataList
|
2018-10-11 12:06:21 +13:00
|
|
|
* @return SS_List
|
2016-11-29 12:31:16 +13:00
|
|
|
*/
|
|
|
|
public function getManipulatedData(GridField $gridField, SS_List $dataList);
|
2016-08-19 10:51:35 +12:00
|
|
|
}
|