tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-06-28 23:49:26 +02:00
Code Issues Projects Releases Wiki Activity

MINOR Correct GridField_DataManipulator PHPDOC to not assume DataList

Browse Source 
Tweak GridField_DataManipulator to not assume only DataList will be
provided. Use the SS_List Interface instead. (#8460)
This commit is contained in:
Maxime Rainville 2018-10-11 12:06:21 +13:00
parent 2e2ca5a4a7
commit ef439f9306
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/Forms/GridField/GridField_DataManipulator.php
View File

@ -2,7 +2,6 @@
namespace SilverStripe\Forms\GridField; namespace SilverStripe\Forms\GridField;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\SS_List; use SilverStripe\ORM\SS_List;
/** /**
@ -12,17 +11,17 @@ use SilverStripe\ORM\SS_List;
* component can apply a sort. * component can apply a sort.
* *
* Generally, the data manipulator will make use of to {@link GridState} * Generally, the data manipulator will make use of to {@link GridState}
* variables to decide how to modify the {@link DataList}. * variables to decide how to modify the {@link SS_List}.
*/ */
interface GridField_DataManipulator extends GridFieldComponent interface GridField_DataManipulator extends GridFieldComponent
{ {
/** /**
* Manipulate the {@link DataList} as needed by this grid modifier. * Manipulate the {@link SS_List} as needed by this grid modifier.
* *
* @param GridField $gridField * @param GridField $gridField
* @param SS_List $dataList * @param SS_List $dataList
* @return DataList * @return SS_List
*/ */
public function getManipulatedData(GridField $gridField, SS_List $dataList); public function getManipulatedData(GridField $gridField, SS_List $dataList);
} }