Context object that contains information about the state of a specific ResourceLoader web request. More...

Inheritance diagram for ResourceLoaderContext:

[legend]

Collaboration diagram for ResourceLoaderContext:

[legend]

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

	encodeJson ( $data)
	Wrapper around json_encode that avoids needless escapes, and pretty-prints in debug mode.

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

	getReqBase ()
	Get the request base parameters, omitting any defaults.

	getRequest ()

	getResourceLoader ()

	getSkin ()

	getUser ()

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

	getVariant ()

	getVersion ()

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

	shouldIncludeMessages ()

	shouldIncludeScripts ()

	shouldIncludeStyles ()

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

Public Attributes
const	DEFAULT_LANG = 'qqx'

const	DEFAULT_SKIN = 'fallback'

Protected Attributes
	$debug

	$direction

	$format

	$hash

	$image

ResourceLoaderImage false	$imageObj

	$language

	$logger

	$modules

	$only

	$raw

	$request

	$resourceLoader

	$skin

	$user

	$userObj

	$variant

	$version

Detailed Description

Context object that contains information about the state of a specific ResourceLoader web request.

Passed around to ResourceLoaderModule methods.

Since: 1.17

Definition at line 33 of file ResourceLoaderContext.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ResourceLoader	$resourceLoader
WebRequest	$request

Definition at line 66 of file ResourceLoaderContext.php.

References $modules, $resourceLoader, WebRequest\getFuzzyBool(), and WebRequest\getRawVal().

Member Function Documentation

◆ encodeJson()

ResourceLoaderContext::encodeJson ( $data )

Wrapper around json_encode that avoids needless escapes, and pretty-prints in debug mode.

Definition at line 433 of file ResourceLoaderContext.php.

References getDebug().

Referenced by ResourceLoaderClientHtml\makeLoad().

◆ getConfig()

ResourceLoaderContext::getConfig ( )

Deprecated: since 1.34 Use ResourceLoaderModule::getConfig instead inside module methods. Use ResourceLoader::getConfig elsewhere.

Returns: Config

Definition at line 134 of file ResourceLoaderContext.php.

References getResourceLoader(), and wfDeprecated().

◆ 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 349 of file ResourceLoaderContext.php.

Referenced by ResourceLoaderClientHtml\makeContext().

◆ getDebug()

ResourceLoaderContext::getDebug ( )

Returns: bool

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 254 of file ResourceLoaderContext.php.

References $debug.

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

◆ getDirection()

ResourceLoaderContext::getDirection ( )

Returns: string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 185 of file ResourceLoaderContext.php.

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

◆ getFormat()

ResourceLoaderContext::getFormat ( )

Returns: string|null

Definition at line 298 of file ResourceLoaderContext.php.

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 385 of file ResourceLoaderContext.php.

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

◆ getImage()

ResourceLoaderContext::getImage ( )

Returns: string|null

Definition at line 284 of file ResourceLoaderContext.php.

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 308 of file ResourceLoaderContext.php.

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

◆ getLanguage()

ResourceLoaderContext::getLanguage ( )

Returns: string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 166 of file ResourceLoaderContext.php.

References $lang, and getRequest().

Referenced by getDirection(), getHash(), ResourceLoaderModule\getMessageBlob(), getReqBase(), and msg().

◆ getLogger()

ResourceLoaderContext::getLogger ( )

Deprecated: since 1.34 Use ResourceLoaderModule::getLogger instead inside module methods. Use ResourceLoader::getLogger elsewhere.

Since: 1.27

Returns: \Psr\Log\LoggerInterface

Definition at line 152 of file ResourceLoaderContext.php.

◆ 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 261 of file ResourceLoaderContext.php.

Referenced by getHash(), shouldIncludeMessages(), shouldIncludeScripts(), and shouldIncludeStyles().

◆ getRaw()

ResourceLoaderContext::getRaw ( )

Returns: bool

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 277 of file ResourceLoaderContext.php.

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

◆ getReqBase()

ResourceLoaderContext::getReqBase ( )

Get the request base parameters, omitting any defaults.

Definition at line 411 of file ResourceLoaderContext.php.

References getDebug(), getLanguage(), and getSkin().

◆ getRequest()

ResourceLoaderContext::getRequest ( )

Returns: WebRequest

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 142 of file ResourceLoaderContext.php.

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

◆ getResourceLoader()

ResourceLoaderContext::getResourceLoader ( )

Returns: ResourceLoader

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 124 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 201 of file ResourceLoaderContext.php.

Referenced by getHash(), and getReqBase().

◆ getUser()

ResourceLoaderContext::getUser ( )

