MediaWiki  master
ResourceLoaderContext Class Reference

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

Inheritance diagram for ResourceLoaderContext:
Collaboration diagram for ResourceLoaderContext:

Public Member Functions

 __construct (ResourceLoader $resourceLoader, WebRequest $request)
 
 encodeJson ( $data)
 Wrapper around json_encode that avoids needless escapes, and pretty-prints in debug mode. More...
 
 getConfig ()
 
 getContentOverrideCallback ()
 Return the replaced-content mapping callback. More...
 
 getDebug ()
 
 getDirection ()
 
 getFormat ()
 
 getHash ()
 All factors that uniquely identify this request, except 'modules'. More...
 
 getImage ()
 
 getImageObj ()
 If this is a request for an image, get the ResourceLoaderImage object. More...
 
 getLanguage ()
 
 getLogger ()
 
 getModules ()
 
 getOnly ()
 
 getRaw ()
 
 getReqBase ()
 Get the request base parameters, omitting any defaults. More...
 
 getRequest ()
 
 getResourceLoader ()
 
 getSkin ()
 
 getUser ()
 
 getUserObj ()
 Get the possibly-cached User object for the specified username. More...
 
 getVariant ()
 
 getVersion ()
 
 msg ( $key,... $params)
 Get a Message object with context set. More...
 
 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. More...
 

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, $request, $resourceLoader, DEFAULT_SKIN, and ResourceLoader\expandModuleNames().

Member Function Documentation

◆ encodeJson()

◆ getConfig()

ResourceLoaderContext::getConfig ( )
Deprecated:
since 1.34 Use ResourceLoaderModule::getConfig instead inside module methods. Use ResourceLoader::getConfig elsewhere.
Returns
Config

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

Referenced by ResourceLoaderWikiModule\getContentObj(), ResourceLoaderWikiModule\getTitleInfo(), and ResourceLoaderWikiModule\shouldEmbedModule().

◆ getDebug()

◆ getDirection()

ResourceLoaderContext::getDirection ( )

◆ getFormat()

ResourceLoaderContext::getFormat ( )
Returns
string|null

Definition at line 279 of file ResourceLoaderContext.php.

References $format.

Referenced by getHash(), ResourceLoaderImage\getImageData(), and ResourceLoaderImage\sendResponseHeaders().

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

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

Referenced by ResourceLoaderFileModule\expandPackageFiles(), ResourceLoaderModule\getModuleContent(), ResourceLoaderFileModule\getPackageFiles(), ResourceLoaderModule\getVersionHash(), and ResourceFileCache\newFromContext().

◆ getImage()

ResourceLoaderContext::getImage ( )
Returns
string|null

Definition at line 265 of file ResourceLoaderContext.php.

References $image.

Referenced by getHash(), and ResourceFileCache\newFromContext().

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

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

Referenced by ResourceLoader\makeModuleResponse(), ResourceLoader\respond(), and ResourceLoader\sendResponseHeaders().

◆ getLanguage()

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

References $logger.

◆ getModules()

◆ getOnly()

◆ getRaw()

ResourceLoaderContext::getRaw ( )

◆ getReqBase()

ResourceLoaderContext::getReqBase ( )

Get the request base parameters, omitting any defaults.

Definition at line 383 of file ResourceLoaderContext.php.

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

Referenced by ResourceLoaderStartUpModule\getScript().

◆ getRequest()

◆ getResourceLoader()

◆ getSkin()

◆ getUser()

ResourceLoaderContext::getUser ( )
Returns
string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 195 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

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 223 of file ResourceLoaderContext.php.

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

Referenced by ResourceLoaderUserModule\getPages(), ResourceLoaderUserStylesModule\getPages(), and ResourceLoaderUserOptionsModule\getScript().

◆ getVariant()

ResourceLoaderContext::getVariant ( )
Returns
string|null

Definition at line 272 of file ResourceLoaderContext.php.

References $variant.

Referenced by getHash(), and ResourceLoaderImage\getImageData().

◆ getVersion()

ResourceLoaderContext::getVersion ( )

