Displays information about a page. More...

Inheritance diagram for InfoAction:

[legend]

Collaboration diagram for InfoAction:

[legend]

Public Member Functions
	__construct (Page $page, IContextSource $context, Language $contentLanguage, HookContainer $hookContainer, LanguageNameUtils $languageNameUtils, LinkBatchFactory $linkBatchFactory, LinkRenderer $linkRenderer, ILoadBalancer $loadBalancer, MagicWordFactory $magicWordFactory, NamespaceInfo $namespaceInfo, PageProps $pageProps, RepoGroup $repoGroup, RevisionLookup $revisionLookup, WANObjectCache $wanObjectCache, WatchedItemStoreInterface $watchedItemStore, RedirectLookup $redirectLookup, RestrictionStore $restrictionStore, LinksMigration $linksMigration)

	getName ()
	Returns the name of the action this object responds to.

	onView ()
	Shows page information on GET request.

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

	requiresWrite ()
	Whether this action requires the wiki not to be locked.

Public Member Functions inherited from FormlessAction
	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.

	doesWrites ()
	Indicates whether this action may perform database writes.

	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.

Static Public Member Functions
static	invalidateCache (PageIdentity $page, $revid=null)
	Clear the info cache for a given Title.

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 Member Functions
	addRow ( $table, $name, $value, $id)
	Adds a row to a table that will be added to the content.

	addTable ( $content, $table)
	Adds a table to the content that will be added to the output.

	getDescription ()
	Returns the description that goes below the "<h1>" tag.

	getNamespaceProtectionMessage (Title $title)
	Get namespace protection message for title or null if no namespace protection has been applied.

	getPageTitle ()
	Returns the name that goes in the "<h1>" page title.

	makeHeader ( $header, $canonicalId)
	Creates a header that can be added to the output.

	pageInfo ()
	Returns an array of info groups (will be rendered as tables), keyed by group ID.

Protected Member Functions inherited from Action
	checkCanExecute (User $user)
	Checks if the given user (identified by an object) can perform this action.

	getHookContainer ()

	getHookRunner ()

	setHeaders ()
	Set output headers for noindexing etc.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Static Protected Member Functions
static	getCacheKey (WANObjectCache $cache, PageIdentity $page, $revId)

Additional Inherited Members
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

Displays information about a page.

Definition at line 46 of file InfoAction.php.

Constructor & Destructor Documentation

◆ __construct()

InfoAction::__construct	(	Page	$page,
		IContextSource	$context,
		Language	$contentLanguage,
		HookContainer	$hookContainer,
		LanguageNameUtils	$languageNameUtils,
		LinkBatchFactory	$linkBatchFactory,
		LinkRenderer	$linkRenderer,
		ILoadBalancer	$loadBalancer,
		MagicWordFactory	$magicWordFactory,
		NamespaceInfo	$namespaceInfo,
		PageProps	$pageProps,
		RepoGroup	$repoGroup,
		RevisionLookup	$revisionLookup,
		WANObjectCache	$wanObjectCache,
		WatchedItemStoreInterface	$watchedItemStore,
		RedirectLookup	$redirectLookup,
		RestrictionStore	$restrictionStore,
		LinksMigration	$linksMigration )

Parameters

Page	$page
IContextSource	$context
Language	$contentLanguage
HookContainer	$hookContainer
LanguageNameUtils	$languageNameUtils
LinkBatchFactory	$linkBatchFactory
LinkRenderer	$linkRenderer
ILoadBalancer	$loadBalancer
MagicWordFactory	$magicWordFactory
NamespaceInfo	$namespaceInfo
PageProps	$pageProps
RepoGroup	$repoGroup
RevisionLookup	$revisionLookup
WANObjectCache	$wanObjectCache
WatchedItemStoreInterface	$watchedItemStore
RedirectLookup	$redirectLookup
RestrictionStore	$restrictionStore
LinksMigration	$linksMigration

Definition at line 117 of file InfoAction.php.

Member Function Documentation

◆ addRow()

InfoAction::addRow	(	$table,
		$name,
		$value,
		$id )

protected

Adds a row to a table that will be added to the content.

Parameters

string	$table	The table that will be added to the content
string	$name	The name of the row
string	$value	The value of the row
string \| null	$id	The ID to use for the 'tr' element

Returns: string The table with the row added

Definition at line 317 of file InfoAction.php.

Referenced by onView().

◆ addTable()

