DerivativeResourceLoaderContext Class Reference

A mutable version of ResourceLoaderContext. More...

Inheritance diagram for DerivativeResourceLoaderContext:

Collaboration diagram for DerivativeResourceLoaderContext:

Public Member Functions
	__construct (ResourceLoaderContext $context)
	getContentOverrideCallback ()
	Return the replaced-content mapping callback.
	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)
	encodeJson ( $data)
	Wrapper around json_encode that avoids needless escapes, and pretty-prints in debug mode.
	getConfig ()
	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.
	getLogger ()
	getReqBase ()
	Get the request base parameters, omitting any defaults.
	getUserObj ()
	Get the possibly-cached User object for the specified username.
	getVariant ()
	msg ( $key,... $params)
	Get a Message object with context set.
	shouldIncludeMessages ()
	shouldIncludeScripts ()
	shouldIncludeStyles ()

Public Attributes
const	INHERIT_VALUE = -1
Public Attributes inherited from ResourceLoaderContext
const	DEFAULT_LANG = 'qqx'
const	DEFAULT_SKIN = 'fallback'

Protected Attributes
	$contentOverrideCallback = self::INHERIT_VALUE
	$debug = self::INHERIT_VALUE
	$direction = self::INHERIT_VALUE
	$language = self::INHERIT_VALUE
int array	$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
ResourceLoaderImage false	$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	newDummyContext ()
	Return a dummy ResourceLoaderContext object suitable for passing into things that don't "really" need a context.

Detailed Description

A mutable version of ResourceLoaderContext.

Allows changing specific properties of a context object, without changing the main one. Inspired by MediaWiki's DerivativeContext.

Since

1.24

Definition at line 31 of file DerivativeResourceLoaderContext.php.

Constructor & Destructor Documentation

__construct()

DerivativeResourceLoaderContext::__construct

(

ResourceLoaderContext

$context

)

Definition at line 51 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 203 of file DerivativeResourceLoaderContext.php.

References $contentOverrideCallback.

getDebug()

DerivativeResourceLoaderContext::getDebug

(

)

Returns

bool

Reimplemented from ResourceLoaderContext.

Definition at line 136 of file DerivativeResourceLoaderContext.php.

References $debug.

getDirection()

DerivativeResourceLoaderContext::getDirection

(

)

Returns

string

Reimplemented from ResourceLoaderContext.

Definition at line 87 of file DerivativeResourceLoaderContext.php.

References $direction, and getLanguage().

getLanguage()

DerivativeResourceLoaderContext::getLanguage

(

)

Returns

string

Reimplemented from ResourceLoaderContext.

Definition at line 70 of file DerivativeResourceLoaderContext.php.

References $language.

Referenced by getDirection().

getModules()

DerivativeResourceLoaderContext::getModules

(

)

Returns

array

Reimplemented from ResourceLoaderContext.

Definition at line 55 of file DerivativeResourceLoaderContext.php.

References $modules.

getOnly()

DerivativeResourceLoaderContext::getOnly

(

)

Returns

string|null

Reimplemented from ResourceLoaderContext.

Definition at line 151 of file DerivativeResourceLoaderContext.php.

References $only.

getRaw()

DerivativeResourceLoaderContext::getRaw

(

)

Returns

bool

Reimplemented from ResourceLoaderContext.

Definition at line 181 of file DerivativeResourceLoaderContext.php.

References $raw.

getRequest()

DerivativeResourceLoaderContext::getRequest

(

)

Returns

WebRequest

Reimplemented from ResourceLoaderContext.

Definition at line 195 of file DerivativeResourceLoaderContext.php.

getResourceLoader()

DerivativeResourceLoaderContext::getResourceLoader

(

)

Returns

ResourceLoader

Reimplemented from ResourceLoaderContext.

Definition at line 199 of file DerivativeResourceLoaderContext.php.

getSkin()

DerivativeResourceLoaderContext::getSkin

(

)

Returns

string

Reimplemented from ResourceLoaderContext.

Definition at line 105 of file DerivativeResourceLoaderContext.php.

References $skin.

getUser()

DerivativeResourceLoaderContext::getUser

(

)

Returns

string|null

Reimplemented from ResourceLoaderContext.

Definition at line 120 of file DerivativeResourceLoaderContext.php.

References $user.

getVersion()

DerivativeResourceLoaderContext::getVersion

(

)

See also

ResourceLoaderModule::getVersionHash

ResourceLoaderClientHtml::makeLoad

Returns

string|null

Reimplemented from ResourceLoaderContext.

Definition at line 166 of file DerivativeResourceLoaderContext.php.

References $version.

setContentOverrideCallback()

DerivativeResourceLoaderContext::setContentOverrideCallback

