class GridFieldDataColumns extends AbstractGridFieldComponent implements GridField_ColumnProvider (View source)

Traits

A class that can be instantiated or replaced via DI

Properties

array $fieldCasting
array $fieldFormatting

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.

augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

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.

array
getFieldCasting()

No description

$this
setFieldFormatting(array $formatting)

Specify custom formatting for fields, e.g. to render a link instead of pure text.

array
getFieldFormatting()

No description

string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)

HTML for the column, content of the element.

array
getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Attributes for the element containing the content returned by {@link 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.

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

augmentColumns(GridField $gridField, array $columns)

Modify the list of columns displayed in the table.

See {@link GridFieldDataColumns->getDisplayFields()} and {@link GridFieldDataColumns}.

Parameters

GridField $gridField
array $columns

List reference of all column names.

array getColumnsHandled(GridField $gridField)

Names of all columns which are affected by this component.

Parameters

GridField $gridField

Return Value

array

$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')

Parameters

array $fields

Return Value

$this

array getDisplayFields(GridField $gridField)

Get the DisplayFields

Parameters

GridField $gridField

Return Value

array

See also

GridFieldDataColumns::setDisplayFields

$this setFieldCasting(array $casting)

Specify castings with fieldname as the key, and the desired casting as value.

Example: array("MyCustomDate"=>"Date","MyShortText"=>"Text->FirstSentence")

Parameters

array $casting

Return Value

$this

array getFieldCasting()

Return Value

array

$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.

Parameters

array $formatting

Return Value

$this

array getFieldFormatting()

Return Value

array

string getColumnContent(GridField $gridField, DataObject $record, string $columnName)

HTML for the column, content of the element.

Parameters

GridField $gridField
DataObject $record
  • Record displayed in this row
string $columnName

Return Value

string
  • HTML for the column. Return NULL to skip.

array getColumnAttributes(GridField $gridField, DataObject $record, string $columnName)

Attributes for the element containing the content returned by {@link getColumnContent()}.

Parameters

GridField $gridField
DataObject $record

displayed in this row

string $columnName

Return Value

array

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.

Parameters

GridField $gridField
string $column

Return Value

array
  • Map of arbitrary metadata identifiers to their values.