MediaWiki  master
McrUndoAction Class Reference

Temporary action for MCR undos. More...

Inheritance diagram for McrUndoAction:
Collaboration diagram for McrUndoAction:

Public Member Functions

 getDescription ()
 
 getName ()
 
 onSubmit ( $data)
 
 onSuccess ()
 
 show ()
 
- Public Member Functions inherited from FormAction
 doesWrites ()
 
 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 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...
 
 doesWrites ()
 Indicates whether this action may perform database writes. More...
 
 getContext ()
 Get the IContextSource in use here. More...
 
 getLanguage ()
 Shortcut to get the user Language being used for this instance. More...
 
 getName ()
 Return the name of the action this object responds to. 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...
 
 msg ( $key)
 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...
 
 show ()
 The main action entry point. More...
 

Public Attributes

 $cur = 0
 
 $undoafter = 0
 

Protected Member Functions

 addStatePropagationFields (HTMLForm $form)
 
 alterForm (HTMLForm $form)
 
 checkCanExecute (User $user)
 
 getFormFields ()
 
 initFromParameters ()
 
 preText ()
 
 usesOOUI ()
 
- Protected Member Functions inherited from FormAction
 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
 postText ()
 
 preText ()
 Add pre- or post-text to the form. More...
 
 usesOOUI ()
 Whether the form should use OOUI. More...
 
- Protected Member Functions inherited from Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getDescription ()
 Returns the description that goes below the \<h1\> tag. More...
 
 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
 $context
 IContextSource if specified; otherwise we'll use the Context from the Page. More...
 
 $fields
 The fields used to create the HTMLForm. More...
 
 $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 ( $name)
 Check if a given action is recognised, even if it's disabled. More...
 
static factory ( $action, Page $page, 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

Definition at line 432 of file McrUndoAction.php.

References HTMLForm\addHiddenField(), and undo.

Referenced by alterForm().

◆ alterForm()

◆ checkCanExecute()

McrUndoAction::checkCanExecute ( User  $user)
protected

Definition at line 109 of file McrUndoAction.php.

References initFromParameters(), null, and undo.

◆ generateDiffOrPreview()

McrUndoAction::generateDiffOrPreview ( )
private

Definition at line 226 of file McrUndoAction.php.

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

Referenced by getFormFields().

◆ getDescription()

McrUndoAction::getDescription ( )

Definition at line 40 of file McrUndoAction.php.

◆ getFormFields()

◆ getName()

McrUndoAction::getName ( )

Definition at line 36 of file McrUndoAction.php.

◆ getNewRevision()

McrUndoAction::getNewRevision ( )
private
Returns
MutableRevisionRecord

Definition at line 132 of file McrUndoAction.php.

References $curRev, $newRev, as, Revision\RevisionRecord\getId(), null, and undo.

Referenced by generateDiffOrPreview(), and onSubmit().

◆ initFromParameters()

McrUndoAction::initFromParameters ( )
protected

Definition at line 93 of file McrUndoAction.php.

References Action\getRequest(), page, and undo.

Referenced by checkCanExecute().

◆ onSubmit()

◆ onSuccess()

McrUndoAction::onSuccess ( )

Definition at line 438 of file McrUndoAction.php.

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

◆ preText()

McrUndoAction::preText ( )
protected

Definition at line 442 of file McrUndoAction.php.

◆ show()

◆ showPreview()

McrUndoAction::showPreview ( RevisionRecord  $rev)
private

◆ usesOOUI()

McrUndoAction::usesOOUI ( )
protected

Definition at line 361 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

Definition at line 34 of file McrUndoAction.php.

Referenced by getNewRevision(), and McrRestoreAction\initFromParameters().

◆ $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: