File reversion user interface WikiPage must contain getFile method: \WikiFilePage Article::getFile is only for b/c: \ImagePage. More...

Inheritance diagram for RevertAction:

[legend]

Collaboration diagram for RevertAction:

[legend]

Public Member Functions
	doesWrites ()
	Stable to override.

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

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

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

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

Public Member Functions inherited from FormAction
	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.

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 Stable to override.

	checkCanExecute (User $user)
	Checks if the given user (identified by an object) can perform this action.

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

	getFormFields ()
	Get an HTMLForm descriptor array Stable to override.

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

	usesOOUI ()
	Whether the form should use OOUI Stable to override.

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

	postText ()
	Stable to override.

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

Protected Member Functions inherited from Action
	getHookContainer ()

	getHookRunner ()

	setHeaders ()
	Set output headers for noindexing etc.

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

Protected Attributes
OldLocalFile	$oldFile

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.

Private Member Functions
	getFile ()

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, Page $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.

Detailed Description

File reversion user interface WikiPage must contain getFile method: \WikiFilePage Article::getFile is only for b/c: \ImagePage.

Definition at line 35 of file RevertAction.php.

Member Function Documentation

◆ alterForm()

RevertAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially Stable to override.

Parameters

HTMLForm $form

Reimplemented from FormAction.

Definition at line 75 of file RevertAction.php.

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

◆ checkCanExecute()

RevertAction::checkCanExecute ( User $user )

protected

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 Stable to override

Parameters

User $user

Exceptions

UserBlockedError|ReadOnlyError|PermissionsError

Reimplemented from Action.

Definition at line 49 of file RevertAction.php.

References Action\getRequest(), Action\getTitle(), Action\msg(), and NS_FILE.

◆ doesWrites()

RevertAction::doesWrites ( )

Stable to override.

Returns: bool

Reimplemented from FormAction.

Definition at line 178 of file RevertAction.php.

◆ getDescription()

RevertAction::getDescription ( )

protected

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

Since: 1.17 Stable to override

Returns: string HTML

Reimplemented from Action.

Definition at line 174 of file RevertAction.php.

References Action\getTitle().

◆ getFile()

RevertAction::getFile ( )

private

Since: 1.35

Returns: File

Definition at line 186 of file RevertAction.php.

Referenced by getFormFields(), onSubmit(), and onSuccess().

◆ getFormFields()

RevertAction::getFormFields ( )

protected

Get an HTMLForm descriptor array Stable to override.

Returns: array

Reimplemented from FormAction.

Definition at line 82 of file RevertAction.php.

References $lang, getFile(), Action\getLanguage(), Action\getRequest(), Action\getTitle(), Action\getUser(), Action\msg(), PROTO_CURRENT, and wfExpandUrl().

◆ getName()

RevertAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from Action.

Definition at line 41 of file RevertAction.php.

◆ getPageTitle()

RevertAction::getPageTitle ( )

protected

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

Stable to override

Returns: string

Reimplemented from Action.

Definition at line 170 of file RevertAction.php.

References Action\getTitle(), and Action\msg().

◆ getRestriction()

RevertAction::getRestriction ( )

Get the permission required to perform this action.

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

Since: 1.17 Stable to override

Returns: string|null

Reimplemented from Action.

Definition at line 45 of file RevertAction.php.

◆ onSubmit()

RevertAction::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 120 of file RevertAction.php.

References $oldFile, $source, getFile(), Action\getRequest(), LocalFile\getSha1(), Action\getTitle(), Action\getUser(), OldLocalFile\newFromArchiveName(), and Action\useTransactionalTimeLimit().

◆ onSuccess()

RevertAction::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 151 of file RevertAction.php.

References $lang, getFile(), Action\getLanguage(), Action\getOutput(), Action\getRequest(), Action\getTitle(), Action\getUser(), PROTO_CURRENT, and wfExpandUrl().

◆ usesOOUI()

RevertAction::usesOOUI ( )

protected

Whether the form should use OOUI Stable to override.

Returns: bool

Reimplemented from FormAction.

Definition at line 71 of file RevertAction.php.

Member Data Documentation

◆ $oldFile

OldLocalFile RevertAction::$oldFile

protected

Definition at line 39 of file RevertAction.php.

Referenced by onSubmit().

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

includes/actions/RevertAction.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ alterForm()

◆ checkCanExecute()

◆ doesWrites()

◆ getDescription()

◆ getFile()

◆ getFormFields()

◆ getName()

◆ getPageTitle()

◆ getRestriction()

◆ onSubmit()

◆ onSuccess()

◆ usesOOUI()

Member Data Documentation

◆ $oldFile