class CommentsGridFieldSpamAction implements GridField_ColumnProvider, GridField_ActionProvider, GridField_ActionMenuItem (View source)

Methods

public
augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

public
string
getTitle(GridField $gridField, DataObject $record, $columnName)

Gets the title for this menu item

public
array
getExtraData(GridField $gridField, DataObject $record, $columnName)

Gets any extra data that could go in to the schema that the menu generates

public
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.

public
array
getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Attributes for the element containing the content returned by getColumnContent().

public
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.

public
array
getColumnsHandled(GridField $gridField)

Names of all columns which are affected by this component.

public
string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)

HTML for the column, content of the element.

public
getSpamAction($gridField, $record, $columnName)

Returns the FormAction object, used by other methods to get properties

public
array
getActions(GridField $gridField)

Return a list of the actions handled by this action provider.

public
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)

Handle an action on the given GridField.

Details

augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

Parameters

GridField $gridField
array $columns

List reference of all column names.

string getTitle(GridField $gridField, DataObject $record, $columnName)

Gets the title for this menu item

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string $title

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

Gets any extra data that could go in to the schema that the menu generates

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

array $data

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.

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string|null $group

array getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Attributes for the element containing the content returned by getColumnContent().

Parameters

GridField $gridField
DataObject $record

displayed in this row

string $columnName

Return Value

array

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.

Parameters

GridField $gridField
string $columnName

Return Value

array
  • Map of arbitrary metadata identifiers to their values.

array getColumnsHandled(GridField $gridField)

Names of all columns which are affected by this component.

Parameters

GridField $gridField

Return Value

array

string getColumnContent(GridField $gridField, DataObject $record, string $columnName)

HTML for the column, content of the element.

Parameters

GridField $gridField
DataObject $record
  • Record displayed in this row
string $columnName

Return Value

string
  • HTML for the column. Return NULL to skip.

GridField_FormAction|null getSpamAction($gridField, $record, $columnName)

Returns the FormAction object, used by other methods to get properties

Parameters

$gridField
$record
$columnName

Return Value

GridField_FormAction|null

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.

Parameters

GridField $gridField

Return Value

array

with action identifier strings.

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.

Parameters

GridField $gridField
string $actionName

Action identifier, see getActions().

array $arguments

Arguments relevant for this

array $data

All form data