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

Provides the entry point to editing a single record presented by the GridField.

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

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

Traits

A trait that makes a class able to consume and use a GridFieldStateManagerInterface implementation

A class that can be instantiated or replaced via DI

Properties

protected GridFieldStateManagerInterface $stateManager from  GridFieldStateAware
protected string[] $extraClass

HTML classes to be added to GridField edit buttons

Methods

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public
getStateManager()

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

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
string
getUrl(GridField $gridField, DataObject $record, $columnName, bool $addState = true)

No description

public
augmentColumns(GridField $gridField, array $columns)

Add a column 'Delete'

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
string
getExtraClass()

Get the extra HTML classes to add for edit buttons

public
$this
addExtraClass(string $class)

Add an extra HTML class

public
$this
removeExtraClass(string $class)

Remove an HTML class

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

Handle the actions and apply any changes to the GridField.

Details

static Injectable create(mixed ...$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::class); $list = SiteTree::get();

Parameters

mixed ...$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)

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

string getUrl(GridField $gridField, DataObject $record, $columnName, bool $addState = true)

No description

Parameters

GridField $gridField
DataObject $record
$columnName
bool $addState

DEPRECATED: Should be removed in major release

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 $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.

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 getActions().

array $arguments

Arguments relevant for this

array $data

All form data