1. class
  2. SilverStripe
  3. \
  4. Forms
  5. \
  6. GridField
  7. \
  8. GridFieldEditButton

GridFieldEditButton

class GridFieldEditButton implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuLink

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

Injectable
A class that can be instantiated or replaced via DI
GridFieldStateAware
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

from Injectable
static Injectable
singleton(string $class = null)

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

from Injectable
GridFieldStateAware
setStateManager(GridFieldStateManagerInterface $manager)

No description

from GridFieldStateAware
GridFieldStateManagerInterface
getStateManager()

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

from GridFieldStateAware
string
getTitle($gridField, $record, $columnName)

No description

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

No description

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

No description

string
getUrl($gridField, $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 $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

in Injectable at line 26
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

in Injectable at line 43
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

in GridFieldStateAware at line 23
GridFieldStateAware setStateManager(GridFieldStateManagerInterface $manager)

Parameters

GridFieldStateManagerInterface $manager

Return Value

GridFieldStateAware

in GridFieldStateAware at line 36
GridFieldStateManagerInterface getStateManager()

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

Return Value

GridFieldStateManagerInterface

at line 40
string getTitle($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string $title

at line 48
string|null getGroup($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string|null $group

at line 56
array getExtraData($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

array $data

at line 66
string getUrl($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string $url

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

Add a column 'Delete'

Parameters

GridField $gridField
array $columns List reference of all column names.

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

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

Which columns are handled by this component

Parameters

GridField $gridField

Return Value

array

at line 135
array getActions(GridField $gridField)

Which GridField actions are this component handling.

Parameters

GridField $gridField

Return Value

array with action identifier strings.

at line 146
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.

at line 165
string getExtraClass()

Get the extra HTML classes to add for edit buttons

Return Value

string

at line 176
$this addExtraClass(string $class)

Add an extra HTML class

Parameters

string $class

Return Value

$this

at line 189
$this removeExtraClass(string $class)

Remove an HTML class

Parameters

string $class

Return Value

$this

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