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.

	getConfig ()
	Get the Config object.

	getContext ()
	Get the base IContextSource object.

	getLanguage ()
	Get the Language object.

	getOutput ()
	Get the OutputPage object.

	getRequest ()
	Get the WebRequest object.

	getSkin ()
	Get the Skin object.

	getStats ()
	Get the Stats object.

	getTiming ()
	Get the Timing object.

	getTitle ()
	Get the Title object.

	getUser ()
	Get the User object.

	getWikiPage ()
	Get the WikiPage object.

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

	setContext (IContextSource $context)
	Set the IContextSource object.

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.

Since: 1.18

Definition at line 30 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

Returns: bool

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 100 of file ContextSource.php.

References getContext().

Referenced by SkinTemplate\buildContentNavigationUrls(), and OutputPage\getJSVars().

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

Returns: array

Since: 1.21

Implements IContextSource.

Definition at line 202 of file ContextSource.php.

References getContext().

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

◆ getConfig()

ContextSource::getConfig ( )

Get the Config object.

Since: 1.23

Returns: Config

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 68 of file ContextSource.php.

References getContext().

◆ getContext()

ContextSource::getContext ( )

Get the base IContextSource object.

Since: 1.18

Returns: IContextSource

Definition at line 41 of file ContextSource.php.

References $context, RequestContext\getMain(), and wfDebug().

Referenced by ApiMain\__construct(), RevisionItem\__construct(), ApiBase\__construct(), OutputPage\addSubtitle(), SkinTemplate\buildContentNavigationUrls(), UsersPager\buildGroupLink(), SkinTemplate\buildNavUrls(), canUseWikiPage(), DerivativeContext\canUseWikiPage(), CategoryViewer\clearCategoryState(), ApiBlock\execute(), ApiComparePages\execute(), ApiEmailUser\execute(), ApiExpandTemplates\execute(), ApiFeedContributions\execute(), ApiHelp\execute(), ApiLogin\execute(), ApiOptions\execute(), ApiParse\execute(), ApiQueryUsers\execute(), ApiRevisionDelete\execute(), ApiUnblock\execute(), ApiUserrights\execute(), ApiMain\executeAction(), ApiMain\executeActionWithErrorHandling(), exportSession(), ApiFeedContributions\feedItem(), ChangesList\formatCharacterDifference(), ProtectedPagesPager\formatValue(), ApiUpload\getChunkResult(), getConfig(), DerivativeContext\getConfig(), ApiComparePages\getDiffContent(), FormatMetadata\getExtendedMetadataFromHook(), ApiAMCreateAccount\getFinalDescription(), ApiBase\getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), ApiBase\getFinalParamDescription(), ApiBase\getFinalSummary(), OutputPage\getHeadLinksArray(), OutputPage\getJSVars(), getLanguage(), DerivativeContext\getLanguage(), EditWatchlistNormalHTMLForm\getLegend(), getOutput(), DerivativeContext\getOutput(), UsersPager\getPageHeader(), DifferenceEngine\getParserOutput(), getRequest(), DerivativeContext\getRequest(), getSkin(), DerivativeContext\getSkin(), UploadForm\getSourceSection(), CategoryPager\getStartForm(), getTiming(), DerivativeContext\getTiming(), getTitle(), DerivativeContext\getTitle(), HTMLForm\getTitle(), ApiUserrights\getUrUser(), getUser(), DerivativeContext\getUser(), getWikiPage(), DerivativeContext\getWikiPage(), OutputPage\headElement(), HistoryPager\historyLine(), ChangesList\insertLog(), ChangesList\insertLogEntry(), ChangesList\insertRollback(), LogEventsList\logLine(), ApiParse\makeParserOptions(), msg(), SkinTemplate\outputPage(), OutputPage\parserOptions(), ApiUpload\performUpload(), SkinTemplate\prepareQuickTemplate(), ChangesList\recentChangesFlags(), OutputPage\setHTMLTitle(), OutputPage\setPageTitle(), OutputPage\setTitle(), DifferenceEngine\showDiffPage(), LogEventsList\showOptions(), and SkinTemplate\tabAction().

