GridFieldMergeAction
class GridFieldMergeAction implements GridField_ColumnProvider, GridField_ActionProvider (View source)
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | array|SS_List | $records | List of records to show in the MergeAction column. |
|
| protected | string | $parentType | Type of parent DataObject (i.e BlogTag, BlogCategory). |
|
| protected | string | $parentMethod | Relationship method to reference parent (i.e BlogTags). |
|
| protected | string | $childMethod | Relationship method to reference child (i.e BlogPosts). |
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.
No description
Modify the list of columns displayed in the table.
HTML for the column, content of the
Attributes for the element containing the content returned by getColumnContent().
Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.
Handle an action on the given 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).
__construct(array|SS_List $records, string $parentType, string $parentMethod, string $childMethod)
No description
augmentColumns(GridField $gridField, array $columns)
Modify the list of columns displayed in the table.
array
getColumnsHandled(GridField $gridField)
Names of all columns which are affected by this component.
string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)
HTML for the column, content of the
array
getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)
Attributes for the element containing the content returned by getColumnContent().
array
getColumnMetadata(GridField $gridField, string $columnName)
Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.
array
getActions(GridField $gridField)
Return a list of the actions handled by this action provider.
Used to identify the action later on through the $actionName parameter in handleAction.
There is no namespacing on these actions, so you need to ensure that they don't conflict with other components.
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)
Handle an action on the given GridField.
Calls ALL components for every action handled, so the component needs to ensure it only accepts actions it is actually supposed to handle.