GridFieldMergeAction
class GridFieldMergeAction implements GridField_ColumnProvider, GridField_ActionProvider (View source)
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
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
__construct(array|SS_List $records = array(), 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)
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.