Actions are things which can be done to pages (edit, delete, rollback, etc). More...

Inheritance diagram for Action:

[legend]

Collaboration diagram for Action:

Public Member Functions
	__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...

	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 ( $key,... $params)
	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 Member Functions
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 Member Functions
	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...

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

Static Private Member Functions
static	getClass ( $action, array $overrides)
	Get the Action subclass which should be used to handle this action, false if the action is disabled, or null if it's not recognised. More...

Detailed Description

Actions are things which can be done to pages (edit, delete, rollback, etc).

They are distinct from Special Pages because an action must apply to exactly one page.

To add an action in an extension, create a subclass of Action, and add the key to $wgActions.

Actions generally fall into two groups: the show-a-form-then-do-something-with-the-input format (protect, delete, move, etc), and the just-do-something format (watch, rollback, patrol, etc). The FormAction and FormlessAction classes represent these two groups.

Definition at line 39 of file Action.php.

Constructor & Destructor Documentation

◆ __construct()

Action::__construct	(	Page	$page,
		IContextSource	$context = `null`
	)

Only public since 1.21.

Parameters

Page	$page
IContextSource \| null	$context

Definition at line 269 of file Action.php.

References $context, $page, and wfWarn().

Member Function Documentation

◆ addHelpLink()

Action::addHelpLink	(	$to,
		$overrideBaseUrl = `false`
	)

Adds help link with an icon via page indicators.

Link target can be overridden by a local message containing a wikilink: the message key is: lowercase action name + '-helppage'.

Parameters

string	$to	Target MediaWiki.org page title or encoded URL.
bool	$overrideBaseUrl	Whether $url is a full URL, to avoid MW.o.

Since: 1.25

Definition at line 395 of file Action.php.

References getContext(), getOutput(), Skin\makeUrl(), and wfMessage().

Referenced by InfoAction\onView(), HistoryAction\onView(), and DeleteAction\show().

◆ checkCanExecute()

Action::checkCanExecute ( User $user )

protected

Checks if the given user (identified by an object) can perform this action.

Can be overridden by sub-classes with more complicated permissions schemes. Failures here must throw subclasses of ErrorPageError

Since: 1.17

Parameters

User $user The user to check, or null to use the context user

Exceptions

UserBlockedError|ReadOnlyError|PermissionsError

Reimplemented in McrUndoAction, WatchAction, and RevertAction.

Definition at line 308 of file Action.php.

References User\getBlock(), getName(), getRestriction(), getTitle(), User\isBlockedFrom(), requiresUnblock(), requiresWrite(), and wfReadOnly().

Referenced by FormlessAction\show(), PurgeAction\show(), and FormAction\show().

◆ doesWrites()

Action::doesWrites ( )

Indicates whether this action may perform database writes.

Returns: bool

Since: 1.27

Reimplemented in WatchAction, RevertAction, FormAction, MarkpatrolledAction, PurgeAction, SpecialPageAction, UnwatchAction, EditAction, ProtectAction, RollbackAction, DeleteAction, and UnprotectAction.

Definition at line 433 of file Action.php.

◆ exists()

static Action::exists ( $name )

staticfinal

Check if a given action is recognised, even if it's disabled.

Since: 1.17

Parameters

string $name Name of an action

Returns: bool

Definition at line 170 of file Action.php.

References getClass().

Referenced by MediaWiki\Permissions\PermissionManager\checkUserBlock(), and HistoryAction\fetchRevisions().

◆ factory()

static Action::factory	(		$action,
		Page	$page,
		IContextSource	$context = `null`
	)

staticfinal

Get an appropriate Action subclass for the given action.

Since: 1.17

Parameters

string	$action
Page	$page
IContextSource \| null	$context

Returns: Action|bool|null False if the action is disabled, null if it is not recognised

Definition at line 97 of file Action.php.

References $context, $page, and getClass().

Referenced by MediaWiki\Permissions\PermissionManager\checkUserBlock(), RebuildFileCache\execute(), getActionName(), MediaWiki\performAction(), and SkinTemplate\prepareQuickTemplate().

◆ getActionName()

static Action::getActionName ( IContextSource $context )

staticfinal

Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter.

