Group all the pieces relevant to the context of a request into one instance. More...

Inheritance diagram for RequestContext:

[legend]

Collaboration diagram for RequestContext:

[legend]

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

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID.

	getConfig ()

	getLanguage ()
	Get the Language object.

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

	hasTitle ()
	Check, if a Title object is set.

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage()

	setConfig (Config $config)

	setLanguage ( $language)

	setOutput (OutputPage $output)

	setRequest (WebRequest $request)

	setSkin (Skin $skin)

	setTitle (Title $title=null)

	setUser (User $user)

	setWikiPage (WikiPage $wikiPage)

Static Public Member Functions
static	getMain ()
	Get the RequestContext object associated with the main request.

static	getMainAndWarn ( $func=__METHOD__)
	Get the RequestContext object associated with the main request and gives a warning to the log, to find places, where a context maybe is missing.

static	importScopedSession (array $params)
	Import an client IP address, HTTP headers, user ID, and session ID.

static	newExtraneousContext (Title $title, $request=[])
	Create a new extraneous context.

static	resetMain ()
	Resets singleton returned by getMain().

static	sanitizeLangCode ( $code)
	Accepts a language code and ensures it's sane.

Private Attributes
Config	$config

Language	$lang

bool	$languageRecursion = false
	Boolean flag to guard against recursion in getLanguage.

OutputPage	$output

WebRequest	$request

Skin	$skin

Timing	$timing

Title	$title

User	$user

WikiPage	$wikipage

Static Private Attributes
static RequestContext	$instance = null

Detailed Description

Group all the pieces relevant to the context of a request into one instance.

Definition at line 33 of file RequestContext.php.

Member Function Documentation

◆ canUseWikiPage()

RequestContext::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

Implements IContextSource.

Definition at line 198 of file RequestContext.php.

References $title, Title\canExist(), and getTitle().

◆ exportSession()

RequestContext::exportSession ( )

Export the resolved user IP, HTTP headers, user ID, and session ID.

The result will be reasonably sized to allow for serialization.

Returns: array

Since: 1.21

Implements IContextSource.

Definition at line 471 of file RequestContext.php.

References getRequest(), and getUser().

◆ getConfig()

RequestContext::getConfig ( )

Returns: Config

Implements IContextSource.

Definition at line 100 of file RequestContext.php.

Referenced by getLanguage(), and getSkin().

◆ getLanguage()

RequestContext::getLanguage ( )

Get the Language object.

Initialization of user or request objects can depend on this.

Returns: Language

Exceptions

Exception

Since: 1.19

Implements IContextSource.

Definition at line 326 of file RequestContext.php.

References $lang, getConfig(), User\getOption(), WebRequest\getRawVal(), getRequest(), getUser(), and wfDebugLog().

◆ getMain()

static RequestContext::getMain ( )

static

Get the RequestContext object associated with the main request.

Returns: RequestContext

Definition at line 431 of file RequestContext.php.

Referenced by importScopedSession().

◆ getMainAndWarn()

static RequestContext::getMainAndWarn ( $func = __METHOD__ )

static

Get the RequestContext object associated with the main request and gives a warning to the log, to find places, where a context maybe is missing.

Parameters

string $func

Returns: RequestContext

Since: 1.24

Definition at line 447 of file RequestContext.php.

References wfDebug().

◆ getOutput()

RequestContext::getOutput ( )

Returns: OutputPage

Implements IContextSource.

Definition at line 254 of file RequestContext.php.

◆ getRequest()

RequestContext::getRequest ( )

Returns: WebRequest

Implements IContextSource.

Definition at line 120 of file RequestContext.php.

References $wgCommandLineMode.

Referenced by exportSession(), getLanguage(), getSkin(), and getUser().

◆ getSkin()

RequestContext::getSkin ( )

Returns: Skin

Implements IContextSource.

Definition at line 375 of file RequestContext.php.

References getConfig(), getRequest(), and getUser().

