User interface for the rollback action. More...

Inheritance diagram for RollbackAction:

[legend]

Collaboration diagram for RollbackAction:

[legend]

Public Member Functions
	__construct (Page $page, ?IContextSource $context, IContentHandlerFactory $contentHandlerFactory, RollbackPageFactory $rollbackPageFactory, UserOptionsLookup $userOptionsLookup, WatchlistManager $watchlistManager)

	doesWrites ()

	getName ()
	Return the name of the action this object responds to.

	getRestriction ()
	Get the permission required to perform this action.

	handleRollbackRequest ()

	onSubmit ( $data)
	Process the form on POST submission.

	onSuccess ()
	Do something exciting on successful processing of the form.

	show ()

Public Member Functions inherited from Action
	__construct (Page $page, IContextSource $context=null)
	Only public since 1.21.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	getArticle ()
	Get a Article object.

	getContext ()
	Get the IContextSource in use here.

	getLanguage ()
	Shortcut to get the user Language being used for this instance.

	getOutput ()
	Get the OutputPage being used for this instance.

	getRequest ()
	Get the WebRequest being used for this instance.

	getSkin ()
	Shortcut to get the Skin being used for this instance.

	getTitle ()
	Shortcut to get the Title object from the page.

	getUser ()
	Shortcut to get the User being used for this instance.

	getWikiPage ()
	Get a WikiPage object.

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	needsReadRights ()
	Indicates whether this action requires read rights.

	requiresUnblock ()
	Whether this action can still be executed by a blocked user.

	requiresWrite ()
	Whether this action requires the wiki not to be locked.

Protected Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

	getDescription ()
	Returns the description that goes below the \<h1\> tag.

	getFormFields ()
	Get an HTMLForm descriptor array.

	usesOOUI ()
	Whether the form should use OOUI.

Protected Member Functions inherited from FormAction
	getForm ()
	Get the HTMLForm to control behavior.

	postText ()

	preText ()
	Add pre- or post-text to the form.

Protected Member Functions inherited from Action
	checkCanExecute (User $user)
	Checks if the given user (identified by an object) can perform this action.

	getHookContainer ()

	getHookRunner ()

	getPageTitle ()
	Returns the name that goes in the \<h1\> page title.

	setHeaders ()
	Set output headers for noindexing etc.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Private Member Functions
	enableTransactionalTimelimit ()
	Enables transactional time limit for POST and GET requests to RollbackAction.

	showRollbackConfirmationForm ()

Private Attributes
IContentHandlerFactory	$contentHandlerFactory

RollbackPageFactory	$rollbackPageFactory

UserOptionsLookup	$userOptionsLookup

WatchlistManager	$watchlistManager

Additional Inherited Members
Static Public Member Functions inherited from Action
static	exists (string $name)
	Check if a given action is recognised, even if it's disabled.

static	factory (string $action, Article $article, IContextSource $context=null)
	Get an appropriate Action subclass for the given action.

static	getActionName (IContextSource $context)
	Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter.

Protected Attributes inherited from Action
IContextSource	$context
	IContextSource if specified; otherwise we'll use the Context from the Page.

array	$fields
	The fields used to create the HTMLForm.

WikiPage Article ImagePage CategoryPage Page	$page
	Page on which we're performing the action.

Detailed Description

User interface for the rollback action.

Definition at line 36 of file RollbackAction.php.

Constructor & Destructor Documentation

◆ __construct()

RollbackAction::__construct	(	Page	$page,
		?IContextSource	$context,
		IContentHandlerFactory	$contentHandlerFactory,
		RollbackPageFactory	$rollbackPageFactory,
		UserOptionsLookup	$userOptionsLookup,
		WatchlistManager	$watchlistManager
	)

Parameters

Page	$page
IContextSource \| null	$context
IContentHandlerFactory	$contentHandlerFactory
RollbackPageFactory	$rollbackPageFactory
UserOptionsLookup	$userOptionsLookup
WatchlistManager	$watchlistManager

Definition at line 58 of file RollbackAction.php.

References $userOptionsLookup, and $watchlistManager.

Member Function Documentation

◆ alterForm()

RollbackAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Stability: stable: to override

Parameters

HTMLForm $form

Reimplemented from FormAction.

Definition at line 101 of file RollbackAction.php.

References HTMLForm\addHiddenField(), Action\getRequest(), HTMLForm\setSubmitTextMsg(), HTMLForm\setTokenSalt(), and HTMLForm\setWrapperLegendMsg().

◆ doesWrites()

RollbackAction::doesWrites ( )

Stability: stable: to override

Returns: bool

Reimplemented from FormAction.

