class LocaleToggleColumn implements GridField_SaveHandler, GridField_ColumnProvider (View source)

Traits

A class that can be instantiated or replaced via DI

Constants

COLUMN_NAME

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)

No description

public
array
getColumnsHandled(GridField $gridField)

No description

public
string
getColumnContent(GridField $gridField, Locale $locale, string $columnName)

No description

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

Attributes for the element containing the content returned by getColumnContent().

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

Additional metadata about the column which can be used by other components, e.g. to set a title for a search column header.

public
handleSave(GridField $gridField, DataObjectInterface $record)

Called when a grid field is saved - i.e. the form is submitted.

protected
getFieldName(GridField $grid, Locale $locale)

No description

public
getRecord(GridField $gridField)

Get record to edit

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)

No description

Parameters

GridField $gridField
array $columns

List reference of all column names.

array getColumnsHandled(GridField $gridField)

No description

Parameters

GridField $gridField

Return Value

array

string getColumnContent(GridField $gridField, Locale $locale, string $columnName)

No description

Parameters

GridField $gridField
Locale $locale
string $columnName

Return Value

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

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

Attributes for the element containing the content returned by getColumnContent().

Parameters

GridField $gridField
ViewableData $record

displayed in this row

string $columnName

Return Value

array

array getColumnMetadata(GridField $gridField, string $columnName)

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

Return Value

array
  • Map of arbitrary metadata identifiers to their values.

handleSave(GridField $gridField, DataObjectInterface $record)

Called when a grid field is saved - i.e. the form is submitted.

Parameters

GridField $gridField
DataObjectInterface $record

protected getFieldName(GridField $grid, Locale $locale)

No description

Parameters

GridField $grid
Locale $locale

DataObject|FluentFilteredExtension getRecord(GridField $gridField)

Get record to edit

Parameters

GridField $gridField

Return Value

DataObject|FluentFilteredExtension

Exceptions

LogicException