CommentsGridFieldApproveAction
class CommentsGridFieldApproveAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem (View source)
Methods
Modify the list of columns displayed in the table.
Gets any extra data that could go in to the schema that the menu generates
Gets the group this menu item will belong to. A null value should indicate the button should not display.
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.
HTML for the column, content of the
Returns the FormAction object, used by other methods to get properties
Handle an action on the given GridField.
Details
augmentColumns(GridField $gridField, array $columns)
Modify the list of columns displayed in the table.
string
getTitle(GridField $gridField, DataObject $record, $columnName)
Gets the title for this menu item
array
getExtraData(GridField $gridField, DataObject $record, $columnName)
Gets any extra data that could go in to the schema that the menu generates
string|null
getGroup(GridField $gridField, DataObject $record, $columnName)
Gets the group this menu item will belong to. A null value should indicate the button should not display.
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
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
GridField_FormAction|null
getApproveAction($gridField, $record, $columnName)
Returns the FormAction object, used by other methods to get properties
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.