silverstripe-framework/src/Forms/GridField/GridField_DataManipulator.php

28 lines
688 B
PHP
Raw Normal View History

<?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}
* variables to decide how to modify the {@link SS_List}.
*/
interface GridField_DataManipulator extends GridFieldComponent
{
2016-11-29 00:31:16 +01:00
/**
* Manipulate the {@link SS_List} as needed by this grid modifier.
2016-11-29 00:31:16 +01:00
*
* @param GridField $gridField
* @param SS_List $dataList
* @return SS_List
2016-11-29 00:31:16 +01:00
*/
public function getManipulatedData(GridField $gridField, SS_List $dataList);
}