MediaWiki  REL1_19
Public Member Functions | Static Public Member Functions | Protected Attributes
ResourceLoaderContext Class Reference

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

List of all members.

Public Member Functions

 __construct ($resourceLoader, WebRequest $request)
 getDebug ()
 getDirection ()
 getHash ()
 getLanguage ()
 getModules ()
 getOnly ()
 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' )
static newDummyContext ()
 Return a dummy ResourceLoaderContext object suitable for passing into things that don't "really" need a context.

Protected Attributes

 $debug
 $direction
 $hash
 $language
 $modules
 $only
 $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 27 of file ResourceLoaderContext.php.

Constructor & Destructor Documentation

ResourceLoaderContext::__construct ( $  resourceLoader,
WebRequest $  request 
)
Parameters:
$resourceLoaderResourceLoader
$requestWebRequest

Definition at line 49 of file ResourceLoaderContext.php.

References $modules, $request, $resourceLoader, $wgDefaultSkin, $wgResourceLoaderDebug, expandModuleNames(), WebRequest\getFuzzyBool(), Skin\getSkinNames(), and WebRequest\getVal().

Here is the call graph for this function:

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:
$modulesString Packed module name list
Returns:
array of module names

Definition at line 80 of file ResourceLoaderContext.php.

References $modules.

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

Here is the caller graph for this function:

ResourceLoaderContext::getDebug ( )
Returns:
bool

Definition at line 183 of file ResourceLoaderContext.php.

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

Here is the caller graph for this function:

ResourceLoaderContext::getDirection ( )
Returns:
string

Definition at line 155 of file ResourceLoaderContext.php.

References Language\factory().

Referenced by getHash().

Here is the call graph for this function:

Here is the caller graph for this function:

ResourceLoaderContext::getHash ( )
Returns:
string

Definition at line 225 of file ResourceLoaderContext.php.

References getDirection(), and getLanguage().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ResourceLoaderContext::getLanguage ( )
Returns:
string

Definition at line 141 of file ResourceLoaderContext.php.

References $wgLang.

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

Here is the caller graph for this function:

ResourceLoaderContext::getModules ( )
Returns:
array

Definition at line 134 of file ResourceLoaderContext.php.

Referenced by ResourceFileCache\newFromContext(), and ResourceLoader\respond().

Here is the caller graph for this function:

ResourceLoaderContext::getOnly ( )
Returns:
String|null

Definition at line 190 of file ResourceLoaderContext.php.

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

Here is the caller graph for this function:

ResourceLoaderContext::getRequest ( )
Returns:
WebRequest

Definition at line 127 of file ResourceLoaderContext.php.

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

Here is the caller graph for this function:

ResourceLoaderContext::getResourceLoader ( )
Returns:
ResourceLoader

Definition at line 120 of file ResourceLoaderContext.php.

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

Here is the caller graph for this function:

ResourceLoaderContext::getSkin ( )
Returns:
string|null

Definition at line 169 of file ResourceLoaderContext.php.

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

Here is the caller graph for this function:

ResourceLoaderContext::getUser ( )
Returns:
string|null

Definition at line 176 of file ResourceLoaderContext.php.

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

Here is the caller graph for this function:

ResourceLoaderContext::getVersion ( )
Returns:
String|null

Definition at line 197 of file ResourceLoaderContext.php.

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

Here is the caller graph for this function:

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

ResourceLoaderContext::shouldIncludeMessages ( )
Returns:
bool

Definition at line 218 of file ResourceLoaderContext.php.

Referenced by ResourceLoader\makeModuleResponse().

Here is the caller graph for this function:

ResourceLoaderContext::shouldIncludeScripts ( )
Returns:
bool

Definition at line 204 of file ResourceLoaderContext.php.

Referenced by ResourceLoader\makeModuleResponse().

Here is the caller graph for this function:

ResourceLoaderContext::shouldIncludeStyles ( )
Returns:
bool

Definition at line 211 of file ResourceLoaderContext.php.

Referenced by ResourceLoader\makeModuleResponse().

Here is the caller graph for this function:

Member Data Documentation

ResourceLoaderContext::$debug [protected]

Definition at line 38 of file ResourceLoaderContext.php.

ResourceLoaderContext::$direction [protected]

Definition at line 35 of file ResourceLoaderContext.php.

ResourceLoaderContext::$hash [protected]

Definition at line 41 of file ResourceLoaderContext.php.

ResourceLoaderContext::$language [protected]

Definition at line 34 of file ResourceLoaderContext.php.

ResourceLoaderContext::$modules [protected]

Definition at line 33 of file ResourceLoaderContext.php.

Referenced by __construct(), and expandModuleNames().

ResourceLoaderContext::$only [protected]

Definition at line 39 of file ResourceLoaderContext.php.

ResourceLoaderContext::$request [protected]

Definition at line 32 of file ResourceLoaderContext.php.

Referenced by __construct().

ResourceLoaderContext::$resourceLoader [protected]

Definition at line 31 of file ResourceLoaderContext.php.

Referenced by __construct().

ResourceLoaderContext::$skin [protected]

Definition at line 36 of file ResourceLoaderContext.php.

ResourceLoaderContext::$user [protected]

Definition at line 37 of file ResourceLoaderContext.php.

ResourceLoaderContext::$version [protected]

Definition at line 40 of file ResourceLoaderContext.php.

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