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 ()

	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.

Since: 1.18

Definition at line 29 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 91 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 179 of file ContextSource.php.

References getContext().

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

◆ getConfig()

ContextSource::getConfig ( )

Since: 1.23

Returns: Config

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 63 of file ContextSource.php.

References getContext().

◆ getContext()

ContextSource::getContext ( )

Get the base IContextSource object.

Since: 1.18

Returns: IContextSource

Definition at line 40 of file ContextSource.php.

References $context, and wfDebug().

Referenced by RevisionItem\__construct(), ApiBase\__construct(), UsersPager\buildGroupLink(), canUseWikiPage(), CategoryViewer\clearCategoryState(), ApiBlock\execute(), ApiComparePages\execute(), ApiEmailUser\execute(), ApiExpandTemplates\execute(), ApiFeedContributions\execute(), ApiHelp\execute(), ApiOptions\execute(), ApiParse\execute(), ApiQueryUsers\execute(), ApiRevisionDelete\execute(), ApiUnblock\execute(), ApiUserrights\execute(), exportSession(), ApiFeedContributions\feedItem(), ChangesList\formatCharacterDifference(), ProtectedPagesPager\formatValue(), DifferenceEngine\generateContentDiffBody(), DifferenceEngine\generateTextDiffBody(), ApiUpload\getChunkResult(), getConfig(), ApiComparePages\getDiffRevision(), ApiAMCreateAccount\getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), getLanguage(), EditWatchlistNormalHTMLForm\getLegend(), getOutput(), UsersPager\getPageHeader(), DifferenceEngine\getParserOutput(), ApiOptions\getPreferences(), getRequest(), getSkin(), DifferenceEngine\getSlotDiffRenderers(), UploadForm\getSourceSection(), CategoryPager\getStartForm(), getTiming(), getTitle(), ApiUserrights\getUrUser(), getUser(), getWikiPage(), HistoryPager\historyLine(), ChangesList\insertLog(), ChangesList\insertLogEntry(), ChangesList\insertRollback(), LogEventsList\logLine(), ApiParse\makeParserOptions(), msg(), PageImages\onBeforePageDisplay(), ApiUpload\performUpload(), SpecialTags\processCreateTagForm(), SpecialTags\processTagForm(), ChangesList\recentChangesFlags(), ApiOptions\resetPreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\saveFormData(), SpecialComparePages\showDiff(), DifferenceEngine\showDiffPage(), LogEventsList\showOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\submitForm(), and DifferenceEngine\textDiff().

◆ getLanguage()

ContextSource::getLanguage ( )

Since: 1.19

Returns: Language

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 128 of file ContextSource.php.

References getContext().

Referenced by ApiMain\__construct(), AllMessagesTablePager\__construct(), DifferenceEngine\addHeader(), OutputPage\addInlineStyle(), ApiMain\addRequestedFields(), OutputPage\enableOOUI(), ApiFeedWatchlist\execute(), ApiHelp\execute(), ApiParamInfo\execute(), ApiQueryAllMessages\execute(), ApiQueryLanguageinfo\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(), CategoryViewer\getHTML(), Skin\getHtmlElementAttributes(), SkinTemplate\getLanguages(), IndexPager\getLimitLinks(), TablePager\getLimitSelectList(), AlphabeticPager\getNavigationBar(), ReverseChronologicalPager\getNavigationBar(), FormatMetadata\getPriorityLanguages(), ImageGalleryBase\getRenderLang(), BlockListPager\getRestrictionListHTML(), DifferenceEngine\getRevisionHeader(), OutputPage\getRlClientContext(), DifferenceEngine\getSlotHeader(), UploadForm\getSourceSection(), ImageHistoryList\getThumbForLine(), ChangesList\getTimestamp(), Skin\getUndeleteLink(), 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 ( )

Since: 1.18

Returns: OutputPage

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 112 of file ContextSource.php.

References getContext().

