MediaWiki REL1_41
Public Member Functions | List of all members
IContextSource Interface Reference

Interface for objects which can provide a MediaWiki context on request. More...

Inherits MessageLocalizer, and MediaWiki\Session\CsrfTokenSetProvider.

Inherited by ContextSource, and RequestContext.

Collaboration diagram for IContextSource:
Collaboration graph
[legend]

Public Member Functions

 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage().
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID.
 
 getActionName ()
 Get the action name for the current web request.
 
 getAuthority ()
 
 getConfig ()
 Get the site configuration.
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object.
 
- Public Member Functions inherited from MessageLocalizer
 msg ( $key,... $params)
 This is the method for getting translated interface messages.
 
- Public Member Functions inherited from MediaWiki\Session\CsrfTokenSetProvider
 getCsrfTokenSet ()
 Get a set of CSRF tokens to obtain and match specific tokens.
 

Detailed Description

Interface for objects which can provide a MediaWiki context on request.

Context objects contain request-dependent objects that manage the core web request/response logic for essentially all requests to MediaWiki. The contained objects include: a) Key objects that depend (for construction/loading) on the HTTP request b) Key objects used for response building and PHP session state control c) Performance metric deltas accumulated from request execution d) The site configuration object All of the objects are useful for the vast majority of MediaWiki requests. The site configuration object is included on grounds of extreme utility, even though it should not actually depend on the web request.

More specifically, the scope of the context includes: a) Objects that represent the HTTP request/response and PHP session state b) Object representing the MediaWiki user (as determined by the HTTP request) c) Primary MediaWiki output builder objects (OutputPage, user skin object) d) The language object for the user/request e) The title and wiki page objects requested via URL (if any) f) Performance metric deltas accumulated from request execution g) The site configuration object

This class is not intended as a service-locator nor a service singleton. Objects that only depend on site configuration do not belong here (aside from Config itself). Objects that represent persistent data stores do not belong here either. Session state changes should only be propagated on shutdown by separate persistence handler objects, for example.

Must not be implemented directly by extensions, extend ContextSource instead.

Since
1.18
Stability: stable
to type
Author
Happy-melon

Definition at line 64 of file IContextSource.php.

Member Function Documentation

◆ canUseWikiPage()

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

Implemented in ContextSource, DerivativeContext, and RequestContext.

◆ exportSession()

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

Implemented in ContextSource, and RequestContext.

◆ getActionName()

IContextSource::getActionName ( )

Get the action name for the current web request.

Since
1.38
Returns
string

Implemented in ContextSource, DerivativeContext, and RequestContext.

Referenced by Action\getActionName().

◆ getAuthority()

IContextSource::getAuthority ( )
Since
1.36
Returns
Authority

Implemented in ContextSource, DerivativeContext, and RequestContext.

Referenced by MediaWiki\Pager\PagerTools\__construct(), MediaWiki\Specials\SpecialBlock\processForm(), MediaWiki\Specials\SpecialEmailUser\submit(), and DeleteAction\tempDelete().

◆ getConfig()

IContextSource::getConfig ( )

Get the site configuration.

Since
1.23
Returns
Config

Implemented in ContextSource, DerivativeContext, and RequestContext.

Referenced by MediaWiki\Output\OutputPage\__construct(), MediaWiki\Category\CategoryViewer\__construct(), MediaWiki\Specials\SpecialPageLanguage\changePageLanguage(), MediaWiki\SpecialPage\SpecialPageFactory\executePath(), ApiHelp\getHelp(), MediaWiki\preOutputCommit(), and MediaWiki\Specials\SpecialEmailUser\submit().

◆ getLanguage()

IContextSource::getLanguage ( )
Returns
Language
Since
1.19

Implemented in ContextSource, DerivativeContext, and RequestContext.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\capturePath(), MediaWiki\Preferences\DefaultPreferencesFactory\datetimePreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions(), MWDebug\getDebugInfo(), MWDebug\getFilesIncluded(), MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor(), ApiHelp\getHelp(), MediaWiki\Block\AbstractBlock\getPermissionsError(), ParserOptions\newFromContext(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\searchPreferences(), Message\setContext(), MediaWiki\Preferences\DefaultPreferencesFactory\skinPreferences(), MediaWiki\Specials\SpecialEmailUser\submit(), DeleteAction\tempDelete(), and HTMLFileCache\useFileCache().

◆ getOutput()

IContextSource::getOutput ( )
Returns
OutputPage

Implemented in ContextSource, DerivativeContext, and RequestContext.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\capturePath(), MediaWiki\SpecialPage\SpecialPageFactory\executePath(), MediaWiki\Preferences\DefaultPreferencesFactory\getForm(), ApiHelp\getHelp(), HTMLFileCache\loadFromFileCache(), MediaWiki\preOutputCommit(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\submitForm(), and DeleteAction\tempDelete().

◆ getRequest()

IContextSource::getRequest ( )
Returns
WebRequest

Implemented in ContextSource, DerivativeContext, and RequestContext.

Referenced by MediaWiki\Output\OutputPage\__construct(), MediaWiki\SpecialPage\SpecialPageFactory\capturePath(), MediaWiki\SpecialPage\SpecialPageFactory\executePath(), MWDebug\getDebugInfo(), MediaWiki\Preferences\DefaultPreferencesFactory\getForm(), MediaWiki\Block\AbstractBlock\getPermissionsError(), TextSlotDiffRenderer\getTablePrefix(), ChangesList\newFromContext(), MediaWiki\preOutputCommit(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\run(), MediaWiki\Preferences\DefaultPreferencesFactory\submitForm(), DeleteAction\tempDelete(), and HTMLFileCache\useFileCache().

◆ getSkin()

IContextSource::getSkin ( )
Returns
Skin

Implemented in ContextSource, DerivativeContext, and RequestContext.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor(), and ChangesList\newFromContext().

◆ getTiming()

IContextSource::getTiming ( )
Since
1.27
Returns
Timing

Implemented in ContextSource, DerivativeContext, and RequestContext.

◆ getTitle()

IContextSource::getTitle ( )
Returns
Title|null

Implemented in ContextSource, DerivativeContext, RequestContext, DifferenceEngine, HTMLForm, ImageHistoryPseudoPager, MediaWiki\Pager\AllMessagesTablePager, and MediaWiki\Pager\ImageListPager.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getForm(), HTMLFileCache\loadFromFileCache(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), MediaWiki\run(), and Message\setContext().

◆ getUser()

IContextSource::getUser ( )
Returns
User

Implemented in ContextSource, DerivativeContext, and RequestContext.

Referenced by MediaWiki\SpecialPage\SpecialPageFactory\capturePath(), MediaWiki\Specials\SpecialPageLanguage\changePageLanguage(), MediaWiki\Block\AbstractBlock\getPermissionsError(), ParserOptions\newFromContext(), ChangesList\newFromContext(), MediaWiki\preOutputCommit(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), DeleteAction\tempDelete(), and HTMLFileCache\useFileCache().

◆ getWikiPage()

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

Implemented in ContextSource, DerivativeContext, and RequestContext.

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