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.
	getDescription ()
	Returns the description that goes below the <h1> element.
	getName ()
	Return the name of the action this object responds to. Since 1.17 Returns string Lowercase name
	onView ()
	Show something on GET request.
	requiresUnblock ()
	Whether this action can still be executed by a blocked user.
	show ()
Public Member Functions inherited from Action
	__construct (Page $page, IContextSource $context=null)
	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.
	getRestriction ()
	Get the permission required to perform this action.
	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.
	requiresWrite ()
	Whether this action requires the wiki not to be locked.

Static Public Attributes
static array	$actionToSpecialPageMapping
	A mapping of action names to special page names.

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.
	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	exists (string $name)
	Check if a given action is recognised, even if it's disabled.
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.
WikiPage Article ImagePage CategoryPage Page	$page
	Page on which we're performing the action.

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.

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

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.

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 getContext(), getSpecialPage(), and Action\msg().

Member Data Documentation

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

---

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

• includes/actions/SpecialPageAction.php