class ElementalGridFieldDeleteAction extends GridFieldDeleteAction (View source)

Properties

protected bool $removeRelation

If this is set to true, this GridField_ActionProvider will remove the object from the list, instead of deleting.

from  GridFieldDeleteAction

Methods

public
__construct(bool $removeRelation = false)

No description

public
augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

public
array
getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Return any special attributes that will be used for FormField::create_tag()

public
array
getColumnMetadata(GridField $gridField, string $columnName)

Add the title

public
array
getColumnsHandled(GridField $gridField)

Which columns are handled by this component

public
array
getActions($gridField)

Which GridField actions are this component handling

public
string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)

No description

public
handleAction(GridField $gridField, $actionName, $arguments, $data)

Handle the actions and apply any changes to the GridField

Details

__construct(bool $removeRelation = false)

No description

Parameters

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

augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

Parameters

GridField $gridField
array $columns

List of columns

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

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.

array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

array getActions($gridField)

Which GridField actions are this component handling

Parameters

$gridField

Return Value

array

with action identifier strings.

string getColumnContent(GridField $gridField, DataObject $record, string $columnName)

No description

Parameters

GridField $gridField
DataObject $record
  • Record displayed in this row
string $columnName

Return Value

string
  • HTML for the column. Return NULL to skip.

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

Handle the actions and apply any changes to the GridField

Parameters

GridField $gridField
$actionName
$arguments
$data