Class CMSBatchAction

A class representing back actions

CMSMain::register_batch_action('publishitems', new CMSBatchAction('doPublish',
        _t('CMSBatchActions.PUBLISHED_PAGES', 'published %d pages')));

Object

CMSBatchAction

Direct known subclasses

CMSBatchAction_Delete, CMSBatchAction_DeleteFromLive, CMSBatchAction_Publish

Abstract
Package: cms\batchaction
Located at cms/code/CMSBatchAction.php

Methods summary

`abstract public`	# `getActionTitle( )` The the text to show in the dropdown for this action The the text to show in the dropdown for this action
`abstract public`	# `getDoingText( )` Get text to be shown while the action is being processed, of the form "publishing pages". Get text to be shown while the action is being processed, of the form "publishing pages".
`abstract public`	# `run( DataObjectSet $pages )` Run this action for the given set of pages. Return a set of status-updated JavaScript to return to the CMS. Run this action for the given set of pages. Return a set of status-updated JavaScript to return to the CMS.
`public`	# `batchaction( DataObjectSet $pages, mixed $helperMethod, mixed $successMessage, mixed $arguments = array() )` Helper method for processing batch actions. Returns a set of status-updating JavaScript to return to the CMS. Helper method for processing batch actions. Returns a set of status-updating JavaScript to return to the CMS. Parameters `$pages` $pages The DataObjectSet of SiteTree objects to perform this batch action on. `$helperMethod` $helperMethod The method to call on each of those objects. `$successMessage` `$arguments`
`public`	# `applicablePagesHelper( mixed $ids, mixed $methodName, mixed $checkStagePages = true, mixed $checkLivePages = true )` Helper method for applicablePages() methods. Acts as a skeleton implementation. Helper method for applicablePages() methods. Acts as a skeleton implementation. Parameters `$ids` $ids The IDs passed to applicablePages `$methodName` $methodName The canXXX() method to call on each page to check if the action is applicable `$checkStagePages` $checkStagePages Set to true if you want to check stage pages `$checkLivePages` $checkLivePages Set to true if you want to check live pages (e.g, for deleted-from-draft)
`public`	# `getParameterFields( )`
`public`	# `canView( )` If you wish to restrict the batch action to some users, overload this function. If you wish to restrict the batch action to some users, overload this function.

Methods inherited from Object

__call(), __construct(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), defineMethods(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

Properties inherited from Object

$class, $extension_instances, $extensions

Packages

Classes

Class CMSBatchAction

Direct known subclasses

Methods summary

Parameters

Parameters

Methods inherited from Object

Magic methods summary

Properties summary

Properties inherited from Object