An IContextSource implementation which will inherit context from another source but allow individual pieces of context to be changed locally eg: A ContextSource that can inherit from the main RequestContext but have a different Title instance set on it. More...

Inherits MediaWiki\Context\ContextSource, and MediaWiki\Context\MutableContext.

Collaboration diagram for MediaWiki\Context\DerivativeContext:

[legend]

Public Member Functions
	__construct (IContextSource $context)

	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().

	getActionName ()
	Get the action name for the current web request.

	getAuthority ()

	getConfig ()

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	msg ( $key,... $params)
	Get a message using the current context.

	setActionName (string $action)

	setAuthority (Authority $authority)

	setConfig (Config $config)

	setLanguage ( $language)

	setOutput (OutputPage $output)

	setRequest (WebRequest $request)

	setSkin (Skin $skin)

	setTitle (Title $title)

	setUser (User $user)

	setWikiPage (WikiPage $wikiPage)

Public Member Functions inherited from MediaWiki\Context\ContextSource
	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getContext ()
	Get the base IContextSource object.

	getLanguageCode ()

	setContext (IContextSource $context)

Detailed Description

An IContextSource implementation which will inherit context from another source but allow individual pieces of context to be changed locally eg: A ContextSource that can inherit from the main RequestContext but have a different Title instance set on it.

Stability: newable

Since: 1.19

Definition at line 35 of file DerivativeContext.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Context\DerivativeContext::__construct ( IContextSource $context )

Stability: stable: to call

Parameters

IContextSource $context Context to inherit from

Definition at line 95 of file DerivativeContext.php.

References MediaWiki\Context\ContextSource\setContext().

Member Function Documentation

◆ canUseWikiPage()

MediaWiki\Context\DerivativeContext::canUseWikiPage ( )

Check whether a WikiPage object can be get with getWikiPage().

Callers should expect that an exception is thrown from getWikiPage() if this method returns false.

Since: 1.19

Returns: bool

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 152 of file DerivativeContext.php.

◆ getActionName()

MediaWiki\Context\DerivativeContext::getActionName ( )

Get the action name for the current web request.

Since: 1.38

Returns: string Action

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 208 of file DerivativeContext.php.

◆ getAuthority()

MediaWiki\Context\DerivativeContext::getAuthority ( )

Since: 1.36

Returns: Authority

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 259 of file DerivativeContext.php.

◆ getConfig()

MediaWiki\Context\DerivativeContext::getConfig ( )

Returns: Config

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 106 of file DerivativeContext.php.

References MediaWiki\Context\ContextSource\getContext().

◆ getCsrfTokenSet()

MediaWiki\Context\DerivativeContext::getCsrfTokenSet ( )

Get a repository to obtain and match CSRF tokens.

Returns: CsrfTokenSet

Since: 1.37

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 128 of file DerivativeContext.php.

◆ getLanguage()

MediaWiki\Context\DerivativeContext::getLanguage ( )

Returns: Language

Since: 1.19

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 282 of file DerivativeContext.php.

◆ getOutput()

MediaWiki\Context\DerivativeContext::getOutput ( )

Returns: OutputPage

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 227 of file DerivativeContext.php.

◆ getRequest()

MediaWiki\Context\DerivativeContext::getRequest ( )

Returns: WebRequest

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 124 of file DerivativeContext.php.

References MediaWiki\Context\ContextSource\getContext().

◆ getSkin()

MediaWiki\Context\DerivativeContext::getSkin ( )

Returns: Skin

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 294 of file DerivativeContext.php.

◆ getTiming()

MediaWiki\Context\DerivativeContext::getTiming ( )

Returns: Timing

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 113 of file DerivativeContext.php.

References MediaWiki\Context\ContextSource\getContext().

◆ getTitle()

MediaWiki\Context\DerivativeContext::getTitle ( )

Returns: Title|null

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 140 of file DerivativeContext.php.

◆ getUser()

MediaWiki\Context\DerivativeContext::getUser ( )

Returns: User

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 239 of file DerivativeContext.php.

◆ getWikiPage()

