1. interface
  2. SilverStripe
  3. \
  4. Forms
  5. \
  6. GridField
  7. \
  8. GridField_ActionMenuItem

GridField_ActionMenuItem

interface GridField_ActionMenuItem implements GridFieldComponent (View source)

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

Constants

DEFAULT_GROUP

Default group name

Methods

public
string
getTitle(GridField $gridField, DataObject $record, $columnName)

Gets the title for this menu item

public
array
getExtraData(GridField $gridField, DataObject $record, $columnName)

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

public
string|null
getGroup(GridField $gridField, DataObject $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 $gridField, DataObject $record, $columnName)

Gets the title for this menu item

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string $title

See also

{@link GridField_ActionMenu->getColumnContent()}

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

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

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

array $data

See also

{@link GridField_ActionMenu->getColumnContent()}

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

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

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string|null $group

See also

{@link GridField_ActionMenu->getColumnContent()}