class GridFieldEditButton implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuLink (View source)

Provides the entry point to editing a single record presented by the {@link GridField}.

Doesn't show an edit view on its own or modifies the record, but rather relies on routing conventions established in {@link getColumnContent()}.

The default routing applies to the {@link GridFieldDetailForm} component, which has to be added separately to the {@link GridField} configuration.

Traits

A class that can be instantiated or replaced via DI

A trait that makes a class able to consume and use a {@link GridFieldStateManagerInterface} implementation

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

getStateManager()

Fallback on the direct Injector access, but allow a custom implementation to be applied

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

No description

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

No description

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

No description

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

No description

augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

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)

No description

string
getExtraClass()

Get the extra HTML classes to add for edit buttons

$this
addExtraClass(string $class)

Add an extra HTML class

$this
removeExtraClass(string $class)

Remove an HTML class

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

Handle the actions and apply any changes to the GridField.

Details

static Injectable create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

GridFieldStateManagerInterface getStateManager()

Fallback on the direct Injector access, but allow a custom implementation to be applied

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

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string

$title

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

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string|null

$group

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

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

array

$data

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

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string

$url

augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

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)

Which GridField actions are this component handling.

Parameters

$gridField

Return Value

array

with action identifier strings.

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.

string getExtraClass()

Get the extra HTML classes to add for edit buttons

Return Value

string

$this addExtraClass(string $class)

Add an extra HTML class

Parameters

string $class

Return Value

$this

$this removeExtraClass(string $class)

Remove an HTML class

Parameters

string $class

Return Value

$this

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