GridFieldDeleteAction
class GridFieldDeleteAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem (View source)
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
No description
Return any special attributes that will be used for FormField::create_tag()
Which GridField actions are this component handling
Handle the actions and apply any changes to the GridField
Get whether to remove or delete the relation
Set whether to remove or delete the relation
Details
__construct(bool $removeRelation = false)
string
getTitle(GridField $gridField, DataObject $record, $columnName)
string|null
getGroup(GridField $gridField, DataObject $record, $columnName)
array
getExtraData(GridField $gridField, DataObject $record, $columnName)
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)
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)
Handle the actions and apply any changes to the GridField
bool
getRemoveRelation()
Get whether to remove or delete the relation
$this
setRemoveRelation(bool $removeRelation)
Set whether to remove or delete the relation