ResourceLoaderContext Class Reference

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

Public Member Functions
	__construct ( $resourceLoader, WebRequest $request)
	getDebug ()
	getDirection ()
	getHash ()
	getLanguage ()
	getModules ()
	getOnly ()
	getRaw ()
	getRequest ()
	getResourceLoader ()
	getSkin ()
	getUser ()
	getVersion ()
	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
	$hash
	$language
	$modules
	$only
	$raw
	$request
	$resourceLoader
	$skin
	$user
	$version

Detailed Description

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

Definition at line 29 of file ResourceLoaderContext.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

$resourceLoader	ResourceLoader
$request	WebRequest

Definition at line 52 of file ResourceLoaderContext.php.

References $modules, $request, $resourceLoader, array(), expandModuleNames(), Skin\getSkinNames(), WebRequest\getVal(), global, only, 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 array( 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' )

Parameters

string

$modules

Packed module name list

Returns

array of module names

Definition at line 84 of file ResourceLoaderContext.php.

References $modules, $retval, array(), and as.

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

getDebug()

ResourceLoaderContext::getDebug

(

)

Returns

bool

Definition at line 182 of file ResourceLoaderContext.php.

References $debug.

Referenced by ResourceLoaderFileModule\getModifiedTime(), ResourceLoaderFileModule\getScriptFiles(), ResourceLoaderStartUpModule\getStartupModulesUrl(), ResourceLoader\makeModuleResponse(), ResourceLoader\sendResponseHeaders(), ResourceLoader\tryRespondFromFileCache(), and ResourceLoader\tryRespondLastModified().

getDirection()

ResourceLoaderContext::getDirection

(

)

Returns

string

Definition at line 154 of file ResourceLoaderContext.php.

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

Referenced by getHash().

getHash()

ResourceLoaderContext::getHash

(

)

Returns

string

Definition at line 231 of file ResourceLoaderContext.php.

References $hash, array(), getDirection(), getLanguage(), only, skin(), user, and version.

Referenced by ResourceLoaderUserCSSPrefsModule\getModifiedTime(), ResourceLoaderUserOptionsModule\getModifiedTime(), ResourceLoaderStartUpModule\getModifiedTime(), ResourceLoaderFileModule\getModifiedTime(), ResourceLoaderWikiModule\getTitleMtimes(), and ResourceFileCache\newFromContext().

getLanguage()

ResourceLoaderContext::getLanguage

(

)

Returns

string

Definition at line 143 of file ResourceLoaderContext.php.

References $language, request, and RequestContext\sanitizeLangCode().

Referenced by getDirection(), getHash(), ResourceLoaderLanguageDataModule\getModifiedHash(), ResourceLoaderWikiModule\getModifiedTime(), ResourceLoaderFileModule\getModifiedTime(), ResourceLoaderLanguageDataModule\getScript(), ResourceLoaderFileModule\getScriptFiles(), ResourceLoaderModule\getScriptURLsForDebug(), ResourceLoaderStartUpModule\getStartupModulesUrl(), ResourceLoaderModule\getStyleURLsForDebug(), ResourceLoader\makeModuleResponse(), and ResourceLoader\preloadModuleInfo().

getModules()

ResourceLoaderContext::getModules

(

)

Returns

array

Definition at line 136 of file ResourceLoaderContext.php.

References $modules.

Referenced by ResourceFileCache\newFromContext().

getOnly()

ResourceLoaderContext::getOnly

(

)

Returns

String|null

Definition at line 189 of file ResourceLoaderContext.php.

References $only.

Referenced by ResourceLoaderStartUpModule\getScript(), ResourceLoader\makeModuleResponse(), ResourceFileCache\newFromContext(), and ResourceLoader\sendResponseHeaders().

getRaw()

ResourceLoaderContext::getRaw

(

)

Returns

bool

Definition at line 203 of file ResourceLoaderContext.php.

References $raw.

Referenced by ResourceLoader\makeModuleResponse().

getRequest()

ResourceLoaderContext::getRequest

(

)

Returns

WebRequest

Definition at line 129 of file ResourceLoaderContext.php.

References $request.

Referenced by ResourceLoaderStartUpModule\getModuleRegistrations(), ResourceLoaderUserModule\getPages(), ResourceLoaderModule\getScriptURLsForDebug(), ResourceLoaderModule\getStyleURLsForDebug(), ResourceLoader\tryRespondLastModified(), and ResourceFileCache\useFileCache().

getResourceLoader()

ResourceLoaderContext::getResourceLoader

(

)

Returns

ResourceLoader

Definition at line 122 of file ResourceLoaderContext.php.

References $resourceLoader.

Referenced by ResourceLoaderStartUpModule\getModifiedTime(), ResourceLoaderStartUpModule\getModuleRegistrations(), and ResourceLoaderStartUpModule\getStartupModulesUrl().

getSkin()

ResourceLoaderContext::getSkin

(

)

Returns

string|null

Definition at line 168 of file ResourceLoaderContext.php.

References $skin.

Referenced by ResourceLoaderFileModule\getModifiedTime(), ResourceLoaderSiteModule\getPages(), ResourceLoaderUserModule\getPages(), ResourceLoaderFileModule\getScriptFiles(), ResourceLoaderModule\getScriptURLsForDebug(), ResourceLoaderStartUpModule\getStartupModulesUrl(), ResourceLoaderFileModule\getStyleFiles(), ResourceLoaderFileModule\getStyles(), ResourceLoaderModule\getStyleURLsForDebug(), and ResourceLoader\preloadModuleInfo().

getUser()

ResourceLoaderContext::getUser

(

)

Returns

string|null

Definition at line 175 of file ResourceLoaderContext.php.

References $user.

Referenced by ResourceLoaderUserGroupsModule\getPages(), ResourceLoaderUserModule\getPages(), ResourceLoaderModule\getScriptURLsForDebug(), and ResourceLoaderModule\getStyleURLsForDebug().

getVersion()

ResourceLoaderContext::getVersion

(

)

Returns

String|null

Definition at line 196 of file ResourceLoaderContext.php.

References $version.

Referenced by ResourceLoaderModule\getScriptURLsForDebug(), ResourceLoaderModule\getStyleURLsForDebug(), ResourceLoader\sendResponseHeaders(), and ResourceLoader\tryRespondFromFileCache().

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

References array().

shouldIncludeMessages()

ResourceLoaderContext::shouldIncludeMessages

(

)

Returns

bool

Definition at line 224 of file ResourceLoaderContext.php.

References only.

Referenced by ResourceLoader\makeModuleResponse().

shouldIncludeScripts()

ResourceLoaderContext::shouldIncludeScripts

(

)

Returns

bool

Definition at line 210 of file ResourceLoaderContext.php.

References only.

Referenced by ResourceLoader\makeModuleResponse().

shouldIncludeStyles()

ResourceLoaderContext::shouldIncludeStyles

(

)

Returns

bool

Definition at line 217 of file ResourceLoaderContext.php.

References only.

Referenced by ResourceLoader\makeModuleResponse().

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

Referenced by getDirection().

$hash

ResourceLoaderContext::$hash

protected

Definition at line 43 of file ResourceLoaderContext.php.

Referenced by getHash().

$language

ResourceLoaderContext::$language

protected

Definition at line 36 of file ResourceLoaderContext.php.

Referenced by getLanguage().

$modules

ResourceLoaderContext::$modules

protected

Definition at line 35 of file ResourceLoaderContext.php.

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

$only

ResourceLoaderContext::$only

protected

Definition at line 41 of file ResourceLoaderContext.php.

Referenced by getOnly().

$raw

ResourceLoaderContext::$raw

protected

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

Referenced by getUser().

$version

ResourceLoaderContext::$version

protected

Definition at line 42 of file ResourceLoaderContext.php.

Referenced by getVersion().

---

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

• includes/resourceloader/ResourceLoaderContext.php