MediaWiki master
RollbackAction Class Reference

User interface for the rollback action. More...

Inherits FormAction.

Collaboration diagram for RollbackAction:

Public Member Functions

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

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

Additional Inherited Members

- Static Public Member Functions inherited from 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.
 
- Protected Attributes inherited from 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.
 

Detailed Description

User interface for the rollback action.

Definition at line 44 of file RollbackAction.php.

Constructor & Destructor Documentation

◆ __construct()

RollbackAction::__construct ( Article $article,
IContextSource $context,
IContentHandlerFactory $contentHandlerFactory,
RollbackPageFactory $rollbackPageFactory,
UserOptionsLookup $userOptionsLookup,
WatchlistManager $watchlistManager,
CommentFormatter $commentFormatter )
Parameters
Article$article
IContextSource$context
IContentHandlerFactory$contentHandlerFactory
RollbackPageFactory$rollbackPageFactory
UserOptionsLookup$userOptionsLookup
WatchlistManager$watchlistManager
CommentFormatter$commentFormatter

Definition at line 61 of file RollbackAction.php.

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

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

◆ doesWrites()

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

Reimplemented from FormAction.

Definition at line 94 of file RollbackAction.php.

◆ getDescription()

RollbackAction::getDescription ( )
protected

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

Since
1.17
Stability: stable
to override
Returns
string HTML

Reimplemented from Action.

Definition at line 90 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 312 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 78 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

Implementations 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 Action.

Definition at line 82 of file RollbackAction.php.

◆ handleRollbackRequest()

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

◆ show()

RollbackAction::show ( )

◆ usesOOUI()

RollbackAction::usesOOUI ( )
protected

Whether the form should use OOUI.

Stability: stable
to override
Returns
bool

Reimplemented from FormAction.

Definition at line 86 of file RollbackAction.php.


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