MediaWiki master
MediaWiki\Context\ContextSource Class Reference

The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and provide accessors to it. More...

Inherits MediaWiki\Context\IContextSource.

Inherited by DifferenceEngine, FormatMetadata, ImageGalleryBase, ImportReporter, LoginHelper, MediaWiki\Api\ApiBase, MediaWiki\Api\ApiModuleManager, MediaWiki\Category\CategoryViewer, MediaWiki\Context\DerivativeContext, MediaWiki\HTMLForm\HTMLForm, MediaWiki\Logging\LogEventsList, MediaWiki\Output\OutputPage, MediaWiki\Page\ImageHistoryList, MediaWiki\Pager\IndexPager, MediaWiki\RecentChanges\ChangesList, MediaWiki\RevisionList\RevisionListBase, and Skin.

Collaboration diagram for MediaWiki\Context\ContextSource:

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 ()
 
 getContext ()
 Get the base IContextSource object.
 
 getCsrfTokenSet ()
 Get a repository to obtain and match CSRF tokens.
 
 getLanguage ()
 
 getLanguageCode ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object.
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 setContext (IContextSource $context)
 

Detailed Description

The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and provide accessors to it.

Stability: stable
to extend
Since
1.18
Author
Happy-melon

Definition at line 48 of file ContextSource.php.

Member Function Documentation

◆ canUseWikiPage()

MediaWiki\Context\ContextSource::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
Stability: stable
to override
Returns
bool

Implements MediaWiki\Context\IContextSource.

Reimplemented in MediaWiki\Context\DerivativeContext.

Definition at line 118 of file ContextSource.php.

References MediaWiki\Context\ContextSource\getContext().

◆ exportSession()

MediaWiki\Context\ContextSource::exportSession ( )

Export the resolved user IP, HTTP headers, user ID, and session ID.

The result will be reasonably sized to allow for serialization.

Since
1.21
Stability: stable
to override
Returns
array

Implements MediaWiki\Context\IContextSource.

Definition at line 236 of file ContextSource.php.

◆ getActionName()

MediaWiki\Context\ContextSource::getActionName ( )

Get the action name for the current web request.

Since
1.38
Stability: stable
to override
Returns
string

Implements MediaWiki\Context\IContextSource.

Reimplemented in MediaWiki\Context\DerivativeContext.

Definition at line 143 of file ContextSource.php.

◆ getAuthority()

◆ getConfig()

MediaWiki\Context\ContextSource::getConfig ( )
Since
1.23
Stability: stable
to override
Returns
Config

Implements MediaWiki\Context\IContextSource.

Reimplemented in MediaWiki\Context\DerivativeContext.

Definition at line 87 of file ContextSource.php.

References MediaWiki\Context\ContextSource\getContext().