◆ getLanguage()

ContextSource::getLanguage ( )

Get the Language object.

Since: 1.19

Returns: Language

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 143 of file ContextSource.php.

References getContext().

Referenced by ApiMain\__construct(), AllMessagesTablePager\__construct(), DifferenceEngine\addHeader(), OutputPage\addInlineStyle(), ApiMain\addRequestedFields(), OutputPage\buildExemptModules(), OutputPage\enableOOUI(), ApiFeedWatchlist\execute(), ApiHelp\execute(), ApiParamInfo\execute(), ApiQueryAllMessages\execute(), FormatMetadata\fetchExtendedMetadata(), OldChangesList\formatChangeLine(), SkinTemplate\formatLanguageName(), FormatMetadata\formatNum(), CategoryPager\formatRow(), ActiveUsersPager\formatRow(), NewFilesPager\formatRow(), UsersPager\formatRow(), AllMessagesTablePager\formatValue(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), ChangesList\getArticleLink(), UploadForm\getExtensionsMessage(), LogEventsList\getFilterLinks(), CategoryViewer\getHTML(), Skin\getHtmlElementAttributes(), SkinTemplate\getLanguages(), EditWatchlistNormalHTMLForm\getLegend(), IndexPager\getLimitLinks(), TablePager\getLimitSelectList(), AlphabeticPager\getNavigationBar(), ReverseChronologicalPager\getNavigationBar(), FormatMetadata\getPriorityLanguages(), ImageGalleryBase\getRenderLang(), DifferenceEngine\getRevisionHeader(), OutputPage\getRlClientContext(), AllMessagesTablePager\getRowAttrs(), UploadForm\getSourceSection(), ImageHistoryList\getThumbForLine(), ChangesList\getTimestamp(), OutputPage\headElement(), HistoryPager\historyLine(), ImageHistoryList\imageHistoryLine(), ChangesList\insertDateHeader(), ChangesList\insertLogEntry(), ChangesList\insertUserRelatedLinks(), Skin\lastModified(), LogEventsList\logLine(), FormatMetadata\makeFormattedData(), SkinTemplate\prepareQuickTemplate(), EnhancedChangesList\recentChangesBlockGroup(), EnhancedChangesList\recentChangesLine(), HistoryPager\revLink(), OutputPage\showLagWarning(), DifferenceEngine\showMissingRevision(), OutputPage\styleLink(), and Skin\subPageSubtitle().

◆ getOutput()

ContextSource::getOutput ( )

Get the OutputPage object.

Since: 1.18

Returns: OutputPage

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 123 of file ContextSource.php.

References getContext().

Referenced by OOUIHTMLForm\__construct(), CategoryViewer\__construct(), UploadForm\__construct(), UploadForm\addUploadJS(), ChangesList\beginRecentChangesList(), EnhancedChangesList\beginRecentChangesList(), Skin\bottomScripts(), SkinTemplate\buildContentNavigationUrls(), SkinTemplate\buildNavUrls(), ApiMain\checkConditionalRequestHeaders(), ImportReporter\close(), HTMLForm\displayForm(), SkinVector\enableResponsiveMode(), TablePager\getBody(), Skin\getCachedNotice(), Skin\getCategories(), Skin\getCategoryLinks(), Skin\getDefaultModules(), HTMLForm\getErrorsOrWarnings(), HTMLForm\getHTML(), VFormHTMLForm\getHTML(), CategoryViewer\getHTML(), SkinTemplate\getLanguages(), DifferenceEngine\getMarkPatrolledLinkInfo(), TablePager\getNavigationBar(), Skin\getNewtalks(), DerivativeContext\getOutput(), Skin\getRevisionId(), HistoryPager\getStartBody(), ApiMain\handleCORS(), Skin\lastModified(), ImportReporter\open(), SkinTemplate\outputPage(), ImageListPager\outputUserDoesNotExist(), SkinTemplate\prepareQuickTemplate(), DifferenceEngine\renderNewRevision(), ImportReporter\reportNotice(), ImportReporter\reportPage(), ApiMain\sendCacheHeaders(), DifferenceEngine\showDiff(), DifferenceEngine\showDiffPage(), DifferenceEngine\showDiffStyle(), DifferenceEngine\showMissingRevision(), LogEventsList\showOptions(), LoginHelper\showReturnToPage(), Skin\subPageSubtitle(), and TraditionalImageGallery\toHTML().