MediaWiki\Context\DerivativeContext::getWikiPage ( )

Get the WikiPage object.

May throw an exception if there's no Title object set or the Title object belongs to a special namespace that doesn't have WikiPage, so use first canUseWikiPage() to check whether this method can be called safely.

Since: 1.19

Returns: WikiPage

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 186 of file DerivativeContext.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ msg()

MediaWiki\Context\DerivativeContext::msg	(		$key,
			$params )

Get a message using the current context.

This can't just inherit from ContextSource, since then it would set only the original context, and not take into account any changes.

Parameters

string \| string[] \| MessageSpecifier	$key	Message key, or array of keys, or a MessageSpecifier.
	MessageParam\|MessageSpecifier\|string\|int\|float\|list<MessageParam\|MessageSpecifier\|string\|int\|float>	...$params See Message::params()

Returns: Message

Reimplemented from MediaWiki\Context\ContextSource.

Definition at line 312 of file DerivativeContext.php.

References wfMessage().

◆ setActionName()

MediaWiki\Context\DerivativeContext::setActionName ( string $action )

Since: 1.38

Parameters

string $action

Implements MediaWiki\Context\MutableContext.

Definition at line 198 of file DerivativeContext.php.

◆ setAuthority()

MediaWiki\Context\DerivativeContext::setAuthority ( Authority $authority )

Stability: unstable

Parameters

Authority $authority

Implements MediaWiki\Context\MutableContext.

Definition at line 249 of file DerivativeContext.php.

◆ setConfig()

MediaWiki\Context\DerivativeContext::setConfig ( Config $config )

Returns: void

Implements MediaWiki\Context\MutableContext.

Definition at line 99 of file DerivativeContext.php.

◆ setLanguage()

MediaWiki\Context\DerivativeContext::setLanguage ( $language )

Parameters

Language | string $language Language instance or language code

Since: 1.19

Implements MediaWiki\Context\MutableContext.

Definition at line 267 of file DerivativeContext.php.

◆ setOutput()

MediaWiki\Context\DerivativeContext::setOutput ( OutputPage $output )

Returns: void

Implements MediaWiki\Context\MutableContext.

Definition at line 220 of file DerivativeContext.php.

◆ setRequest()

MediaWiki\Context\DerivativeContext::setRequest ( WebRequest $request )

Returns: void

Implements MediaWiki\Context\MutableContext.

Definition at line 117 of file DerivativeContext.php.

◆ setSkin()

MediaWiki\Context\DerivativeContext::setSkin ( Skin $skin )

Returns: void

Implements MediaWiki\Context\MutableContext.

Definition at line 286 of file DerivativeContext.php.

References MediaWiki\Context\ContextSource\setContext().

◆ setTitle()

MediaWiki\Context\DerivativeContext::setTitle ( Title $title )

Returns: void

Implements MediaWiki\Context\MutableContext.

Definition at line 132 of file DerivativeContext.php.

◆ setUser()

MediaWiki\Context\DerivativeContext::setUser ( User $user )

Returns: void

Implements MediaWiki\Context\MutableContext.

Definition at line 231 of file DerivativeContext.php.

◆ setWikiPage()

MediaWiki\Context\DerivativeContext::setWikiPage ( WikiPage $wikiPage )

Since: 1.19

Parameters

WikiPage $wikiPage

Implements MediaWiki\Context\MutableContext.

Definition at line 168 of file DerivativeContext.php.

References MediaWiki\Page\WikiPage\getTitle().

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

includes/Context/DerivativeContext.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canUseWikiPage()

◆ getActionName()

◆ getAuthority()

◆ getConfig()

◆ getCsrfTokenSet()

◆ getLanguage()

◆ getOutput()

◆ getRequest()

◆ getSkin()

◆ getTiming()

◆ getTitle()

◆ getUser()

◆ getWikiPage()

◆ msg()

◆ setActionName()

◆ setAuthority()

◆ setConfig()

◆ setLanguage()

◆ setOutput()

◆ setRequest()

◆ setSkin()

◆ setTitle()

◆ setUser()

◆ setWikiPage()