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

Inheritance diagram for ResourceLoaderContext:

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 ()
	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 array( '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 31 of file ResourceLoaderContext.php.

Constructor & Destructor Documentation

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

Parameters

ResourceLoader	$resourceLoader
WebRequest	$request

Definition at line 60 of file ResourceLoaderContext.php.

References $modules, $request, $resourceLoader, format, ResourceLoader\getConfig(), WebRequest\getFuzzyBool(), ResourceLoader\getLogger(), Skin\getSkinNames(), WebRequest\getVal(), request, skin(), user, and version.

Member Function Documentation

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 array( 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' )

Parameters

string $modules Packed module name list

Returns: array Array of module names

Definition at line 99 of file ResourceLoaderContext.php.

References $modules, $retval, and as.

Referenced by ResourceLoaderTest\testexpandModuleNames().

ResourceLoaderContext::getDebug ( )

Returns: bool

Definition at line 248 of file ResourceLoaderContext.php.

References $debug.

Referenced by ResourceLoaderModule\buildContent(), ResourceLoaderFileModule\getFileHashes(), getHash(), ResourceLoaderFileModule\getScriptFiles(), ResourceLoaderStartUpModule\getStartupModulesUrl(), ResourceLoader\makeModuleResponse(), ResourceLoader\respond(), ResourceLoader\sendResponseHeaders(), ResourceLoader\tryRespondFromFileCache(), and ResourceLoader\tryRespondNotModified().

ResourceLoaderContext::getDirection ( )

Returns: string

Definition at line 189 of file ResourceLoaderContext.php.

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

Referenced by ResourceLoaderImage\getPath().

ResourceLoaderContext::getFormat ( )

Returns: string|null

Definition at line 292 of file ResourceLoaderContext.php.

References $format.

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

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.