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

Inheritance diagram for Action:

Collaboration diagram for Action:

Public Member Functions
	execute ()
	Execute the action in a silent fashion: do not display anything or release any errors.
	getContext ()
	Get the IContextSource in use here.
	getLang ()
	Shortcut to get the user Language being used for this instance.
	getLanguage ()
	Shortcut to get the user Language being used for this instance.
	getName ()
	Return the name of the action this object responds to.
	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.
	msg ()
	Get a Message object with context set Parameters are the same as wfMessage()
	requiresUnblock ()
	Whether this action can still be executed by a blocked user.
	requiresWrite ()
	Whether this action requires the wiki not to be locked.
	show ()
	The main action entry point.
Static Public Member Functions
static	exists ($name)
	Check if a given action is recognised, even if it's disabled.
static	factory ($action, Page $page, 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 Member Functions
	__construct (Page $page, IContextSource $context=null)
	Protected constructor: use Action::factory( $action, $page ) to actually build these things in the real world.
	checkCanExecute (User $user)
	Checks if the given user (identified by an object) can perform this action.
	getDescription ()
	Returns the description that goes below the <h1> tag.
	getPageTitle ()
	Returns the name that goes in the <h1> page title.
	setHeaders ()
	Set output headers for noindexing etc.
Protected Attributes
IContextSource	$context
	IContextSource if specified; otherwise we'll use the Context from the Page $context.
Array	$fields
	The fields used to create the HTMLForm $fields.
Page	$page
	Page on which we're performing the action $page.
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.

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. There is also the deprecated UnknownAction hook

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 respresent these two groups.

Definition at line 37 of file Action.php.

Constructor & Destructor Documentation

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

Protected constructor: use Action::factory( $action, $page ) to actually build these things in the real world.

Parameters:

$page	Page
$context	IContextSource

Definition at line 246 of file Action.php.

Member Function Documentation

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

Parameters:

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

Exceptions:

ErrorPageError

Returns:: bool True on success

Reimplemented in WatchAction, and RevertFileAction.

Definition at line 275 of file Action.php.

Referenced by PurgeAction\show().

Action::execute ( ) [abstract]

Execute the action in a silent fashion: do not display anything or release any errors.

Returns:: Bool whether execution was successful

Reimplemented in RevertAction.

static Action::exists ( $ name ) [static, final]

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

Parameters:

$name String: name of an action

Returns:: Bool

Definition at line 150 of file Action.php.

Referenced by HistoryAction\fetchRevisions().

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

Get an appropriate Action subclass for the given action.

Parameters:

$action	String
$page	Page
$context	IContextSource

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

Definition at line 88 of file Action.php.

Referenced by WatchAction\doUnwatch(), WatchAction\doWatch(), and SkinTemplate\outputPage().

static Action::getActionName ( IContextSource $ context ) [static, final]

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:

$context IContextSource

Returns:: string: action name

Definition at line 106 of file Action.php.

static Action::getClass	(	$	action,
		array $	overrides
	)		`[static, final, private]`

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:

$action	String
$overrides	Array

Returns:: bool|null|string

Definition at line 61 of file Action.php.

Action::getContext ( ) [final]

Get the IContextSource in use here.

Returns:: IContextSource

Definition at line 158 of file Action.php.

Referenced by RawPage\__construct(), RawAction\getRawText(), RollbackAction\onView(), InfoAction\onView(), HistoryAction\onView(), EditAction\show(), and RevisiondeleteAction\show().

Action::getDescription ( ) [protected]

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

Returns:: String

Reimplemented in InfoAction, UnwatchAction, RevertFileAction, RollbackAction, HistoryAction, PurgeAction, RevisiondeleteAction, WatchAction, CreditsAction, and MarkpatrolledAction.

Definition at line 340 of file Action.php.

Action::getLang ( ) [final]

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

Deprecated:: 1.19 Use getLanguage instead

Returns:: Language

Definition at line 216 of file Action.php.

Action::getLanguage ( ) [final]

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

Returns:: Language

Definition at line 206 of file Action.php.

Referenced by CreditsAction\getAuthor(), CreditsAction\getContributors(), InfoAction\getContributors(), RevertFileAction\getFormFields(), RevertFileAction\onSuccess(), and InfoAction\pageInfo().

Action::getName ( ) [abstract]

Return the name of the action this object responds to.

Returns:: String lowercase

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

Action::getOutput ( ) [final]

Get the OutputPage being used for this instance.

Returns:: OutputPage

Definition at line 179 of file Action.php.

Referenced by RevertFileAction\getDescription(), PurgeAction\onSuccess(), RevertFileAction\onSuccess(), WatchAction\onSuccess(), UnwatchAction\onSuccess(), MarkpatrolledAction\onView(), RollbackAction\onView(), RawAction\onView(), HistoryAction\onView(), and RevertAction\show().

Action::getPageTitle ( ) [protected]

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

Returns:: String

Reimplemented in InfoAction, RevertFileAction, and HistoryAction.

Definition at line 331 of file Action.php.

Action::getRequest ( ) [final]

Get the WebRequest being used for this instance.

Returns:: WebRequest

Definition at line 170 of file Action.php.

Referenced by RevertFileAction\alterForm(), RevertFileAction\checkCanExecute(), HistoryAction\feed(), RawAction\getContentType(), RevertFileAction\getFormFields(), RawAction\getOldId(), RawAction\getRawText(), RevertFileAction\onSubmit(), RevertFileAction\onSuccess(), MarkpatrolledAction\onView(), RollbackAction\onView(), RawAction\onView(), HistoryAction\onView(), EditAction\show(), and PurgeAction\show().

Action::getRestriction ( )

Get the permission required to perform this action.

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

Returns:: String|null

Reimplemented in RevertFileAction, and RollbackAction.

Definition at line 262 of file Action.php.

Action::getSkin ( ) [final]

Shortcut to get the Skin being used for this instance.

Returns:: Skin

Definition at line 197 of file Action.php.

Action::getTitle ( ) [final]

Action::getUser ( ) [final]

Shortcut to get the User being used for this instance.

Returns:: User

Definition at line 188 of file Action.php.

Referenced by RevertFileAction\getFormFields(), WatchAction\onSubmit(), UnwatchAction\onSubmit(), RevertFileAction\onSuccess(), MarkpatrolledAction\onView(), RollbackAction\onView(), RawAction\onView(), InfoAction\pageInfo(), EditAction\show(), WatchAction\show(), and PurgeAction\show().

Action::msg ( ) [final]

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

Returns:: Message object

Definition at line 235 of file Action.php.

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

Action::requiresUnblock ( )

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

Returns:: Bool

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

Definition at line 310 of file Action.php.

Action::requiresWrite ( )

Whether this action requires the wiki not to be locked.

Returns:: Bool

Reimplemented in InfoAction, HistoryAction, and RawAction.

Definition at line 302 of file Action.php.

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.

Definition at line 318 of file Action.php.

Referenced by WatchAction\show(), and PurgeAction\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.

Exceptions:

ErrorPageError

Reimplemented in FormlessAction, FormAction, SubmitAction, PurgeAction, WatchAction, UnprotectAction, RevisiondeleteAction, RevertAction, DeleteAction, EditAction, ProtectAction, RenderAction, and ViewAction.