Referenced by MediaWiki\Api\ApiMain\__construct(), ImageGalleryBase\__construct(), MediaWiki\Api\ApiBlock\__construct(), MediaWiki\Api\ApiUnblock\__construct(), MediaWiki\Api\ApiQuery\__construct(), MediaWiki\Api\ApiEditPage\__construct(), MediaWiki\Api\ApiUpload\__construct(), MediaWiki\Api\ApiMove\__construct(), MediaWiki\Api\ApiDelete\__construct(), MediaWiki\Api\ApiRollback\__construct(), MediaWiki\Api\ApiUserrights\__construct(), MediaWiki\Api\ApiWatch\__construct(), MediaWiki\Api\ApiProtect\__construct(), MediaWiki\Api\ApiUndelete\__construct(), MediaWiki\Api\ApiQueryCategories\__construct(), MediaWiki\Api\ApiQueryCategoryMembers\__construct(), MediaWiki\Api\ApiQueryQueryPage\__construct(), MediaWiki\Pager\HistoryPager\__construct(), MediaWiki\Pager\ImageListPager\__construct(), MediaWiki\Pager\ActiveUsersPager\__construct(), UploadForm\addUploadJS(), MediaWiki\Api\ApiQuerySiteinfo\appendDbReplLagInfo(), MediaWiki\Api\ApiQuerySiteinfo\appendExtensions(), MediaWiki\Api\ApiQuerySiteinfo\appendFileExtensions(), MediaWiki\Api\ApiQuerySiteinfo\appendGeneralInfo(), MediaWiki\Api\ApiQuerySiteinfo\appendInstalledLibraries(), MediaWiki\Api\ApiQuerySiteinfo\appendInterwikiMap(), MediaWiki\Api\ApiQuerySiteinfo\appendNamespaces(), MediaWiki\Api\ApiQuerySiteinfo\appendProtocols(), MediaWiki\Api\ApiQuerySiteinfo\appendRestrictions(), MediaWiki\Api\ApiQuerySiteinfo\appendRightsInfo(), MediaWiki\Api\ApiQuerySiteinfo\appendUploadDialog(), MediaWiki\Api\ApiQuerySiteinfo\appendUserGroups(), MediaWiki\Api\ApiBlock\execute(), MediaWiki\Api\ApiFeedContributions\execute(), MediaWiki\Api\ApiFeedRecentChanges\execute(), MediaWiki\Api\ApiFeedWatchlist\execute(), MediaWiki\Api\ApiLogin\execute(), MediaWiki\Api\ApiOpenSearch\execute(), MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryAuthManagerInfo\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryCodexIcons\execute(), MediaWiki\Api\ApiQueryFileRepoInfo\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryUserContribs\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiRemoveAuthenticationData\execute(), MediaWiki\Api\ApiRollback\execute(), MediaWiki\Api\ApiSetPageLanguage\execute(), MediaWiki\Api\ApiUpload\execute(), MediaWiki\Pager\UsersPager\formatRow(), MediaWiki\Api\ApiImport\getAllowedImportSources(), MediaWiki\Api\ApiFeedWatchlist\getAllowedParams(), MediaWiki\Api\ApiQueryAllUsers\getAllowedParams(), MediaWiki\Api\ApiQueryLogEvents\getAllowedParams(), MediaWiki\Api\ApiBlock\getAllowedParams(), MediaWiki\Api\ApiFeedContributions\getAllowedParams(), MediaWiki\Api\ApiFeedRecentChanges\getAllowedParams(), MediaWiki\Api\ApiOpenSearch\getAllowedParams(), MediaWiki\Api\ApiQueryAllDeletedRevisions\getAllowedParams(), MediaWiki\Api\ApiQueryAllImages\getAllowedParams(), MediaWiki\Api\ApiQueryAllPages\getAllowedParams(), MediaWiki\Api\ApiQueryAllRevisions\getAllowedParams(), MediaWiki\Api\ApiQueryBacklinksprop\getAllowedParams(), MediaWiki\Api\ApiQueryBlocks\getAllowedParams(), MediaWiki\Api\ApiQueryCategoryMembers\getAllowedParams(), MediaWiki\Api\ApiQueryExtLinksUsage\getAllowedParams(), MediaWiki\Api\ApiQueryProtectedTitles\getAllowedParams(), MediaWiki\Api\ApiQueryUserContribs\getAllowedParams(), MediaWiki\Api\ApiResetPassword\getAllowedParams(), MediaWiki\Api\ApiQuerySiteinfo\getCacheMode(), MediaWiki\Api\ApiQueryUserInfo\getCurrentUserInfo(), UploadForm\getDescriptionSection(), MediaWiki\Api\ApiResetPassword\getExamplesMessages(), MediaWiki\Api\ApiLogin\getExtendedDescription(), MediaWiki\Api\ApiSetPageLanguage\getExtendedDescription(), UploadForm\getExtensionsMessage(), MediaWiki\Pager\ImageListPager\getFieldNames(), MediaWiki\Pager\LogPager\getFilterParams(), MediaWiki\Category\CategoryViewer\getHTML(), MediaWiki\RecentChanges\EnhancedChangesList\getLineData(), MediaWiki\Api\ApiPageSet\getPageTableFields(), MediaWiki\Pager\ActiveUsersPager\getQueryInfo(), MediaWiki\Pager\LogPager\getQueryInfo(), MediaWiki\Api\ApiQueryUserInfo\getRateLimits(), UploadForm\getSourceSection(), SkinFallback\getTemplateData(), MediaWiki\Api\ApiFormatBase\initPrinter(), MediaWiki\Api\ApiLogin\isDeprecated(), MediaWiki\Pager\ImageListPager\isFieldSortable(), MediaWiki\Api\ApiQueryImageInfo\mergeThumbParams(), SkinTemplate\prepareQuickTemplate(), MediaWiki\Pager\ContributionsPager\reallyDoQuery(), MediaWiki\RecentChanges\EnhancedChangesList\recentChangesBlockGroup(), MediaWiki\RecentChanges\EnhancedChangesList\recentChangesBlockLine(), MediaWiki\RecentChanges\ChangesList\recentChangesFlags(), MediaWiki\Api\ApiQueryInfo\requestExtraData(), MediaWiki\Api\ApiQueryRecentChanges\run(), MediaWiki\Api\ApiQueryAllDeletedRevisions\run(), MediaWiki\Api\ApiQueryAllRevisions\run(), SkinTemplate\setupTemplate(), MediaWiki\Logging\LogEventsList\showOptions(), LoginHelper\showReturnToPage(), TraditionalImageGallery\toHTML(), and SkinTemplate\useCombinedLoginLink().

