Temporary action for restoring multi-content revisions. More...

Inherits MediaWiki\Actions\McrUndoAction.

Collaboration diagram for MediaWiki\Actions\McrRestoreAction:

[legend]

Public Member Functions

getDescription ()

Returns the description that goes below the <h1> element.

Since: 1.17

Stability: stable: to override

Returns: string HTML

getName ()

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Public Member Functions inherited from MediaWiki\Actions\McrUndoAction

__construct (Article $article, IContextSource $context, ReadOnlyMode $readOnlyMode, RevisionLookup $revisionLookup, RevisionRenderer $revisionRenderer, CommentFormatter $commentFormatter, Config $config)

getRestriction ()

Get the permission required to perform this action.Often, but not always, the same as the action nameImplementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.

Since: 1.17

Stability: stable: to override

Returns: string|null

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

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).

show ()

The basic pattern for actions is to display some sort of HTMLForm UI, maybe with some stuff underneath (history etc); to do some processing on submission of that form (delete, protect, etc) and to do something exciting on 'success', be that display something new or redirect to somewhere.Some actions have more exotic behavior, but that's what subclassing is for :D

Stability: stable: to override

Public Member Functions inherited from MediaWiki\Actions\FormAction

doesWrites ()

Public Member Functions inherited from MediaWiki\Actions\Action

__construct (Article $article, IContextSource $context)

Only public since 1.21.

addHelpLink ( $to, $overrideBaseUrl=false)

Adds help link with an icon via page indicators.

getArticle ()

Get a Article object.

getAuthority ()

Shortcut to get the Authority executing this instance.

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 ()

Indicates whether this action page write access to the wiki.

setHookContainer (HookContainer $hookContainer)

Protected Member Functions

addStatePropagationFields (HTMLForm $form)

alterForm (HTMLForm $form)

Play with the HTMLForm if you need to more substantially.

initFromParameters ()

Protected Member Functions inherited from MediaWiki\Actions\McrUndoAction

checkCanExecute (User $user)

Checks if the given user (identified by an object) can perform this action.Can be overridden by sub-classes with more complicated permissions schemes. Failures here must throw subclasses of ErrorPageError

Since: 1.17

Stability: stable: to override

Parameters

User $user

Exceptions

UserBlockedError|ReadOnlyError|PermissionsError

getFormFields ()

Get an HTMLForm descriptor array.

Stability: stable: to override

Returns: array

preText ()

Add pre- or post-text to the form.

Stability: stable: to override

Returns: string HTML which will be sent to $form->addPreHtml()

usesOOUI ()

Whether the form should use OOUI.

Stability: stable: to override

Returns: bool

Protected Member Functions inherited from MediaWiki\Actions\FormAction

getForm ()

Get the HTMLForm to control behavior.

postText ()

Protected Member Functions inherited from MediaWiki\Actions\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.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\Actions\Action
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 MediaWiki\Actions\McrUndoAction
int	$cur = 0

RevisionRecord null	$curRev = null

int	$undo = 0

int	$undoafter = 0

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

array	$fields
	The fields used to create the HTMLForm.