GridFieldDeleteAction
class GridFieldDeleteAction implements GridField_ColumnProvider, GridField_ActionProvider (View source)
This class is a GridField component that adds a delete action for objects.
This component also supports unlinking a relation instead of deleting the object.
Use the $removeRelation property set in the constructor.
$action = new GridFieldDeleteAction(); // delete objects permanently
// removes the relation to object instead of deleting
$action = new GridFieldDeleteAction(true);Properties
| protected | bool | $removeRelation | If this is set to true, this GridField_ActionProvider will remove the object from the list, instead of deleting. |
Methods
Return any special attributes that will be used for FormField::create_tag()
Handle the actions and apply any changes to the GridField
Details
__construct(bool $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)
Which GridField actions are this component handling
string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)
No description
handleAction(GridField $gridField, $actionName, $arguments, $data)
Handle the actions and apply any changes to the GridField