class GridFieldEditButton implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuLink

Provides the entry point to editing a single record presented by the {@link GridField}.

Doesn't show an edit view on its own or modifies the record, but rather relies on routing conventions established in {@link getColumnContent()}.

The default routing applies to the {@link GridFieldDetailForm} component, which has to be added separately to the {@link GridField} configuration.

Methods

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

No description

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

No description

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

No description

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

No description

augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

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

Return any special attributes that will be used for FormField::create_tag()

array
getColumnMetadata(GridField $gridField, string $columnName)

Add the title

array
getColumnsHandled(GridField $gridField)

Which columns are handled by this component

array
getActions(GridField $gridField)

Which GridField actions are this component handling.

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

No description

string
getExtraClass()

Get the extra HTML classes to add for edit buttons

$this
addExtraClass(string $class)

Add an extra HTML class

$this
removeExtraClass(string $class)

Remove an HTML class

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

Handle the actions and apply any changes to the GridField.

Details

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

Parameters

$gridField
$record
$columnName

Return Value

string $title

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

Parameters

$gridField
$record
$columnName

Return Value

string|null $group

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

Parameters

$gridField
$record
$columnName

Return Value

array $data

at line 63
string getUrl($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string $url

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

Add a column 'Delete'

Parameters

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

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

Return any special attributes that will be used for FormField::create_tag()

Parameters

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

Return Value

array

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

Add the title

Parameters

GridField $gridField
string $columnName

Return Value

array
  • Map of arbitrary metadata identifiers to their values.

at line 120
array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

at line 131
array getActions(GridField $gridField)

Which GridField actions are this component handling.

Parameters

GridField $gridField

Return Value

array with action identifier strings.

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

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 161
string getExtraClass()

Get the extra HTML classes to add for edit buttons

Return Value

string

at line 172
$this addExtraClass(string $class)

Add an extra HTML class

Parameters

string $class

Return Value

$this

at line 185
$this removeExtraClass(string $class)

Remove an HTML class

Parameters

string $class

Return Value

$this

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

Handle the actions and apply any changes to the GridField.

Parameters

GridField $gridField
string $actionName Action identifier, see {@link getActions()}.
array $arguments Arguments relevant for this
array $data All form data