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

Inheritance diagram for ContextSource:

[legend]

Collaboration diagram for ContextSource:

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

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	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)

Private Attributes
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

Definition at line 32 of file ContextSource.php.

Member Function Documentation

◆ canUseWikiPage()

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

Reimplemented in DerivativeContext.

Definition at line 102 of file ContextSource.php.

References getContext().

◆ exportSession()

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

Definition at line 208 of file ContextSource.php.

References getContext().

Referenced by ApiUpload\getChunkResult(), and ApiUpload\performUpload().

◆ getAuthority()

ContextSource::getAuthority ( )

Since: 1.36

Returns: Authority

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 143 of file ContextSource.php.

Referenced by UploadForm\__construct(), ApiQuery\doExport(), LogPager\enforceActionRestrictions(), LogPager\enforcePerformerRestrictions(), ApiBlock\execute(), ApiChangeContentModel\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiManageTags\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryLogEvents\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetPageLanguage\execute(), ApiTag\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUserrights\execute(), ApiQueryInfo\extractPageInfo(), ApiFeedContributions\feedItem(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), ApiQueryUserInfo\getCurrentUserInfo(), BlockListPager\getQueryInfo(), ApiComparePages\getRevisionById(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryInfo\getWatchedInfo(), ApiQueryInfo\getWatcherInfo(), LogPager\limitType(), ApiMove\movePage(), ApiMove\moveSubpages(), ApiUpload\performUpload(), ApiQueryUserContribs\prepareQuery(), and ApiTag\processIndividual().

◆ getConfig()

ContextSource::getConfig ( )

Since: 1.23

Stability: stable: to override

Returns: Config

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 71 of file ContextSource.php.

References getContext().

◆ getContext()

ContextSource::getContext ( )

Get the base IContextSource object.

Since: 1.18

Stability: stable: to override

Returns: IContextSource

Definition at line 46 of file ContextSource.php.

References $context, and wfDebug().

Referenced by ApiBase\__construct(), RevisionItem\__construct(), canUseWikiPage(), DerivativeContext\canUseWikiPage(), CategoryViewer\clearCategoryState(), SpecialUnblock\execute(), ApiChangeContentModel\execute(), ApiComparePages\execute(), ApiEmailUser\execute(), ApiExpandTemplates\execute(), ApiFeedContributions\execute(), ApiHelp\execute(), ApiQueryUsers\execute(), ApiRevisionDelete\execute(), ApiUserrights\execute(), ApiFeedContributions\feedItem(), ProtectedPagesPager\formatValue(), ApiUpload\getChunkResult(), getConfig(), DerivativeContext\getConfig(), ApiComparePages\getDiffRevision(), FormatMetadata\getExtendedMetadataFromHook(), ApiAMCreateAccount\getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), EditWatchlistNormalHTMLForm\getLegend(), getOutput(), DerivativeContext\getOutput(), getRequest(), DerivativeContext\getRequest(), UploadForm\getSourceSection(), CategoryPager\getStartForm(), DerivativeContext\getTiming(), getTitle(), DerivativeContext\getTitle(), ApiUserrights\getUrUser(), getUser(), DerivativeContext\getUser(), getWikiPage(), DerivativeContext\getWikiPage(), ApiUpload\performUpload(), SpecialTags\processCreateTagForm(), SpecialTags\processTagForm(), MediaWiki\Preferences\DefaultPreferencesFactory\saveFormData(), SpecialComparePages\showDiff(), MediaWiki\Preferences\DefaultPreferencesFactory\submitForm(), and MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature().

◆ getLanguage()

ContextSource::getLanguage ( )

Since: 1.19

Stability: stable: to override

Returns: Language

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 152 of file ContextSource.php.

References getContext().

Referenced by ApiMain\__construct(), AllMessagesTablePager\__construct(), DifferenceEngine\addHeader(), Skin\buildSidebar(), ApiFeedWatchlist\execute(), ApiHelp\execute(), ApiParamInfo\execute(), ApiQueryAllMessages\execute(), ApiQueryLanguageinfo\execute(), FormatMetadata\fetchExtendedMetadata(), OldChangesList\formatChangeLine(), FormatMetadata\formatNum(), CategoryPager\formatRow(), ActiveUsersPager\formatRow(), NewFilesPager\formatRow(), UsersPager\formatRow(), AllMessagesTablePager\formatValue(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), ChangesList\getArticleLink(), UploadForm\getExtensionsMessage(), CategoryViewer\getHTML(), Skin\getHtmlElementAttributes(), Skin\getLanguages(), IndexPager\getLimitLinks(), TablePager\getLimitSelectList(), AlphabeticPager\getNavigationBar(), ReverseChronologicalPager\getNavigationBar(), FormatMetadata\getPriorityLanguages(), ImageGalleryBase\getRenderLang(), BlockListPager\getRestrictionListHTML(), DifferenceEngine\getRevisionHeader(), DifferenceEngine\getSlotHeader(), UploadForm\getSourceSection(), ImageHistoryList\getThumbForLine(), Skin\getUndeleteLink(), HistoryPager\historyLine(), ImageHistoryList\imageHistoryLine(), ChangesList\insertDateHeader(), Skin\lastModified(), LogEventsList\logLine(), FormatMetadata\makeFormattedData(), EnhancedChangesList\recentChangesBlockGroup(), EnhancedChangesList\recentChangesLine(), HistoryPager\revLink(), DifferenceEngine\showMissingRevision(), and Skin\subPageSubtitleInternal().

