class GridFieldExternalLink extends GridFieldDataColumns (View source)

Displays a link to an external source referenced 'external link'

Traits

A class that can be instantiated or replaced via DI

Properties

public array $fieldCasting from  GridFieldDataColumns
public array $fieldFormatting from  GridFieldDataColumns
protected array $displayFields

This is the columns that will be visible

from  GridFieldDataColumns

Methods

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public
augmentColumns(GridField $gridField, array $columns)

Add a column for the actions

public
array
getColumnsHandled(GridField $gridField)

Which columns are handled by this component

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

public
array
getDisplayFields(GridField $gridField)

Get the DisplayFields

public
$this
setFieldCasting(array $casting)

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

public
array
getFieldCasting()

No description

public
$this
setFieldFormatting(array $formatting)

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

public
array
getFieldFormatting()

No description

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

No description

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

Return any special attributes that will be used for FormField::create_tag()

public
array
getColumnMetadata(GridField $gridField, string $columnName)

Add the title

protected
string|null
getValueFromRelation(DataObject $record, string $columnName)

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, DataObject $item, string $fieldName, string $value)

No description

protected
string
escapeValue(GridField $gridField, string $value)

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();

Parameters

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

Add a column for the actions

Parameters

GridField $gridField
array $columns

List reference of all column names.

array getColumnsHandled(GridField $gridField)

Which columns are handled 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()

No description

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()

No description

Return Value

array

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

No description

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)

Return any special attributes that will be used for FormField::create_tag()

Parameters

GridField $gridField
DataObject $record

displayed in this row

string $columnName

Return Value

array

array getColumnMetadata(GridField $gridField, string $columnName)

Add the title

Parameters

GridField $gridField
string $columnName

Return Value

array
  • Map of arbitrary metadata identifiers to their values.

protected string|null getValueFromRelation(DataObject $record, string $columnName)

Translate a Object.RelationName.ColumnName $columnName into the value that ColumnName returns

Parameters

DataObject $record
string $columnName

Return Value

string|null
  • returns null if it could not found a value

protected string castValue(GridField $gridField, string $fieldName, string $value)

Casts a field to a string which is safe to insert into HTML

Parameters

GridField $gridField
string $fieldName
string $value

Return Value

string

protected string formatValue(GridField $gridField, DataObject $item, string $fieldName, string $value)

No description

Parameters

GridField $gridField
DataObject $item
string $fieldName
string $value

Return Value

string

protected string escapeValue(GridField $gridField, string $value)

Remove values from a value using FieldEscape setter

Parameters

GridField $gridField
string $value

Return Value

string