InfoAction::addTable	(		$content,
			$table )

protected

Adds a table to the content that will be added to the output.

Parameters

string	$content	The content that will be added to the output
string	$table

Returns: string The content with the table added

Definition at line 334 of file InfoAction.php.

References $content.

Referenced by onView().

◆ getCacheKey()

static InfoAction::getCacheKey	(	WANObjectCache	$cache,
		PageIdentity	$page,
			$revId )

staticprotected

Parameters

WANObjectCache	$cache
PageIdentity	$page
int	$revId

Returns: string

Definition at line 1078 of file InfoAction.php.

References $cache.

◆ getDescription()

InfoAction::getDescription ( )

protected

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

Returns: string

Reimplemented from Action.

Definition at line 1068 of file InfoAction.php.

◆ getName()

InfoAction::getName ( )

Returns the name of the action this object responds to.

Returns: string Lowercase name

Reimplemented from Action.

Definition at line 161 of file InfoAction.php.

◆ getNamespaceProtectionMessage()

InfoAction::getNamespaceProtectionMessage ( Title $title )

protected

Get namespace protection message for title or null if no namespace protection has been applied.

Parameters

Title $title

Returns: ?string HTML

Definition at line 890 of file InfoAction.php.

Referenced by pageInfo().

◆ getPageTitle()

InfoAction::getPageTitle ( )

protected

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

Returns: string

Reimplemented from Action.

Definition at line 1059 of file InfoAction.php.

References getTitle().

◆ invalidateCache()

static InfoAction::invalidateCache	(	PageIdentity	$page,
			$revid = null )

static

Clear the info cache for a given Title.

Since: 1.22

Parameters

PageIdentity	$page	Title to clear cache for
int \| null	$revid	Revision id to clear

Definition at line 190 of file InfoAction.php.

References $cache.

◆ makeHeader()

InfoAction::makeHeader	(		$header,
			$canonicalId )

protected

Creates a header that can be added to the output.

Parameters

string	$header	The header text.
string	$canonicalId

Returns: string The HTML.

Definition at line 293 of file InfoAction.php.

References $header.

Referenced by onView().

◆ onView()

InfoAction::onView ( )

Shows page information on GET request.

Returns: string Page information that will be added to the output

Reimplemented from FormlessAction.

Definition at line 209 of file InfoAction.php.

References $content, $header, Action\addHelpLink(), addRow(), addTable(), Action\getArticle(), getContext(), Action\getOutput(), makeHeader(), Action\msg(), and pageInfo().

◆ pageInfo()

InfoAction::pageInfo ( )

protected

Returns an array of info groups (will be rendered as tables), keyed by group ID.

Group IDs are arbitrary and used so that extensions may add additional information in arbitrary positions (and as message keys for section headers for the tables, prefixed with 'pageinfo-'). Each info group is a non-associative array of info items (rendered as table rows). Each info item is an array with two elements: the first describes the type of information, the second the value for the current page. Both can be strings (will be interpreted as raw HTML) or messages (will be interpreted as plain text and escaped).

Returns: array

Definition at line 355 of file InfoAction.php.

References $lang, $magicWords, $title, Action\exists(), Linker\formatHiddenCategories(), Action\getArticle(), getAuthority(), getContext(), Action\getLanguage(), getNamespaceProtectionMessage(), getTitle(), SpecialPage\getTitleFor(), SpecialPage\getTitleValueFor(), getUser(), Action\getWikiPage(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), MediaWiki\Linker\LinkRenderer\makeLink(), Action\msg(), User\newFromName(), NS_CATEGORY, NS_FILE, NS_USER, NS_USER_TALK, and Linker\revUserTools().

Referenced by onView().

◆ requiresUnblock()

InfoAction::requiresUnblock ( )

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

Returns: bool

Reimplemented from Action.

Definition at line 170 of file InfoAction.php.

◆ requiresWrite()

InfoAction::requiresWrite ( )

Whether this action requires the wiki not to be locked.

Returns: bool

Reimplemented from Action.

Definition at line 179 of file InfoAction.php.

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

includes/actions/InfoAction.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addRow()

◆ addTable()

◆ getCacheKey()

◆ getDescription()

◆ getName()

◆ getNamespaceProtectionMessage()

◆ getPageTitle()

◆ invalidateCache()

◆ makeHeader()

◆ onView()

◆ pageInfo()

◆ requiresUnblock()

◆ requiresWrite()