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

GridFieldRestoreAction

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

This class is a GridField component that adds a restore action for versioned objects.

Methods

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

No description

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

No description

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

No description

public
augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

public
array
getColumnAttributes(GridField $gridField, ModelData $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
GridField_FormAction|null
getRestoreAction(GridField $gridField, DataObject $record, string $columnName)

Creates a restore action if the action is able to be preformed

public
string
getColumnContent(GridField $gridField, ModelData $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.

Details

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

No description

Parameters

GridField $gridField
ModelData $record
$columnName

Return Value

string $title

at line 33
string|null getGroup(GridField $gridField, ModelData $record, $columnName)

No description

Parameters

GridField $gridField
ModelData $record
$columnName

Return Value

string|null $group

at line 43
array getExtraData(GridField $gridField, ModelData $record, $columnName)

No description

Parameters

GridField $gridField
ModelData $record
$columnName

Return Value

array $data

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

Add a column 'Delete'

Parameters

GridField $gridField
array $columns

List reference of all column names.

at line 71
array getColumnAttributes(GridField $gridField, ModelData $record, string $columnName)

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

Parameters

GridField $gridField
ModelData $record

displayed in this row
string $columnName

Return Value

array

at line 83
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 97
array getColumnsHandled(GridField $gridField)

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

at line 108
array getActions(GridField $gridField)

Which GridField actions are this component handling.

Parameters

GridField $gridField

Return Value

array

with action identifier strings.

at line 121
GridField_FormAction|null getRestoreAction(GridField $gridField, DataObject $record, string $columnName)

Creates a restore action if the action is able to be preformed

Parameters

GridField $gridField
DataObject $record
string $columnName

Return Value

GridField_FormAction|null

at line 158
string getColumnContent(GridField $gridField, ModelData $record, string $columnName)

No description

Parameters

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

Return Value

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

at line 175
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