Referenced by OOUIHTMLForm\__construct(), CategoryViewer\__construct(), UploadForm\__construct(), DifferenceEngineSlotDiffRenderer\addModules(), UploadForm\addUploadJS(), MediaWiki\Extension\OATHAuth\Special\DisableOATHForUser\alterForm(), ChangesList\beginRecentChangesList(), EnhancedChangesList\beginRecentChangesList(), Skin\bottomScripts(), SkinTemplate\buildContentNavigationUrls(), SkinTemplate\buildNavUrls(), ApiMain\checkConditionalRequestHeaders(), ImportReporter\close(), HTMLForm\displayForm(), Skin\editUrlOptions(), SkinVector\enableResponsiveMode(), TablePager\getBody(), Skin\getCachedNotice(), Skin\getCategories(), Skin\getCategoryLinks(), CategoryTreeCategoryViewer\getCategoryTree(), Skin\getCopyright(), Skin\getDefaultModules(), HTMLForm\getErrorsOrWarnings(), MediaWiki\Extension\OATHAuth\HTMLForm\TOTPEnableForm\getHTML(), HTMLForm\getHTML(), VFormHTMLForm\getHTML(), CategoryViewer\getHTML(), CategoryViewer\getImageSection(), SkinTemplate\getLanguages(), DifferenceEngine\getMarkPatrolledLinkInfo(), TablePager\getNavigationBar(), Skin\getNewtalks(), CategoryViewer\getPagesSection(), Skin\getRevisionId(), HistoryPager\getStartBody(), ApiMain\handleCORS(), Skin\isRevisionCurrent(), Skin\lastModified(), CategoryTreeHooks\onSkinBuildSidebar(), MediaWiki\Extension\OATHAuth\HTMLForm\TOTPDisableForm\onSuccess(), MediaWiki\Extension\OATHAuth\HTMLForm\TOTPEnableForm\onSuccess(), ImportReporter\open(), SkinTemplate\outputPage(), ImageListPager\outputUserDoesNotExist(), SkinTemplate\prepareQuickTemplate(), Skin\printSource(), DifferenceEngine\renderNewRevision(), ImportReporter\reportNotice(), ImportReporter\reportPage(), ApiMain\sendCacheHeaders(), DifferenceEngine\showDiff(), DifferenceEngine\showDiffPage(), DifferenceEngine\showDiffStyle(), DifferenceEngine\showMissingRevision(), LoginHelper\showReturnToPage(), Skin\subPageSubtitle(), and TraditionalImageGallery\toHTML().

◆ getRequest()

ContextSource::getRequest ( )

Since: 1.18

Returns: WebRequest

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 71 of file ContextSource.php.

References getContext().

Referenced by ApiMain\__construct(), ApiContinuationManager\__construct(), ImageListPager\__construct(), UsersPager\__construct(), IndexPager\__construct(), TablePager\__construct(), OutputPage\addAcceptLanguage(), CategoryTreeCategoryViewer\addSubcategoryObject(), SkinTemplate\buildContentNavigationUrls(), SkinTemplate\buildNavUrls(), SkinTemplate\buildPersonalUrls(), ApiMain\checkConditionalRequestHeaders(), ApiMain\checkExecutePermissions(), OutputPage\checkLastModified(), ApiMain\checkMaxLag(), CategoryViewer\clearCategoryState(), ApiFormatBase\closePrinter(), ApiMain\createErrorPrinter(), WikiEditorHooks\editPageShowEditFormFields(), ApiCSPReport\error(), ApiCheckToken\execute(), ApiCSPReport\execute(), ApiEditPage\execute(), ApiFeedRecentChanges\execute(), ApiLogin\execute(), ApiQueryDeletedrevs\execute(), ApiQueryTokens\execute(), ApiMain\executeActionWithErrorHandling(), HTMLForm\getButtons(), OOUIHTMLForm\getButtons(), ApiQueryUserInfo\getCurrentUserInfo(), IndexPager\getDefaultQuery(), MediaWiki\Extension\OATHAuth\HTMLForm\TOTPEnableForm\getDescriptors(), 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(), PageDataRequestHandler\handleRequest(), OutputPage\haveCacheVaryCookies(), ApiQuery\instantiateModules(), ApiQuery\isReadMode(), ApiMain\lacksSameOriginSecurity(), HTMLForm\loadData(), ApiMain\logRequest(), MediaWiki\Extension\OATHAuth\HTMLForm\TOTPDisableForm\onSubmit(), MediaWiki\Extension\OATHAuth\HTMLForm\TOTPEnableForm\onSubmit(), OutputPage\output(), HTMLForm\prepareForm(), SkinTemplate\prepareQuickTemplate(), ApiMain\reportUnusedParams(), OutputPage\returnToMain(), ApiQueryRecentChanges\run(), OutputPage\sendCacheControl(), ApiMain\sendCacheHeaders(), ApiMain\setRequestExpectations(), ApiMain\setupExternalResponse(), SkinTemplate\setupTemplateForOutput(), DifferenceEngine\showDiffPage(), OutputPage\showPermissionsErrorPage(), HTMLForm\tryAuthorizedSubmit(), OutputPage\userCanPreview(), and ApiCSPReport\verifyPostBodyOk().

◆ getSkin()

ContextSource::getSkin ( )

Since: 1.18

Returns: Skin

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 136 of file ContextSource.php.

References getContext().

