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

Inheritance diagram for IContextSource:

[legend]

Collaboration diagram for IContextSource:

Public Member Functions
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage(). More...

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID. More...

	getConfig ()
	Get the site configuration. More...

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object. More...

Public Member Functions inherited from MessageLocalizer
	msg ( $key,... $params)
	This is the method for getting translated interface messages. More...

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.

Definition at line 53 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 RequestContext, DerivativeContext, and ContextSource.

◆ 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 RequestContext, and ContextSource.

◆ getConfig()

IContextSource::getConfig ( )

Get the site configuration.

Since: 1.23

Returns: Config

Implemented in RequestContext, DerivativeContext, and ContextSource.

Referenced by MediaWiki\__construct(), ImageHistoryList\__construct(), CategoryViewer\__construct(), MediaWiki\Special\SpecialPageFactory\executePath(), ImageGalleryBase\factory(), ApiHelp\getHelp(), MediaWiki\preOutputCommit(), and ChangesList\showCharacterDifference().

◆ getLanguage()

IContextSource::getLanguage ( )

Returns: Language

Since: 1.19

Implemented in RequestContext, DerivativeContext, and ContextSource.

Referenced by MediaWiki\Special\SpecialPageFactory\capturePath(), MediaWiki\Preferences\DefaultPreferencesFactory\datetimePreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), MediaWiki\Block\AbstractBlock\getBlockErrorParams(), MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor(), ApiHelp\getHelp(), ApiHelp\getHelpInternal(), MediaWiki\Preferences\DefaultPreferencesFactory\getTimezoneOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), ChangesList\showCharacterDifference(), LogEventsList\showLogExtract(), and MediaWiki\Preferences\DefaultPreferencesFactory\skinPreferences().

◆ getOutput()

IContextSource::getOutput ( )

Returns: OutputPage

Implemented in RequestContext, DerivativeContext, and ContextSource.

Referenced by MediaWiki\Special\SpecialPageFactory\capturePath(), ApiHelp\execute(), MediaWiki\Special\SpecialPageFactory\executePath(), MediaWiki\Preferences\DefaultPreferencesFactory\getForm(), ApiHelp\getHelp(), MediaWiki\preOutputCommit(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), LogEventsList\showLogExtract(), and MediaWiki\Preferences\DefaultPreferencesFactory\submitForm().

◆ getRequest()

IContextSource::getRequest ( )

Returns: WebRequest

Implemented in DerivativeContext, RequestContext, and ContextSource.

Referenced by MediaWiki\Special\SpecialPageFactory\capturePath(), MediaWiki\Special\SpecialPageFactory\executePath(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), MediaWiki\Block\AbstractBlock\getBlockErrorParams(), MediaWiki\Preferences\DefaultPreferencesFactory\getForm(), MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor(), ChangesList\newFromContext(), MediaWiki\preOutputCommit(), MediaWiki\run(), and MediaWiki\Preferences\DefaultPreferencesFactory\submitForm().

◆ getSkin()

IContextSource::getSkin ( )

Returns: Skin

Implemented in RequestContext, DerivativeContext, and ContextSource.

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

◆ getStats()

IContextSource::getStats ( )

Deprecated:: since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)

Since: 1.25

Returns: IBufferingStatsdDataFactory

Implemented in ContextSource, RequestContext, and DerivativeContext.

◆ getTiming()

IContextSource::getTiming ( )

Since: 1.27

Returns: Timing

Implemented in RequestContext, ContextSource, and DerivativeContext.

◆ getTitle()

IContextSource::getTitle ( )

Returns: Title|null

Implemented in HTMLForm, ImageListPager, AllMessagesTablePager, DifferenceEngine, RequestContext, DerivativeContext, ContextSource, ProtectedTitlesPager, and ImageHistoryPseudoPager.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getForm(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), and MediaWiki\run().

◆ getUser()

IContextSource::getUser ( )

Returns: User

Implemented in RequestContext, DerivativeContext, and ContextSource.

Referenced by MediaWiki\Special\SpecialPageFactory\capturePath(), MediaWiki\Block\AbstractBlock\getBlockErrorParams(), ChangesList\newFromContext(), and MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences().

◆ 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.