class GridFieldViewButton extends AbstractGridFieldComponent 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.

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

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

static Injectable create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

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.