Referenced by GadgetHooks\beforePageDisplay(), OutputPage\enableOOUI(), OutputPage\getJSVars(), OutputPage\getRlClient(), OutputPage\getRlClientContext(), and OutputPage\output().

◆ getStats()

ContextSource::getStats ( )

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

Since: 1.25

Returns: IBufferingStatsdDataFactory

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 154 of file ContextSource.php.

◆ getTiming()

ContextSource::getTiming ( )

Since: 1.27

Returns: Timing

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 144 of file ContextSource.php.

References getContext().

◆ getTitle()

ContextSource::getTitle ( )

Since: 1.18

Returns: Title|null

Implements IContextSource.

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

Definition at line 79 of file ContextSource.php.

References getContext().

Referenced by HistoryPager\curLink(), HistoryPager\formatRow(), HistoryPager\getEndBody(), TablePager\getNavigationBar(), UsersPager\getPageHeader(), HistoryPager\getStartBody(), HistoryPager\historyLine(), HistoryPager\lastLink(), IndexPager\makeLink(), MultimediaViewerHooks\onBeforePageDisplay(), and HistoryPager\revLink().

◆ getUser()

ContextSource::getUser ( )

Since: 1.18

Returns: User

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 120 of file ContextSource.php.

References getContext().

Referenced by LogEventsList\__construct(), UploadForm\__construct(), HistoryPager\__construct(), IndexPager\__construct(), GadgetHooks\beforePageDisplay(), ImageHistoryList\beginImageHistoryList(), ApiQuery\doExport(), CodeEditorHooks\editPageShowEditFormInitial(), LogPager\enforceActionRestrictions(), LogPager\enforcePerformerRestrictions(), MediaWiki\Extension\OATHAuth\Api\Module\ApiOATHValidate\execute(), MediaWiki\Extension\OATHAuth\Api\Module\ApiQueryOATH\execute(), ApiScribuntoConsole\execute(), ApiQueryTitleBlacklist\execute(), 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(), ApiParse\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiPurge\execute(), ApiQueryAuthManagerInfo\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryImageInfo\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\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(), ApiQueryInfo\extractPageInfo(), ApiQueryLogEvents\extractRowInfo(), ApiFeedContributions\feedItem(), HistoryPager\formatRow(), UsersPager\formatRow(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), ApiQueryLogEvents\getCacheMode(), ApiUpload\getChunkResult(), ApiUpload\getContextResult(), ApiQueryUserInfo\getCurrentUserInfo(), UploadForm\getDescriptionSection(), ApiComparePages\getDiffRevision(), HistoryPager\getEndBody(), ApiQueryUserInfo\getLatestContributionTime(), EnhancedChangesList\getLineData(), DifferenceEngine\getMarkPatrolledLinkInfo(), UploadForm\getOptionsSection(), ApiParse\getParsedContent(), BlockListPager\getQueryInfo(), DeletedContribsPager\getQueryInfo(), UsersPager\getQueryInfo(), ApiQueryUserInfo\getRateLimits(), ApiComparePages\getRevisionById(), DifferenceEngine\getRevisionHeader(), LogEventsList\getShowHideLinks(), UploadForm\getSourceSection(), HistoryPager\getStartBody(), ImageHistoryList\getThumbForLine(), ApiTokens\getTokenTypes(), LogEventsList\getTypeMenuDesc(), ApiOptions\getUserForUpdates(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryInfo\getWatchedInfo(), ApiQueryInfo\getWatcherInfo(), HistoryPager\historyLine(), ImageHistoryList\imageHistoryLine(), ChangesList\insertDateHeader(), ChangesList\insertDiffHist(), ChangesList\insertRollback(), ApiQueryGadgets\isNeeded(), LogPager\limitType(), DifferenceEngine\loadNewText(), DifferenceEngine\loadText(), ApiMergeHistory\merge(), ApiMove\movePage(), ApiMove\moveSubpages(), MultimediaViewerHooks\onMakeGlobalVariablesScript(), MediaWiki\Extension\OATHAuth\HTMLForm\TOTPDisableForm\onSubmit(), MediaWiki\Extension\OATHAuth\HTMLForm\TOTPEnableForm\onSubmit(), ApiUpload\performStash(), ApiUpload\performUpload(), ApiQueryUserContribs\prepareQuery(), ApiTag\processIndividual(), ImportReporter\reportPage(), DifferenceEngine\revisionDeleteLink(), HistoryPager\revLink(), ApiUpload\selectUploadModule(), DifferenceEngine\setRevisions(), SkinMonoBook\setupSkinUserCss(), ApiComparePages\setVals(), ChangesList\showAsUnpatrolled(), DifferenceEngine\showDiffPage(), RevDelList\updateLog(), and DifferenceEngine\userCanEdit().

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