interface GridField_ActionMenuItem implements GridFieldComponent

GridField action menu item interface, this provides data so the action will be included if there is a {see GridField_ActionMenu}

Constants

DEFAULT_GROUP

Default group name

Methods

string
getTitle($gridField, $record, $columnName)

Gets the title for this menu item

array
getExtraData($gridField, $record, $columnName)

Gets any extra data that could go in to the schema that the menu generates

string|null
getGroup($gridField, $record, $columnName)

Gets the group this menu item will belong to. A null value should indicate the button should not display.

Details

at line 28
string getTitle($gridField, $record, $columnName)

Gets the title for this menu item

Parameters

$gridField
$record
$columnName

Return Value

string $title

See also

{@link GridField_ActionMenu->getColumnContent()}

at line 40
array getExtraData($gridField, $record, $columnName)

Gets any extra data that could go in to the schema that the menu generates

Parameters

$gridField
$record
$columnName

Return Value

array $data

See also

{@link GridField_ActionMenu->getColumnContent()}

at line 53
string|null getGroup($gridField, $record, $columnName)

Gets the group this menu item will belong to. A null value should indicate the button should not display.

Parameters

$gridField
$record
$columnName

Return Value

string|null $group

See also

{@link GridField_ActionMenu->getColumnContent()}