GridFieldDataColumns
class GridFieldDataColumns extends AbstractGridFieldComponent implements GridField_ColumnProvider (View source)
Traits
A class that can be instantiated or replaced via DI
Properties
| public | array | $fieldCasting | ||
| public | array | $fieldFormatting | ||
| protected | array | $displayFields | This is the columns that will be visible |
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.
Override the default behaviour of showing the models summaryFields with these fields instead Example: array( 'Name' => 'Members name', 'Email' => 'Email address')
Specify castings with fieldname as the key, and the desired casting as value.
Specify custom formatting for fields, e.g. to render a link instead of pure text.
HTML for the column, content of the
Attributes for the element containing the content returned by getColumnContent().
Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.
Translate a Object.RelationName.ColumnName $columnName into the value that ColumnName returns
No description
Remove values from a value using FieldEscape setter
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).
augmentColumns(GridField $gridField, array $columns)
Modify the list of columns displayed in the table.
See GridFieldDataColumns->getDisplayFields()} and {@link GridFieldDataColumns.
array
getColumnsHandled(GridField $gridField)
Names of all columns which are affected by this component.
$this
setDisplayFields(array $fields)
Override the default behaviour of showing the models summaryFields with these fields instead Example: array( 'Name' => 'Members name', 'Email' => 'Email address')
array
getDisplayFields(GridField $gridField)
Get the DisplayFields
$this
setFieldCasting(array $casting)
Specify castings with fieldname as the key, and the desired casting as value.
Example: array("MyCustomDate"=>"Date","MyShortText"=>"Text->FirstSentence")
array
getFieldCasting()
No description
$this
setFieldFormatting(array $formatting)
Specify custom formatting for fields, e.g. to render a link instead of pure text.
Caution: Make sure to escape special php-characters like in a normal php-statement. Example: "myFieldName" => '<a href=\"custom-admin/$ID\">$ID'.
Alternatively, pass a anonymous function, which takes two parameters: The value and the original list item.
Formatting is applied after field casting, so if you're modifying the string to include further data through custom formatting, ensure it's correctly escaped.
array
getFieldFormatting()
No description
string
getColumnContent(GridField $gridField, ViewableData $record, string $columnName)
HTML for the column, content of the
array
getColumnAttributes(GridField $gridField, ViewableData $record, string $columnName)
Attributes for the element containing the content returned by getColumnContent().
array
getColumnMetadata(GridField $gridField, string $column)
Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.
protected string|null
getValueFromRelation(ViewableData $record, string $columnName)
deprecated
deprecated
Translate a Object.RelationName.ColumnName $columnName into the value that ColumnName returns
protected string
castValue(GridField $gridField, string $fieldName, string $value)
Casts a field to a string which is safe to insert into HTML
protected string
formatValue(GridField $gridField, ViewableData $item, string $fieldName, string $value)
No description
protected string
escapeValue(GridField $gridField, string $value)
Remove values from a value using FieldEscape setter