◆ getStats()

RequestContext::getStats ( )

Deprecated:: since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)

Returns: IBufferingStatsdDataFactory

Implements IContextSource.

Definition at line 139 of file RequestContext.php.

◆ getTiming()

RequestContext::getTiming ( )

Returns: Timing

Implements IContextSource.

Definition at line 146 of file RequestContext.php.

◆ getTitle()

RequestContext::getTitle ( )

Returns: Title|null

Implements IContextSource.

Definition at line 167 of file RequestContext.php.

References $title, $wgTitle, wfDebugLog(), and wfGetAllCallers().

◆ getUser()

RequestContext::getUser ( )

Returns: User

Implements IContextSource.

Definition at line 274 of file RequestContext.php.

References getRequest(), and User\newFromSession().

Referenced by MediaWiki\Rest\EntryPoint\main().

◆ getWikiPage()

RequestContext::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

Exceptions

MWException

Returns: WikiPage

Implements IContextSource.

Definition at line 232 of file RequestContext.php.

References $title, and getTitle().

◆ hasTitle()

RequestContext::hasTitle ( )

Check, if a Title object is set.

Since: 1.25

Returns: bool

Definition at line 186 of file RequestContext.php.

Referenced by setWikiPage().

◆ importScopedSession()

static RequestContext::importScopedSession ( array $params )

static

Import an client IP address, HTTP headers, user ID, and session ID.

This sets the current session, $wgUser, and $wgRequest from $params. Once the return value falls out of scope, the old context is restored. This method should only be called in contexts where there is no session ID or end user receiving the response (CLI or HTTP job runners). This is partly enforced, and is done so to avoid leaking cookies if certain error conditions arise.

This is useful when background scripts inherit context when acting on behalf of a user. In general the 'sessionId' parameter should be set to an empty string unless session importing is truly needed. This feature is somewhat deprecated.

Note: suhosin.session.encrypt may interfere with this method.

Parameters

array $params Result of RequestContext::exportSession()

Returns: ScopedCallback

Exceptions

MWException

Since: 1.21

Definition at line 503 of file RequestContext.php.

References $context, $wgRequest, User\getId(), getMain(), User\load(), User\newFromId(), User\newFromName(), and WebRequest\setIP().

◆ msg()

RequestContext::msg	(	$key,
		$params
	)

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

Parameters

string \| string[] \| MessageSpecifier	$key	Message key, or array of keys, or a MessageSpecifier.
	mixed	...$params

Returns: Message

Implements MessageLocalizer.

Definition at line 422 of file RequestContext.php.

References wfMessage().

◆ newExtraneousContext()

static RequestContext::newExtraneousContext	(	Title	$title,
			$request = `[]`
	)

static

Create a new extraneous context.

The context is filled with information external to the current session.

Title is specified by argument
Request is a FauxRequest, or a FauxRequest can be specified by argument
User is an anonymous user, for separation IPv4 localhost is used
Language will be based on the anonymous user and request, may be content language or a uselang param in the fauxrequest data may change the lang
Skin will be based on the anonymous user, should be the wiki's default skin

Parameters

Title	$title	Title to use for the extraneous request
WebRequest \| array	$request	A WebRequest or data to use for a FauxRequest

Returns: RequestContext

Definition at line 601 of file RequestContext.php.

References $context, $title, and User\newFromName().

◆ resetMain()

static RequestContext::resetMain ( )

static

Resets singleton returned by getMain().

Should be called only from unit tests.

Definition at line 457 of file RequestContext.php.

◆ sanitizeLangCode()

static RequestContext::sanitizeLangCode ( $code )

static

Accepts a language code and ensures it's sane.

Outputs a cleaned up language code and replaces with $wgLanguageCode if not sane.

Parameters

string $code Language code

Returns: string

Definition at line 288 of file RequestContext.php.

References $wgLanguageCode.

◆ setConfig()

RequestContext::setConfig ( Config $config )

Parameters

