GridFieldEditButton
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
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Fallback on the direct Injector access, but allow a custom implementation to be applied
Return any special attributes that will be used for FormField::create_tag()
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();
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).
GridFieldStateAware
setStateManager(GridFieldStateManagerInterface $manager)
No description
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
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, bool $addState = true)
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.