Displays information about a page. More...

Inherits MediaWiki\Actions\FormlessAction.

Collaboration diagram for MediaWiki\Actions\InfoAction:

[legend]

Public Member Functions
	__construct (Article $article, IContextSource $context, Language $contentLanguage, LanguageNameUtils $languageNameUtils, LinkBatchFactory $linkBatchFactory, LinkRenderer $linkRenderer, IConnectionProvider $dbProvider, MagicWordFactory $magicWordFactory, NamespaceInfo $namespaceInfo, PageProps $pageProps, RepoGroup $repoGroup, RevisionLookup $revisionLookup, WANObjectCache $wanObjectCache, WatchedItemStoreInterface $watchedItemStore, RedirectLookup $redirectLookup, RestrictionStore $restrictionStore, LinksMigration $linksMigration, UserFactory $userFactory)

	getName ()
	Return the name of the action this object responds to. Since 1.17 Returns string Lowercase name

	onView ()
	Shows page information on GET request.

	requiresUnblock ()
	Whether this action can still be executed by a blocked user.Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state. Since 1.17 Stability: stable to override Returns bool

	requiresWrite ()
	Indicates whether this action page write access to the wiki.Subclasses must override this method to return true if the operation they will perform is not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that subclasses handling POST requests might still implement "safe" operations, particularly in the case where large input parameters are required. Since 1.17 Stability: stable to override Returns bool

Public Member Functions inherited from MediaWiki\Actions\FormlessAction
	show ()

Public Member Functions inherited from MediaWiki\Actions\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()

	needsReadRights ()
	Indicates whether this action requires read rights.

	setHookContainer (HookContainer $hookContainer)

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

Static Public Member Functions inherited from MediaWiki\Actions\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
	getDescription ()
	Returns the description that goes below the "<h1>" tag.

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

Protected Member Functions inherited from MediaWiki\Actions\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 MediaWiki\Actions\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

Displays information about a page.

Definition at line 69 of file InfoAction.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Actions\InfoAction::__construct	(	Article	$article,
		IContextSource	$context,
		Language	$contentLanguage,
		LanguageNameUtils	$languageNameUtils,
		LinkBatchFactory	$linkBatchFactory,
		LinkRenderer	$linkRenderer,
		IConnectionProvider	$dbProvider,
		MagicWordFactory	$magicWordFactory,
		NamespaceInfo	$namespaceInfo,
		PageProps	$pageProps,
		RepoGroup	$repoGroup,
		RevisionLookup	$revisionLookup,
		WANObjectCache	$wanObjectCache,
		WatchedItemStoreInterface	$watchedItemStore,
		RedirectLookup	$redirectLookup,
		RestrictionStore	$restrictionStore,
		LinksMigration	$linksMigration,
		UserFactory	$userFactory )

Definition at line 89 of file InfoAction.php.

References MediaWiki\Actions\Action\$context.

Member Function Documentation

◆ getCacheKey()

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

staticprotected

Parameters

WANObjectCache	$cache
PageIdentity	$page
int	$revId

Returns: string

Definition at line 1021 of file InfoAction.php.

References Wikimedia\ObjectCache\WANObjectCache\makeKey().

Referenced by MediaWiki\Actions\InfoAction\invalidateCache().

◆ getDescription()

MediaWiki\Actions\InfoAction::getDescription ( )

protected

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

Returns: string

Reimplemented from MediaWiki\Actions\Action.

Definition at line 1011 of file InfoAction.php.

◆ getName()

MediaWiki\Actions\InfoAction::getName ( )

Return the name of the action this object responds to.

Since: 1.17

Returns: string Lowercase name

Reimplemented from MediaWiki\Actions\Action.

Definition at line 129 of file InfoAction.php.

◆ getPageTitle()

MediaWiki\Actions\InfoAction::getPageTitle ( )

protected

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

Returns: Message

Reimplemented from MediaWiki\Actions\Action.

Definition at line 1002 of file InfoAction.php.

References getTitle().

◆ invalidateCache()

static MediaWiki\Actions\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 150 of file InfoAction.php.

References MediaWiki\Actions\InfoAction\getCacheKey(), and MediaWiki\MediaWikiServices\getInstance().

Referenced by MediaWiki\JobQueue\Jobs\RefreshLinksJob\runForTitle().

◆ onView()

MediaWiki\Actions\InfoAction::onView ( )

Shows page information on GET request.

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

Reimplemented from MediaWiki\Actions\FormlessAction.

Definition at line 167 of file InfoAction.php.

References MediaWiki\Actions\Action\addHelpLink(), MediaWiki\Actions\Action\getArticle(), MediaWiki\Actions\Action\getContext(), MediaWiki\Actions\Action\getHookRunner(), MediaWiki\Actions\Action\getOutput(), and MediaWiki\Actions\Action\msg().

◆ requiresUnblock()

MediaWiki\Actions\InfoAction::requiresUnblock ( )

Whether this action can still be executed by a blocked user.Implementations of this methods must always return the same value, regardless of parameters passed to the constructor or system state.

Since: 1.17

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Actions\Action.

Definition at line 134 of file InfoAction.php.

◆ requiresWrite()

MediaWiki\Actions\InfoAction::requiresWrite ( )

Indicates whether this action page write access to the wiki.Subclasses must override this method to return true if the operation they will perform is not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that subclasses handling POST requests might still implement "safe" operations, particularly in the case where large input parameters are required.

Since: 1.17

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\Actions\Action.

Definition at line 139 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

◆ getCacheKey()

◆ getDescription()

◆ getName()

◆ getPageTitle()

◆ invalidateCache()

◆ onView()

◆ requiresUnblock()

◆ requiresWrite()