CMSBatchAction
abstract class CMSBatchAction (View source)
A class representing back actions.
See CMSMain.BatchActions.js on how to add custom javascript functionality.
CMSMain::register_batch_action('publishitems', new CMSBatchAction('doPublish',
_t('CMSBatchActions.PUBLISHED_PAGES', 'published %d pages')));Traits
A class that can be instantiated or replaced via DI
Properties
| protected | $managedClass |
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.
Helper method for responding to a back action request
Helper method for processing batch actions.
Helper method for applicablePages() methods. Acts as a skeleton implementation.
Given a list of object IDs, filter out which items can have this batch action applied to them.
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).
abstract
getActionTitle()
The the text to show in the dropdown for this action
abstract HTTPResponse
run(SS_List $objs)
Run this action for the given set of pages.
Return a set of status-updated JavaScript to return to the CMS.
HTTPResponse
response(string $successMessage, array $status)
Helper method for responding to a back action request
HTTPResponse
batchaction(SS_List $objs, string $helperMethod, string $successMessage, array $arguments = [])
Helper method for processing batch actions.
Returns a set of status-updating JavaScript to return to the CMS.
array
applicablePagesHelper(array $ids, string $methodName, bool $checkStagePages = true, bool $checkLivePages = true)
Helper method for applicablePages() methods. Acts as a skeleton implementation.
getParameterFields()
No description
canView()
If you wish to restrict the batch action to some users, overload this function.
array
applicablePages(array $ids)
Given a list of object IDs, filter out which items can have this batch action applied to them.