GridFieldEditButton

class GridFieldEditButton implements GridField_ColumnProvider

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

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

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

Handle the actions and apply any changes to the GridField.

Details

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

Add a column 'Delete'

Parameters

GridField $gridField
array $columns List of columns

at line 37
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 48
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 60
array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

at line 70
array getActions(GridField $gridField)

Which GridField actions are this component handling.

Parameters

GridField $gridField

Return Value

array

at line 81
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 102
void handleAction(GridField $gridField, string $actionName, mixed $arguments, array $data)

Handle the actions and apply any changes to the GridField.

Parameters

GridField $gridField
string $actionName
mixed $arguments
array $data
  • form data

Return Value

void