GridFieldViewButton

class GridFieldViewButton implements GridField_ColumnProvider (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 GridField instances.

Methods

public
augmentColumns($field, $cols)

Modify the list of columns displayed in the table.

public
array
getColumnsHandled($field)

Names of all columns which are affected by this component.

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

HTML for the column, content of the element.

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

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

public
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

at line 12
augmentColumns($field, $cols)

Modify the list of columns displayed in the table.

Parameters

$field
$cols

at line 16
array getColumnsHandled($field)

Names of all columns which are affected by this component.

Parameters

$field

Return Value

array

at line 20
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.

at line 29
array getColumnAttributes($field, DataObject $record, $col)

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

Parameters

$field
DataObject $record

displayed in this row
$col

Return Value

array

at line 33
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.