MediaWiki  REL1_20
DerivativeContext Class Reference

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:
Collaboration diagram for DerivativeContext:

List of all members.

Public Member Functions

 __construct (IContextSource $context)
 Constructor.
 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.
 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 (Title $t)
 Set the Title object.
 setUser (User $u)
 Set the User object.
 setWikiPage (WikiPage $p)
 Set the WikiPage object.

Private Attributes

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

Constructor.

Parameters:
$contextIContextSource Context to inherit from

Definition at line 66 of file DerivativeContext.php.


Member Function Documentation

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 122 of file DerivativeContext.php.

Deprecated:
1.19 Use getLanguage instead
Returns:
Language

Reimplemented from ContextSource.

Definition at line 236 of file DerivativeContext.php.

Get the Language object.

Returns:
Language
Since:
1.19

Reimplemented from ContextSource.

Definition at line 247 of file DerivativeContext.php.

References ContextSource\getContext().

Get the OutputPage object.

Returns:
OutputPage object

Reimplemented from ContextSource.

Definition at line 173 of file DerivativeContext.php.

Get the WebRequest object.

Returns:
WebRequest

Reimplemented from ContextSource.

Definition at line 84 of file DerivativeContext.php.

Get the Skin object.

Returns:
Skin

Reimplemented from ContextSource.

Definition at line 270 of file DerivativeContext.php.

Get the Title object.

Returns:
Title

Reimplemented from ContextSource.

Definition at line 106 of file DerivativeContext.php.

Get the User object.

Returns:
User

Reimplemented from ContextSource.

Definition at line 195 of file DerivativeContext.php.

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 151 of file DerivativeContext.php.

Set the Language object.

Deprecated:
1.19 Use setLanguage instead
Parameters:
$lMixed Language instance or language code

Definition at line 209 of file DerivativeContext.php.

References setLanguage(), and wfDeprecated().

Set the Language object.

Parameters:
$lMixed Language instance or language code
Since:
1.19

Definition at line 220 of file DerivativeContext.php.

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

Referenced by setLang().

Set the OutputPage object.

Parameters:
$oOutputPage

Definition at line 164 of file DerivativeContext.php.

Set the WebRequest object.

Parameters:
$rWebRequest object

Definition at line 75 of file DerivativeContext.php.

Set the Skin object.

Parameters:
$sSkin

Definition at line 260 of file DerivativeContext.php.

Set the Title object.

Parameters:
$tTitle object

Definition at line 97 of file DerivativeContext.php.

Set the User object.

Parameters:
$uUser

Definition at line 186 of file DerivativeContext.php.

Set the WikiPage object.

Since:
1.19
Parameters:
$pWikiPage object

Definition at line 138 of file DerivativeContext.php.


Member Data Documentation

Language DerivativeContext::$lang [private]

Definition at line 56 of file DerivativeContext.php.

OutputPage DerivativeContext::$output [private]

Definition at line 48 of file DerivativeContext.php.

WebRequest DerivativeContext::$request [private]

Definition at line 36 of file DerivativeContext.php.

Skin DerivativeContext::$skin [private]

Definition at line 60 of file DerivativeContext.php.

Title DerivativeContext::$title [private]

Definition at line 40 of file DerivativeContext.php.

User DerivativeContext::$user [private]

Definition at line 52 of file DerivativeContext.php.

WikiPage DerivativeContext::$wikipage [private]

Definition at line 44 of file DerivativeContext.php.


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