Temporary action for MCR undos. More...

Inherited by MediaWiki\Actions\McrRestoreAction.

Collaboration diagram for MediaWiki\Actions\McrUndoAction:

[legend]

Public Member Functions

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

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

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.

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

initFromParameters ()

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.

Protected Attributes
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.

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

Temporary action for MCR undos.

This is intended to go away when real MCR support is added to EditPage and the standard undo-with-edit behavior can be implemented there instead.

If this were going to be kept, we'd probably want to figure out a good way to reuse the same code for generating the headers, summary box, and buttons on EditPage and here, and to better share the diffing and preview logic between the two. But doing that now would require much of the rewriting of EditPage that we're trying to put off by doing this instead.

Since: 1.32

Definition at line 53 of file McrUndoAction.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Actions\McrUndoAction::__construct	(	Article	$article,
		IContextSource	$context,
		ReadOnlyMode	$readOnlyMode,
		RevisionLookup	$revisionLookup,
		RevisionRenderer	$revisionRenderer,
		CommentFormatter	$commentFormatter,
		Config	$config )

Parameters

Article	$article
IContextSource	$context
ReadOnlyMode	$readOnlyMode
RevisionLookup	$revisionLookup
RevisionRenderer	$revisionRenderer
CommentFormatter	$commentFormatter
Config	$config

Definition at line 77 of file McrUndoAction.php.

References MediaWiki\Actions\Action\$context, MediaWiki\Config\Config\get(), and MediaWiki\MainConfigNames\UseRCPatrol.

Member Function Documentation

◆ addStatePropagationFields()

MediaWiki\Actions\McrUndoAction::addStatePropagationFields ( HTMLForm $form )

protected

Reimplemented in MediaWiki\Actions\McrRestoreAction.

Definition at line 532 of file McrUndoAction.php.

References MediaWiki\HTMLForm\HTMLForm\addHiddenField().

◆ alterForm()

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

Reimplemented in MediaWiki\Actions\McrRestoreAction.

Definition at line 505 of file McrUndoAction.php.

References MediaWiki\HTMLForm\HTMLForm\addButton(), MediaWiki\MainConfigNames\EditSubmitButtonLabelPublish, MediaWiki\HTMLForm\HTMLForm\setCancelTarget(), MediaWiki\HTMLForm\HTMLForm\setId(), MediaWiki\HTMLForm\HTMLForm\setSubmitName(), MediaWiki\HTMLForm\HTMLForm\setSubmitTextMsg(), MediaWiki\HTMLForm\HTMLForm\setSubmitTooltip(), MediaWiki\HTMLForm\HTMLForm\setWrapperLegendMsg(), and MediaWiki\HTMLForm\HTMLForm\showCancel().

◆ checkCanExecute()

MediaWiki\Actions\McrUndoAction::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 179 of file McrUndoAction.php.

References MediaWiki\Actions\Action\getTitle(), and MediaWiki\Actions\McrUndoAction\initFromParameters().

◆ getDescription()

MediaWiki\Actions\McrUndoAction::getDescription ( )

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

Since: 1.17

Stability: stable: to override

Returns: string HTML

Reimplemented from MediaWiki\Actions\Action.

Reimplemented in MediaWiki\Actions\McrRestoreAction.

Definition at line 100 of file McrUndoAction.php.

◆ getFormFields()

MediaWiki\Actions\McrUndoAction::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 462 of file McrUndoAction.php.

◆ getName()

MediaWiki\Actions\McrUndoAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from MediaWiki\Actions\Action.

Reimplemented in MediaWiki\Actions\McrRestoreAction.

Definition at line 95 of file McrUndoAction.php.

◆ getRestriction()

MediaWiki\Actions\McrUndoAction::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 105 of file McrUndoAction.php.

◆ initFromParameters()

MediaWiki\Actions\McrUndoAction::initFromParameters ( )

protected

Reimplemented in MediaWiki\Actions\McrRestoreAction.

Definition at line 162 of file McrUndoAction.php.

References MediaWiki\Actions\McrUndoAction\$curRev, MediaWiki\Actions\Action\getRequest(), and MediaWiki\Actions\Action\getWikiPage().

Referenced by MediaWiki\Actions\McrUndoAction\checkCanExecute().

◆ onSubmit()

MediaWiki\Actions\McrUndoAction::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 371 of file McrUndoAction.php.

References EDIT_AUTOSUMMARY, EDIT_UPDATE, MediaWiki\CommentStore\CommentStoreComment\newUnsavedComment(), and MediaWiki\Storage\EditResult\REVERT_UNDO.

◆ onSuccess()

MediaWiki\Actions\McrUndoAction::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 539 of file McrUndoAction.php.

◆ preText()

MediaWiki\Actions\McrUndoAction::preText ( )

protected

Add pre- or post-text to the form.

Stability: stable: to override

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

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 544 of file McrUndoAction.php.

◆ show()

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

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 111 of file McrUndoAction.php.

References MediaWiki\Actions\Action\getOutput(), MediaWiki\Actions\Action\getRequest(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and MediaWiki\Actions\Action\useTransactionalTimeLimit().

◆ usesOOUI()

MediaWiki\Actions\McrUndoAction::usesOOUI ( )

protected

Whether the form should use OOUI.

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Actions\FormAction.

Definition at line 457 of file McrUndoAction.php.

Member Data Documentation

◆ $cur

int MediaWiki\Actions\McrUndoAction::$cur = 0

protected

Definition at line 57 of file McrUndoAction.php.

Referenced by MediaWiki\Actions\McrRestoreAction\initFromParameters().

◆ $curRev

RevisionRecord null MediaWiki\Actions\McrUndoAction::$curRev = null

protected

Definition at line 60 of file McrUndoAction.php.

Referenced by MediaWiki\Actions\McrRestoreAction\initFromParameters(), and MediaWiki\Actions\McrUndoAction\initFromParameters().

◆ $undo

int MediaWiki\Actions\McrUndoAction::$undo = 0

protected

Definition at line 55 of file McrUndoAction.php.

◆ $undoafter

int MediaWiki\Actions\McrUndoAction::$undoafter = 0

protected

Definition at line 56 of file McrUndoAction.php.

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

includes/Actions/McrUndoAction.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addStatePropagationFields()

◆ alterForm()

◆ checkCanExecute()

◆ getDescription()

◆ getFormFields()

◆ getName()

◆ getRestriction()

◆ initFromParameters()

◆ onSubmit()

◆ onSuccess()

◆ preText()

◆ show()

◆ usesOOUI()

Member Data Documentation

◆ $cur

◆ $curRev

◆ $undo

◆ $undoafter