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

GridFieldGroupDeleteAction

class GridFieldGroupDeleteAction extends GridFieldDeleteAction

Adds a delete action for the gridfield to remove a relationship from group.

This is a special case where it captures whether the current user is the record being removed and prevents removal from happening.

Methods

__construct($groupID)

No description

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

No description

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

Get the ActionMenu group (not related to Member group)

array
getExtraData($gridField, $record, $columnName)

No description

from GridFieldDeleteAction
augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

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

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

from GridFieldDeleteAction
array
getColumnMetadata(GridField $gridField, string $columnName)

Add the title

from GridFieldDeleteAction
array
getColumnsHandled(GridField $gridField)

Which columns are handled by this component

from GridFieldDeleteAction
array
getActions(GridField $gridField)

Which GridField actions are this component handling

from GridFieldDeleteAction
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

from GridFieldDeleteAction
$this
setRemoveRelation(bool $removeRelation)

Set whether to remove or delete the relation

from GridFieldDeleteAction

Details

at line 23
__construct($groupID)

Parameters

$groupID

in GridFieldDeleteAction at line 51
string getTitle($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string $title

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

Get the ActionMenu group (not related to Member group)

Parameters

$gridField
$record
$columnName

Return Value

string|null $group

in GridFieldDeleteAction at line 79
array getExtraData($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

array $data

in GridFieldDeleteAction at line 97
augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

Parameters

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

in GridFieldDeleteAction at line 112
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

in GridFieldDeleteAction at line 124
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.

in GridFieldDeleteAction at line 137
array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

in GridFieldDeleteAction at line 148
array getActions(GridField $gridField)

Which GridField actions are this component handling

Parameters

GridField $gridField

Return Value

array with action identifier strings.

at line 36
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 69
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

in GridFieldDeleteAction at line 262
bool getRemoveRelation()

Get whether to remove or delete the relation

Return Value

bool

in GridFieldDeleteAction at line 272
$this setRemoveRelation(bool $removeRelation)

Set whether to remove or delete the relation

Parameters

bool $removeRelation

Return Value

$this