◆ getRequest()

ContextSource::getRequest ( )

Get the WebRequest object.

Since: 1.18

Returns: WebRequest

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 78 of file ContextSource.php.

References getContext().

Referenced by ApiMain\__construct(), AllMessagesTablePager\__construct(), ApiContinuationManager\__construct(), ImageListPager\__construct(), IndexPager\__construct(), TablePager\__construct(), UsersPager\__construct(), OutputPage\addAcceptLanguage(), SkinTemplate\buildContentNavigationUrls(), OutputPage\buildExemptModules(), SkinTemplate\buildNavUrls(), SkinTemplate\buildPersonalUrls(), ApiMain\checkConditionalRequestHeaders(), ApiMain\checkExecutePermissions(), OutputPage\checkLastModified(), ApiMain\checkMaxLag(), CategoryViewer\clearCategoryState(), ApiFormatBase\closePrinter(), ApiMain\createErrorPrinter(), ApiCSPReport\error(), ApiCheckToken\execute(), ApiCSPReport\execute(), ApiEditPage\execute(), ApiFeedRecentChanges\execute(), ApiLogin\execute(), ApiQueryDeletedrevs\execute(), ApiQueryTokens\execute(), ApiMain\executeActionWithErrorHandling(), OutputPage\getBottomScripts(), HTMLForm\getButtons(), OOUIHTMLForm\getButtons(), ApiQueryUserInfo\getCurrentUserInfo(), LogEventsList\getDefaultQuery(), IndexPager\getDefaultQuery(), LogEventsList\getExtraInputs(), LogPager\getFilterParams(), OutputPage\getHeadLinksArray(), TablePager\getHiddenFields(), ApiCSPReport\getReport(), OutputPage\getRlClientContext(), UploadForm\getSourceSection(), NewFilesPager\getStartBody(), ApiTokens\getTokenTypes(), Skin\getUndeleteLink(), ApiMain\getUpload(), ApiMain\getUserAgent(), ApiMain\getVal(), ApiMain\handleCORS(), ApiMain\handleException(), OutputPage\haveCacheVaryCookies(), ApiQuery\instantiateModules(), ApiMain\lacksSameOriginSecurity(), HTMLForm\loadData(), ApiBase\logFeatureUsage(), ApiMain\logRequest(), OutputPage\output(), HTMLForm\prepareForm(), SkinTemplate\prepareQuickTemplate(), ApiMain\reportUnusedParams(), ApiBase\requirePostedParameters(), OutputPage\returnToMain(), ApiQueryRecentChanges\run(), OutputPage\sendCacheControl(), ApiMain\sendCacheHeaders(), ApiMain\setRequestExpectations(), ApiMain\setupExternalResponse(), SkinTemplate\setupTemplateForOutput(), DifferenceEngine\showDiffPage(), OutputPage\showPermissionsErrorPage(), HTMLForm\tryAuthorizedSubmit(), OutputPage\userCanPreview(), ApiBase\useTransactionalTimeLimit(), ApiBase\validateToken(), and ApiCSPReport\verifyPostBodyOk().

◆ getSkin()

ContextSource::getSkin ( )

Get the Skin object.

Since: 1.18

Returns: Skin

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 153 of file ContextSource.php.

References getContext().

