MediaWiki  1.23.2
RollbackAction Class Reference

User interface for the rollback action. More...

Inheritance diagram for RollbackAction:
Collaboration diagram for RollbackAction:

Public Member Functions

 getName ()
 Return the name of the action this object responds to. More...
 
 getRestriction ()
 Get the permission required to perform this action. More...
 
 onView ()
 Show something on GET request. More...
 
- Public Member Functions inherited from FormlessAction
 execute (array $data=null, $captureErrors=true)
 Execute the action silently, not giving any output. More...
 
 onSubmit ( $data)
 
 onSuccess ()
 
 show ()
 The main action entry point. More...
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Constructor. More...
 
 execute ()
 Execute the action in a silent fashion: do not display anything or release any errors. More...
 
 getContext ()
 Get the IContextSource in use here. More...
 
 getLang ()
 Shortcut to get the user Language being used for this instance. 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...
 
 msg ()
 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

 getDescription ()
 Returns the description that goes below the <h1> tag. More...
 
- Protected Member Functions inherited from FormlessAction
 getFormFields ()
 We don't want an HTMLForm. More...
 
- Protected Member Functions inherited from Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getPageTitle ()
 Returns the name that goes in the <h1> page title. More...
 
 setHeaders ()
 Set output headers for noindexing etc. More...
 

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...
 
- Protected Attributes inherited from Action
IContextSource $context
 IContextSource if specified; otherwise we'll use the Context from the Page $context. More...
 
array $fields
 The fields used to create the HTMLForm $fields. More...
 
WikiPage Article ImagePage CategoryPage Page $page
 Page on which we're performing the action $page. More...
 

Detailed Description

User interface for the rollback action.

Definition at line 28 of file RollbackAction.php.

Member Function Documentation

◆ getDescription()

RollbackAction::getDescription ( )
protected

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

Returns
string

Reimplemented from Action.

Definition at line 117 of file RollbackAction.php.

◆ getName()

RollbackAction::getName ( )

Return the name of the action this object responds to.

Returns
string Lowercase name

Reimplemented from Action.

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

Returns
string|null

Reimplemented from Action.

Definition at line 34 of file RollbackAction.php.

◆ onView()

RollbackAction::onView ( )

Show something on GET request.

Returns
string|null Will be added to the HTMLForm if present, or just added to the output if not. Return null to not add anything

Reimplemented from FormlessAction.

Definition at line 38 of file RollbackAction.php.

References $error, array(), as, Linker\formatComment(), Action\getContext(), Action\getOutput(), Action\getRequest(), Action\getTitle(), Action\getUser(), Action\msg(), page, Linker\revUserTools(), and true.


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