Returns: string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 208 of file ResourceLoaderContext.php.

◆ getUserObj()

ResourceLoaderContext::getUserObj ( )

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

Since: 1.25

Returns: User

Definition at line 236 of file ResourceLoaderContext.php.

References getUser().

◆ getVariant()

ResourceLoaderContext::getVariant ( )

Returns: string|null

Definition at line 291 of file ResourceLoaderContext.php.

Referenced by getHash().

◆ getVersion()

ResourceLoaderContext::getVersion ( )

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

Returns: string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 270 of file ResourceLoaderContext.php.

Referenced by getHash().

◆ msg()

ResourceLoaderContext::msg	(		$key,
			$params )

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	...$params

Returns: Message

Implements MessageLocalizer.

Definition at line 221 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 109 of file ResourceLoaderContext.php.

◆ shouldIncludeMessages()

ResourceLoaderContext::shouldIncludeMessages ( )

Returns: bool

Definition at line 370 of file ResourceLoaderContext.php.

References getOnly().

◆ shouldIncludeScripts()

ResourceLoaderContext::shouldIncludeScripts ( )

Returns: bool

Definition at line 356 of file ResourceLoaderContext.php.

References getOnly().

◆ shouldIncludeStyles()

ResourceLoaderContext::shouldIncludeStyles ( )

Returns: bool

Definition at line 363 of file ResourceLoaderContext.php.

References getOnly().

Member Data Documentation

◆ $debug

ResourceLoaderContext::$debug

protected

Definition at line 44 of file ResourceLoaderContext.php.

◆ $direction

ResourceLoaderContext::$direction

protected

Definition at line 56 of file ResourceLoaderContext.php.

Referenced by getDirection().

◆ $format

ResourceLoaderContext::$format

protected

Definition at line 54 of file ResourceLoaderContext.php.

◆ $hash

ResourceLoaderContext::$hash

protected

Definition at line 57 of file ResourceLoaderContext.php.

◆ $image

ResourceLoaderContext::$image

protected

Definition at line 52 of file ResourceLoaderContext.php.

Referenced by getImageObj().

◆ $imageObj

ResourceLoaderImage false ResourceLoaderContext::$imageObj

protected

Definition at line 60 of file ResourceLoaderContext.php.

◆ $language

ResourceLoaderContext::$language

protected

Definition at line 43 of file ResourceLoaderContext.php.

◆ $logger

ResourceLoaderContext::$logger

protected

Definition at line 39 of file ResourceLoaderContext.php.

◆ $modules

ResourceLoaderContext::$modules

protected

Definition at line 48 of file ResourceLoaderContext.php.

◆ $only

ResourceLoaderContext::$only

protected

Definition at line 49 of file ResourceLoaderContext.php.

◆ $raw

ResourceLoaderContext::$raw

protected

Definition at line 51 of file ResourceLoaderContext.php.

◆ $request

ResourceLoaderContext::$request

protected

Definition at line 38 of file ResourceLoaderContext.php.

◆ $resourceLoader

ResourceLoaderContext::$resourceLoader

protected

Definition at line 37 of file ResourceLoaderContext.php.

◆ $skin

ResourceLoaderContext::$skin

protected

Definition at line 42 of file ResourceLoaderContext.php.

◆ $user

ResourceLoaderContext::$user

protected

Definition at line 45 of file ResourceLoaderContext.php.

◆ $userObj

ResourceLoaderContext::$userObj

protected

Definition at line 58 of file ResourceLoaderContext.php.

◆ $variant

ResourceLoaderContext::$variant

protected

Definition at line 53 of file ResourceLoaderContext.php.

◆ $version

ResourceLoaderContext::$version

protected

Definition at line 50 of file ResourceLoaderContext.php.

◆ DEFAULT_LANG

const ResourceLoaderContext::DEFAULT_LANG = 'qqx'

Definition at line 34 of file ResourceLoaderContext.php.

◆ DEFAULT_SKIN

const ResourceLoaderContext::DEFAULT_SKIN = 'fallback'

Definition at line 35 of file ResourceLoaderContext.php.

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

includes/resourceloader/ResourceLoaderContext.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ encodeJson()

◆ getConfig()

◆ getContentOverrideCallback()

◆ getDebug()

◆ getDirection()

◆ getFormat()

◆ getHash()

◆ getImage()

◆ getImageObj()

◆ getLanguage()

◆ getLogger()

◆ getModules()

◆ getOnly()

◆ getRaw()

◆ getReqBase()

◆ 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

◆ DEFAULT_LANG

◆ DEFAULT_SKIN