class DMSGridFieldEditButton extends GridFieldEditButton implements GridField_ColumnProvider (View source)

Methods

public
augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

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

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

public
array
getColumnMetadata(GridField $gridField, string $columnName)

Add the title

public
array
getColumnsHandled(GridField $gridField)

Which columns are handled by this component

public
array
getActions(GridField $gridField)

Which GridField actions are this component handling.

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

Overriding the parent method to change the template that the DMS edit button will be rendered with based on whether or not the user has edit permissions.

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

Handle the actions and apply any changes to the GridField.

Details

augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

Parameters

GridField $gridField
array $columns

List of columns

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

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.

array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

array getActions(GridField $gridField)

Which GridField actions are this component handling.

Parameters

GridField $gridField

Return Value

array

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

Overriding the parent method to change the template that the DMS edit button will be rendered with based on whether or not the user has edit permissions.

Parameters

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

Return Value

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

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