SilverStripe\Admin\CMSBatchActionHandler
Special request handler for admin/batchaction
Synopsis
class CMSBatchActionHandler
extends RequestHandler
{
- // members
- private static array $batch_actions = ;
- private static $registered_actions = NULL;
- private static array $url_handlers = ;
- private static array $allowed_actions = ;
- protected Controller $parentController;
- protected String $urlSegment;
- protected String $recordClass = SiteTree::class;
- // methods
- public void __construct()
- public static array registeredActions()
- public static void register()
- public void Link()
- public HTTPResponse handleBatchAction()
- public HTTPResponse handleApplicablePages()
- public HTTPResponse handleConfirmation()
- protected CMSBatchAction actionByName()
- public ArrayList batchActionList()
- protected CMSBatchAction buildAction()
- protected array cleanIDs()
- public array batchActions()
- protected SS_List getPages()
Hierarchy
Extends
- SilverStripe\Control\RequestHandler
Members
private
- $allowed_actions
- $batch_actions
- $registered_actions
—
null
List of registered actions - $url_handlers
protected
- $parentController — SilverStripe\Control\Controller
- $recordClass — SilverStripe\Admin\String
- $urlSegment — SilverStripe\Admin\String
Methods
protected
- actionByName() — Get an action for a given name
- buildAction() — Safely generate batch action object for a given classname
- cleanIDs() — Sanitise ID list from string input
- getPages() — Safely query and return all pages queried
public
- __construct()
- Link()
- batchActionList() — Return a SS_List of ArrayData objects containing the following pieces of info about each batch action: - Link - Title
- batchActions() — Get all registered actions through the static defaults set by {@link register()}.
- handleApplicablePages() — Respond with the list of applicable pages for a given filter
- handleBatchAction() — Invoke a batch action
- handleConfirmation() — Check if this action has a confirmation step
- register() — Register a new batch action. Each batch action needs to be represented by a subclass of {@link CMSBatchAction}.
- registeredActions() — Get all registered actions