class GridField_ActionMenu implements GridField_ColumnProvider, GridField_ActionProvider

Groups exiting actions in the Actions column in to a menu

Methods

augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

array
getColumnsHandled(GridField $gridField)

Names of all columns which are affected by this component.

string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)

HTML for the column, content of the element.

array
getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Attributes for the element containing the content returned by {@link getColumnContent()}.

array
getColumnMetadata(GridField $gridField, string $columnName)

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

array
getActions(GridField $gridField)

Return a list of the actions handled by this action provider.

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

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

array
getItems($gridfield)

Gets the list of items setup

Details

at line 14
augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

Parameters

GridField $gridField
array $columns List reference of all column names.

at line 21
array getColumnsHandled(GridField $gridField)

Names of all columns which are affected by this component.

Parameters

GridField $gridField

Return Value

array

at line 26
string getColumnContent(GridField $gridField, DataObject $record, string $columnName)

HTML for the column, content of the element.

Parameters

GridField $gridField
DataObject $record
  • Record displayed in this row
string $columnName

Return Value

string
  • HTML for the column. Return NULL to skip.

at line 61
array getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Attributes for the element containing the content returned by {@link getColumnContent()}.

Parameters

GridField $gridField
DataObject $record displayed in this row
string $columnName

Return Value

array

at line 66
array getColumnMetadata(GridField $gridField, string $columnName)

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

Parameters

GridField $gridField
string $columnName

Return Value

array
  • Map of arbitrary metadata identifiers to their values.

at line 71
array getActions(GridField $gridField)

Return a list of the actions handled by this action provider.

Used to identify the action later on through the $actionName parameter in {@link handleAction}.

There is no namespacing on these actions, so you need to ensure that they don't conflict with other components.

Parameters

GridField $gridField

Return Value

array with action identifier strings.

at line 84
handleAction(GridField $gridField, string $actionName, array $arguments, array $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
string $actionName Action identifier, see {@link getActions()}.
array $arguments Arguments relevant for this
array $data All form data

at line 103
array getItems($gridfield)

Gets the list of items setup

Parameters

$gridfield

Return Value

array