Object passed around to modules which contains information about the state of a specific loader request. More...

Inheritance diagram for ResourceLoaderContext:

[legend]

Collaboration diagram for ResourceLoaderContext:

Public Member Functions
	__construct (ResourceLoader $resourceLoader, WebRequest $request)

	getConfig ()

	getContentOverrideCallback ()
	Return the replaced-content mapping callback.

	getDebug ()

	getDirection ()

	getFormat ()

	getHash ()
	All factors that uniquely identify this request, except 'modules'.

	getImage ()

	getImageObj ()
	If this is a request for an image, get the ResourceLoaderImage object.

	getLanguage ()

	getLogger ()

	getModules ()

	getOnly ()

	getRaw ()

	getRequest ()

	getResourceLoader ()

	getSkin ()

	getUser ()

	getUserObj ()
	Get the possibly-cached User object for the specified username.

	getVariant ()

	getVersion ()

	msg ( $key)
	Get a Message object with context set.

	shouldIncludeMessages ()

	shouldIncludeScripts ()

	shouldIncludeStyles ()

Static Public Member Functions
static	expandModuleNames ( $modules)
	Reverse the process done by ResourceLoader::makePackedModulesString().

static	newDummyContext ()
	Return a dummy ResourceLoaderContext object suitable for passing into things that don't "really" need a context.

Protected Attributes
	$debug

	$direction

	$format

	$hash

	$image

	$imageObj

	$language

	$logger

	$modules

	$only

	$raw

	$request

	$resourceLoader

	$skin

	$user

	$userObj

	$variant

	$version

Detailed Description

Object passed around to modules which contains information about the state of a specific loader request.

Definition at line 32 of file ResourceLoaderContext.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoaderContext::__construct	(	ResourceLoader	$resourceLoader,
		WebRequest	$request
	)

Parameters

ResourceLoader	$resourceLoader
WebRequest	$request

Definition at line 61 of file ResourceLoaderContext.php.

References $modules, $request, $resourceLoader, format, getConfig(), request, user, and version.

Member Function Documentation

◆ expandModuleNames()

static ResourceLoaderContext::expandModuleNames ( $modules )

static

Reverse the process done by ResourceLoader::makePackedModulesString().

Deprecated:: since 1.33 Use ResourceLoader::expandModuleNames instead.

Parameters

string $modules Packed module name list

Returns: array Array of module names

Definition at line 101 of file ResourceLoaderContext.php.

References $modules, and wfDeprecated().

◆ getConfig()

ResourceLoaderContext::getConfig ( )

Returns: Config

Definition at line 137 of file ResourceLoaderContext.php.

References getResourceLoader().

Referenced by __construct(), and getLanguage().

◆ getContentOverrideCallback()

ResourceLoaderContext::getContentOverrideCallback ( )

Return the replaced-content mapping callback.

When editing a page that's used to generate the scripts or styles of a ResourceLoaderWikiModule, a preview should use the to-be-saved version of the page rather than the current version in the database. A context supporting such previews should return a callback to return these mappings here.

Since: 1.32

Returns: callable|null Signature is Content|null func( Title $t )

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 345 of file ResourceLoaderContext.php.

Referenced by ResourceLoaderClientHtml\makeContext().

◆ getDebug()

ResourceLoaderContext::getDebug ( )

Returns: bool

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 250 of file ResourceLoaderContext.php.

References $debug.

Referenced by getHash(), and ResourceLoaderClientHtml\makeLoad().

◆ getDirection()

ResourceLoaderContext::getDirection ( )

Returns: string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 183 of file ResourceLoaderContext.php.

References $direction, getLanguage(), and getRequest().

◆ getFormat()

ResourceLoaderContext::getFormat ( )

Returns: string|null

Definition at line 294 of file ResourceLoaderContext.php.

References $format.

Referenced by getHash().

◆ getHash()

ResourceLoaderContext::getHash ( )

All factors that uniquely identify this request, except 'modules'.

The list of modules is excluded here for legacy reasons as most callers already split up handling of individual modules. Including it here would massively fragment the cache and decrease its usefulness.

E.g. Used by RequestFileCache to form a cache key for storing the reponse output.

Returns: string

Definition at line 381 of file ResourceLoaderContext.php.

References $hash, getDebug(), getFormat(), getImage(), getLanguage(), getOnly(), getRaw(), getSkin(), getUser(), getVariant(), and getVersion().

◆ getImage()

ResourceLoaderContext::getImage ( )

Returns: string|null

