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

Inherits IContextSource.

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

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

	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 38 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 108 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 214 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 133 of file ContextSource.php.

References getActionName().

Referenced by getActionName().

◆ getAuthority()

ContextSource::getAuthority ( )

Since: 1.36

Returns: Authority

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 160 of file ContextSource.php.

Referenced by MediaWiki\Pager\HistoryPager\__construct(), MediaWiki\Pager\UsersPager\canSeeHideuser(), MediaWiki\Pager\HistoryPager\doBatchLookups(), MediaWiki\Pager\DeletedContribsPager\doBatchLookups(), ApiAMCreateAccount\execute(), ApiBlock\execute(), ApiChangeContentModel\execute(), ApiEditPage\execute(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiManageTags\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiPurge\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(), MediaWiki\Pager\HistoryPager\formatRow(), MediaWiki\Pager\NewPagesPager\formatRow(), MediaWiki\Pager\ProtectedPagesPager\formatValue(), MediaWiki\Pager\BlockListPager\formatValue(), ImageHistoryPseudoPager\getBody(), ApiQueryLogEvents\getCacheMode(), ApiQueryUserInfo\getCurrentUserInfo(), MediaWiki\Pager\BlockListPager\getQueryInfo(), MediaWiki\Pager\DeletedContribsPager\getQueryInfo(), MediaWiki\Pager\HistoryPager\getStartBody(), 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 77 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 52 of file ContextSource.php.

References wfDebug().

Referenced by ApiBase\__construct(), RevisionItem\__construct(), MediaWiki\Pager\UsersPager\buildGroupLink(), MediaWiki\Category\CategoryViewer\clearCategoryState(), MediaWiki\Specials\SpecialUnblock\execute(), ApiChangeContentModel\execute(), ApiComparePages\execute(), ApiEmailUser\execute(), ApiExpandTemplates\execute(), ApiFeedContributions\execute(), ApiRevisionDelete\execute(), ApiUserrights\execute(), ApiFeedContributions\feedItem(), MediaWiki\Pager\HistoryPager\formatRow(), MediaWiki\Pager\ProtectedTitlesPager\formatRow(), MediaWiki\Pager\ProtectedPagesPager\formatValue(), ApiAMCreateAccount\getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), MediaWiki\Pager\UsersPager\getPageHeader(), MediaWiki\Pager\NewFilesPager\getStartBody(), MediaWiki\Pager\CategoryPager\getStartForm(), ApiUpload\performUpload(), MediaWiki\Specials\SpecialTags\processCreateTagForm(), MediaWiki\Specials\SpecialTags\processTagForm(), MediaWiki\Preferences\DefaultPreferencesFactory\saveFormData(), MediaWiki\Specials\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 224 of file ContextSource.php.

◆ getLanguage()

ContextSource::getLanguage ( )

Since: 1.19

Stability: stable: to override

Returns: Language

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 169 of file ContextSource.php.

References getContext().

◆ getOutput()

ContextSource::getOutput ( )

Since: 1.18

Stability: stable: to override

Returns: OutputPage

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 142 of file ContextSource.php.

References getContext().

Referenced by OOUIHTMLForm\__construct(), UploadForm\__construct(), MediaWiki\Category\CategoryViewer\__construct(), DifferenceEngineSlotDiffRenderer\addModules(), UploadForm\addUploadJS(), ImageHistoryList\beginImageHistoryList(), ChangesList\beginRecentChangesList(), EnhancedChangesList\beginRecentChangesList(), ImportReporter\close(), HTMLForm\displayForm(), SkinMustache\generateHTML(), SkinTemplate\generateHTML(), PreferencesFormOOUI\getBody(), CodexHTMLForm\getHTML(), VFormHTMLForm\getHTML(), MediaWiki\Category\CategoryViewer\getHTML(), DifferenceEngine\getMarkPatrolledLinkInfo(), MediaWiki\Pager\TablePager\getNavigationBar(), MediaWiki\Pager\HistoryPager\getStartBody(), SkinMustache\getTemplateData(), ImportReporter\open(), SkinTemplate\outputPage(), MediaWiki\Pager\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 86 of file ContextSource.php.

References getContext().

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

◆ getSkin()

ContextSource::getSkin ( )

Since: 1.18

Stability: stable: to override

Returns: Skin

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 178 of file ContextSource.php.

References getContext().

◆ getTiming()

ContextSource::getTiming ( )

Since: 1.27

Stability: stable: to override

Returns: Timing

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 187 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, MediaWiki\Pager\AllMessagesTablePager, and MediaWiki\Pager\ImageListPager.

Definition at line 95 of file ContextSource.php.

References getContext().

Referenced by MediaWiki\Pager\HistoryPager\__construct(), MediaWiki\Pager\HistoryPager\doBatchLookups(), MediaWiki\Pager\HistoryPager\formatRow(), MediaWiki\Pager\TablePager\getNavigationBar(), MediaWiki\Pager\UsersPager\getPageHeader(), and MediaWiki\Pager\HistoryPager\getStartBody().

◆ getUser()

ContextSource::getUser ( )

Stability: stable: to override

Since: 1.18

Stability: stable: to override

Returns: User

Implements IContextSource.

Reimplemented in DerivativeContext.

Definition at line 152 of file ContextSource.php.

References getContext().

Referenced by ImageHistoryPseudoPager\__construct(), MediaWiki\Pager\HistoryPager\__construct(), MediaWiki\Pager\IndexPager\__construct(), MediaWiki\Output\OutputPage\checkLastModified(), MediaWiki\Specials\SpecialUnblock\execute(), ApiAcquireTempUserName\execute(), 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(), 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(), MediaWiki\Pager\MergeHistoryPager\formatRow(), MediaWiki\Pager\NewPagesPager\formatRow(), MediaWiki\Pager\ProtectedTitlesPager\formatRow(), MediaWiki\Pager\UsersPager\formatRow(), MediaWiki\Pager\ProtectedPagesPager\formatValue(), ApiQueryUserInfo\getCurrentUserInfo(), ApiQueryUserInfo\getLatestContributionTime(), ApiQueryUserInfo\getRateLimits(), ApiUpload\performUpload(), ApiTag\processIndividual(), 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.