MediaWiki  1.28.0
SpecialPageAction Class Reference

An action that just passes the request to the relevant special page. More...

Inheritance diagram for SpecialPageAction:
Collaboration diagram for SpecialPageAction:

Public Member Functions

 doesWrites ()
 
 getDescription ()
 
static array getName ()
 
 onView ()
 
 requiresUnblock ()
 
 show ()
 
- Public Member Functions inherited from FormlessAction
 onView ()
 Show something on GET request. More...
 
 show ()
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Constructor. 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 ()
 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...
 

Static Public Attributes

static array $actionToSpecialPageMapping
 A mapping of action names to special page names. More...
 

Protected Member Functions

 getSpecialPage ()
 
- 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...
 

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

Detailed Description

An action that just passes the request to the relevant special page.

Since
1.25

Definition at line 27 of file SpecialPageAction.php.

Member Function Documentation

SpecialPageAction::doesWrites ( )

Definition at line 79 of file SpecialPageAction.php.

References $special, and getSpecialPage().

SpecialPageAction::getDescription ( )

Definition at line 59 of file SpecialPageAction.php.

static array SpecialPageAction::getName ( )

Definition at line 36 of file SpecialPageAction.php.

References $request, and Action\getRequest().

Referenced by getSpecialPage().

SpecialPageAction::getSpecialPage ( )
protected
Returns
SpecialPage|null

Definition at line 88 of file SpecialPageAction.php.

References getName(), and SpecialPageFactory\getPage().

Referenced by doesWrites(), and show().

SpecialPageAction::onView ( )

Definition at line 63 of file SpecialPageAction.php.

SpecialPageAction::requiresUnblock ( )

Definition at line 55 of file SpecialPageAction.php.

SpecialPageAction::show ( )

Definition at line 67 of file SpecialPageAction.php.

References $special, Action\getContext(), getSpecialPage(), and Action\msg().

Member Data Documentation

array SpecialPageAction::$actionToSpecialPageMapping
static
Initial value:
= [
'revisiondelete' => 'Revisiondelete'

A mapping of action names to special page names.

Definition at line 31 of file SpecialPageAction.php.


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