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

Inheritance diagram for RequestContext:

Collaboration diagram for RequestContext:

Public Member Functions
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().
	getLang ()
	getLanguage ()
	Get the Language object.
	getOutput ()
	Get the OutputPage object.
	getRequest ()
	Get the WebRequest object.
	getSkin ()
	Get the Skin object.
	getTitle ()
	Get the Title object.
	getUser ()
	Get the User object.
	getWikiPage ()
	Get the WikiPage object.
	msg ()
	Helpful methods.
	setLang ($l)
	Set the Language 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 $t)
	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	newExtraneousContext (Title $title, $request=array())
	Create a new extraneous context.
static	sanitizeLangCode ($code)
	Accepts a language code and ensures it's sane.
Private Attributes
Language	$lang
OutputPage	$output
WebRequest	$request
Skin	$skin
Title	$title
User	$user
WikiPage	$wikipage

Detailed Description

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

Definition at line 30 of file RequestContext.php.

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.

Definition at line 112 of file RequestContext.php.

RequestContext::getLang ( )

Deprecated:: 1.19 Use getLanguage instead

Returns:: Language

Implements IContextSource.

Definition at line 251 of file RequestContext.php.

RequestContext::getLanguage ( )

Get the Language object.

Initialization of user or request objects can depend on this.

Returns:: Language

Since:: 1.19

Implements IContextSource.

Definition at line 263 of file RequestContext.php.

Referenced by UploadFromUrlTestSuite\setUp().

static RequestContext::getMain ( ) [static]

Static methods.

Get the RequestContext object associated with the main request

Returns:: RequestContext object

Definition at line 371 of file RequestContext.php.

Referenced by LogFormatter\__construct(), StubUserLang\_newObject(), Linker\buildRollbackLink(), ApiTestCase\doApiRequest(), Linker\generateRollback(), and wfStreamThumb().

RequestContext::getOutput ( )

Get the OutputPage object.

Returns:: OutputPage object

Implements IContextSource.

Definition at line 169 of file RequestContext.php.

RequestContext::getRequest ( )

Get the WebRequest object.

Returns:: WebRequest

Implements IContextSource.

Definition at line 74 of file RequestContext.php.

RequestContext::getSkin ( )

Get the Skin object.

Returns:: Skin

Implements IContextSource.

Definition at line 313 of file RequestContext.php.

RequestContext::getTitle ( )

Get the Title object.

Returns:: Title

Implements IContextSource.

Definition at line 96 of file RequestContext.php.

RequestContext::getUser ( )

Get the User object.

Returns:: User

Implements IContextSource.

Definition at line 190 of file RequestContext.php.

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

Returns:: WikiPage

Implements IContextSource.

Definition at line 146 of file RequestContext.php.

RequestContext::msg ( )

Helpful methods.

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

Returns:: Message object

Implements IContextSource.

Definition at line 359 of file RequestContext.php.

static RequestContext::newExtraneousContext	(	Title $	title,
		$	request = `array()`
	)		`[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 393 of file RequestContext.php.

Referenced by RecentChangeTest\__construct(), Title\moveToInternal(), and ManualLogEntry\publish().

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:

$code string

Returns:: string

Definition at line 203 of file RequestContext.php.

References Language\isValidCode(), and wfDebug().

Referenced by DerivativeContext\setLanguage(), and setLanguage().

RequestContext::setLang ( $ l )

Set the Language object.

Deprecated:: 1.19 Use setLanguage instead

Parameters:

$l	Mixed Language instance or language code

Definition at line 224 of file RequestContext.php.

References setLanguage(), and wfDeprecated().

RequestContext::setLanguage ( $ l )

Set the Language object.

Parameters:

$l	Mixed Language instance or language code

Since:: 1.19

Definition at line 235 of file RequestContext.php.

References Language\factory(), and sanitizeLangCode().

Referenced by setLang().

RequestContext::setOutput ( OutputPage $ o )

Parameters:

$o	OutputPage

Definition at line 160 of file RequestContext.php.

RequestContext::setRequest ( WebRequest $ r )

Set the WebRequest object.

Parameters:

$r	WebRequest object

Definition at line 65 of file RequestContext.php.

RequestContext::setSkin ( Skin $ s )

Set the Skin object.

Parameters:

$s Skin

Definition at line 303 of file RequestContext.php.

RequestContext::setTitle ( Title $ t )

Set the Title object.

Parameters:

$t	Title object

Definition at line 87 of file RequestContext.php.

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

RequestContext::setUser ( User $ u )

Set the User object.

Parameters:

$u User

Definition at line 181 of file RequestContext.php.

Referenced by SpecialSearchTest\testProfileAndNamespaceLoading().

RequestContext::setWikiPage ( WikiPage $ p )

Set the WikiPage object.

Since:: 1.19

Parameters:

$p	WikiPage object

Definition at line 133 of file RequestContext.php.

Member Data Documentation

Language RequestContext::$lang [private]

Definition at line 54 of file RequestContext.php.

OutputPage RequestContext::$output [private]

Definition at line 46 of file RequestContext.php.

WebRequest RequestContext::$request [private]

Definition at line 34 of file RequestContext.php.

Skin RequestContext::$skin [private]

Definition at line 58 of file RequestContext.php.

Title RequestContext::$title [private]

Definition at line 38 of file RequestContext.php.

User RequestContext::$user [private]

Definition at line 50 of file RequestContext.php.

WikiPage RequestContext::$wikipage [private]

Definition at line 42 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

Detailed Description

Member Function Documentation

Member Data Documentation