MediaWiki  master
McrUndoAction Class Reference

Temporary action for MCR undos. More...

Inheritance diagram for McrUndoAction:
Collaboration diagram for McrUndoAction:

Public Member Functions

 getDescription ()
 Returns the description that goes below the \<h1\> tag. More...
 
 getName ()
 Return the name of the action this object responds to. More...
 
 onSubmit ( $data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form. More...
 
 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. More...
 
- Public Member Functions inherited from FormAction
 doesWrites ()
 Indicates whether this action may perform database writes. More...
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Only public since 1.21. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 getArticle ()
 Get a Article object. More...
 
 getContext ()
 Get the IContextSource in use here. More...
 
 getLanguage ()
 Shortcut to get the user Language being used for this instance. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission required to perform this action. More...
 
 getSkin ()
 Shortcut to get the Skin being used for this instance. More...
 
 getTitle ()
 Shortcut to get the Title object from the page. More...
 
 getUser ()
 Shortcut to get the User being used for this instance. More...
 
 getWikiPage ()
 Get a WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 requiresUnblock ()
 Whether this action can still be executed by a blocked user. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 

Public Attributes

 $cur = 0
 
 $undoafter = 0
 

Protected Member Functions

 addStatePropagationFields (HTMLForm $form)
 
 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
 initFromParameters ()
 
 preText ()
 Add pre- or post-text to the form. More...
 
 usesOOUI ()
 Whether the form should use OOUI. More...
 
- Protected Member Functions inherited from FormAction
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 postText ()
 
- Protected Member Functions inherited from Action
 getHookContainer ()
 
 getHookRunner ()
 
 getPageTitle ()
 Returns the name that goes in the \<h1\> page title. More...
 
 setHeaders ()
 Set output headers for noindexing etc. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

RevisionRecord null $curRev = null
 
 $undo = 0
 
- Protected Attributes inherited from Action
IContextSource $context
 IContextSource if specified; otherwise we'll use the Context from the Page. More...
 
array $fields
 The fields used to create the HTMLForm. More...
 
WikiPage Article ImagePage CategoryPage Page $page
 Page on which we're performing the action. More...
 

Private Member Functions

 generateDiffOrPreview ()
 
 getNewRevision ()
 
 showPreview (RevisionRecord $rev)
 

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. More...
 
static factory (?string $action, Page $article, IContextSource $context=null)
 Get an appropriate Action subclass for the given action. More...
 
static getActionName (IContextSource $context)
 Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter. More...
 

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
Deprecated:
since 1.32

Definition at line 29 of file McrUndoAction.php.

Member Function Documentation

◆ addStatePropagationFields()

McrUndoAction::addStatePropagationFields ( HTMLForm  $form)
protected

Reimplemented in McrRestoreAction.

Definition at line 433 of file McrUndoAction.php.

References HTMLForm\addHiddenField().

Referenced by alterForm().

◆ alterForm()

◆ checkCanExecute()

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
Parameters
User$user
Exceptions
UserBlockedError|ReadOnlyError|PermissionsError

Reimplemented from Action.

Definition at line 109 of file McrUndoAction.php.

References initFromParameters().

◆ generateDiffOrPreview()

McrUndoAction::generateDiffOrPreview ( )
private

Definition at line 226 of file McrUndoAction.php.

References getNewRevision(), Action\getRequest(), and showPreview().

Referenced by getFormFields().

◆ getDescription()

McrUndoAction::getDescription ( )

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

Since
1.17
Returns
string HTML

Reimplemented from Action.

Reimplemented in McrRestoreAction.

Definition at line 40 of file McrUndoAction.php.

◆ getFormFields()

McrUndoAction::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Returns
array

Reimplemented from FormAction.

Definition at line 366 of file McrUndoAction.php.

References CommentStore\COMMENT_CHARACTER_LIMIT, Linker\commentBlock(), generateDiffOrPreview(), Action\getRequest(), and Xml\tags().

◆ getName()

McrUndoAction::getName ( )

Return the name of the action this object responds to.

Since
1.17
Returns
string Lowercase name

Reimplemented from Action.

Reimplemented in McrRestoreAction.

Definition at line 36 of file McrUndoAction.php.

◆ getNewRevision()

◆ initFromParameters()

McrUndoAction::initFromParameters ( )
protected

Reimplemented in McrRestoreAction.

Definition at line 93 of file McrUndoAction.php.

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

Referenced by checkCanExecute().

◆ onSubmit()

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

Definition at line 305 of file McrUndoAction.php.

References $curRev, $wgUseRCPatrol, EDIT_AUTOSUMMARY, EDIT_UPDATE, Revision\RevisionRecord\getId(), getNewRevision(), Action\getRequest(), Revision\RevisionRecord\getSlotRoles(), Action\getWikiPage(), StatusValue\newFatal(), StatusValue\newGood(), CommentStoreComment\newUnsavedComment(), and RecentChange\PRC_AUTOPATROLLED.

◆ onSuccess()

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

Definition at line 439 of file McrUndoAction.php.

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

◆ preText()

McrUndoAction::preText ( )
protected

Add pre- or post-text to the form.

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

Reimplemented from FormAction.

Definition at line 443 of file McrUndoAction.php.

◆ show()

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

Reimplemented from FormAction.

Definition at line 44 of file McrUndoAction.php.

References Action\getContext(), MediaWiki\Session\SessionManager\getGlobalSession(), Action\getOutput(), Action\getRequest(), Action\getTitle(), SpecialPage\getTitleFor(), Action\useTransactionalTimeLimit(), wfReadOnly(), and wfReadOnlyReason().

◆ showPreview()

McrUndoAction::showPreview ( RevisionRecord  $rev)
private

◆ usesOOUI()

McrUndoAction::usesOOUI ( )
protected

Whether the form should use OOUI.

Returns
bool

Reimplemented from FormAction.

Definition at line 362 of file McrUndoAction.php.

Member Data Documentation

◆ $cur

McrUndoAction::$cur = 0

Definition at line 31 of file McrUndoAction.php.

Referenced by McrRestoreAction\initFromParameters().

◆ $curRev

RevisionRecord null McrUndoAction::$curRev = null
protected

◆ $undo

McrUndoAction::$undo = 0
protected

Definition at line 31 of file McrUndoAction.php.

◆ $undoafter

McrUndoAction::$undoafter = 0

Definition at line 31 of file McrUndoAction.php.


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