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

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
$this
setFieldSorting(array $sorting)

Specify sortings with fieldname as the key, and actual fieldname to sort as value.

public
array
getFieldSorting()

No description

public
array
getHTMLFragments($gridField)

Returns the header row providing titles with sort buttons

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)

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.

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

$this setFieldSorting(array $sorting)

Specify sortings with fieldname as the key, and actual fieldname to sort as value.

Example: array("MyCustomTitle"=>"Title", "MyCustomBooleanField" => "ActualBooleanField")

Parameters

array $sorting

Return Value

$this

array getFieldSorting()

No description

Return Value

array

array getHTMLFragments($gridField)

Returns the header row providing titles with sort buttons

Parameters

$gridField

Return Value

array

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)

Returns the manipulated (sorted) DataList. Field names will simply add an 'ORDER BY' clause, relation names will add appropriate joins to the DataQuery first.

Parameters

GridField $gridField
SS_List $dataList

Return Value

DataList