Actions disabled in $wgActions will be replaced by "nosuchaction".

Since: 1.19

Parameters

IContextSource $context

Returns: string Action name

Definition at line 123 of file Action.php.

References $context, $wgActions, and factory().

Referenced by SkinTemplate\buildContentNavigationUrls(), MediaWiki\getAction(), OutputPage\getHeadLinksArray(), OutputPage\getJSVars(), OutputPage\headElement(), and SkinTemplate\wrapHTML().

◆ getClass()

static Action::getClass	(		$action,
		array	$overrides
	)

staticfinalprivate

Get the Action subclass which should be used to handle this action, false if the action is disabled, or null if it's not recognised.

Parameters

string	$action
array	$overrides

Returns: bool|null|string|callable|Action

Definition at line 69 of file Action.php.

References $wgActions.

Referenced by exists(), and factory().

◆ getContext()

Action::getContext ( )

final

Get the IContextSource in use here.

Since: 1.17

Returns: IContextSource

Definition at line 179 of file Action.php.

References $context, RequestContext\getMain(), wfDebug(), and wfWarn().

Referenced by addHelpLink(), HistoryAction\getDescription(), FormAction\getForm(), getLanguage(), getOutput(), RawAction\getRawText(), getRequest(), getSkin(), getUser(), RollbackAction\handleRollbackRequest(), HistoryAction\hasUnseenRevisionMarkers(), msg(), InfoAction\onView(), HistoryAction\onView(), InfoAction\pageInfo(), ProtectAction\show(), EditAction\show(), McrUndoAction\show(), and SpecialPageAction\show().

◆ getDescription()

Action::getDescription ( )

protected

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

Since: 1.17

Returns: string HTML

Reimplemented in InfoAction, RevertAction, SpecialPageAction, HistoryAction, RollbackAction, McrUndoAction, PurgeAction, WatchAction, CreditsAction, MarkpatrolledAction, and McrRestoreAction.

Definition at line 383 of file Action.php.

References getName(), and msg().

Referenced by setHeaders().

◆ getLanguage()

Action::getLanguage ( )

final

Shortcut to get the user Language being used for this instance.

Returns: Language

Definition at line 237 of file Action.php.

References getContext().

Referenced by CreditsAction\getAuthor(), CachedAction\getCacheKey(), CreditsAction\getContributors(), InfoAction\getContributors(), HistoryAction\getDescription(), RevertAction\getFormFields(), RevertAction\onSuccess(), and InfoAction\pageInfo().

◆ getName()

Action::getName ( )

abstract

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented in HistoryAction, InfoAction, SpecialPageAction, RawAction, RevertAction, McrUndoAction, CreditsAction, MarkpatrolledAction, PurgeAction, RollbackAction, WatchAction, DeleteAction, EditAction, ProtectAction, RenderAction, SubmitAction, UnprotectAction, UnwatchAction, ViewAction, and McrRestoreAction.

Referenced by checkCanExecute(), CachedAction\getCacheKey(), getDescription(), and FormAction\getForm().

◆ getOutput()

Action::getOutput ( )

final

Get the OutputPage being used for this instance.

Since: 1.17

Returns: OutputPage

Definition at line 208 of file Action.php.

References getContext().

Referenced by CachedAction\addCachedHTML(), addHelpLink(), RollbackAction\handleRollbackRequest(), CachedAction\onCacheInitialized(), MarkpatrolledAction\onSubmit(), UnwatchAction\onSuccess(), WatchAction\onSuccess(), PurgeAction\onSuccess(), RevertAction\onSuccess(), McrUndoAction\onSuccess(), RawAction\onView(), HistoryAction\onView(), setHeaders(), FormlessAction\show(), ProtectAction\show(), EditAction\show(), ViewAction\show(), McrUndoAction\show(), and McrUndoAction\showPreview().

◆ getPageTitle()

Action::getPageTitle ( )

protected

Returns the name that goes in the \<h1\> page title.

Returns: string

Reimplemented in InfoAction, RevertAction, and HistoryAction.

Definition at line 373 of file Action.php.

References getTitle().

Referenced by setHeaders().

◆ getRequest()

Action::getRequest ( )

final

