1. class
  2. SilverStripe
  3. \
  4. Forms
  5. \
  6. GridField
  7. \
  8. GridFieldDeleteAction

GridFieldDeleteAction

class GridFieldDeleteAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem

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

string
getTitle($gridField, $record, $columnName)

No description

string|null
getGroup($gridField, $record, $columnName)

No description

array
getExtraData($gridField, $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

Details

at line 42
__construct(boolean $removeRelation = false)

Parameters

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

at line 50
string getTitle($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string $title

at line 64
string|null getGroup($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string|null $group

at line 78
array getExtraData($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

array $data

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

Add a column 'Delete'

Parameters

GridField $gridField
array $columns List reference of all column names.

at line 111
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 123
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 136
array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

at line 147
array getActions(GridField $gridField)

Which GridField actions are this component handling

Parameters

GridField $gridField

Return Value

array with action identifier strings.

at line 159
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 179
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

Exceptions

ValidationException

at line 267
bool getRemoveRelation()

Get whether to remove or delete the relation

Return Value

bool

at line 277
$this setRemoveRelation(bool $removeRelation)

Set whether to remove or delete the relation

Parameters

bool $removeRelation

Return Value

$this