MediaWiki  1.33.0
DerivativeResourceLoaderContext Class Reference

Allows changing specific properties of a context object, without changing the main one. More...

Inheritance diagram for DerivativeResourceLoaderContext:
Collaboration diagram for DerivativeResourceLoaderContext:

Public Member Functions

 __construct (ResourceLoaderContext $context)
 
 getContentOverrideCallback ()
 Return the replaced-content mapping callback. More...
 
 getDebug ()
 
 getDirection ()
 
 getLanguage ()
 
 getModules ()
 
 getOnly ()
 
 getRaw ()
 
 getRequest ()
 
 getResourceLoader ()
 
 getSkin ()
 
 getUser ()
 
 getVersion ()
 
 setContentOverrideCallback ( $callback)
 
 setDebug ( $debug)
 
 setDirection ( $direction)
 
 setLanguage ( $language)
 
 setModules (array $modules)
 
 setOnly ( $only)
 
 setRaw ( $raw)
 
 setSkin ( $skin)
 
 setUser ( $user)
 
 setVersion ( $version)
 
- Public Member Functions inherited from ResourceLoaderContext
 __construct (ResourceLoader $resourceLoader, WebRequest $request)
 
 getConfig ()
 
 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...
 
 getLogger ()
 
 getUserObj ()
 Get the possibly-cached User object for the specified username. More...
 
 getVariant ()
 
 msg ( $key)
 Get a Message object with context set. More...
 
 shouldIncludeMessages ()
 
 shouldIncludeScripts ()
 
 shouldIncludeStyles ()
 

Public Attributes

const INHERIT_VALUE = -1
 

Protected Attributes

 $contentOverrideCallback = self::INHERIT_VALUE
 
 $debug = self::INHERIT_VALUE
 
 $direction = self::INHERIT_VALUE
 
 $language = self::INHERIT_VALUE
 
 $modules = self::INHERIT_VALUE
 
 $only = self::INHERIT_VALUE
 
 $raw = self::INHERIT_VALUE
 
 $skin = self::INHERIT_VALUE
 
 $user = self::INHERIT_VALUE
 
 $version = self::INHERIT_VALUE
 
- Protected Attributes inherited from ResourceLoaderContext
 $debug
 
 $direction
 
 $format
 
 $hash
 
 $image
 
 $imageObj
 
 $language
 
 $logger
 
 $modules
 
 $only
 
 $raw
 
 $request
 
 $resourceLoader
 
 $skin
 
 $user
 
 $userObj
 
 $variant
 
 $version
 

Private Attributes

ResourceLoaderContext $context
 

Additional Inherited Members

- Static Public Member Functions inherited from ResourceLoaderContext
static expandModuleNames ( $modules)
 Reverse the process done by ResourceLoader::makePackedModulesString(). More...
 
static newDummyContext ()
 Return a dummy ResourceLoaderContext object suitable for passing into things that don't "really" need a context. More...
 

Detailed Description

Allows changing specific properties of a context object, without changing the main one.

Inspired by DerivativeContext.

Since
1.24

Definition at line 30 of file DerivativeResourceLoaderContext.php.

Constructor & Destructor Documentation

◆ __construct()

DerivativeResourceLoaderContext::__construct ( ResourceLoaderContext  $context)

Definition at line 49 of file DerivativeResourceLoaderContext.php.

References $context.

Member Function Documentation

◆ getContentOverrideCallback()

DerivativeResourceLoaderContext::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 from ResourceLoaderContext.

Definition at line 200 of file DerivativeResourceLoaderContext.php.

References $contentOverrideCallback.

◆ getDebug()

DerivativeResourceLoaderContext::getDebug ( )
Returns
bool

Reimplemented from ResourceLoaderContext.

Definition at line 133 of file DerivativeResourceLoaderContext.php.

References $debug.

◆ getDirection()

DerivativeResourceLoaderContext::getDirection ( )
Returns
string

Reimplemented from ResourceLoaderContext.

Definition at line 84 of file DerivativeResourceLoaderContext.php.

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

◆ getLanguage()

DerivativeResourceLoaderContext::getLanguage ( )
Returns
string

Reimplemented from ResourceLoaderContext.

Definition at line 67 of file DerivativeResourceLoaderContext.php.

References $language, and language().

Referenced by getDirection().

◆ getModules()

DerivativeResourceLoaderContext::getModules ( )
Returns
array

Reimplemented from ResourceLoaderContext.

Definition at line 53 of file DerivativeResourceLoaderContext.php.

References $modules.

◆ getOnly()

DerivativeResourceLoaderContext::getOnly ( )
Returns
string|null

Reimplemented from ResourceLoaderContext.

Definition at line 148 of file DerivativeResourceLoaderContext.php.

References $only.

◆ getRaw()

DerivativeResourceLoaderContext::getRaw ( )
Returns
bool

Reimplemented from ResourceLoaderContext.

Definition at line 178 of file DerivativeResourceLoaderContext.php.

References $raw.

◆ getRequest()

DerivativeResourceLoaderContext::getRequest ( )
Returns
WebRequest

Reimplemented from ResourceLoaderContext.

Definition at line 192 of file DerivativeResourceLoaderContext.php.

◆ getResourceLoader()

DerivativeResourceLoaderContext::getResourceLoader ( )
Returns
ResourceLoader

Reimplemented from ResourceLoaderContext.

Definition at line 196 of file DerivativeResourceLoaderContext.php.

◆ getSkin()

DerivativeResourceLoaderContext::getSkin ( )
Returns
string

