BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
RequestContext Class Reference
Inheritance diagram for RequestContext:
Collaboration diagram for RequestContext:

Public Member Functions

 setConfig (Config $config)
 
 getConfig ()
 
 setRequest (WebRequest $request)
 
 getRequest ()
 
 getStats ()
 
 getTiming ()
 
 setTitle (Title $title=null)
 
 getTitle ()
 
 hasTitle ()
 
 canUseWikiPage ()
 
 setWikiPage (WikiPage $wikiPage)
 
 getWikiPage ()
 
 setOutput (OutputPage $output)
 
 getOutput ()
 
 setUser (User $user)
 
 getUser ()
 
 setLanguage ($language)
 
 getLanguage ()
 
 setSkin (Skin $skin)
 
 getSkin ()
 
 msg ($key)
 
 exportSession ()
 

Static Public Member Functions

static sanitizeLangCode ($code)
 
static getMain ()
 
static getMainAndWarn ($func=__METHOD__)
 
static resetMain ()
 
static importScopedSession (array $params)
 
static newExtraneousContext (Title $title, $request=[])
 

Detailed Description

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

Member Function Documentation

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.

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.

RequestContext::getConfig ( )
Returns
Config

Implements IContextSource.

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.

static RequestContext::getMain ( )
static

Get the RequestContext object associated with the main request

Returns
RequestContext
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
RequestContext::getOutput ( )
Returns
OutputPage

Implements IContextSource.

RequestContext::getRequest ( )
Returns
WebRequest

Implements IContextSource.

RequestContext::getSkin ( )
Returns
Skin

Implements IContextSource.

RequestContext::getStats ( )
Deprecated:
since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)
Returns
IBufferingStatsdDataFactory

Implements IContextSource.

RequestContext::getTiming ( )
Returns
Timing

Implements IContextSource.

RequestContext::getTitle ( )
Returns
Title|null

Implements IContextSource.

RequestContext::getUser ( )
Returns
User

Implements IContextSource.

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.

RequestContext::hasTitle ( )

Check, if a Title object is set

Since
1.25
Returns
bool
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$paramsResult of RequestContext::exportSession()
Returns
ScopedCallback
Exceptions
MWException
Since
1.21
RequestContext::msg (   $key)

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$args,...
Returns
Message

Implements MessageLocalizer.

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$titleTitle to use for the extraneous request
WebRequest | array$requestA WebRequest or data to use for a FauxRequest
Returns
RequestContext
static RequestContext::resetMain ( )
static

Resets singleton returned by getMain(). Should be called only from unit tests.

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$codeLanguage code
Returns
string
RequestContext::setConfig ( Config  $config)
Parameters
Config$config

Implements MutableContext.

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

Implements MutableContext.

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

Implements MutableContext.

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

Implements MutableContext.

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

Implements MutableContext.

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

Implements MutableContext.

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

Implements MutableContext.

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

Implements MutableContext.


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