Referenced by OutputPage\enableOOUI(), OutputPage\getJSVars(), OutputPage\getRlClient(), OutputPage\getRlClientContext(), DerivativeContext\getSkin(), and OutputPage\output().

◆ getStats()

ContextSource::getStats ( )

Get the Stats object.

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

Since: 1.25

Returns: IBufferingStatsdDataFactory

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 175 of file ContextSource.php.

◆ getTiming()

ContextSource::getTiming ( )

Get the Timing object.

Since: 1.27

Returns: Timing

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 163 of file ContextSource.php.

References getContext().

◆ getTitle()

ContextSource::getTitle ( )

Get the Title object.

Since: 1.18

Returns: Title|null

Implements IContextSource.

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

Definition at line 88 of file ContextSource.php.

References getContext().

Referenced by OutputPage\addAcceptLanguage(), OutputPage\addParserOutputMetadata(), Skin\addToSidebarPlain(), OutputPage\addWikiText(), OutputPage\addWikiTextTidy(), SkinTemplate\buildContentNavigationUrls(), OutputPage\buildExemptModules(), SkinTemplate\buildNavUrls(), SkinTemplate\buildPersonalUrls(), HistoryPager\curLink(), ApiEditPage\execute(), HistoryPager\formatRow(), OutputPage\getBottomScripts(), Skin\getCategories(), Skin\getCategoryLinks(), Skin\getCopyright(), DifferenceEngine\getDiffLang(), HistoryPager\getEndBody(), LogEventsList\getFilterLinks(), OutputPage\getHeadLinksArray(), OutputPage\getJSVars(), SkinTemplate\getLanguages(), SkinTemplate\getNameSpaceKey(), TablePager\getNavigationBar(), UsersPager\getPageHeader(), Skin\getRelevantTitle(), HistoryPager\getStartBody(), Skin\getUndeleteLink(), OutputPage\headElement(), HistoryPager\historyLine(), Skin\isRevisionCurrent(), OutputPage\isUserCssPreview(), OutputPage\isUserJsPreview(), HistoryPager\lastLink(), Skin\lastModified(), DifferenceEngine\loadRevisionData(), DifferenceEngine\loadRevisionIds(), IndexPager\makeLink(), DifferenceEngine\mapDiffPrevNext(), OutputPage\parse(), SkinTemplate\prepareQuickTemplate(), Skin\printSource(), DifferenceEngine\renderNewRevision(), HistoryPager\revLink(), OutputPage\setFeedAppendQuery(), SkinTemplate\setupTemplateForOutput(), DifferenceEngine\showDiffPage(), and OutputPage\userCanPreview().

◆ getUser()

ContextSource::getUser ( )

Get the User object.

Since: 1.18

Returns: User

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 133 of file ContextSource.php.

References getContext().