Definition at line 280 of file ResourceLoaderContext.php.

References $image.

Referenced by getHash().

◆ getImageObj()

ResourceLoaderContext::getImageObj ( )

If this is a request for an image, get the ResourceLoaderImage object.

Since: 1.25

Returns: ResourceLoaderImage|bool false if a valid object cannot be created

Definition at line 304 of file ResourceLoaderContext.php.

References $image, $imageObj, $modules, getModules(), and getResourceLoader().

◆ getLanguage()

ResourceLoaderContext::getLanguage ( )

Returns: string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 166 of file ResourceLoaderContext.php.

References $lang, $language, getConfig(), and getRequest().

Referenced by getDirection(), ResourceLoaderFileModule\getFileHashes(), getHash(), ResourceLoaderModule\getMessageBlob(), ResourceLoaderFileModule\getScriptFiles(), and msg().

◆ getLogger()

ResourceLoaderContext::getLogger ( )

Since: 1.27

Returns: \Psr\Log\LoggerInterface

Definition at line 152 of file ResourceLoaderContext.php.

References $logger.

◆ getModules()

ResourceLoaderContext::getModules ( )

Returns: array

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 159 of file ResourceLoaderContext.php.

References $modules.

Referenced by getImageObj().

◆ getOnly()

ResourceLoaderContext::getOnly ( )

Returns: string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 257 of file ResourceLoaderContext.php.

References $only.

Referenced by getHash(), ResourceLoaderStartUpModule\getScript(), shouldIncludeMessages(), shouldIncludeScripts(), and shouldIncludeStyles().

◆ getRaw()

ResourceLoaderContext::getRaw ( )

Returns: bool

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 273 of file ResourceLoaderContext.php.

References $raw.

Referenced by getHash(), and ResourceLoaderClientHtml\makeLoad().

◆ getRequest()

ResourceLoaderContext::getRequest ( )

Returns: WebRequest

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 144 of file ResourceLoaderContext.php.

References $request.

Referenced by getDirection(), getLanguage(), and ResourceLoaderClientHtml\makeContext().

◆ getResourceLoader()

ResourceLoaderContext::getResourceLoader ( )

Returns: ResourceLoader

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 130 of file ResourceLoaderContext.php.

References $resourceLoader.

Referenced by ResourceLoaderClientHtml\__construct(), getConfig(), getImageObj(), ResourceLoaderClientHtml\makeContext(), and ResourceLoaderClientHtml\makeLoad().

◆ getSkin()

ResourceLoaderContext::getSkin ( )

Returns: string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 197 of file ResourceLoaderContext.php.

References $skin.

Referenced by getHash().

◆ getUser()

ResourceLoaderContext::getUser ( )

Returns: string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 204 of file ResourceLoaderContext.php.

References $user.

Referenced by getHash(), and getUserObj().

◆ getUserObj()

ResourceLoaderContext::getUserObj ( )

Get the possibly-cached User object for the specified username.

Since: 1.25

Returns: User

Definition at line 232 of file ResourceLoaderContext.php.

References $username, $userObj, getUser(), and User\newFromName().

◆ getVariant()

ResourceLoaderContext::getVariant ( )

Returns: string|null

Definition at line 287 of file ResourceLoaderContext.php.

References $variant.

Referenced by getHash().

◆ getVersion()

ResourceLoaderContext::getVersion ( )

See also: ResourceLoaderModule::getVersionHash; ResourceLoaderClientHtml::makeLoad

Returns: string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 266 of file ResourceLoaderContext.php.

References $version.

Referenced by getHash().

◆ msg()

ResourceLoaderContext::msg ( $key )

Get a Message object with context set.

See wfMessage for parameters.

Since: 1.27

Parameters

string \| string[] \| MessageSpecifier	$key	Message key, or array of keys, or a MessageSpecifier.
mixed	$args,...

Returns: Message

Implements MessageLocalizer.

Definition at line 217 of file ResourceLoaderContext.php.

References getLanguage(), and wfMessage().

◆ newDummyContext()

static ResourceLoaderContext::newDummyContext ( )

static

Return a dummy ResourceLoaderContext object suitable for passing into things that don't "really" need a context.

Use cases:

Unit tests (deprecated, create empty instance directly or use RLTestCase).

Returns: ResourceLoaderContext

Definition at line 115 of file ResourceLoaderContext.php.

Referenced by ResourceLoaderContextTest\testDummy(), and ResourceLoaderWikiModuleTest\testGetPages().

◆ shouldIncludeMessages()

