class GridFieldDeleteAction implements GridField_ColumnProvider, GridField_ActionProvider

This class is a {@link GridField} component that adds a delete action for objects.

This component also supports unlinking a relation instead of deleting the object.

Use the {@link $removeRelation} property set in the constructor.

$action = new GridFieldDeleteAction(); // delete objects permanently

// removes the relation to object instead of deleting $action = new GridFieldDeleteAction(true);

Methods

__construct(boolean $removeRelation = false)

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

handleAction(GridField $gridField, String $actionName, Array $arguments, Array $data)

Handle the actions and apply any changes to the GridField

Details

at line 38
__construct(boolean $removeRelation = false)

Parameters

boolean $removeRelation
  • true if removing the item from the list, but not deleting it

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

Add a column 'Delete'

Parameters

GridField $gridField
array $columns List of columns

at line 62
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 73
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 85
array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

at line 95
Array getActions(GridField $gridField)

Which GridField actions are this component handling

Parameters

GridField $gridField

Return Value

Array with action identifier strings.

at line 106
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 137
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