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

Inherits MediaWiki\Actions\FormAction.

Collaboration diagram for MediaWiki\Actions\RevertAction:

[legend]

Public Member Functions

__construct (Article $article, IContextSource $context, Language $contentLanguage, RepoGroup $repoGroup)

doesWrites ()

Stability: stable: to override

Returns: bool

getName ()

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

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

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

alterForm (HTMLForm $form)

Play with the HTMLForm if you need to more substantially.

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

getDescription ()

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

Since: 1.17

Stability: stable: to override

Returns: string HTML

getFormFields ()

Get an HTMLForm descriptor array.

Stability: stable: to override

Returns: array

getPageTitle ()

Returns the name that goes in the <h1> page title.Since 1.45, returning a string from this method is no longer allowed.

Stability: stable: to override

Returns: Message

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

preText ()

Add pre- or post-text to the form.

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

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.

Detailed Description

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

Definition at line 39 of file RevertAction.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Actions\RevertAction::__construct	(	Article	$article,
		IContextSource	$context,
		Language	$contentLanguage,
		RepoGroup	$repoGroup )

Parameters

Article	$article
IContextSource	$context
Language	$contentLanguage
RepoGroup	$repoGroup

Definition at line 50 of file RevertAction.php.

References MediaWiki\Actions\Action\$context.

Member Function Documentation

◆ alterForm()

MediaWiki\Actions\RevertAction::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Stability: stable: to override

Parameters

HTMLForm $form

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 115 of file RevertAction.php.

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

◆ checkCanExecute()

MediaWiki\Actions\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

Stability: stable: to override

Parameters

User $user

Exceptions

UserBlockedError|ReadOnlyError|PermissionsError

Reimplemented from MediaWiki\Actions\Action.

Definition at line 78 of file RevertAction.php.

References MediaWiki\User\User\equals(), MediaWiki\Actions\Action\getRequest(), MediaWiki\Actions\Action\getTitle(), MediaWiki\User\User\isAllowedAny(), MediaWiki\Actions\Action\msg(), and NS_FILE.

◆ doesWrites()

MediaWiki\Actions\RevertAction::doesWrites ( )

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 223 of file RevertAction.php.

◆ getDescription()

MediaWiki\Actions\RevertAction::getDescription ( )

protected

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

Since: 1.17

Stability: stable: to override

Returns: string HTML

Reimplemented from MediaWiki\Actions\Action.

Definition at line 218 of file RevertAction.php.

References MediaWiki\Actions\Action\getTitle().

◆ getFormFields()

MediaWiki\Actions\RevertAction::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 123 of file RevertAction.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Actions\Action\getLanguage(), MediaWiki\Actions\Action\getRequest(), MediaWiki\Actions\Action\getTitle(), MediaWiki\Actions\Action\getUser(), MediaWiki\Actions\Action\msg(), and PROTO_CURRENT.

◆ getName()

MediaWiki\Actions\RevertAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from MediaWiki\Actions\Action.

Definition at line 67 of file RevertAction.php.

◆ getPageTitle()

MediaWiki\Actions\RevertAction::getPageTitle ( )

protected

Returns the name that goes in the <h1> page title.Since 1.45, returning a string from this method is no longer allowed.

Stability: stable: to override

Returns: Message

Reimplemented from MediaWiki\Actions\Action.

Definition at line 213 of file RevertAction.php.

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

◆ getRestriction()

MediaWiki\Actions\RevertAction::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

Reimplemented from MediaWiki\Actions\Action.

Definition at line 72 of file RevertAction.php.

◆ onSubmit()

MediaWiki\Actions\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 MediaWiki\Actions\FormAction.

Definition at line 161 of file RevertAction.php.

References MediaWiki\Actions\RevertAction\$oldFile, $source, MediaWiki\Actions\Action\getAuthority(), MediaWiki\Actions\Action\getRequest(), MediaWiki\FileRepo\File\LocalFile\getSha1(), MediaWiki\Actions\Action\getTitle(), and MediaWiki\Actions\Action\useTransactionalTimeLimit().

◆ onSuccess()

MediaWiki\Actions\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 MediaWiki\Actions\FormAction.

Definition at line 193 of file RevertAction.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Actions\Action\getLanguage(), MediaWiki\Actions\Action\getOutput(), MediaWiki\Actions\Action\getRequest(), MediaWiki\Actions\Action\getTitle(), MediaWiki\Actions\Action\getUser(), and PROTO_CURRENT.

◆ usesOOUI()

MediaWiki\Actions\RevertAction::usesOOUI ( )

protected

Whether the form should use OOUI.

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 111 of file RevertAction.php.

Member Data Documentation

◆ $oldFile

OldLocalFile MediaWiki\Actions\RevertAction::$oldFile

protected

Definition at line 64 of file RevertAction.php.

Referenced by MediaWiki\Actions\RevertAction\onSubmit().

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

includes/Actions/RevertAction.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ checkCanExecute()

◆ doesWrites()

◆ getDescription()

◆ getFormFields()

◆ getName()

◆ getPageTitle()

◆ getRestriction()

◆ onSubmit()

◆ onSuccess()

◆ usesOOUI()

Member Data Documentation

◆ $oldFile