ResourceLoaderContext::shouldIncludeMessages ( )

Returns: bool

Definition at line 366 of file ResourceLoaderContext.php.

References getOnly().

◆ shouldIncludeScripts()

ResourceLoaderContext::shouldIncludeScripts ( )

Returns: bool

Definition at line 352 of file ResourceLoaderContext.php.

References getOnly().

◆ shouldIncludeStyles()

ResourceLoaderContext::shouldIncludeStyles ( )

Returns: bool

Definition at line 359 of file ResourceLoaderContext.php.

References getOnly().

Member Data Documentation

◆ $debug

ResourceLoaderContext::$debug

protected

Definition at line 40 of file ResourceLoaderContext.php.

Referenced by getDebug().

◆ $direction

ResourceLoaderContext::$direction

protected

Definition at line 52 of file ResourceLoaderContext.php.

Referenced by getDirection().

◆ $format

ResourceLoaderContext::$format

protected

Definition at line 50 of file ResourceLoaderContext.php.

Referenced by getFormat().

◆ $hash

ResourceLoaderContext::$hash

protected

Definition at line 53 of file ResourceLoaderContext.php.

Referenced by getHash().

◆ $image

ResourceLoaderContext::$image

protected

Definition at line 48 of file ResourceLoaderContext.php.

Referenced by getImage(), and getImageObj().

◆ $imageObj

ResourceLoaderContext::$imageObj

protected

Definition at line 55 of file ResourceLoaderContext.php.

Referenced by getImageObj().

◆ $language

ResourceLoaderContext::$language

protected

Definition at line 39 of file ResourceLoaderContext.php.

Referenced by getLanguage().

◆ $logger

ResourceLoaderContext::$logger

protected

Definition at line 35 of file ResourceLoaderContext.php.

Referenced by getLogger().

◆ $modules

ResourceLoaderContext::$modules

protected

Definition at line 44 of file ResourceLoaderContext.php.

Referenced by __construct(), expandModuleNames(), getImageObj(), and getModules().

◆ $only

ResourceLoaderContext::$only

protected

Definition at line 45 of file ResourceLoaderContext.php.

Referenced by getOnly().

◆ $raw

ResourceLoaderContext::$raw

protected

Definition at line 47 of file ResourceLoaderContext.php.

Referenced by getRaw().

◆ $request

ResourceLoaderContext::$request

protected

Definition at line 34 of file ResourceLoaderContext.php.

Referenced by __construct(), and getRequest().

◆ $resourceLoader

ResourceLoaderContext::$resourceLoader

protected

Definition at line 33 of file ResourceLoaderContext.php.

Referenced by __construct(), and getResourceLoader().

◆ $skin

ResourceLoaderContext::$skin

protected

Definition at line 38 of file ResourceLoaderContext.php.

Referenced by getSkin().

◆ $user

ResourceLoaderContext::$user

protected

Definition at line 41 of file ResourceLoaderContext.php.

Referenced by getUser().

◆ $userObj

ResourceLoaderContext::$userObj

protected

Definition at line 54 of file ResourceLoaderContext.php.

Referenced by getUserObj().

◆ $variant

ResourceLoaderContext::$variant

protected

Definition at line 49 of file ResourceLoaderContext.php.

Referenced by getVariant().

◆ $version

ResourceLoaderContext::$version

protected

Definition at line 46 of file ResourceLoaderContext.php.

Referenced by getVersion().

The documentation for this class was generated from the following file:

includes/resourceloader/ResourceLoaderContext.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ expandModuleNames()

◆ getConfig()

◆ getContentOverrideCallback()

◆ getDebug()

◆ getDirection()

◆ getFormat()

◆ getHash()

◆ getImage()

◆ getImageObj()

◆ getLanguage()

◆ getLogger()

◆ getModules()

◆ getOnly()

◆ getRaw()

◆ getRequest()

◆ getResourceLoader()

◆ getSkin()

◆ getUser()

◆ getUserObj()

◆ getVariant()

◆ getVersion()

◆ msg()

◆ newDummyContext()

◆ shouldIncludeMessages()

◆ shouldIncludeScripts()

◆ shouldIncludeStyles()

Member Data Documentation

◆ $debug

◆ $direction

◆ $format

◆ $hash

◆ $image

◆ $imageObj

◆ $language

◆ $logger

◆ $modules

◆ $only

◆ $raw

◆ $request

◆ $resourceLoader

◆ $skin

◆ $user

◆ $userObj

◆ $variant

◆ $version