MediaWiki  1.30.0
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
ResourceLoaderContext Class Reference

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

Inheritance diagram for ResourceLoaderContext:
Inheritance graph
[legend]
Collaboration diagram for ResourceLoaderContext:
Collaboration graph
[legend]

Public Member Functions

 __construct (ResourceLoader $resourceLoader, WebRequest $request)
 
 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 ()
 
 getRequest ()
 
 getResourceLoader ()
 
 getSkin ()
 
 getUser ()
 
 getUserObj ()
 Get the possibly-cached User object for the specified username. More...
 
 getVariant ()
 
 getVersion ()
 
 msg ( $key)
 Get a Message object with context set. More...
 
 shouldIncludeMessages ()
 
 shouldIncludeScripts ()
 
 shouldIncludeStyles ()
 

Static Public Member Functions

static expandModuleNames ( $modules)
 Expand a string of the form jquery.foo,bar|jquery.ui.baz,quux to an array of module names like [ 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' ]. More...
 
static newDummyContext ()
 Return a dummy ResourceLoaderContext object suitable for passing into things that don't "really" need a context. More...
 

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, expandModuleNames(), format, WebRequest\getRawVal(), Skin\getSkinNames(), request, skin(), user, and version.

Member Function Documentation

◆ expandModuleNames()

static ResourceLoaderContext::expandModuleNames (   $modules)
static

Expand a string of the form jquery.foo,bar|jquery.ui.baz,quux to an array of module names like [ 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' ].

Parameters
string$modulesPacked module name list
Returns
array Array of module names

Definition at line 107 of file ResourceLoaderContext.php.

References $modules, $retval, and as.

Referenced by __construct(), and ResourceLoaderTest\testExpandModuleNames().

◆ getDebug()

ResourceLoaderContext::getDebug ( )
Returns
bool

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 263 of file ResourceLoaderContext.php.

References $debug.

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

◆ getDirection()

ResourceLoaderContext::getDirection ( )
Returns
string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 196 of file ResourceLoaderContext.php.

References $direction, Language\factory(), getLanguage(), and getRequest().

◆ getFormat()

ResourceLoaderContext::getFormat ( )
Returns
string|null

Definition at line 307 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 378 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 293 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 317 of file ResourceLoaderContext.php.

References $image, $imageObj, $modules, captcha-old\count, getModules(), and getResourceLoader().

◆ getLanguage()

ResourceLoaderContext::getLanguage ( )
Returns
string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 178 of file ResourceLoaderContext.php.

References $lang, $language, getRequest(), getResourceLoader(), Language\isValidBuiltInCode(), language(), and wfDebug().

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

References $logger.

◆ getModules()

ResourceLoaderContext::getModules ( )
Returns
array

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 171 of file ResourceLoaderContext.php.

References $modules.

Referenced by getImageObj().

◆ getOnly()

ResourceLoaderContext::getOnly ( )
Returns
string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 270 of file ResourceLoaderContext.php.

References $only.

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

◆ getRaw()

ResourceLoaderContext::getRaw ( )
Returns
bool

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 286 of file ResourceLoaderContext.php.

References $raw.

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

◆ getRequest()

ResourceLoaderContext::getRequest ( )
Returns
WebRequest

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 156 of file ResourceLoaderContext.php.

References $request.

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

◆ getResourceLoader()

ResourceLoaderContext::getResourceLoader ( )
Returns
ResourceLoader

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 149 of file ResourceLoaderContext.php.

References $resourceLoader.

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

◆ getSkin()

ResourceLoaderContext::getSkin ( )
Returns
string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 210 of file ResourceLoaderContext.php.

References $skin.

Referenced by getHash().

◆ getUser()

ResourceLoaderContext::getUser ( )
Returns
string|null

Reimplemented in DerivativeResourceLoaderContext.

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

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

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

◆ getVariant()

ResourceLoaderContext::getVariant ( )
Returns
string|null

Definition at line 300 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 279 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$keyMessage key, or array of keys, or a MessageSpecifier.
mixed$args,...
Returns
Message

Implements MessageLocalizer.

Definition at line 230 of file ResourceLoaderContext.php.

References getLanguage(), and Title\newFromText().

◆ newDummyContext()

static ResourceLoaderContext::newDummyContext ( )
static

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

Returns
ResourceLoaderContext

Definition at line 139 of file ResourceLoaderContext.php.

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

◆ shouldIncludeMessages()

ResourceLoaderContext::shouldIncludeMessages ( )
Returns
bool

Definition at line 363 of file ResourceLoaderContext.php.

References getOnly().

◆ shouldIncludeScripts()

ResourceLoaderContext::shouldIncludeScripts ( )
Returns
bool

Definition at line 349 of file ResourceLoaderContext.php.

References getOnly().

◆ shouldIncludeStyles()

ResourceLoaderContext::shouldIncludeStyles ( )
Returns
bool

Definition at line 356 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: