class GridFieldArchiveAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem (View source)

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

Methods

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

No description

public
string|null
getGroup(GridField $gridField, DataObject $record, $columnName)

No description

public
array
getExtraData(GridField $gridField, DataObject $record, $columnName)

No description

public
augmentColumns(GridField $gridField, array $columns)

Add a column 'Actions'

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 $gridField)

Which GridField actions are this component handling

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

No description

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

Handle the actions and apply any changes to the GridField

public
getArchiveAction(GridField $gridField, DataObject $record)

Returns the GridField_FormAction if archive can be performed

Details

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

No description

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string $title

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

No description

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string|null $group

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

No description

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

array $data

augmentColumns(GridField $gridField, array $columns)

Add a column 'Actions'

Parameters

GridField $gridField
array $columns

List reference of all column names.

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 $gridField)

Which GridField actions are this component handling

Parameters

GridField $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, string $actionName, array $arguments, array $data)

Handle the actions and apply any changes to the GridField

Parameters

GridField $gridField
string $actionName

Action identifier, see getActions().

array $arguments

Arguments relevant for this

array $data

All form data

Exceptions

ValidationException

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