Config $config

Implements MutableContext.

Definition at line 93 of file RequestContext.php.

◆ setLanguage()

RequestContext::setLanguage ( $language )

Parameters

Language | string $language Language instance or language code

Exceptions

MWException

Since: 1.19

Implements MutableContext.

Definition at line 307 of file RequestContext.php.

◆ setOutput()

RequestContext::setOutput ( OutputPage $output )

Parameters

OutputPage $output

Implements MutableContext.

Definition at line 247 of file RequestContext.php.

◆ setRequest()

RequestContext::setRequest ( WebRequest $request )

Parameters

WebRequest $request

Implements MutableContext.

Definition at line 113 of file RequestContext.php.

Referenced by ApiEditPage\execute().

◆ setSkin()

RequestContext::setSkin ( Skin $skin )

Parameters

Skin $skin

Implements MutableContext.

Definition at line 367 of file RequestContext.php.

References ContextSource\setContext().

◆ setTitle()

RequestContext::setTitle ( Title $title = null )

Parameters

Title | null $title

Implements MutableContext.

Definition at line 158 of file RequestContext.php.

References $title.

Referenced by Parser\braceSubstitution(), MediaWiki\Rest\EntryPoint\main(), and setWikiPage().

◆ setUser()

RequestContext::setUser ( User $user )

Parameters

User $user

Implements MutableContext.

Definition at line 265 of file RequestContext.php.

Referenced by ApiParamInfo\execute().

◆ setWikiPage()

RequestContext::setWikiPage ( WikiPage $wikiPage )

Since: 1.19

Parameters

WikiPage $wikiPage

Implements MutableContext.

Definition at line 213 of file RequestContext.php.

References WikiPage\getTitle(), hasTitle(), and setTitle().

Member Data Documentation

◆ $config

Config RequestContext::$config

private

Definition at line 77 of file RequestContext.php.

◆ $instance

RequestContext RequestContext::$instance = null

staticprivate

Definition at line 82 of file RequestContext.php.

◆ $lang

Language RequestContext::$lang

private

Definition at line 62 of file RequestContext.php.

◆ $languageRecursion

bool RequestContext::$languageRecursion = false

private

Boolean flag to guard against recursion in getLanguage.

Definition at line 88 of file RequestContext.php.

◆ $output

OutputPage RequestContext::$output

private

Definition at line 52 of file RequestContext.php.

◆ $request

WebRequest RequestContext::$request

private

Definition at line 37 of file RequestContext.php.

◆ $skin

Skin RequestContext::$skin

private

Definition at line 67 of file RequestContext.php.

◆ $timing

Timing RequestContext::$timing

private

Definition at line 72 of file RequestContext.php.

◆ $title

Title RequestContext::$title

private

Definition at line 42 of file RequestContext.php.

◆ $user

User RequestContext::$user

private

Definition at line 57 of file RequestContext.php.

◆ $wikipage

WikiPage RequestContext::$wikipage

private

Definition at line 47 of file RequestContext.php.

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

includes/context/RequestContext.php

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ canUseWikiPage()

◆ exportSession()

◆ getConfig()

◆ getLanguage()

◆ getMain()

◆ getMainAndWarn()

◆ getOutput()

◆ getRequest()

◆ getSkin()

◆ getStats()

◆ getTiming()

◆ getTitle()

◆ getUser()

◆ getWikiPage()

◆ hasTitle()

◆ importScopedSession()

◆ msg()

◆ newExtraneousContext()

◆ resetMain()

◆ sanitizeLangCode()

◆ setConfig()

◆ setLanguage()

◆ setOutput()

◆ setRequest()

◆ setSkin()

◆ setTitle()

◆ setUser()

◆ setWikiPage()

Member Data Documentation

◆ $config

◆ $instance

◆ $lang

◆ $languageRecursion

◆ $output

◆ $request

◆ $skin

◆ $timing

◆ $title

◆ $user

◆ $wikipage