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.

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

	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)

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 33 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 103 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 221 of file ContextSource.php.

References getContext().

Referenced by ApiUpload\performUpload().

◆ getActionName()

ContextSource::getActionName ( )

Get the action name for the current web request.

Since: 1.38

Stability: stable: to override

Returns: string

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 128 of file ContextSource.php.

◆ getAuthority()

ContextSource::getAuthority ( )

Since: 1.36

Returns: Authority

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 155 of file ContextSource.php.

Referenced by UploadForm\__construct(), ApiAMCreateAccount\execute(), ApiBlock\execute(), ApiChangeContentModel\execute(), ApiEditPage\execute(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiManageTags\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryImageInfo\execute(), ApiQueryLogEvents\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetPageLanguage\execute(), ApiTag\execute(), ApiUnblock\execute(), ApiUserrights\execute(), ApiFeedContributions\feedItem(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), ImageHistoryPseudoPager\getBody(), ApiQueryLogEvents\getCacheMode(), ApiQueryUserInfo\getCurrentUserInfo(), BlockListPager\getQueryInfo(), UploadForm\getSourceSection(), ApiMergeHistory\merge(), ApiMove\moveSubpages(), ApiUpload\performUpload(), and ApiTag\processIndividual().

◆ getConfig()

ContextSource::getConfig ( )

Since: 1.23

Stability: stable: to override

Returns: Config

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 72 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 47 of file ContextSource.php.

References wfDebug().

Referenced by ApiBase\__construct(), UploadForm\__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(), getConfig(), DerivativeContext\getConfig(), FormatMetadata\getExtendedMetadataFromHook(), ApiAMCreateAccount\getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), EditWatchlistNormalHTMLForm\getLegend(), getRequest(), DerivativeContext\getRequest(), CategoryPager\getStartForm(), DerivativeContext\getTiming(), getTitle(), DerivativeContext\getTitle(), getWikiPage(), DerivativeContext\getWikiPage(), ApiUpload\performUpload(), SpecialTags\processCreateTagForm(), SpecialTags\processTagForm(), MediaWiki\Preferences\DefaultPreferencesFactory\saveFormData(), SpecialComparePages\showDiff(), MediaWiki\Preferences\DefaultPreferencesFactory\submitForm(), and MediaWiki\Preferences\DefaultPreferencesFactory\validateSignature().

◆ getCsrfTokenSet()

ContextSource::getCsrfTokenSet ( )

Get a repository to obtain and match CSRF tokens.

Returns: CsrfTokenSet

Since: 1.37

Implements MediaWiki\Session\CsrfTokenSetProvider.

Definition at line 231 of file ContextSource.php.

◆ getLanguage()

ContextSource::getLanguage ( )

Since: 1.19

Stability: stable: to override

Returns: Language

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 164 of file ContextSource.php.

References getContext().

Referenced by ApiMain\__construct(), AllMessagesTablePager\__construct(), DifferenceEngine\addHeader(), ApiFeedWatchlist\execute(), ApiHelp\execute(), ApiParamInfo\execute(), ApiQueryAllMessages\execute(), ApiQueryLanguageinfo\execute(), FormatMetadata\fetchExtendedMetadata(), CategoryPager\formatRow(), ActiveUsersPager\formatRow(), NewFilesPager\formatRow(), UsersPager\formatRow(), AllMessagesTablePager\formatValue(), ProtectedPagesPager\formatValue(), BlockListPager\formatValue(), ChangesList\getArticleLink(), UploadForm\getExtensionsMessage(), CategoryViewer\getHTML(), TablePager\getLimitSelectList(), FormatMetadata\getPriorityLanguages(), ImageGalleryBase\getRenderLang(), DifferenceEngine\getRevisionHeader(), DifferenceEngine\getSlotHeader(), ImageHistoryList\getThumbForLine(), ImageHistoryList\imageHistoryLine(), ChangesList\insertDateHeader(), LogEventsList\logLine(), FormatMetadata\makeFormattedData(), SkinTemplate\prepareQuickTemplate(), EnhancedChangesList\recentChangesBlockGroup(), and EnhancedChangesList\recentChangesLine().

◆ getOutput()

ContextSource::getOutput ( )

Since: 1.18

Stability: stable: to override

Returns: OutputPage

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 137 of file ContextSource.php.

References getContext().

