MediaWiki  master
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

 __construct (Page $page, IContextSource $context, SpecialPageFactory $specialPageFactory, string $actionName)
 
 doesWrites ()
 Indicates whether this action may perform database writes. More...
 
 getDescription ()
 Returns the description that goes below the \<h1\> tag. More...
 
 getName ()
 Return the name of the action this object responds to.
Since
1.17
Returns
string Lowercase name
More...
 
 onView ()
 Show something on GET request. More...
 
 requiresUnblock ()
 Whether this action can still be executed by a blocked user. 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...
 
 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...
 
 getWikiPage ()
 Get a WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. 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...
 
 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 Attributes

string $actionName
 Name of this action, must exist as a key in $actionToSpecialPageMapping. More...
 
SpecialPageFactory $specialPageFactory
 

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

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

Since
1.25

Definition at line 29 of file SpecialPageAction.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialPageAction::__construct ( Page  $page,
IContextSource  $context,
SpecialPageFactory  $specialPageFactory,
string  $actionName 
)
Parameters
Page$page
IContextSource$context
SpecialPageFactory$specialPageFactory
string$actionName

Definition at line 50 of file SpecialPageAction.php.

References $actionName, Action\$context, Action\$page, and $specialPageFactory.

Member Function Documentation

◆ doesWrites()

SpecialPageAction::doesWrites ( )

Indicates whether this action may perform database writes.

Returns
bool
Since
1.27
Stability: stable
to override

Reimplemented from Action.

Definition at line 97 of file SpecialPageAction.php.

References getSpecialPage().

◆ getDescription()

SpecialPageAction::getDescription ( )

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 77 of file SpecialPageAction.php.

◆ getName()

SpecialPageAction::getName ( )

Return the name of the action this object responds to.

Since
1.17
Returns
string Lowercase name

Reimplemented from Action.

Definition at line 69 of file SpecialPageAction.php.

References $actionName.

◆ getSpecialPage()

SpecialPageAction::getSpecialPage ( )
protected
Returns
SpecialPage|null

Definition at line 106 of file SpecialPageAction.php.

Referenced by doesWrites(), and show().

◆ onView()

SpecialPageAction::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 81 of file SpecialPageAction.php.

◆ requiresUnblock()

SpecialPageAction::requiresUnblock ( )

Whether this action can still be executed by a blocked user.

Since
1.17
Stability: stable
to override
Returns
bool

Reimplemented from Action.

Definition at line 73 of file SpecialPageAction.php.

◆ show()

SpecialPageAction::show ( )
Stability: stable
to override

Reimplemented from FormlessAction.

Definition at line 85 of file SpecialPageAction.php.

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

Member Data Documentation

◆ $actionName

string SpecialPageAction::$actionName
private

Name of this action, must exist as a key in $actionToSpecialPageMapping.

Definition at line 42 of file SpecialPageAction.php.

Referenced by __construct(), and getName().

◆ $actionToSpecialPageMapping

array SpecialPageAction::$actionToSpecialPageMapping
static
Initial value:
= [
'revisiondelete' => 'Revisiondelete',
'editchangetags' => 'EditTags',
]

A mapping of action names to special page names.

Definition at line 33 of file SpecialPageAction.php.

◆ $specialPageFactory

SpecialPageFactory SpecialPageAction::$specialPageFactory
private

Definition at line 39 of file SpecialPageAction.php.

Referenced by __construct().


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