Get the WebRequest being used for this instance.

Since: 1.17

Returns: WebRequest

Definition at line 198 of file Action.php.

References getContext().

Referenced by RollbackAction\alterForm(), RevertAction\alterForm(), MarkpatrolledAction\alterForm(), RevertAction\checkCanExecute(), RollbackAction\enableTransactionalTimelimit(), HistoryAction\feed(), McrUndoAction\generateDiffOrPreview(), RawAction\getContentType(), FormAction\getForm(), McrUndoAction\getFormFields(), SpecialPageAction\getName(), RawAction\getOldId(), RawAction\getRawText(), MarkpatrolledAction\getRecentChange(), RollbackAction\handleRollbackRequest(), McrRestoreAction\initFromParameters(), McrUndoAction\initFromParameters(), RevertAction\onSubmit(), McrUndoAction\onSubmit(), RawAction\onView(), HistoryAction\onView(), McrUndoAction\show(), PurgeAction\show(), RollbackAction\show(), CachedAction\startCache(), and useTransactionalTimeLimit().

◆ getRestriction()

Action::getRestriction ( )

Get the permission required to perform this action.

Often, but not always, the same as the action name

Since: 1.17

Returns: string|null

Reimplemented in RevertAction, MarkpatrolledAction, and RollbackAction.

Definition at line 295 of file Action.php.

Referenced by checkCanExecute().

◆ getSkin()

Action::getSkin ( )

final

Shortcut to get the Skin being used for this instance.

Since: 1.17

Returns: Skin

Definition at line 228 of file Action.php.

References getContext().

◆ getTitle()

Action::getTitle ( )

final

Shortcut to get the Title object from the page.

Since: 1.17

Returns: Title

Definition at line 247 of file Action.php.

Referenced by RevertAction\alterForm(), McrUndoAction\alterForm(), RevertAction\checkCanExecute(), checkCanExecute(), HistoryAction\feed(), HistoryAction\feedEmpty(), HistoryAction\feedItem(), HistoryAction\fetchRevisions(), HistoryAction\getDescription(), RevertAction\getDescription(), FormAction\getForm(), RevertAction\getFormFields(), HistoryAction\getPageTitle(), RevertAction\getPageTitle(), getPageTitle(), InfoAction\getPageTitle(), RawAction\getRawText(), RollbackAction\handleRollbackRequest(), HistoryAction\hasUnseenRevisionMarkers(), UnwatchAction\onSubmit(), WatchAction\onSubmit(), RevertAction\onSubmit(), UnwatchAction\onSuccess(), WatchAction\onSuccess(), PurgeAction\onSuccess(), RevertAction\onSuccess(), McrUndoAction\onSuccess(), RawAction\onView(), HistoryAction\onView(), CreditsAction\othersLink(), InfoAction\pageInfo(), EditAction\show(), McrUndoAction\show(), and McrUndoAction\showPreview().

◆ getUser()

Action::getUser ( )

final

Shortcut to get the User being used for this instance.

Since: 1.17

Returns: User

Definition at line 218 of file Action.php.

References getContext().

Referenced by RevertAction\getFormFields(), RollbackAction\handleRollbackRequest(), HistoryAction\hasUnseenRevisionMarkers(), UnwatchAction\onSubmit(), WatchAction\onSubmit(), MarkpatrolledAction\onSubmit(), RevertAction\onSubmit(), RevertAction\onSuccess(), RawAction\onView(), InfoAction\pageInfo(), FormlessAction\show(), EditAction\show(), PurgeAction\show(), RollbackAction\show(), and FormAction\show().

◆ msg()

Action::msg	(	$key,
		$params
	)

final

Get a Message object with context set Parameters are the same as wfMessage()

Parameters

string \| string[] \| MessageSpecifier	$key
	mixed	...$params

Returns: Message

Implements MessageLocalizer.

Definition at line 259 of file Action.php.

References getContext().