◆ getContext()

MediaWiki\Context\ContextSource::getContext ( )

Get the base IContextSource object.

Since
1.18
Stability: stable
to override
Returns
IContextSource

Definition at line 62 of file ContextSource.php.

References MediaWiki\Context\RequestContext\getMain(), and wfDebug().

Referenced by MediaWiki\Api\ApiBase\__construct(), UploadForm\__construct(), MediaWiki\RevisionList\RevisionItem\__construct(), MediaWiki\Pager\UsersPager\buildGroupLink(), MediaWiki\Context\ContextSource\canUseWikiPage(), MediaWiki\Context\DerivativeContext\canUseWikiPage(), MediaWiki\Category\CategoryViewer\clearCategoryState(), MediaWiki\Specials\SpecialUnblock\execute(), MediaWiki\RecentChanges\ChangesList\formatCharacterDifference(), MediaWiki\Pager\HistoryPager\formatRow(), MediaWiki\Pager\ProtectedTitlesPager\formatRow(), MediaWiki\Pager\ProtectedPagesPager\formatValue(), MediaWiki\Context\ContextSource\getConfig(), MediaWiki\Context\DerivativeContext\getConfig(), EditWatchlistNormalHTMLForm\getLegend(), MediaWiki\Pager\UsersPager\getPageHeader(), MediaWiki\Context\ContextSource\getRequest(), MediaWiki\Context\DerivativeContext\getRequest(), DifferenceEngine\getSlotDiffRenderers(), MediaWiki\Pager\NewFilesPager\getStartBody(), MediaWiki\Pager\CategoryPager\getStartForm(), MediaWiki\Context\DerivativeContext\getTiming(), MediaWiki\Context\ContextSource\getTitle(), MediaWiki\Context\DerivativeContext\getTitle(), MediaWiki\Context\ContextSource\getWikiPage(), MediaWiki\Context\DerivativeContext\getWikiPage(), MediaWiki\RecentChanges\ChangesList\insertLog(), MediaWiki\Logging\LogEventsList\logLine(), MediaWiki\Specials\SpecialTags\processCreateTagForm(), MediaWiki\Specials\SpecialTags\processTagForm(), MediaWiki\RecentChanges\ChangesList\recentChangesFlags(), MediaWiki\Preferences\DefaultPreferencesFactory\saveFormData(), MediaWiki\Specials\SpecialComparePages\showDiff(), MediaWiki\Logging\LogEventsList\showOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\submitForm(), and MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature().

◆ getCsrfTokenSet()

MediaWiki\Context\ContextSource::getCsrfTokenSet ( )

Get a repository to obtain and match CSRF tokens.

Returns
CsrfTokenSet
Since
1.37

Implements MediaWiki\Session\CsrfTokenSetProvider.

Definition at line 246 of file ContextSource.php.

◆ getLanguage()

MediaWiki\Context\ContextSource::getLanguage ( )
Since
1.19
Stability: stable
to override
Returns
Language

Implements MediaWiki\Context\IContextSource.

Reimplemented in MediaWiki\Context\DerivativeContext.

