GridFieldFilterHeader
class GridFieldFilterHeader implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider (View source)
GridFieldFilterHeader alters the GridField with some filtering fields in the header of each column.
Properties
| protected | $throwExceptionOnBadDataType | See setThrowExceptionOnBadDataType() |
Methods
Determine what happens when this component is used with a list that isn't SS_Filterable.
Handle an action on the given GridField.
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.
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.
protected string
columnToFilterField(string $class, string $column)
No description
array
getHTMLFragments($gridField)
No description