MediaWiki master
Public Member Functions | Static Public Member Functions | List of all members
RequestContext Class Reference

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

Inherits IContextSource, and MutableContext.

Collaboration diagram for RequestContext:
Collaboration graph
[legend]

Public Member Functions

 __clone ()
 
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage().
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID.
 
 getActionName ()
 Get the action name for the current web request.
 
 getAuthority ()
 
 getConfig ()
 
 getCsrfTokenSet ()
 Get a set of CSRF tokens to obtain and match specific tokens.
 
 getLanguage ()
 Get the Language object.
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getSkinName ()
 Get the name of the skin.
 
 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()
 
 setActionName (string $action)
 
 setAuthority (Authority $authority)
 
 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 a 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 sensible.
 

Detailed Description

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

Stability: newable
Note
marked as newable in 1.35 for lack of a better alternative, but should use a factory in the future and should be narrowed down to not expose heavy weight objects.

Definition at line 51 of file RequestContext.php.

Member Function Documentation

◆ __clone()

RequestContext::__clone ( )
Returns
never

Definition at line 776 of file RequestContext.php.

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

References MediaWiki\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 631 of file RequestContext.php.

References getRequest(), and getUser().

◆ getActionName()

RequestContext::getActionName ( )

Get the action name for the current web request.

This generally returns "view" if the current request or process is not for a skinned index.php web request (e.g. load.php, thumb.php, job runner, CLI, API).

Warning
This must not be called before or during the Setup.php phase, and may cause an error or warning if called too early.
Since
1.38
Returns
string Action

Implements IContextSource.

Definition at line 295 of file RequestContext.php.

◆ getAuthority()

RequestContext::getAuthority ( )
Since
1.36
Returns
Authority

Implements IContextSource.

Definition at line 388 of file RequestContext.php.

◆ getConfig()

RequestContext::getConfig ( )
Returns
Config

Implements IContextSource.

Definition at line 139 of file RequestContext.php.

◆ getCsrfTokenSet()

RequestContext::getCsrfTokenSet ( )

Get a set of CSRF tokens to obtain and match specific tokens.

Returns
CsrfTokenSet

Implements MediaWiki\Session\CsrfTokenSetProvider.

Definition at line 641 of file RequestContext.php.

◆ getLanguage()

RequestContext::getLanguage ( )

Get the Language object.

Initialization of user or request objects can depend on this.

Returns
Language
Exceptions
LogicException
Since
1.19

Implements IContextSource.

Definition at line 442 of file RequestContext.php.

References getRequest(), and getUser().

◆ getMain()

static RequestContext::getMain ( )
static

Get the RequestContext object associated with the main request.

Returns
RequestContext

Definition at line 593 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 607 of file RequestContext.php.

References wfDebug().

◆ getOutput()

RequestContext::getOutput ( )
Returns
OutputPage

Implements IContextSource.

Definition at line 336 of file RequestContext.php.

◆ getRequest()

RequestContext::getRequest ( )
Returns
WebRequest

Implements IContextSource.

Definition at line 157 of file RequestContext.php.

References $wgCommandLineMode.

◆ getSkin()

RequestContext::getSkin ( )
Returns
Skin

Implements IContextSource.

Definition at line 558 of file RequestContext.php.

◆ getSkinName()

RequestContext::getSkinName ( )

Get the name of the skin.

Since
1.41
Returns
string

Definition at line 508 of file RequestContext.php.

◆ getTiming()

RequestContext::getTiming ( )
Returns
Timing

Implements IContextSource.

Definition at line 174 of file RequestContext.php.

◆ getTitle()

RequestContext::getTitle ( )
Returns
Title|null

Implements IContextSource.

Definition at line 194 of file RequestContext.php.

References $wgTitle.

◆ getUser()

RequestContext::getUser ( )
Returns
User

Implements IContextSource.

Definition at line 357 of file RequestContext.php.

References getRequest().

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

References getTitle().

◆ hasTitle()

RequestContext::hasTitle ( )

Check, if a Title object is set.

Since
1.25
Returns
bool

Definition at line 214 of file RequestContext.php.

Referenced by setWikiPage().

◆ importScopedSession()

static RequestContext::importScopedSession ( array  $params)
static

Import a 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.

Parameters
array$paramsResult of RequestContext::exportSession()
Returns
ScopedCallback
Since
1.21

Definition at line 664 of file RequestContext.php.

References $wgRequest, and getMain().

◆ msg()

RequestContext::msg (   $key,
  $params 
)

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

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

Implements MessageLocalizer.

Definition at line 584 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 MediaWiki\Request\FauxRequest, or a MediaWiki\Request\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$titleTitle to use for the extraneous request
WebRequest | array$requestA WebRequest or data to use for a MediaWiki\Request\FauxRequest
Returns
RequestContext

Definition at line 762 of file RequestContext.php.

◆ resetMain()

static RequestContext::resetMain ( )
static

Resets singleton returned by getMain().

Should be called only from unit tests.

Definition at line 617 of file RequestContext.php.

◆ sanitizeLangCode()

static RequestContext::sanitizeLangCode (   $code)
static

Accepts a language code and ensures it's sensible.

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

Parameters
?string$code Language code
Returns
string

Definition at line 398 of file RequestContext.php.

References $wgLanguageCode.

◆ setActionName()

RequestContext::setActionName ( string  $action)
Since
1.38
Parameters
string$action

Implements MutableContext.

Definition at line 278 of file RequestContext.php.

◆ setAuthority()

RequestContext::setAuthority ( Authority  $authority)
Parameters
Authority$authority

Implements MutableContext.

Definition at line 375 of file RequestContext.php.

◆ setConfig()

RequestContext::setConfig ( Config  $config)
Parameters
Config$config

Implements MutableContext.

Definition at line 132 of file RequestContext.php.

◆ setLanguage()

RequestContext::setLanguage (   $language)
Parameters
Language | string$languageLanguage instance or language code
Since
1.19

Implements MutableContext.

Definition at line 423 of file RequestContext.php.

◆ setOutput()

RequestContext::setOutput ( OutputPage  $output)
Parameters
OutputPage$output

Implements MutableContext.

Definition at line 329 of file RequestContext.php.

◆ setRequest()

RequestContext::setRequest ( WebRequest  $request)
Parameters
WebRequest$request

Implements MutableContext.

Definition at line 150 of file RequestContext.php.

Referenced by ApiEditPage\execute().

◆ setSkin()

RequestContext::setSkin ( Skin  $skin)
Parameters
Skin$skin

Implements MutableContext.

Definition at line 495 of file RequestContext.php.

References Skin\getSkinName(), and ContextSource\setContext().

◆ setTitle()

RequestContext::setTitle ( Title  $title = null)
Parameters
Title | null$title

Implements MutableContext.

Definition at line 184 of file RequestContext.php.

Referenced by Parser\braceSubstitution(), and setWikiPage().

◆ setUser()

RequestContext::setUser ( User  $user)
Parameters
User$user

Implements MutableContext.

Definition at line 345 of file RequestContext.php.

Referenced by ApiParamInfo\execute().

◆ setWikiPage()

RequestContext::setWikiPage ( WikiPage  $wikiPage)
Since
1.19
Parameters
WikiPage$wikiPage

Implements MutableContext.

Definition at line 241 of file RequestContext.php.

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

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