◆ msg()

ResourceLoaderContext::msg (   $key,
  $params 
)

Get a Message object with context set.

See wfMessage for parameters.

Since
1.27
Parameters
string | string[] | MessageSpecifier$keyMessage key, or array of keys, or a MessageSpecifier.
mixed...$params
Returns
Message

Implements MessageLocalizer.

Definition at line 208 of file ResourceLoaderContext.php.

References getLanguage(), Title\newFromText(), 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 111 of file ResourceLoaderContext.php.

◆ shouldIncludeMessages()

ResourceLoaderContext::shouldIncludeMessages ( )

Definition at line 342 of file ResourceLoaderContext.php.

References getOnly().

◆ shouldIncludeScripts()

ResourceLoaderContext::shouldIncludeScripts ( )

Definition at line 334 of file ResourceLoaderContext.php.

References getOnly().

Referenced by ResourceLoader\makeModuleResponse(), and ResourceLoader\respond().

◆ shouldIncludeStyles()

ResourceLoaderContext::shouldIncludeStyles ( )

Definition at line 338 of file ResourceLoaderContext.php.

References getOnly().

Member Data Documentation

◆ $debug

ResourceLoaderContext::$debug
protected

Definition at line 44 of file ResourceLoaderContext.php.

Referenced by getDebug().

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

Referenced by getFormat().

◆ $hash

ResourceLoaderContext::$hash
protected

Definition at line 57 of file ResourceLoaderContext.php.

Referenced by getHash().

◆ $image

ResourceLoaderContext::$image
protected

Definition at line 52 of file ResourceLoaderContext.php.

Referenced by getImage(), and getImageObj().

◆ $imageObj

ResourceLoaderImage false ResourceLoaderContext::$imageObj
protected

Definition at line 60 of file ResourceLoaderContext.php.

Referenced by getImageObj().

◆ $language

ResourceLoaderContext::$language
protected

Definition at line 43 of file ResourceLoaderContext.php.

Referenced by getLanguage().

◆ $logger

ResourceLoaderContext::$logger
protected

Definition at line 39 of file ResourceLoaderContext.php.

Referenced by getLogger().

◆ $modules

ResourceLoaderContext::$modules
protected

Definition at line 48 of file ResourceLoaderContext.php.

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

◆ $only

ResourceLoaderContext::$only
protected

Definition at line 49 of file ResourceLoaderContext.php.

Referenced by getOnly().

◆ $raw

ResourceLoaderContext::$raw
protected

Definition at line 51 of file ResourceLoaderContext.php.

Referenced by getRaw().

◆ $request

ResourceLoaderContext::$request
protected

Definition at line 38 of file ResourceLoaderContext.php.

Referenced by __construct(), and getRequest().

◆ $resourceLoader

ResourceLoaderContext::$resourceLoader
protected

Definition at line 37 of file ResourceLoaderContext.php.

Referenced by __construct(), and getResourceLoader().

◆ $skin

ResourceLoaderContext::$skin
protected

Definition at line 42 of file ResourceLoaderContext.php.

Referenced by getSkin().

◆ $user

ResourceLoaderContext::$user
protected

Definition at line 45 of file ResourceLoaderContext.php.

Referenced by getUser().

◆ $userObj

ResourceLoaderContext::$userObj
protected

Definition at line 58 of file ResourceLoaderContext.php.

Referenced by getUserObj().

◆ $variant

ResourceLoaderContext::$variant
protected

Definition at line 53 of file ResourceLoaderContext.php.

Referenced by getVariant().

◆ $version

ResourceLoaderContext::$version
protected

Definition at line 50 of file ResourceLoaderContext.php.

Referenced by getVersion().

◆ DEFAULT_LANG

const ResourceLoaderContext::DEFAULT_LANG = 'qqx'

Definition at line 34 of file ResourceLoaderContext.php.

Referenced by getLanguage().

◆ DEFAULT_SKIN

const ResourceLoaderContext::DEFAULT_SKIN = 'fallback'

Definition at line 35 of file ResourceLoaderContext.php.

Referenced by __construct().


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