Definition at line 179 of file ContextSource.php.

Referenced by MediaWiki\Api\ApiMain\__construct(), MediaWiki\Pager\AllMessagesTablePager\__construct(), MediaWiki\Api\ApiQuerySiteinfo\appendGeneralInfo(), MediaWiki\Api\ApiEmailUser\execute(), MediaWiki\Api\ApiFeedWatchlist\execute(), MediaWiki\Api\ApiHelp\execute(), MediaWiki\Api\ApiParamInfo\execute(), MediaWiki\Api\ApiQueryAllMessages\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryLanguageinfo\execute(), MediaWiki\Pager\CategoryPager\formatRow(), MediaWiki\Pager\HistoryPager\formatRow(), MediaWiki\Pager\ActiveUsersPager\formatRow(), MediaWiki\Pager\NewFilesPager\formatRow(), MediaWiki\Pager\NewPagesPager\formatRow(), MediaWiki\Pager\ProtectedTitlesPager\formatRow(), MediaWiki\Pager\UsersPager\formatRow(), MediaWiki\Pager\AllMessagesTablePager\formatValue(), MediaWiki\Pager\ProtectedPagesPager\formatValue(), MediaWiki\Pager\UploadStashPager\formatValue(), MediaWiki\Pager\BlockListPager\formatValue(), MediaWiki\RecentChanges\ChangesList\getArticleLink(), UploadForm\getExtensionsMessage(), MediaWiki\Category\CategoryViewer\getHTML(), MediaWiki\Pager\UsersPager\getPageHeader(), ImageGalleryBase\getRenderLang(), MediaWiki\Page\ImageHistoryList\getThumbForLine(), MediaWiki\Page\ImageHistoryList\imageHistoryLine(), MediaWiki\RecentChanges\ChangesList\insertDateHeader(), MediaWiki\Logging\LogEventsList\logLine(), FormatMetadata\makeFormattedData(), SkinTemplate\prepareQuickTemplate(), and MediaWiki\RecentChanges\EnhancedChangesList\recentChangesLine().

◆ getLanguageCode()

MediaWiki\Context\ContextSource::getLanguageCode ( )
Since
1.42
Stability: stable
to override
Note
When overriding, keep consistent with getLanguage()!
Returns
Bcp47Code

Implements MediaWiki\Language\LocalizationContext.

Definition at line 189 of file ContextSource.php.

◆ getOutput()

◆ getRequest()

◆ getSkin()

MediaWiki\Context\ContextSource::getSkin ( )
Since
1.18
Stability: stable
to override
Returns
Skin

Implements MediaWiki\Context\IContextSource.

Reimplemented in MediaWiki\Context\DerivativeContext.

Definition at line 198 of file ContextSource.php.

◆ getTiming()

MediaWiki\Context\ContextSource::getTiming ( )
Since
1.27
Stability: stable
to override
Returns
Timing

Implements MediaWiki\Context\IContextSource.

Reimplemented in MediaWiki\Context\DerivativeContext.

Definition at line 207 of file ContextSource.php.

◆ getTitle()

◆ getUser()

◆ getWikiPage()

MediaWiki\Context\ContextSource::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
Stability: stable
to override
Returns
WikiPage

Implements MediaWiki\Context\IContextSource.

Reimplemented in MediaWiki\Context\DerivativeContext.

Definition at line 132 of file ContextSource.php.

References MediaWiki\Context\ContextSource\getContext().

Referenced by MediaWiki\Pager\HistoryPager\formatRow(), and MediaWiki\Pager\HistoryPager\getQueryInfo().

◆ msg()

MediaWiki\Context\ContextSource::msg ( $key,
$params )

Get a Message object with context set Parameters are the same as wfMessage()

Since
1.18
Stability: stable
to override
Parameters
string | string[] | MessageSpecifier$keyMessage key, or array of keys, or a MessageSpecifier. @phpcs:ignore Generic.Files.LineLength
MessageParam|MessageSpecifier|string|int|float|list<MessageParam|MessageSpecifier|string|int|float>...$params See Message::params()
Returns
Message

Implements MessageLocalizer.

Reimplemented in MediaWiki\Context\DerivativeContext.

