class GridFieldFilterHeader implements GridField_HTMLProvider, GridField_DataManipulator, GridField_ActionProvider (View source)

GridFieldFilterHeader alters the {@link GridField} with some filtering fields in the header of each column.

Methods

setThrowExceptionOnBadDataType($throwExceptionOnBadDataType)

Determine what happens when this component is used with a list that isn't {@link SS_Filterable}.

getThrowExceptionOnBadDataType()

See {@link setThrowExceptionOnBadDataType()}

array
getActions($gridField)

No description

handleAction(GridField $gridField, $actionName, $arguments, $data)

Handle an action on the given {@link GridField}.

getManipulatedData(GridField $gridField, SS_List $dataList)

No description

array
getHTMLFragments($gridField)

No description

Details

setThrowExceptionOnBadDataType($throwExceptionOnBadDataType)

Determine what happens when this component is used with a list that isn't {@link 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 {@link GridFieldConfig} subclasses set this to false for flexibility.

Parameters

$throwExceptionOnBadDataType

getThrowExceptionOnBadDataType()

See {@link setThrowExceptionOnBadDataType()}

array getActions($gridField)

Parameters

$gridField

Return Value

array

with action identifier strings.

handleAction(GridField $gridField, $actionName, $arguments, $data)

Handle an action on the given {@link GridField}.

Calls ALL components for every action handled, so the component needs to ensure it only accepts actions it is actually supposed to handle.

Parameters

GridField $gridField
$actionName
$arguments
$data

DataList getManipulatedData(GridField $gridField, SS_List $dataList)

Parameters

GridField $gridField
SS_List $dataList

Return Value

DataList

array getHTMLFragments($gridField)

Parameters

$gridField

Return Value

array