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 ()
	Get the Config object.

	getLanguage ()
	Get the Language object.

	getOutput ()
	Get the OutputPage object.

	getRequest ()
	Get the WebRequest object.

	getSkin ()
	Get the Skin object.

	getStats ()
	Get the Stats object.

	getTiming ()
	Get the timing object.

	getTitle ()
	Get the Title object.

	getUser ()
	Get the User object.

	getWikiPage ()
	Get the WikiPage object.

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

	msg ()
	Helpful methods.

	setConfig (Config $c)
	Set the Config object.

	setLanguage ( $l)
	Set the Language object.

	setOutput (OutputPage $o)

	setRequest (WebRequest $r)
	Set the WebRequest object.

	setSkin (Skin $s)
	Set the Skin object.

	setTitle (Title $title=null)
	Set the Title object.

	setUser (User $u)
	Set the User object.

	setWikiPage (WikiPage $p)
	Set the WikiPage object.

Static Public Member Functions
static	getMain ()
	Static methods.

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

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 32 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 207 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 507 of file RequestContext.php.

References getRequest(), and getUser().

◆ getConfig()

RequestContext::getConfig ( )

Get the Config object.

Returns: Config

Implements IContextSource.

Definition at line 97 of file RequestContext.php.

References $config.

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 344 of file RequestContext.php.

References $code, $e, $lang, $request, $user, $wgContLang, getConfig(), User\getOption(), getRequest(), getUser(), WebRequest\getVal(), global, sanitizeLangCode(), and wfDebugLog().

◆ getMain()

static RequestContext::getMain ( )

static

Static methods.

Get the RequestContext object associated with the main request

Returns: RequestContext

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 467 of file RequestContext.php.

References $instance.

