GridFieldViewButton
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
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Modify the list of columns displayed in the table.
Names of all columns which are affected by this component.
HTML for the column, content of the
Attributes for the element containing the content returned by {@link getColumnContent()}.
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(mixed ...$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();
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).
string
getTitle(GridField $gridField, DataObject $record, $columnName)
string|null
getGroup(GridField $gridField, DataObject $record, $columnName)
array
getExtraData(GridField $gridField, DataObject $record, $columnName)
string
getUrl(GridField $gridField, DataObject $record, $columnName)
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
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.