MediaWiki  master
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:

Public Member Functions

 __construct (IContextSource $context)
 
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 getActionName ()
 Get the action name for the current web request. More...
 
 getAuthority ()
 
 getConfig ()
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a message using the current context. More...
 
 setActionName (string $action)
 
 setAuthority (Authority $authority)
 
 setConfig (Config $config)
 
 setLanguage ( $language)
 
 setOutput (OutputPage $output)
 
 setRequest (WebRequest $request)
 
 setSkin (Skin $skin)
 
 setTitle (Title $title)
 
 setUser (User $user)
 
 setWikiPage (WikiPage $wikiPage)
 
- Public Member Functions inherited from ContextSource
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getContext ()
 Get the base IContextSource object. More...
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens. More...
 
 setContext (IContextSource $context)
 

Private Attributes

string $action
 
Authority $authority
 
Config $config
 
Language $lang
 
OutputPage $output
 
WebRequest $request
 
Skin $skin
 
Timing $timing
 
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.

Stability: newable
Since
1.19

Definition at line 32 of file DerivativeContext.php.

Constructor & Destructor Documentation

◆ __construct()

DerivativeContext::__construct ( IContextSource  $context)
Stability: stable
to call
Parameters
IContextSource$contextContext to inherit from

Definition at line 92 of file DerivativeContext.php.

References ContextSource\setContext().

Member Function Documentation

◆ canUseWikiPage()

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

References ContextSource\getContext().

◆ getActionName()

DerivativeContext::getActionName ( )

Get the action name for the current web request.

Since
1.38
Returns
string Action

Reimplemented from ContextSource.

Definition at line 209 of file DerivativeContext.php.

◆ getAuthority()

DerivativeContext::getAuthority ( )
Since
1.36
Returns
Authority

Reimplemented from ContextSource.

Definition at line 253 of file DerivativeContext.php.

◆ getConfig()

DerivativeContext::getConfig ( )
Returns
Config

Reimplemented from ContextSource.

Definition at line 106 of file DerivativeContext.php.

References ContextSource\getContext().

◆ getLanguage()

DerivativeContext::getLanguage ( )
Returns
Language
Since
1.19

Reimplemented from ContextSource.

Definition at line 278 of file DerivativeContext.php.

References getContext().

◆ getOutput()

DerivativeContext::getOutput ( )
Returns
OutputPage

Reimplemented from ContextSource.

Definition at line 223 of file DerivativeContext.php.

References getContext().

◆ getRequest()

DerivativeContext::getRequest ( )
Returns
WebRequest

Reimplemented from ContextSource.

Definition at line 136 of file DerivativeContext.php.

References ContextSource\getContext().

◆ getSkin()

DerivativeContext::getSkin ( )
Returns
Skin

Reimplemented from ContextSource.

Definition at line 293 of file DerivativeContext.php.

References getContext().

◆ getStats()

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

Reimplemented from ContextSource.

Definition at line 115 of file DerivativeContext.php.

◆ getTiming()

DerivativeContext::getTiming ( )
Returns
Timing

Reimplemented from ContextSource.

Definition at line 122 of file DerivativeContext.php.

References ContextSource\getContext().

◆ getTitle()

DerivativeContext::getTitle ( )
Returns
Title|null

Reimplemented from ContextSource.

Definition at line 150 of file DerivativeContext.php.

References ContextSource\getContext().

◆ getUser()

DerivativeContext::getUser ( )
Returns
User

Reimplemented from ContextSource.

Definition at line 238 of file DerivativeContext.php.

References getContext().

◆ getWikiPage()

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

References ContextSource\getContext().

◆ msg()

DerivativeContext::msg (   $key,
  $params 
)

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 | string[] | MessageSpecifier$keyMessage key, or array of keys, or a MessageSpecifier.
mixed...$params
Returns
Message

Reimplemented from ContextSource.

Definition at line 309 of file DerivativeContext.php.

References wfMessage().

◆ setActionName()

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

Implements MutableContext.

Definition at line 199 of file DerivativeContext.php.

◆ setAuthority()

DerivativeContext::setAuthority ( Authority  $authority)
Stability: unstable
Parameters
Authority$authority

Implements MutableContext.

Definition at line 242 of file DerivativeContext.php.

◆ setConfig()

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

Implements MutableContext.

Definition at line 99 of file DerivativeContext.php.

References $config.

◆ setLanguage()

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

Implements MutableContext.

Definition at line 262 of file DerivativeContext.php.

References RequestContext\sanitizeLangCode().

◆ setOutput()

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

Implements MutableContext.

Definition at line 216 of file DerivativeContext.php.

◆ setRequest()

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

Implements MutableContext.

Definition at line 129 of file DerivativeContext.php.

References $request.

◆ setSkin()

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

Implements MutableContext.

Definition at line 285 of file DerivativeContext.php.

References ContextSource\setContext().

◆ setTitle()

DerivativeContext::setTitle ( Title  $title)
Parameters
Title$title

Implements MutableContext.

Definition at line 143 of file DerivativeContext.php.

References $title.

◆ setUser()

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

Implements MutableContext.

Definition at line 230 of file DerivativeContext.php.

◆ setWikiPage()

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

Implements MutableContext.

Definition at line 178 of file DerivativeContext.php.

Member Data Documentation

◆ $action

string DerivativeContext::$action
private

Definition at line 51 of file DerivativeContext.php.

◆ $authority

Authority DerivativeContext::$authority
private

Definition at line 66 of file DerivativeContext.php.

◆ $config

Config DerivativeContext::$config
private

Definition at line 81 of file DerivativeContext.php.

Referenced by setConfig().

◆ $lang

Language DerivativeContext::$lang
private

Definition at line 71 of file DerivativeContext.php.

◆ $output

OutputPage DerivativeContext::$output
private

Definition at line 56 of file DerivativeContext.php.

◆ $request

WebRequest DerivativeContext::$request
private

Definition at line 36 of file DerivativeContext.php.

Referenced by setRequest().

◆ $skin

Skin DerivativeContext::$skin
private

Definition at line 76 of file DerivativeContext.php.

◆ $timing

Timing DerivativeContext::$timing
private

Definition at line 86 of file DerivativeContext.php.

◆ $title

Title DerivativeContext::$title
private

Definition at line 41 of file DerivativeContext.php.

Referenced by setTitle().

◆ $user

User DerivativeContext::$user
private

Definition at line 61 of file DerivativeContext.php.

◆ $wikipage

WikiPage DerivativeContext::$wikipage
private

Definition at line 46 of file DerivativeContext.php.


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