GridFieldDataColumns
class GridFieldDataColumns implements GridField_ColumnProvider (View source)
Properties
| array | $fieldCasting | ||
| array | $fieldFormatting |
Methods
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.
No description
Specify custom formatting for fields, e.g. to render a link instead of pure text.
No description
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
augmentColumns(GridField $gridField, array $columns)
Modify the list of columns displayed in the table.
See {@link 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()
$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()
string
getColumnContent(GridField $gridField, DataObject $record, string $columnName)
HTML for the column, content of the
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.