Referenced by LogEventsList\__construct(), HistoryPager\__construct(), UploadForm\__construct(), IndexPager\__construct(), ImageHistoryList\beginImageHistoryList(), SkinTemplate\buildContentNavigationUrls(), SkinTemplate\buildNavUrls(), SkinTemplate\buildPersonalUrls(), ApiMain\canApiHighLimits(), ApiMain\checkAsserts(), ApiMain\checkConditionalRequestHeaders(), ApiMain\checkExecutePermissions(), OutputPage\checkLastModified(), ApiBase\checkTitleUserPermissions(), ApiBase\checkUserRightsAny(), DifferenceEngine\deletedLink(), ApiQuery\doExport(), ApiBase\errorArrayToStatus(), ApiQueryTitleBlacklist\execute(), ApiAMCreateAccount\execute(), ApiBlock\execute(), ApiChangeAuthenticationData\execute(), ApiCheckToken\execute(), ApiClearHasMsg\execute(), ApiComparePages\execute(), ApiCSPReport\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiEmailUser\execute(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiLinkAccount\execute(), ApiLogout\execute(), ApiManageTags\execute(), ApiMove\execute(), ApiOptions\execute(), ApiParse\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiPurge\execute(), ApiQueryAuthManagerInfo\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryImageInfo\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryStashImageInfo\execute(), ApiQueryTokens\execute(), ApiRemoveAuthenticationData\execute(), ApiResetPassword\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetNotificationTimestamp\execute(), ApiSetPageLanguage\execute(), ApiStashEdit\execute(), ApiTag\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUpload\execute(), ApiUserrights\execute(), ApiValidatePassword\execute(), ApiWatch\execute(), ApiQueryWatchlist\extractOutputData(), ApiQueryInfo\extractPageInfo(), ApiQueryRevisionsBase\extractRevisionInfo(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), HistoryPager\formatRow(), UsersPager\formatRow(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), ApiQueryLogEvents\getCacheMode(), Skin\getCategories(), Skin\getCategoryLinks(), ApiUpload\getChunkResult(), ApiUpload\getContextResult(), ApiQueryUserInfo\getCurrentUserInfo(), UploadForm\getDescriptionSection(), ApiComparePages\getDiffContent(), HistoryPager\getEndBody(), LogPager\getFilterParams(), OutputPage\getHeadLinksArray(), HTMLForm\getHiddenFields(), OutputPage\getJSVars(), EnhancedChangesList\getLineData(), EnhancedChangesList\getLogText(), DifferenceEngine\getMarkPatrolledLinkInfo(), PreferencesForm\getModifiedUser(), Skin\getNewtalks(), UploadForm\getOptionsSection(), ApiParse\getParsedContent(), ActiveUsersPager\getQueryInfo(), BlockListPager\getQueryInfo(), DeletedContribsPager\getQueryInfo(), UsersPager\getQueryInfo(), ApiQueryUserInfo\getRateLimits(), DifferenceEngine\getRevisionHeader(), OutputPage\getRlClientContext(), LogEventsList\getShowHideLinks(), Skin\getSiteNotice(), UploadForm\getSourceSection(), HistoryPager\getStartBody(), ImageHistoryList\getThumbForLine(), ApiTokens\getTokenTypes(), LogEventsList\getTypeSelector(), Skin\getUndeleteLink(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryInfo\getWatchedInfo(), ApiQueryInfo\getWatcherInfo(), ApiBase\getWatchlistUser(), ApiBase\getWatchlistValue(), OutputPage\headElement(), HistoryPager\historyLine(), ImageHistoryList\imageHistoryLine(), ApiPageSet\initFromRevIDs(), ChangesList\insertDateHeader(), ChangesList\insertDiffHist(), ChangesList\insertRollback(), ApiQueryGadgets\isNeeded(), Skin\lastModified(), LogPager\limitPerformer(), LogPager\limitTitle(), LogPager\limitType(), DifferenceEngine\loadNewText(), DifferenceEngine\loadText(), ApiBase\logFeatureUsage(), ApiMain\logRequest(), ApiMergeHistory\merge(), ApiMove\movePage(), OutputPage\parserOptions(), ApiUpload\performStash(), ApiUpload\performUpload(), Skin\preloadExistence(), ApiQueryContributions\prepareQuery(), ApiTag\processIndividual(), ImportReporter\reportPage(), DifferenceEngine\revisionDeleteLink(), ApiQueryRecentChanges\run(), ApiQueryWatchlist\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), ApiUpload\selectUploadModule(), SkinTemplate\setupTemplateForOutput(), ApiBase\setWatch(), ChangesList\showAsUnpatrolled(), DifferenceEngine\showDiffPage(), Skin\showEmailUser(), ApiQueryBase\showHiddenUsersAddBlockInfo(), OutputPage\showPermissionsErrorPage(), HTMLForm\tryAuthorizedSubmit(), RevDelList\updateLog(), OutputPage\userCanPreview(), ApiQueryBase\userCanSeeRevDel(), and ApiBase\validateToken().

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