Definition at line 89 of file RollbackAction.php.

◆ enableTransactionalTimelimit()

RollbackAction::enableTransactionalTimelimit ( )

private

Enables transactional time limit for POST and GET requests to RollbackAction.

Exceptions

ConfigException

Definition at line 271 of file RollbackAction.php.

References Action\getRequest(), and wfTransactionalTimeLimit().

Referenced by handleRollbackRequest().

◆ getDescription()

RollbackAction::getDescription ( )

protected

Returns the description that goes below the \<h1\> tag.

Since: 1.17

Stability: stable: to override

Returns: string HTML

Reimplemented from Action.

Definition at line 85 of file RollbackAction.php.

◆ getFormFields()

RollbackAction::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Stability: stable: to override

Returns: array

Reimplemented from FormAction.

Definition at line 297 of file RollbackAction.php.

References Action\msg().

◆ getName()

RollbackAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from Action.

Definition at line 73 of file RollbackAction.php.

◆ getRestriction()

RollbackAction::getRestriction ( )

Get the permission required to perform this action.

Often, but not always, the same as the action name

Since: 1.17

Stability: stable: to override

Returns: string|null

Reimplemented from Action.

Definition at line 77 of file RollbackAction.php.

◆ handleRollbackRequest()

RollbackAction::handleRollbackRequest ( )

Definition at line 137 of file RollbackAction.php.

References enableTransactionalTimelimit(), Linker\formatComment(), getAuthority(), getContext(), Action\getOutput(), Action\getRequest(), getTitle(), Action\getUser(), Action\getWikiPage(), Action\msg(), Message\rawParam(), Linker\revUserTools(), and wfEscapeWikiText().

Referenced by show().

◆ onSubmit()

RollbackAction::onSubmit ( $data )

Process the form on POST submission.

If you don't want to do anything with the form, just return false here.

This method will be passed to the HTMLForm as a submit callback (see HTMLForm::setSubmitCallback) and must return as documented for HTMLForm::trySubmit.

See also: HTMLForm::setSubmitCallback(); HTMLForm::trySubmit()

Parameters

array $data

Returns: bool|string|array|Status Must return as documented for HTMLForm::trySubmit

Reimplemented from FormAction.

Definition at line 97 of file RollbackAction.php.

◆ onSuccess()

RollbackAction::onSuccess ( )

Do something exciting on successful processing of the form.

This might be to show a confirmation message (watch, rollback, etc) or to redirect somewhere else (edit, protect, etc).

Reimplemented from FormAction.

Definition at line 93 of file RollbackAction.php.

Referenced by showRollbackConfirmationForm().

◆ show()

RollbackAction::show ( )

Exceptions

ErrorPageError
ReadOnlyError
ThrottledError

Reimplemented from FormAction.

Definition at line 123 of file RollbackAction.php.

References Action\checkCanExecute(), Action\getUser(), handleRollbackRequest(), Action\setHeaders(), and showRollbackConfirmationForm().

◆ showRollbackConfirmationForm()

RollbackAction::showRollbackConfirmationForm ( )

private

Definition at line 290 of file RollbackAction.php.

References FormAction\getForm(), and onSuccess().

Referenced by show().

◆ usesOOUI()

RollbackAction::usesOOUI ( )

protected

Whether the form should use OOUI.

Stability: stable: to override

Returns: bool

Reimplemented from FormAction.

Definition at line 81 of file RollbackAction.php.

Member Data Documentation

◆ $contentHandlerFactory

IContentHandlerFactory RollbackAction::$contentHandlerFactory

private

Definition at line 39 of file RollbackAction.php.

◆ $rollbackPageFactory

RollbackPageFactory RollbackAction::$rollbackPageFactory

private

Definition at line 42 of file RollbackAction.php.

◆ $userOptionsLookup

UserOptionsLookup RollbackAction::$userOptionsLookup

private

Definition at line 45 of file RollbackAction.php.

◆ $watchlistManager

WatchlistManager RollbackAction::$watchlistManager

private

Definition at line 48 of file RollbackAction.php.

The documentation for this class was generated from the following file:

includes/actions/RollbackAction.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ doesWrites()

◆ enableTransactionalTimelimit()

◆ getDescription()

◆ getFormFields()

◆ getName()

◆ getRestriction()

◆ handleRollbackRequest()

◆ onSubmit()

◆ onSuccess()

◆ show()

◆ showRollbackConfirmationForm()

◆ usesOOUI()

Member Data Documentation

◆ $contentHandlerFactory

◆ $rollbackPageFactory

◆ $userOptionsLookup

◆ $watchlistManager