An IContextSource implementation which will inherit context from another source but allow individual pieces of context to be changed locally eg: A ContextSource that can inherit from the main RequestContext but have a different Title instance set on it. More...

Inheritance diagram for DerivativeContext:

[legend]

Collaboration diagram for DerivativeContext:

[legend]

List of all members.

Public Member Functions
	__construct (IContextSource $context)
	Constructor.
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage().
	getConfig ()
	Get the Config object.
	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 ()
	Get a message using the current context.
	setConfig (Config $s)
	Set the SiteConfiguration object.
	setLang ($l)
	Set the Language object.
	setLanguage ($l)
	Set the Language object.
	setOutput (OutputPage $o)
	Set the OutputPage object.
	setRequest (WebRequest $r)
	Set the WebRequest object.
	setSkin (Skin $s)
	Set the Skin object.
	setTitle ($t)
	Set the Title object.
	setUser (User $u)
	Set the User object.
	setWikiPage (WikiPage $p)
	Set the WikiPage object.
Private Attributes
Config	$config
Language	$lang
OutputPage	$output
WebRequest	$request
Skin	$skin
Title	$title
User	$user
WikiPage	$wikipage

Detailed Description

An IContextSource implementation which will inherit context from another source but allow individual pieces of context to be changed locally eg: A ContextSource that can inherit from the main RequestContext but have a different Title instance set on it.

Definition at line 32 of file DerivativeContext.php.

Constructor & Destructor Documentation

DerivativeContext::__construct ( IContextSource $ context )

Constructor.

Parameters:

IContextSource $context Context to inherit from

Definition at line 69 of file DerivativeContext.php.

Member Function Documentation

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

Reimplemented from ContextSource.

Definition at line 151 of file DerivativeContext.php.

DerivativeContext::getConfig ( )

Get the Config object.

Returns:: Config

Reimplemented from ContextSource.

Definition at line 87 of file DerivativeContext.php.

DerivativeContext::getLang ( )

Deprecated:: since 1.19 Use getLanguage instead

Returns:: Language

Reimplemented from ContextSource.

Definition at line 266 of file DerivativeContext.php.

DerivativeContext::getLanguage ( )

Get the Language object.

Returns:: Language

Since:: 1.19

Reimplemented from ContextSource.

Definition at line 277 of file DerivativeContext.php.

DerivativeContext::getOutput ( )

Get the OutputPage object.

Returns:: OutputPage

Reimplemented from ContextSource.

Definition at line 202 of file DerivativeContext.php.

DerivativeContext::getRequest ( )

Get the WebRequest object.

Returns:: WebRequest

Reimplemented from ContextSource.

Definition at line 109 of file DerivativeContext.php.

DerivativeContext::getSkin ( )

Get the Skin object.

Returns:: Skin

Reimplemented from ContextSource.

Definition at line 300 of file DerivativeContext.php.

DerivativeContext::getTitle ( )

Get the Title object.

Returns:: Title

Reimplemented from ContextSource.

Definition at line 135 of file DerivativeContext.php.

DerivativeContext::getUser ( )

Get the User object.

Returns:: User

Reimplemented from ContextSource.

Definition at line 224 of file DerivativeContext.php.

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

Reimplemented from ContextSource.

Definition at line 180 of file DerivativeContext.php.

DerivativeContext::msg ( )

Get a message using the current context.

This can't just inherit from ContextSource, since then it would set only the original context, and not take into account any changes.

Parameters:

String	Message name
Variable	number of message arguments

Returns:: Message

Reimplemented from ContextSource.

Definition at line 319 of file DerivativeContext.php.

DerivativeContext::setConfig ( Config $ s )

Set the SiteConfiguration object.

Parameters:

Config $s

Definition at line 78 of file DerivativeContext.php.

DerivativeContext::setLang ( $ l )

Set the Language object.

Deprecated:: since 1.19 Use setLanguage instead

Parameters:

Language | string $l Language instance or language code

Definition at line 238 of file DerivativeContext.php.

DerivativeContext::setLanguage ( $ l )

Set the Language object.

Parameters:

Language | string $l Language instance or language code

Exceptions:

MWException

Since:: 1.19

Definition at line 250 of file DerivativeContext.php.

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

DerivativeContext::setOutput ( OutputPage $ o )

Set the OutputPage object.

Parameters:

OutputPage $o

Definition at line 193 of file DerivativeContext.php.

DerivativeContext::setRequest ( WebRequest $ r )

Set the WebRequest object.

Parameters:

WebRequest $r

Definition at line 100 of file DerivativeContext.php.

DerivativeContext::setSkin ( Skin $ s )

Set the Skin object.

Parameters:

Skin $s

Definition at line 290 of file DerivativeContext.php.

DerivativeContext::setTitle ( $ t )

Set the Title object.

Parameters:

Title $t

Exceptions:

MWException

Definition at line 123 of file DerivativeContext.php.

DerivativeContext::setUser ( User $ u )

Set the User object.

Parameters:

User $u

Definition at line 215 of file DerivativeContext.php.

DerivativeContext::setWikiPage ( WikiPage $ p )

Set the WikiPage object.

Since:: 1.19

Parameters:

WikiPage $p

Definition at line 167 of file DerivativeContext.php.

Member Data Documentation

Config DerivativeContext::$config [private]

Definition at line 63 of file DerivativeContext.php.

Language DerivativeContext::$lang [private]

Definition at line 55 of file DerivativeContext.php.

OutputPage DerivativeContext::$output [private]

Definition at line 47 of file DerivativeContext.php.

WebRequest DerivativeContext::$request [private]

Definition at line 35 of file DerivativeContext.php.

Skin DerivativeContext::$skin [private]

Definition at line 59 of file DerivativeContext.php.

Title DerivativeContext::$title [private]

Definition at line 39 of file DerivativeContext.php.

User DerivativeContext::$user [private]

Definition at line 51 of file DerivativeContext.php.

WikiPage DerivativeContext::$wikipage [private]

Definition at line 43 of file DerivativeContext.php.

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

includes/context/DerivativeContext.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation