GridFieldPaginator
class GridFieldPaginator extends AbstractGridFieldComponent implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider, GridField_StateProvider (View source)
GridFieldPaginator paginates the GridField list and adds controls to the bottom of the GridField.
Traits
Provides extensions to this object to integrate it with standard config API methods.
A class that can be instantiated or replaced via DI
Config options
| default_items_per_page | int | Specifies default items per page |
Properties
| protected | int | $itemsPerPage | ||
| protected | $throwExceptionOnBadDataType | See setThrowExceptionOnBadDataType() |
||
| protected | $totalItems |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Determine what happens when this component is used with a list that isn't SS_Filterable.
No description
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
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
deprecated
Get inherited config value
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
set_stat(string $name, mixed $value)
deprecated
deprecated
Update the config value for a given property
__construct(int $itemsPerPage = null)
No description
$this
setThrowExceptionOnBadDataType(bool $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.
bool
getThrowExceptionOnBadDataType()
See setThrowExceptionOnBadDataType()
protected bool
checkDataType(SS_List $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 $gridField)
No description
handleAction(GridField $gridField, string $actionName, array $arguments, array $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
void
initDefaultState(GridState_Data $data)
Initialise the default state in the given GridState_Data
We recommend that you call $data->initDefaults() to do this.
ArrayData
getTemplateParameters(GridField $gridField)
Determines arguments to be passed to the template for building this field
array
getHTMLFragments(GridField $gridField)
No description
$this
setItemsPerPage(int $num)
No description
int
getItemsPerPage()
No description