GridFieldPaginator
class GridFieldPaginator implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider (View source)
Properties
| protected | int | $itemsPerPage | ||
| protected | string | $itemClass | Which template to use for rendering |
|
| protected | $throwExceptionOnBadDataType | See setThrowExceptionOnBadDataType() |
||
| protected | $totalItems |
Methods
Determine what happens when this component is used with a list that isn't SS_Filterable.
Retrieves/Sets up the state object used to store and retrieve information about the current paging details of this GridField
Determines arguments to be passed to the template for building this field
Details
__construct(int $itemsPerPage = null)
No description
setThrowExceptionOnBadDataType($throwExceptionOnBadDataType)
Determine what happens when this component is used with a list that isn't SS_Filterable.
- true: An exception is thrown
- false: This component will be ignored - it won't make any changes to the GridField.
By default, this is set to true so that it's clearer what's happening, but the predefined GridFieldConfig subclasses set this to false for flexibility.
getThrowExceptionOnBadDataType()
See setThrowExceptionOnBadDataType()
protected
checkDataType($dataList)
Check that this dataList is of the right data type.
Returns false if it's a bad data type, and if appropriate, throws an exception.
array
getActions($gridField)
No description
handleAction(GridField $gridField, $actionName, $arguments, $data)
No description
protected GridState_Data
getGridPagerState(GridField $gridField)
Retrieves/Sets up the state object used to store and retrieve information about the current paging details of this GridField
ArrayData|null
getTemplateParameters(GridField $gridField)
Determines arguments to be passed to the template for building this field
array
getHTMLFragments($gridField)
No description
setItemsPerPage($num)
No description
int
getItemsPerPage()
No description