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

public
setThrowExceptionOnBadDataType($throwExceptionOnBadDataType)

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

public
getThrowExceptionOnBadDataType()

See setThrowExceptionOnBadDataType()

protected
checkDataType($dataList)

Check that this dataList is of the right data type.

public
array
getActions($gridField)

No description

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

Handle an action on the given GridField.

public
getManipulatedData(GridField $gridField, SS_List $dataList)

No description

protected
string
columnToFilterField(string $class, string $column)

No description

public
array
getHTMLFragments($gridField)

No description

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.

Parameters

$throwExceptionOnBadDataType

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.

Parameters

$dataList

array getActions($gridField)

No description

Parameters

$gridField

Return Value

array

with action identifier strings.

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.

Parameters

GridField $gridField
$actionName
$arguments
$data

DataList getManipulatedData(GridField $gridField, SS_List $dataList)

No description

Parameters

GridField $gridField
SS_List $dataList

Return Value

DataList

protected string columnToFilterField(string $class, string $column)

No description

Parameters

string $class
string $column

Return Value

string

array getHTMLFragments($gridField)

No description

Parameters

$gridField

Return Value

array