GridFieldSortableHeader
class GridFieldSortableHeader extends AbstractGridFieldComponent implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider, GridField_StateProvider (View source)
GridFieldSortableHeader adds column headers to a GridField that can also sort the columns.
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | bool | $throwExceptionOnBadDataType | See setThrowExceptionOnBadDataType() |
|
| public | array | $fieldSorting |
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.
Determine what happens when this component is used with a list that isn't SS_Filterable.
Specify sorting with fieldname as the key, and actual fieldname to sort as value.
Handle an action on the given GridField.
Returns the manipulated (sorted) DataList. Field names will simply add an 'ORDER BY' clause, relation names will add appropriate joins to the DataQuery first.
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).
$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.
$this
setFieldSorting(array $sorting)
Specify sorting with fieldname as the key, and actual fieldname to sort as value.
Example: array("MyCustomTitle"=>"Title", "MyCustomBooleanField" => "ActualBooleanField")
array
getFieldSorting()
No description
array
getHTMLFragments(GridField $gridField)
Returns the header row providing titles with sort buttons
array
getActions(GridField $gridField)
No description
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)
Handle an action on the given GridField.
Calls ALL components for every action handled, so the component needs to ensure it only accepts actions it is actually supposed to handle.
SS_List
getManipulatedData(GridField $gridField, SS_List $dataList)
Returns the manipulated (sorted) DataList. Field names will simply add an 'ORDER BY' clause, relation names will add appropriate joins to the DataQuery first.
void
initDefaultState(GridState_Data $data)
Initialise the default state in the given GridState_Data
We recommend that you call $data->initDefaults() to do this.