An action that views article content. More...

Collaboration diagram for ViewAction:

[legend]

Public Member Functions
	getName ()
	Return the name of the action this object responds to.

	needsReadRights ()
	Indicates whether this action requires read rights.

	onView ()
	Show something on GET request.

	show ()

Public Member Functions inherited from Action
	__construct (Article $article, IContextSource $context)
	Only public since 1.21.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	doesWrites ()
	Indicates whether POST requests handled by this action require write access to the wiki.

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

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

	requiresWrite ()
	Indicates whether this action page write access to the wiki.

	setHookContainer (HookContainer $hookContainer)

Additional Inherited Members
Static Public Member Functions inherited from Action
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 Member Functions inherited from Action
	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>` element.

	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.

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.

Detailed Description

An action that views article content.

This is a wrapper that will call Article::view().

Definition at line 31 of file ViewAction.php.

Member Function Documentation

ViewAction::getName ( )

Return the name of the action this object responds to.

Reimplemented from Action.

Definition at line 33 of file ViewAction.php.

ViewAction::needsReadRights ( )

Indicates whether this action requires read rights.

Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.

Reimplemented from Action.

Definition at line 41 of file ViewAction.php.

ViewAction::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 37 of file ViewAction.php.

ViewAction::show ( )

Reimplemented from FormlessAction.

Definition at line 47 of file ViewAction.php.

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