class GridFieldViewButton implements GridField_ColumnProvider, GridField_ActionMenuLink (View source)

A button that allows a user to view readonly details of a record. This is disabled by default and intended for use in readonly {@link GridField} instances.

Methods

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)

No description

augmentColumns($field, array $columns)

Modify the list of columns displayed in the table.

array
getColumnsHandled($field)

Names of all columns which are affected by this component.

string
getColumnContent($field, DataObject $record, $col)

HTML for the column, content of the element.

array
getColumnAttributes($field, DataObject $record, $col)

Attributes for the element containing the content returned by {@link getColumnContent()}.

array
getColumnMetadata(GridField $gridField, $col)

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

Details

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

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string

$title

string|null getGroup(GridField $gridField, DataObject $record, $columnName)

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string|null

$group

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

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

array

$data

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

Parameters

GridField $gridField
DataObject $record
$columnName

Return Value

string

$url

augmentColumns($field, array $columns)

Modify the list of columns displayed in the table.

Parameters

$field
array $columns

List reference of all column names.

array getColumnsHandled($field)

Names of all columns which are affected by this component.

Parameters

$field

Return Value

array

string getColumnContent($field, DataObject $record, $col)

HTML for the column, content of the element.

Parameters

$field
DataObject $record
  • Record displayed in this row
$col

Return Value

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

array getColumnAttributes($field, DataObject $record, $col)

Attributes for the element containing the content returned by {@link getColumnContent()}.

Parameters

$field
DataObject $record

displayed in this row

$col

Return Value

array

array getColumnMetadata(GridField $gridField, $col)

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
$col

Return Value

array
  • Map of arbitrary metadata identifiers to their values.