Definition at line 224 of file ContextSource.php.

Referenced by UploadForm\__construct(), MediaWiki\Pager\ContributionsPager\__construct(), MediaWiki\Api\ApiQuerySiteinfo\appendInterwikiMap(), MediaWiki\Api\ApiQuerySiteinfo\appendSkins(), MediaWiki\Page\ImageHistoryList\beginImageHistoryList(), SkinTemplate\buildLoginData(), SkinTemplate\buildPersonalUrls(), ImportReporter\close(), MediaWiki\Api\ApiFormatBase\closePrinter(), MediaWiki\Api\ApiAMCreateAccount\execute(), MediaWiki\Api\ApiClientLogin\execute(), MediaWiki\Api\ApiEditPage\execute(), MediaWiki\Api\ApiFeedContributions\execute(), MediaWiki\Api\ApiFeedWatchlist\execute(), MediaWiki\Api\ApiImageRotate\execute(), MediaWiki\Api\ApiOptionsBase\execute(), MediaWiki\Api\ApiQueryAllMessages\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryTags\execute(), MediaWiki\Api\ApiFeedContributions\feedItemDesc(), MediaWiki\Pager\CategoryPager\formatRow(), MediaWiki\Pager\ActiveUsersPager\formatRow(), MediaWiki\Pager\MergeHistoryPager\formatRow(), MediaWiki\Pager\NewPagesPager\formatRow(), MediaWiki\Pager\ProtectedTitlesPager\formatRow(), MediaWiki\Pager\UsersPager\formatRow(), MediaWiki\Pager\AllMessagesTablePager\formatValue(), MediaWiki\Pager\ProtectedPagesPager\formatValue(), MediaWiki\Pager\UploadStashPager\formatValue(), MediaWiki\Pager\BlockListPager\formatValue(), MediaWiki\Page\ImageHistoryPseudoPager\getBody(), MediaWiki\HTMLForm\CodexHTMLForm\getButtons(), MediaWiki\HTMLForm\OOUIHTMLForm\getButtons(), MediaWiki\RecentChanges\EnhancedChangesList\getDiffHistLinks(), MediaWiki\Pager\HistoryPager\getEmptyBody(), MediaWiki\Pager\TablePager\getEmptyBody(), UploadForm\getExtensionsMessage(), MediaWiki\Pager\AllMessagesTablePager\getFieldNames(), MediaWiki\Pager\BlockListPager\getFieldNames(), MediaWiki\Pager\ImageListPager\getFieldNames(), MediaWiki\Pager\ProtectedPagesPager\getFieldNames(), MediaWiki\Pager\UploadStashPager\getFieldNames(), MediaWiki\Api\ApiAMCreateAccount\getFinalDescription(), MediaWiki\Api\ApiClientLogin\getFinalDescription(), MediaWiki\Api\ApiLinkAccount\getFinalDescription(), MediaWiki\Category\CategoryViewer\getHTML(), MediaWiki\HTMLForm\CodexHTMLForm\getLegend(), EditWatchlistNormalHTMLForm\getLegend(), MediaWiki\RecentChanges\EnhancedChangesList\getLineData(), MediaWiki\RecentChanges\EnhancedChangesList\getLogText(), MediaWiki\Pager\TablePager\getNavigationBar(), MediaWiki\Pager\UsersPager\getPageHeader(), UploadForm\getSourceSection(), MediaWiki\Pager\HistoryPager\getStartBody(), MediaWiki\Pager\AllMessagesTablePager\getStartBody(), SkinMustache\getTemplateData(), MediaWiki\Page\ImageHistoryList\getThumbForLine(), MediaWiki\Page\ImageHistoryList\imageHistoryLine(), MediaWiki\RecentChanges\ChangesList\insertLog(), FormatMetadata\makeFormattedData(), MediaWiki\Pager\AllMessagesTablePager\reallyDoQuery(), MediaWiki\RecentChanges\EnhancedChangesList\recentChangesBlockGroup(), ImportReporter\reportNotice(), ImportReporter\reportPage(), MediaWiki\Api\ApiOptions\shouldIgnoreKey(), TraditionalImageGallery\toHTML(), and MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature().

◆ setContext()


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