MediaWiki REL1_34
McrRestoreAction Class Reference

Temporary action for restoring multi-content revisions. More...

Inheritance diagram for McrRestoreAction:
Collaboration diagram for McrRestoreAction:

Public Member Functions

 getDescription ()
 Returns the description that goes below the \<h1\> tag.
 
 getName ()
 Return the name of the action this object responds to.
 
- Public Member Functions inherited from McrUndoAction
 onSubmit ( $data)
 Process the form on POST submission.
 
 onSuccess ()
 Do something exciting on successful processing of the form.
 
 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 FormAction
 doesWrites ()
 Indicates whether this action may perform database writes.
 
- 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.
 
 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.
 
 getRestriction ()
 Get the permission required to perform this action.
 
 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.
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 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

 addStatePropagationFields (HTMLForm $form)
 
 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially.
 
 initFromParameters ()
 
- Protected Member Functions inherited from McrUndoAction
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action.
 
 getFormFields ()
 Get an HTMLForm descriptor array.
 
 preText ()
 Add pre- or post-text to the form.
 
 usesOOUI ()
 Whether the form should use OOUI.
 
- Protected Member Functions inherited from FormAction
 getForm ()
 Get the HTMLForm to control behavior.
 
 postText ()
 
- Protected Member Functions inherited from Action
 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.
 

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.
 
static factory ( $action, Page $page, 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.
 
- Protected Attributes inherited from McrUndoAction
 $cur = 0
 
RevisionRecord null $curRev = null
 
 $undo = 0
 
 $undoafter = 0
 
- Protected Attributes inherited from Action
 $context
 IContextSource if specified; otherwise we'll use the Context from the Page.
 
 $fields
 The fields used to create the HTMLForm.
 
 $page
 Page on which we're performing the action.
 

Detailed Description

Temporary action for restoring multi-content revisions.

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

Since
1.32
Deprecated:
since 1.32

Definition at line 18 of file McrRestoreAction.php.

Member Function Documentation

◆ addStatePropagationFields()

McrRestoreAction::addStatePropagationFields ( HTMLForm  $form)
protected

Reimplemented from McrUndoAction.

Definition at line 44 of file McrRestoreAction.php.

References HTMLForm\addHiddenField().

◆ alterForm()

McrRestoreAction::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Parameters
HTMLForm$form

Reimplemented from McrUndoAction.

Definition at line 49 of file McrRestoreAction.php.

References HTMLForm\setWrapperLegendMsg().

◆ getDescription()

McrRestoreAction::getDescription ( )

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

Since
1.17
Returns
string HTML

Reimplemented from McrUndoAction.

Definition at line 24 of file McrRestoreAction.php.

◆ getName()

McrRestoreAction::getName ( )

Return the name of the action this object responds to.

Since
1.17
Returns
string Lowercase name

Reimplemented from McrUndoAction.

Definition at line 20 of file McrRestoreAction.php.

◆ initFromParameters()

McrRestoreAction::initFromParameters ( )
protected

Reimplemented from McrUndoAction.

Definition at line 28 of file McrRestoreAction.php.

References McrUndoAction\$cur, McrUndoAction\$curRev, and Action\getRequest().


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