Referenced by OOUIHTMLForm\__construct(), UploadForm\__construct(), CategoryViewer\__construct(), DifferenceEngineSlotDiffRenderer\addModules(), UploadForm\addUploadJS(), ImageHistoryList\beginImageHistoryList(), ChangesList\beginRecentChangesList(), EnhancedChangesList\beginRecentChangesList(), ImportReporter\close(), HTMLForm\displayForm(), Article\doDelete(), SkinMustache\generateHTML(), SkinTemplate\generateHTML(), VFormHTMLForm\getHTML(), CategoryViewer\getHTML(), DifferenceEngine\getMarkPatrolledLinkInfo(), TablePager\getNavigationBar(), HistoryPager\getStartBody(), SkinMustache\getTemplateData(), ImportReporter\open(), SkinTemplate\outputPage(), ImageListPager\outputUserDoesNotExist(), SkinTemplate\prepareQuickTemplate(), DifferenceEngine\renderNewRevision(), ImportReporter\reportNotice(), ImportReporter\reportPage(), Article\setOldSubtitle(), Article\showDeletedRevisionHeader(), DifferenceEngine\showDiff(), DifferenceEngine\showDiffPage(), DifferenceEngine\showDiffStyle(), Article\showMissingArticle(), Article\showPatrolFooter(), Article\showRedirectedFromHeader(), LoginHelper\showReturnToPage(), and TraditionalImageGallery\toHTML().

◆ getRequest()

ContextSource::getRequest ( )

Since: 1.18

Stability: stable: to override

Returns: WebRequest

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 81 of file ContextSource.php.

References getContext().

Referenced by ApiMain\__construct(), ApiContinuationManager\__construct(), ImageListPager\__construct(), UsersPager\__construct(), IndexPager\__construct(), TablePager\__construct(), SkinTemplate\buildPersonalUrls(), OutputPage\checkLastModified(), CategoryViewer\clearCategoryState(), ApiFormatBase\closePrinter(), ApiCheckToken\execute(), ApiCSPReport\execute(), ApiEditPage\execute(), ApiFeedRecentChanges\execute(), ApiLogin\execute(), ApiQueryDeletedrevs\execute(), ApiQueryTokens\execute(), MediaWiki\Rest\Handler\ActionModuleBasedHandler\execute(), ApiQueryUserInfo\getCurrentUserInfo(), LogPager\getFilterParams(), TablePager\getHiddenFields(), SkinTemplate\getReturnToParam(), UploadForm\getSourceSection(), NewFilesPager\getStartBody(), PageDataRequestHandler\handleRequest(), ApiQuery\isReadMode(), ApiMain\lacksSameOriginSecurity(), HTMLForm\prepareForm(), SkinTemplate\prepareQuickTemplate(), ApiQueryRecentChanges\run(), SkinTemplate\setupTemplateContext(), DifferenceEngine\showDiffPage(), and HTMLForm\tryAuthorizedSubmit().

◆ getSkin()

ContextSource::getSkin ( )

Since: 1.18

Stability: stable: to override

Returns: Skin

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 173 of file ContextSource.php.

References getContext().

Referenced by DifferenceEngine\renderNewRevision().

◆ getStats()

ContextSource::getStats ( )

Deprecated: since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected). Hard deprecated since 1.39.

Since: 1.25

Returns: IBufferingStatsdDataFactory

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 193 of file ContextSource.php.

References wfDeprecated().

◆ getTiming()

ContextSource::getTiming ( )

Since: 1.27

Stability: stable: to override

Returns: Timing

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 182 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 90 of file ContextSource.php.

References getContext().

Referenced by TablePager\getNavigationBar().

◆ getUser()

ContextSource::getUser ( )

Stability: stable: to override

Since: 1.18

Stability: stable: to override

Returns: User

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 147 of file ContextSource.php.

References getContext().

Referenced by ImageHistoryPseudoPager\__construct(), IndexPager\__construct(), ApiBlock\execute(), ApiChangeAuthenticationData\execute(), ApiCheckToken\execute(), ApiClearHasMsg\execute(), ApiCSPReport\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiEmailUser\execute(), ApiLinkAccount\execute(), ApiLogout\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiPurge\execute(), ApiQueryAuthManagerInfo\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryTokens\execute(), ApiRemoveAuthenticationData\execute(), ApiResetPassword\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetNotificationTimestamp\execute(), ApiStashEdit\execute(), ApiTag\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUpload\execute(), ApiUserrights\execute(), ApiWatch\execute(), ProtectedPagesPager\formatValue(), ApiQueryUserInfo\getCurrentUserInfo(), UploadForm\getDescriptionSection(), ApiQueryUserInfo\getLatestContributionTime(), UploadForm\getOptionsSection(), ApiQueryUserInfo\getRateLimits(), ApiUpload\performUpload(), ApiTag\processIndividual(), ImportReporter\reportPage(), ApiUpload\selectUploadModule(), 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.