UnpublishAction
class UnpublishAction extends BaseAction (View source)
Provides the "publish this locale" action
Traits
A class that can be instantiated or replaced via DI
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
No description
Record must be published before it can be unpublished
Given a gridfield, and either an ID or record, return a list with both the record being localised, and the locale object
Validate locale permission for specific locale
Handle an action on the given GridField.
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();
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).
protected GridField_FormAction|null
getButtonAction(GridField $gridField, DataObject $record, Locale $locale, string $columnName)
No description
protected mixed
appliesToRecord(DataObject $record, Locale $locale)
Record must be published before it can be unpublished
array
getExtraData(GridField $gridField, ViewableData $record, $columnName)
No description
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
string
getTitle(GridField $gridField, ViewableData $record, $columnName)
Gets the title for this menu item
array
getActions(GridField $gridField)
Return a list of the actions handled by this action provider.
Used to identify the action later on through the $actionName parameter in handleAction.
There is no namespacing on these actions, so you need to ensure that they don't conflict with other components.
handleAction(GridField $gridField, string $actionName, array $arguments, array $data)
Handle an action on the given GridField.
Calls ALL components for every action handled, so the component needs to ensure it only accepts actions it is actually supposed to handle.
protected bool
validatePermissions(string $locale, DataObject $record)
Additional permission check - un-publish