GridFieldSortableHeader
class GridFieldSortableHeader implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider (View source)
GridFieldSortableHeader adds column headers to a GridField that can also sort the columns.
Properties
| protected | $throwExceptionOnBadDataType | See setThrowExceptionOnBadDataType() |
||
| public | array | $fieldSorting |
Methods
Determine what happens when this component is used with a list that isn't SS_Filterable.
Specify sortings 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
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.
$this
setFieldSorting(array $sorting)
Specify sortings 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)
Returns the header row providing titles with sort buttons
array
getActions($gridField)
No description
handleAction(GridField $gridField, $actionName, $arguments, $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.