Reimplemented from ResourceLoaderContext.

Definition at line 102 of file DerivativeResourceLoaderContext.php.

References $skin.

◆ getUser()

DerivativeResourceLoaderContext::getUser ( )
Returns
string|null

Reimplemented from ResourceLoaderContext.

Definition at line 117 of file DerivativeResourceLoaderContext.php.

References $user, and user.

◆ getVersion()

DerivativeResourceLoaderContext::getVersion ( )
See also
ResourceLoaderModule::getVersionHash
ResourceLoaderClientHtml::makeLoad
Returns
string|null

Reimplemented from ResourceLoaderContext.

Definition at line 163 of file DerivativeResourceLoaderContext.php.

References $version, and version.

◆ setContentOverrideCallback()

DerivativeResourceLoaderContext::setContentOverrideCallback (   $callback)
See also
self::getContentOverrideCallback
Since
1.32
Parameters
callable | null | int$callbackAs per self::getContentOverrideCallback, or self::INHERIT_VALUE

Definition at line 213 of file DerivativeResourceLoaderContext.php.

◆ setDebug()

DerivativeResourceLoaderContext::setDebug (   $debug)
Parameters
bool$debug

Definition at line 143 of file DerivativeResourceLoaderContext.php.

References $debug.

◆ setDirection()

DerivativeResourceLoaderContext::setDirection (   $direction)
Parameters
string$direction

Definition at line 97 of file DerivativeResourceLoaderContext.php.

References $direction.

◆ setLanguage()

DerivativeResourceLoaderContext::setLanguage (   $language)
Parameters
string$language

Definition at line 77 of file DerivativeResourceLoaderContext.php.

References $language, and language().

◆ setModules()

DerivativeResourceLoaderContext::setModules ( array  $modules)
Parameters
string[]$modules

Definition at line 63 of file DerivativeResourceLoaderContext.php.

References $modules.

◆ setOnly()

DerivativeResourceLoaderContext::setOnly (   $only)
Parameters
string | null$only

Definition at line 158 of file DerivativeResourceLoaderContext.php.

References $only.

◆ setRaw()

DerivativeResourceLoaderContext::setRaw (   $raw)
Parameters
bool$raw

Definition at line 188 of file DerivativeResourceLoaderContext.php.

References $raw.

◆ setSkin()

DerivativeResourceLoaderContext::setSkin (   $skin)
Parameters
string$skin

Definition at line 112 of file DerivativeResourceLoaderContext.php.

References $skin.

◆ setUser()

DerivativeResourceLoaderContext::setUser (   $user)
Parameters
string | null$user

Definition at line 127 of file DerivativeResourceLoaderContext.php.

References $user, and user.

◆ setVersion()

DerivativeResourceLoaderContext::setVersion (   $version)
Parameters
string | null$version

Definition at line 173 of file DerivativeResourceLoaderContext.php.

References $version, and version.

Member Data Documentation

◆ $contentOverrideCallback

DerivativeResourceLoaderContext::$contentOverrideCallback = self::INHERIT_VALUE
protected

Definition at line 47 of file DerivativeResourceLoaderContext.php.

Referenced by getContentOverrideCallback().

◆ $context

ResourceLoaderContext DerivativeResourceLoaderContext::$context
private

Definition at line 36 of file DerivativeResourceLoaderContext.php.

Referenced by __construct().

◆ $debug

DerivativeResourceLoaderContext::$debug = self::INHERIT_VALUE
protected

Definition at line 43 of file DerivativeResourceLoaderContext.php.

Referenced by getDebug(), and setDebug().

◆ $direction

DerivativeResourceLoaderContext::$direction = self::INHERIT_VALUE
protected

Definition at line 40 of file DerivativeResourceLoaderContext.php.

Referenced by getDirection(), and setDirection().

◆ $language

DerivativeResourceLoaderContext::$language = self::INHERIT_VALUE
protected

Definition at line 39 of file DerivativeResourceLoaderContext.php.

Referenced by getLanguage(), and setLanguage().

◆ $modules

DerivativeResourceLoaderContext::$modules = self::INHERIT_VALUE
protected

Definition at line 38 of file DerivativeResourceLoaderContext.php.

Referenced by getModules(), and setModules().

◆ $only

DerivativeResourceLoaderContext::$only = self::INHERIT_VALUE
protected

Definition at line 44 of file DerivativeResourceLoaderContext.php.

Referenced by getOnly(), and setOnly().

◆ $raw

DerivativeResourceLoaderContext::$raw = self::INHERIT_VALUE
protected

Definition at line 46 of file DerivativeResourceLoaderContext.php.

Referenced by getRaw(), and setRaw().

◆ $skin

DerivativeResourceLoaderContext::$skin = self::INHERIT_VALUE
protected

Definition at line 41 of file DerivativeResourceLoaderContext.php.

Referenced by getSkin(), and setSkin().

◆ $user

DerivativeResourceLoaderContext::$user = self::INHERIT_VALUE
protected

Definition at line 42 of file DerivativeResourceLoaderContext.php.

Referenced by getUser(), and setUser().

◆ $version

DerivativeResourceLoaderContext::$version = self::INHERIT_VALUE
protected

Definition at line 45 of file DerivativeResourceLoaderContext.php.

Referenced by getVersion(), and setVersion().

◆ INHERIT_VALUE

const DerivativeResourceLoaderContext::INHERIT_VALUE = -1

Definition at line 31 of file DerivativeResourceLoaderContext.php.


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