◆ getOutput()

ContextSource::getOutput ( )

Since: 1.18

Stability: stable: to override

Returns: OutputPage

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 125 of file ContextSource.php.

References getContext().

Referenced by OOUIHTMLForm\__construct(), CategoryViewer\__construct(), UploadForm\__construct(), DifferenceEngineSlotDiffRenderer\addModules(), UploadForm\addUploadJS(), ChangesList\beginRecentChangesList(), EnhancedChangesList\beginRecentChangesList(), Skin\bottomScripts(), Skin\buildFeedUrls(), Skin\buildNavUrls(), ImportReporter\close(), Article\confirmDelete(), Article\delete(), HTMLForm\displayForm(), Article\doDelete(), Skin\editUrlOptions(), SkinMustache\generateHTML(), TablePager\getBody(), Skin\getCachedNotice(), Skin\getCategories(), Skin\getCategoryLinks(), Skin\getCopyright(), Skin\getDefaultModules(), HTMLForm\getHTML(), VFormHTMLForm\getHTML(), CategoryViewer\getHTML(), CategoryViewer\getImageSection(), Skin\getLanguages(), DifferenceEngine\getMarkPatrolledLinkInfo(), TablePager\getNavigationBar(), Skin\getNewtalks(), CategoryViewer\getPagesSection(), Skin\getRevisionId(), HistoryPager\getStartBody(), SkinMustache\getTemplateData(), Skin\isRevisionCurrent(), Skin\lastModified(), ImportReporter\open(), SkinTemplate\outputPage(), ImageListPager\outputUserDoesNotExist(), Skin\printSource(), DifferenceEngine\renderNewRevision(), ImportReporter\reportNotice(), ImportReporter\reportPage(), Article\setOldSubtitle(), Article\showDeletedRevisionHeader(), DifferenceEngine\showDiff(), DifferenceEngine\showDiffPage(), DifferenceEngine\showDiffStyle(), Article\showMissingArticle(), DifferenceEngine\showMissingRevision(), Article\showPatrolFooter(), Article\showRedirectedFromHeader(), LoginHelper\showReturnToPage(), Article\showViewError(), Skin\subPageSubtitleInternal(), and TraditionalImageGallery\toHTML().

◆ getRequest()

ContextSource::getRequest ( )

Since: 1.18

Stability: stable: to override

Returns: WebRequest

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 80 of file ContextSource.php.

References getContext().

Referenced by ApiMain\__construct(), UsersPager\__construct(), ApiContinuationManager\__construct(), ImageListPager\__construct(), IndexPager\__construct(), TablePager\__construct(), OutputPage\addAcceptLanguage(), OutputPage\checkLastModified(), CategoryViewer\clearCategoryState(), ApiFormatBase\closePrinter(), ApiCSPReport\error(), ApiCheckToken\execute(), ApiCSPReport\execute(), ApiEditPage\execute(), ApiFeedRecentChanges\execute(), ApiLogin\execute(), ApiQueryDeletedrevs\execute(), ApiQueryTokens\execute(), MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute(), ApiQueryUserInfo\getCurrentUserInfo(), IndexPager\getDefaultQuery(), LogPager\getFilterParams(), TablePager\getHiddenFields(), ApiCSPReport\getReport(), UploadForm\getSourceSection(), NewFilesPager\getStartBody(), ApiTokens\getTokenTypes(), Skin\getUndeleteLink(), PageDataRequestHandler\handleRequest(), OutputPage\haveCacheVaryCookies(), ApiQuery\instantiateModules(), ApiQuery\isReadMode(), ApiMain\lacksSameOriginSecurity(), HTMLForm\loadData(), OutputPage\output(), HTMLForm\prepareForm(), ApiQueryRecentChanges\run(), OutputPage\sendCacheControl(), SkinTemplate\setupTemplateContext(), DifferenceEngine\showDiffPage(), OutputPage\showPermissionsErrorPage(), HTMLForm\tryAuthorizedSubmit(), and ApiCSPReport\verifyPostBodyOk().

