GridFieldArchiveAction
class GridFieldArchiveAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem (View source)
This class is a {@link GridField} component that replaces the delete action and adds an archive action for objects.
Methods
Return any special attributes that will be used for FormField::create_tag()
Which GridField actions are this component handling
Handle the actions and apply any changes to the GridField
Returns the GridField_FormAction if archive can be performed
Details
string
getTitle(GridField $gridField, DataObject $record, $columnName)
string|null
getGroup(GridField $gridField, DataObject $record, $columnName)
array
getExtraData(GridField $gridField, DataObject $record, $columnName)
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)
Which GridField actions are this component handling
string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)
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