Referenced by ApiMain\__construct(), CliInstaller\__construct(), Installer\__construct(), UserBlockedError\__construct(), MediaWiki\__construct(), LogFormatter\__construct(), MediaWiki\Session\PHPSessionHandler\__construct(), StubUserLang\_newObject(), BotPasswordTest\addDBData(), MediaWiki\Session\BotPasswordSessionProviderTest\addDBDataOnce(), ResourceLoaderModule\buildContent(), Linker\buildRollbackLink(), Preprocessor\cacheGetTree(), Preprocessor\cacheSetTree(), SpecialPageFactory\capturePath(), ApiStashEdit\checkCache(), Title\checkUserBlock(), LBFactory\commitAll(), User\comparePasswords(), User\crypt(), ApiTestCase\doApiRequest(), ApiTestCase\doLogin(), SiteStatsUpdate\doUpdateContextStats(), SpecialUserLogout\execute(), LoginSignupSpecialPage\execute(), Undelete\execute(), UpdateMediaWiki\execute(), WrapOldPasswords\execute(), DBConnectionError\fileCachedPage(), ResourceLoader\filter(), ChangesList\flag(), FeedUtils\formatDiffRow(), ChangeTags\formatSummaryRow(), File\generateAndSaveThumb(), File\generateBucketsIfNeeded(), Linker\generateRollback(), User\getBlockedStatus(), ActionTest\getContext(), Action\getContext(), ContextSource\getContext(), Article\getContext(), Profiler\getContext(), SpecialPage\getContext(), WatchedItemStore\getDefaultInstance(), MWTimestamp\getHumanTimestamp(), Language\getHumanTimestamp(), Message\getLanguage(), File\getLocalRefPath(), ApiDocumentationTest\getMain(), getMainAndWarn(), ApiContinuationManagerTest\getManager(), BotPassword\getPassword(), User\getPasswordFactory(), MediaWiki\Session\BotPasswordSessionProviderTest\getProvider(), MWTimestamp\getRelativeTimestamp(), User\getRights(), SpecialPageFactory\getUsablePages(), ApiMain\handleApiBeforeMainException(), EditPage\handleStatus(), importScopedSession(), JobQueue\incrStats(), HTMLButtonField\isBadIE(), WikitextContent\isCountable(), LBFactory\newChronologyProtector(), SpecialPageExecutor\newContext(), EmailNotification\notifyOnPageChange(), CategoryMembershipChangeJob\notifyUpdatesForRevision(), MessageCache\replace(), UserNotLoggedIn\report(), User\resetOptions(), ChangeTags\restrictedTagError(), AssembleUploadChunksJob\run(), PublishStashedFileJob\run(), JobRunner\run(), SpecialBotPasswords\save(), TestUser\setPasswordForUser(), EditPage\setPostEditCookie(), LoginSignupSpecialPage\setSessionUserForCurrentRequest(), UploadFromUrlTestSuite\setUp(), ParserTest\setupGlobals(), WebInstaller\setupLanguage(), MediaWikiTestCase\setUserLang(), ChangesList\showCharacterDifference(), LogEventsList\showLogExtract(), MediaWiki\Auth\ConfirmLinkSecondaryAuthenticationProviderTest\testBeginLinkAttempt(), ApiLoginTest\testBotPassword(), MediaWiki\Session\SessionManagerTest\testConstructor(), ApiResultTest\testDeprecatedContinuation(), ApiResultTest\testDeprecatedFunctions(), ApiDocumentationTest\testDocumentationExists(), ImageListPagerTest\testFormatValuesThrowException(), ActionTest\testGetActionName_whenCanNotUseWikiPage_defaultsToView(), RequestContextTest\testImportScopedSession(), BotPasswordTest\testLogin(), BotPasswordTest\testSave(), MediaWiki\Auth\AuthManagerTest\testSingleton(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProviderTest\testTestUserCanAuthenticate(), MediaWikiTest\testTryNormaliseRedirect(), WikiPage\triggerOpportunisticLinksUpdate(), EmailNotification\updateWatchlistTimestamp(), wfIncrStats(), wfInstallerMain(), wfLogProfilingData(), and wfStreamThumb().

◆ 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 483 of file RequestContext.php.

References getMain(), and wfDebug().

Referenced by ImageGalleryBase\factory().

◆ getOutput()

RequestContext::getOutput ( )

Get the OutputPage object.

Returns: OutputPage

Implements IContextSource.

Definition at line 267 of file RequestContext.php.

References $output, and output().

◆ getRequest()

RequestContext::getRequest ( )

Get the WebRequest object.

Returns: WebRequest

Implements IContextSource.

Definition at line 121 of file RequestContext.php.

References $request, $wgCommandLineMode, global, and request.

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

◆ getSkin()

RequestContext::getSkin ( )

Get the Skin object.

Returns: Skin

Implements IContextSource.

Definition at line 402 of file RequestContext.php.

References $factory, $skin, getConfig(), getRequest(), getUser(), Skin\normalizeKey(), ContextSource\setContext(), and skin().

◆ getStats()

RequestContext::getStats ( )

Get the Stats object.

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

Returns: StatsdDataFactory

Implements IContextSource.

Definition at line 142 of file RequestContext.php.

◆ getTiming()

RequestContext::getTiming ( )

Get the timing object.

Returns: Timing

Implements IContextSource.

Definition at line 151 of file RequestContext.php.

References $timing.

◆ getTitle()

RequestContext::getTitle ( )

Get the Title object.

Returns: Title|null

Implements IContextSource.

Definition at line 176 of file RequestContext.php.

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

Referenced by canUseWikiPage(), and getWikiPage().

◆ getUser()

RequestContext::getUser ( )

Get the User object.

Returns: User

Implements IContextSource.

Definition at line 289 of file RequestContext.php.

References $user, getRequest(), and user.

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

◆ 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 243 of file RequestContext.php.

References $title, $wikipage, WikiPage\factory(), and getTitle().

◆ hasTitle()

RequestContext::hasTitle ( )

Check, if a Title object is set.

Since: 1.25

Returns: bool

Definition at line 195 of file RequestContext.php.

References title.

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 539 of file RequestContext.php.

References $context, $name, $params, $request, $user, $value, $wgRequest, $wgUser, array(), as, User\getId(), getMain(), global, IP\isValid(), User\load(), WebRequest\setIP(), and use.

Referenced by AssembleUploadChunksJob\run(), PublishStashedFileJob\run(), and RequestContextTest\testImportScopedSession().

◆ msg()

RequestContext::msg ( )

Helpful methods.

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

Parameters

mixed ...

Returns: Message

Implements IContextSource.

Definition at line 454 of file RequestContext.php.

References $args.

◆ 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 637 of file RequestContext.php.

References $context, $request, and $title.

Referenced by LogPage\addEntry(), ManualLogEntry\getRecentChange(), MovePage\moveToInternal(), SpecialChangeContentModel\onSubmit(), LocalFile\recordUpload2(), and RecentChangeTest\setUp().

◆ resetMain()

static RequestContext::resetMain ( )

static

Resets singleton returned by getMain().

Should be called only from unit tests.

Examples: /src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 493 of file RequestContext.php.

Referenced by LogFormatterTestCase\doTestLogFormatter(), ParserTest\setUp(), TitlePermissionTest\setUp(), UploadFromUrlTestSuite\setUp(), ParserTest\setupGlobals(), and MediaWikiTestCase\tearDown().

◆ 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 303 of file RequestContext.php.

References $code, $wgLanguageCode, global, and wfDebug().

Referenced by ApiMain\__construct(), getLanguage(), DerivativeContext\setLanguage(), and setLanguage().

◆ setConfig()

RequestContext::setConfig ( Config $c )

Set the Config object.

Parameters

Config $c

Implements MutableContext.

Definition at line 88 of file RequestContext.php.

Referenced by ApiFormatPhpTest\testCrossDomainMangling().

◆ setLanguage()

RequestContext::setLanguage ( $l )

Set the Language object.

Parameters

Language | string $l Language instance or language code

Exceptions

MWException

Since: 1.19

Implements MutableContext.

Definition at line 325 of file RequestContext.php.

References sanitizeLangCode().

◆ setOutput()

RequestContext::setOutput ( OutputPage $o )

Parameters

OutputPage $o

Implements MutableContext.

Definition at line 258 of file RequestContext.php.

References output().

◆ setRequest()

RequestContext::setRequest ( WebRequest $r )

Set the WebRequest object.

Parameters

WebRequest $r

Implements MutableContext.

Definition at line 112 of file RequestContext.php.

References request.

Referenced by SpecialRecentchangesTest\assertConditions(), ApiFormatTestBase\encodeData(), and ApiEditPage\execute().

◆ setSkin()

RequestContext::setSkin ( Skin $s )

Set the Skin object.

Parameters

Skin $s

Implements MutableContext.

Definition at line 392 of file RequestContext.php.

References $s, ContextSource\setContext(), and skin().

◆ setTitle()

RequestContext::setTitle ( Title $title = null )

Set the Title object.

Parameters

Title $title

Implements MutableContext.

Definition at line 165 of file RequestContext.php.

References $title, and title.

Referenced by PreferencesTest\__construct(), braceSubstitution(), RebuildFileCache\execute(), and setWikiPage().

◆ setUser()

RequestContext::setUser ( User $u )

Set the User object.

Parameters

User $u

Implements MutableContext.

Definition at line 280 of file RequestContext.php.

References user.

Referenced by ApiParamInfo\execute(), and SpecialSearchTest\testProfileAndNamespaceLoading().

◆ setWikiPage()

RequestContext::setWikiPage ( WikiPage $p )

Set the WikiPage object.

Since: 1.19

Parameters

WikiPage $p

Implements MutableContext.

Definition at line 224 of file RequestContext.php.

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

Member Data Documentation

◆ $config

Config RequestContext::$config

private

Definition at line 76 of file RequestContext.php.

Referenced by getConfig().

◆ $instance

RequestContext RequestContext::$instance = null

staticprivate

Definition at line 81 of file RequestContext.php.

Referenced by getMain().

◆ $lang

Language RequestContext::$lang

private

Definition at line 61 of file RequestContext.php.

Referenced by getLanguage().

◆ $output

OutputPage RequestContext::$output

private

Definition at line 51 of file RequestContext.php.

Referenced by getOutput().

◆ $request

WebRequest RequestContext::$request

private

Definition at line 36 of file RequestContext.php.

Referenced by getLanguage(), getRequest(), importScopedSession(), newExtraneousContext(), and ApiTestContext\newTestContext().

◆ $skin

Skin RequestContext::$skin

private

Definition at line 66 of file RequestContext.php.

Referenced by getSkin().

◆ $timing

Timing RequestContext::$timing

private

Definition at line 71 of file RequestContext.php.

Referenced by getTiming().

◆ $title

Title RequestContext::$title

private

Definition at line 41 of file RequestContext.php.

Referenced by canUseWikiPage(), getTitle(), getWikiPage(), newExtraneousContext(), and setTitle().

◆ $user

User RequestContext::$user

private

Definition at line 56 of file RequestContext.php.

Referenced by getLanguage(), getUser(), importScopedSession(), and ApiTestContext\newTestContext().

◆ $wikipage

WikiPage RequestContext::$wikipage

private

Definition at line 46 of file RequestContext.php.

Referenced by getWikiPage().

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

◆ $output

◆ $request

◆ $skin

◆ $timing

◆ $title

◆ $user

◆ $wikipage