GridFieldDeleteAction
class GridFieldDeleteAction extends AbstractGridFieldComponent implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem (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 = GridFieldDeleteAction::create(); // delete objects permanently
// removes the relation to object instead of deleting
$action = GridFieldDeleteAction::create(true);Traits
A class that can be instantiated or replaced via DI
Properties
| protected | bool | $removeRelation | If this is set to true, this GridField_ActionProvider will remove the object from the list, instead of deleting. |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Return any special attributes that will be used for FormField::create_tag()
Handle the actions and apply any changes to the GridField
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
__construct(bool $removeRelation = false)
No description
string
getTitle(GridField $gridField, DataObject $record, $columnName)
No description
string|null
getGroup(GridField $gridField, DataObject $record, $columnName)
No description
array
getExtraData(GridField $gridField, DataObject $record, $columnName)
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
bool
getRemoveRelation()
Get whether to remove or delete the relation
$this
setRemoveRelation(bool $removeRelation)
Set whether to remove or delete the relation