MediaWiki  master
RollbackAction Class Reference

User interface for the rollback action. More...

Inheritance diagram for RollbackAction:
Collaboration diagram for RollbackAction:

Public Member Functions

 __construct (Page $page, ?IContextSource $context, IContentHandlerFactory $contentHandlerFactory, RollbackPageFactory $rollbackPageFactory, UserOptionsLookup $userOptionsLookup, WatchlistManager $watchlistManager)
 
 doesWrites ()
 
 getName ()
 Return the name of the action this object responds to. More...
 
 getRestriction ()
 Get the permission required to perform this action. More...
 
 handleRollbackRequest ()
 
 onSubmit ( $data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form. More...
 
 show ()
 
- 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...
 
 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...
 

Protected Member Functions

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

Private Member Functions

 enableTransactionalTimelimit ()
 Enables transactional time limit for POST and GET requests to RollbackAction. More...
 
 showRollbackConfirmationForm ()
 

Private Attributes

IContentHandlerFactory $contentHandlerFactory
 
RollbackPageFactory $rollbackPageFactory
 
UserOptionsLookup $userOptionsLookup
 
WatchlistManager $watchlistManager
 

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, Article $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...
 
- 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...
 

Detailed Description

User interface for the rollback action.

Definition at line 35 of file RollbackAction.php.

Constructor & Destructor Documentation

◆ __construct()

RollbackAction::__construct ( Page  $page,
?IContextSource  $context,
IContentHandlerFactory  $contentHandlerFactory,
RollbackPageFactory  $rollbackPageFactory,
UserOptionsLookup  $userOptionsLookup,
WatchlistManager  $watchlistManager 
)
Parameters
Page$page
IContextSource | null$context
IContentHandlerFactory$contentHandlerFactory
RollbackPageFactory$rollbackPageFactory
UserOptionsLookup$userOptionsLookup
WatchlistManager$watchlistManager

Definition at line 57 of file RollbackAction.php.

References $contentHandlerFactory, Action\$context, Action\$page, $rollbackPageFactory, $userOptionsLookup, and $watchlistManager.

Member Function Documentation

◆ alterForm()

RollbackAction::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Stability: stable
to override
Parameters
HTMLForm$form

Reimplemented from FormAction.

Definition at line 100 of file RollbackAction.php.

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

◆ doesWrites()

RollbackAction::doesWrites ( )
Stability: stable
to override
Returns
bool

Reimplemented from FormAction.

Definition at line 88 of file RollbackAction.php.

◆ enableTransactionalTimelimit()

RollbackAction::enableTransactionalTimelimit ( )
private

Enables transactional time limit for POST and GET requests to RollbackAction.

Exceptions
ConfigException

Definition at line 260 of file RollbackAction.php.

References DeferredUpdates\addCallableUpdate(), Action\getRequest(), Profiler\instance(), and wfTransactionalTimeLimit().

Referenced by handleRollbackRequest().

◆ getDescription()

RollbackAction::getDescription ( )
protected

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

Since
1.17
Stability: stable
to override
Returns
string HTML

Reimplemented from Action.

Definition at line 84 of file RollbackAction.php.

◆ getFormFields()

RollbackAction::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Stability: stable
to override
Returns
array

Reimplemented from FormAction.

Definition at line 286 of file RollbackAction.php.

References Action\msg().

◆ getName()

RollbackAction::getName ( )

Return the name of the action this object responds to.

Since
1.17
Returns
string Lowercase name

Reimplemented from Action.

Definition at line 72 of file RollbackAction.php.

◆ getRestriction()

RollbackAction::getRestriction ( )

Get the permission required to perform this action.

Often, but not always, the same as the action name

Since
1.17
Stability: stable
to override
Returns
string|null

Reimplemented from Action.

Definition at line 76 of file RollbackAction.php.

◆ handleRollbackRequest()

◆ onSubmit()

RollbackAction::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 96 of file RollbackAction.php.

◆ onSuccess()

RollbackAction::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 92 of file RollbackAction.php.

Referenced by showRollbackConfirmationForm().

◆ show()

RollbackAction::show ( )
Exceptions
ErrorPageError
ReadOnlyError
ThrottledError

Reimplemented from FormAction.

Definition at line 122 of file RollbackAction.php.

References handleRollbackRequest(), and showRollbackConfirmationForm().

◆ showRollbackConfirmationForm()

RollbackAction::showRollbackConfirmationForm ( )
private

Definition at line 279 of file RollbackAction.php.

References FormAction\getForm(), and onSuccess().

Referenced by show().

◆ usesOOUI()

RollbackAction::usesOOUI ( )
protected

Whether the form should use OOUI.

Stability: stable
to override
Returns
bool

Reimplemented from FormAction.

Definition at line 80 of file RollbackAction.php.

Member Data Documentation

◆ $contentHandlerFactory

IContentHandlerFactory RollbackAction::$contentHandlerFactory
private

Definition at line 38 of file RollbackAction.php.

Referenced by __construct().

◆ $rollbackPageFactory

RollbackPageFactory RollbackAction::$rollbackPageFactory
private

Definition at line 41 of file RollbackAction.php.

Referenced by __construct().

◆ $userOptionsLookup

UserOptionsLookup RollbackAction::$userOptionsLookup
private

Definition at line 44 of file RollbackAction.php.

Referenced by __construct().

◆ $watchlistManager

WatchlistManager RollbackAction::$watchlistManager
private

Definition at line 47 of file RollbackAction.php.

Referenced by __construct().


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