abstract class BaseAction implements GridField_ActionProvider, GridField_ActionMenuItem (View source)

Base action for acting on a single locale / record pair

Note: Any of these actions can be applied either to a list of locales on a single record, or a list of records in the current locale.

Traits

A class that can be instantiated or replaced via DI

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.

protected
getButtonAction(GridField $gridField, DataObject $record, Locale $locale, string $columnName)

No description

protected
mixed
appliesToRecord(DataObject $record, Locale $locale)

Check if this item is enabled for the given record in locale

public
array
getExtraData(GridField $gridField, ViewableData $record, $columnName)

No description

public
string|null
getGroup(GridField $gridField, ViewableData $record, $columnName)

No description

protected
array
getRecordAndLocale(GridField $gridField, DataObject $rowRecord)

Given a gridfield, and either an ID or record, return a list with both the record being localised, and the locale object

protected
bool
validateLocalePermissions(string $locale)

Validate locale permission for specific locale

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

abstract protected GridField_FormAction|null getButtonAction(GridField $gridField, DataObject $record, Locale $locale, string $columnName)

No description

Parameters

GridField $gridField
DataObject $record
Locale $locale
string $columnName

Return Value

GridField_FormAction|null

abstract protected mixed appliesToRecord(DataObject $record, Locale $locale)

Check if this item is enabled for the given record in locale

Parameters

DataObject $record
Locale $locale

Return Value

mixed

array getExtraData(GridField $gridField, ViewableData $record, $columnName)

No description

Parameters

GridField $gridField
ViewableData $record
$columnName

Return Value

array $data

string|null getGroup(GridField $gridField, ViewableData $record, $columnName)

No description

Parameters

GridField $gridField
ViewableData $record
$columnName

Return Value

string|null $group

protected array getRecordAndLocale(GridField $gridField, DataObject $rowRecord)

Given a gridfield, and either an ID or record, return a list with both the record being localised, and the locale object

Parameters

GridField $gridField Gridfield
DataObject $rowRecord

Record in row

Return Value

array

2 length array with localised record, and locale as adjacent items

protected bool validateLocalePermissions(string $locale)

Validate locale permission for specific locale

Parameters

string $locale

Return Value

bool