◆ getSkin()

ContextSource::getSkin ( )

Since: 1.18

Stability: stable: to override

Returns: Skin

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 161 of file ContextSource.php.

References getContext().

Referenced by OutputPage\output().

◆ getStats()

ContextSource::getStats ( )

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

Since: 1.25

Stability: stable: to override

Returns: IBufferingStatsdDataFactory

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 181 of file ContextSource.php.

◆ getTiming()

ContextSource::getTiming ( )

Since: 1.27

Stability: stable: to override

Returns: Timing

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 170 of file ContextSource.php.

References getContext().

◆ getTitle()

ContextSource::getTitle ( )

Since: 1.18

Stability: stable: to override

Returns: Title|null

Implements IContextSource.

Reimplemented in DerivativeContext, DifferenceEngine, HTMLForm, ImageHistoryPseudoPager, AllMessagesTablePager, ImageListPager, and ProtectedTitlesPager.

Definition at line 89 of file ContextSource.php.

References getContext().

Referenced by TablePager\getNavigationBar(), and IndexPager\makeLink().

◆ getUser()

ContextSource::getUser ( )

Stability: stable: to override

Since: 1.18

Stability: stable: to override

Returns: User

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 135 of file ContextSource.php.

References getContext().

Referenced by ImageHistoryPseudoPager\__construct(), IndexPager\__construct(), DifferenceEngine\addHeader(), Skin\buildNavUrls(), OutputPage\checkLastModified(), ApiAMCreateAccount\execute(), ApiBlock\execute(), ApiChangeAuthenticationData\execute(), ApiCheckToken\execute(), ApiClearHasMsg\execute(), ApiCSPReport\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiEmailUser\execute(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiLinkAccount\execute(), ApiLogout\execute(), ApiManageTags\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiPurge\execute(), ApiQueryAuthManagerInfo\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryImageInfo\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryStashImageInfo\execute(), ApiQueryTokens\execute(), ApiQueryUsers\execute(), ApiRemoveAuthenticationData\execute(), ApiResetPassword\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetNotificationTimestamp\execute(), ApiSetPageLanguage\execute(), ApiStashEdit\execute(), ApiTag\execute(), ApiTokens\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUpload\execute(), ApiUserrights\execute(), ApiValidatePassword\execute(), ApiWatch\execute(), ApiQueryWatchlist\extractOutputData(), ApiQueryInfo\extractPageInfo(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), HistoryPager\formatRow(), UsersPager\formatRow(), ProtectedPagesPager\formatValue(), ApiQueryLogEvents\getCacheMode(), Skin\getCategories(), ApiUpload\getChunkResult(), ApiUpload\getContextResult(), ApiQueryUserInfo\getCurrentUserInfo(), Skin\getDefaultModules(), UploadForm\getDescriptionSection(), ApiComparePages\getDiffRevision(), HistoryPager\getEndBody(), HTMLForm\getHiddenFields(), ApiQueryUserInfo\getLatestContributionTime(), DifferenceEngine\getMarkPatrolledLinkInfo(), PreferencesFormOOUI\getModifiedUser(), Skin\getNewtalks(), UploadForm\getOptionsSection(), ApiParse\getPoolKey(), DeletedContribsPager\getQueryInfo(), ApiQueryUserInfo\getRateLimits(), DifferenceEngine\getRevisionHeader(), LogEventsList\getShowHideLinks(), Skin\getSiteNotice(), UploadForm\getSourceSection(), ImageHistoryList\getThumbForLine(), ApiOptions\getUserForUpdates(), ApiQueryInfo\getWatchedInfo(), ChangesList\getWatchlistExpiry(), HistoryPager\historyLine(), ImageHistoryList\imageHistoryLine(), ChangesList\insertDateHeader(), Skin\lastModified(), LogPager\limitType(), ApiMergeHistory\merge(), ApiMove\movePage(), OutputPage\parserOptions(), ApiUpload\performStash(), ApiUpload\performUpload(), Skin\preloadExistence(), ApiQueryUserContribs\prepareQuery(), ApiTag\processIndividual(), ImportReporter\reportPage(), HistoryPager\revLink(), ApiQueryRecentChanges\run(), ApiQueryWatchlist\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), ApiUpload\selectUploadModule(), SkinTemplate\setupTemplateContext(), ApiComparePages\setVals(), DifferenceEngine\showDiffPage(), Skin\showEmailUser(), OutputPage\showPermissionsErrorPage(), HTMLForm\tryAuthorizedSubmit(), RevDelList\updateLog(), and MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature().

◆ getWikiPage()

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.