1. class
  2. SilverStripe
  3. \
  4. Versioned
  5. \
  6. GridFieldArchiveAction

GridFieldArchiveAction

class GridFieldArchiveAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem

This class is a {@link GridField} component that replaces the delete action and adds an archive action for objects.

Methods

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 'Actions'

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

GridField_FormAction|null
getArchiveAction(GridField $gridField, DataObject $record)

Returns the GridField_FormAction if archive can be performed

Details

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

Parameters

$gridField
$record
$columnName

Return Value

string $title

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

Parameters

$gridField
$record
$columnName

Return Value

string|null $group

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

Parameters

$gridField
$record
$columnName

Return Value

array $data

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

Add a column 'Actions'

Parameters

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

at line 91
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 103
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 118
array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

at line 129
array getActions(GridField $gridField)

Which GridField actions are this component handling

Parameters

GridField $gridField

Return Value

array with action identifier strings.

at line 141
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 161
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 187
GridField_FormAction|null getArchiveAction(GridField $gridField, DataObject $record)

Returns the GridField_FormAction if archive can be performed

Parameters

GridField $gridField
DataObject $record

Return Value

GridField_FormAction|null