Referenced by RevertAction\checkCanExecute(), HistoryAction\feed(), HistoryAction\feedEmpty(), HistoryAction\feedItem(), CreditsAction\getAuthor(), CreditsAction\getContributors(), InfoAction\getContributors(), CreditsAction\getDescription(), HistoryAction\getDescription(), getDescription(), UnwatchAction\getFormFields(), WatchAction\getFormFields(), PurgeAction\getFormFields(), RevertAction\getFormFields(), RollbackAction\getFormFields(), HistoryAction\getPageTitle(), RevertAction\getPageTitle(), InfoAction\getPageTitle(), RollbackAction\handleRollbackRequest(), MarkpatrolledAction\onSubmit(), CreditsAction\onView(), InfoAction\onView(), HistoryAction\onView(), CreditsAction\othersLink(), InfoAction\pageInfo(), PurgeAction\postText(), HistoryAction\preCacheMessages(), MarkpatrolledAction\preText(), SpecialPageAction\show(), and CreditsAction\userLink().

◆ requiresUnblock()

Action::requiresUnblock ( )

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

Since: 1.17

Returns: bool

Reimplemented in SpecialPageAction, HistoryAction, InfoAction, RawAction, PurgeAction, and WatchAction.

Definition at line 351 of file Action.php.

Referenced by checkCanExecute().

◆ requiresWrite()

Action::requiresWrite ( )

Whether this action requires the wiki not to be locked.

Since: 1.17

Returns: bool

Reimplemented in InfoAction, HistoryAction, and RawAction.

Definition at line 341 of file Action.php.

Referenced by checkCanExecute().

◆ setHeaders()

Action::setHeaders ( )

protected

Set output headers for noindexing etc.

This function will not be called through the execute() entry point, so only put UI-related stuff in here.

Since: 1.17

Definition at line 360 of file Action.php.

References getDescription(), getOutput(), and getPageTitle().

Referenced by FormlessAction\show(), PurgeAction\show(), and FormAction\show().

◆ show()

Action::show ( )

abstract

The main action entry point.

Do all output for display and send it to the context output. Do not use globals $wgOut, $wgRequest, etc, in implementations; use $this->getOutput(), etc.

Since: 1.17

Exceptions

ErrorPageError

Reimplemented in FormAction, RollbackAction, SpecialPageAction, PurgeAction, McrUndoAction, DeleteAction, EditAction, ProtectAction, RenderAction, ViewAction, FormlessAction, SubmitAction, and UnprotectAction.

◆ useTransactionalTimeLimit()

Action::useTransactionalTimeLimit ( )

protected

Call wfTransactionalTimeLimit() if this request was POSTed.

Since: 1.26

Definition at line 422 of file Action.php.

References getRequest(), and wfTransactionalTimeLimit().

Referenced by RevertAction\onSubmit(), EditAction\show(), DeleteAction\show(), and McrUndoAction\show().

Member Data Documentation

◆ $context

IContextSource Action::$context

protected

IContextSource if specified; otherwise we'll use the Context from the Page.

Since: 1.17

Definition at line 53 of file Action.php.

Referenced by __construct(), factory(), getActionName(), and getContext().

◆ $fields

array Action::$fields

protected

The fields used to create the HTMLForm.

Since: 1.17

Definition at line 60 of file Action.php.

Referenced by HistoryAction\onView().

◆ $page

WikiPage Article ImagePage CategoryPage Page Action::$page

protected

Page on which we're performing the action.

Since: 1.17

Definition at line 46 of file Action.php.

Referenced by __construct(), WatchAction\doUnwatch(), WatchAction\doWatch(), factory(), HistoryAction\getArticle(), CreditsAction\getAuthor(), InfoAction\getContributors(), CreditsAction\link(), InfoAction\pageCounts(), and EditAction\show().

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

includes/actions/Action.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addHelpLink()

◆ checkCanExecute()

◆ doesWrites()

◆ exists()

◆ factory()

◆ getActionName()

◆ getClass()

◆ getContext()

◆ getDescription()

◆ getLanguage()

◆ getName()

◆ getOutput()

◆ getPageTitle()

◆ getRequest()

◆ getRestriction()

◆ getSkin()

◆ getTitle()

◆ getUser()

◆ msg()

◆ requiresUnblock()

◆ requiresWrite()

◆ setHeaders()

◆ show()

◆ useTransactionalTimeLimit()

Member Data Documentation

◆ $context

◆ $fields

◆ $page