1. class
  2. SilverStripe
  3. \
  4. Forms
  5. \
  6. GridField
  7. \
  8. GridFieldViewButton

GridFieldViewButton

class GridFieldViewButton implements GridField_ColumnProvider, GridField_ActionMenuLink

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, $record, $columnName)

No description

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

No description

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

No description

string
getUrl($gridField, $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

at line 19
string getTitle($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string $title

at line 27
string|null getGroup($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string|null $group

at line 35
array getExtraData($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

array $data

at line 45
string getUrl($gridField, $record, $columnName)

Parameters

$gridField
$record
$columnName

Return Value

string $url

at line 50
augmentColumns($field, array $columns)

Modify the list of columns displayed in the table.

Parameters

$field
array $columns List reference of all column names.

at line 57
array getColumnsHandled($field)

Names of all columns which are affected by this component.

Parameters

$field

Return Value

array

at line 62
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 74
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

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