(

$callback

)

See also

self::getContentOverrideCallback

Since

1.32

Parameters

callable | null | int

$callback

As per self::getContentOverrideCallback, or self::INHERIT_VALUE

Definition at line 216 of file DerivativeResourceLoaderContext.php.

setDebug()

DerivativeResourceLoaderContext::setDebug

(

$debug

)

Parameters

bool

$debug

Definition at line 146 of file DerivativeResourceLoaderContext.php.

References $debug.

setDirection()

DerivativeResourceLoaderContext::setDirection

(

$direction

)

Parameters

string

$direction

Definition at line 100 of file DerivativeResourceLoaderContext.php.

References $direction.

setLanguage()

DerivativeResourceLoaderContext::setLanguage

(

$language

)

Parameters

string

$language

Definition at line 80 of file DerivativeResourceLoaderContext.php.

References $language.

setModules()

DerivativeResourceLoaderContext::setModules

(

array

$modules

)

Parameters

string[]

$modules

Definition at line 66 of file DerivativeResourceLoaderContext.php.

References $modules.

setOnly()

DerivativeResourceLoaderContext::setOnly

(

$only

)

Parameters

string | null

$only

Definition at line 161 of file DerivativeResourceLoaderContext.php.

References $only.

setRaw()

DerivativeResourceLoaderContext::setRaw

(

$raw

)

Parameters

bool

$raw

Definition at line 191 of file DerivativeResourceLoaderContext.php.

References $raw.

setSkin()

DerivativeResourceLoaderContext::setSkin

(

$skin

)

Parameters

string

$skin

Definition at line 115 of file DerivativeResourceLoaderContext.php.

References $skin.

setUser()

DerivativeResourceLoaderContext::setUser

(

$user

)

Parameters

string | null

$user

Definition at line 130 of file DerivativeResourceLoaderContext.php.

References $user.

setVersion()

DerivativeResourceLoaderContext::setVersion

(

$version

)

Parameters

string | null

$version

Definition at line 176 of file DerivativeResourceLoaderContext.php.

References $version.

Member Data Documentation

$contentOverrideCallback

DerivativeResourceLoaderContext::$contentOverrideCallback = self::INHERIT_VALUE

protected

Definition at line 49 of file DerivativeResourceLoaderContext.php.

Referenced by getContentOverrideCallback().

$context

ResourceLoaderContext DerivativeResourceLoaderContext::$context

private

Definition at line 37 of file DerivativeResourceLoaderContext.php.

Referenced by __construct().

$debug

DerivativeResourceLoaderContext::$debug = self::INHERIT_VALUE

protected

Definition at line 45 of file DerivativeResourceLoaderContext.php.

Referenced by getDebug(), and setDebug().

$direction

DerivativeResourceLoaderContext::$direction = self::INHERIT_VALUE

protected

Definition at line 42 of file DerivativeResourceLoaderContext.php.

Referenced by getDirection(), and setDirection().

$language

DerivativeResourceLoaderContext::$language = self::INHERIT_VALUE

protected

Definition at line 41 of file DerivativeResourceLoaderContext.php.

Referenced by getLanguage(), and setLanguage().

$modules

int array DerivativeResourceLoaderContext::$modules = self::INHERIT_VALUE

protected

Definition at line 40 of file DerivativeResourceLoaderContext.php.

Referenced by getModules(), and setModules().

$only

DerivativeResourceLoaderContext::$only = self::INHERIT_VALUE

protected

Definition at line 46 of file DerivativeResourceLoaderContext.php.

Referenced by getOnly(), and setOnly().

$raw

DerivativeResourceLoaderContext::$raw = self::INHERIT_VALUE

protected

Definition at line 48 of file DerivativeResourceLoaderContext.php.

Referenced by getRaw(), and setRaw().

$skin

DerivativeResourceLoaderContext::$skin = self::INHERIT_VALUE

protected

Definition at line 43 of file DerivativeResourceLoaderContext.php.

Referenced by getSkin(), and setSkin().

$user

DerivativeResourceLoaderContext::$user = self::INHERIT_VALUE

protected

Definition at line 44 of file DerivativeResourceLoaderContext.php.

Referenced by getUser(), and setUser().

$version

DerivativeResourceLoaderContext::$version = self::INHERIT_VALUE

protected

Definition at line 47 of file DerivativeResourceLoaderContext.php.

Referenced by getVersion(), and setVersion().

INHERIT_VALUE

const DerivativeResourceLoaderContext::INHERIT_VALUE = -1

Definition at line 32 of file DerivativeResourceLoaderContext.php.

---

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

• includes/resourceloader/DerivativeResourceLoaderContext.php