MediaWiki  REL1_22
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 ()
 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' )
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
 $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

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

Definition at line 52 of file ResourceLoaderContext.php.

References $modules, $request, $resourceLoader, array(), expandModuleNames(), WebRequest\getFuzzyBool(), Skin\getSkinNames(), WebRequest\getVal(), global, only, 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$modulesPacked 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().

ResourceLoaderContext::getDebug ( )
Returns:
bool

Definition at line 187 of file ResourceLoaderContext.php.

Referenced by ResourceLoaderFileModule\getModifiedTime(), ResourceLoaderStartUpModule\getScript(), and ResourceLoaderFileModule\getScriptFiles().

ResourceLoaderContext::getDirection ( )
Returns:
string

Definition at line 159 of file ResourceLoaderContext.php.

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

Referenced by getHash().

ResourceLoaderContext::getHash ( )
Returns:
string

Definition at line 236 of file ResourceLoaderContext.php.

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

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

ResourceLoaderContext::getLanguage ( )
Returns:
string

Definition at line 145 of file ResourceLoaderContext.php.

References $wgLang, global, language, and request.

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

ResourceLoaderContext::getModules ( )
Returns:
array

Definition at line 138 of file ResourceLoaderContext.php.

Referenced by ResourceFileCache\newFromContext().

ResourceLoaderContext::getOnly ( )
Returns:
String|null

Definition at line 194 of file ResourceLoaderContext.php.

References only.

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

ResourceLoaderContext::getRaw ( )
Returns:
bool

Definition at line 208 of file ResourceLoaderContext.php.

ResourceLoaderContext::getRequest ( )
Returns:
WebRequest

Definition at line 131 of file ResourceLoaderContext.php.

References request.

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

ResourceLoaderContext::getResourceLoader ( )
Returns:
ResourceLoader

Definition at line 124 of file ResourceLoaderContext.php.

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

ResourceLoaderContext::getSkin ( )
Returns:
string|null

Definition at line 173 of file ResourceLoaderContext.php.

References skin().

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

ResourceLoaderContext::getUser ( )
Returns:
string|null

Definition at line 180 of file ResourceLoaderContext.php.

References user.

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

ResourceLoaderContext::getVersion ( )
Returns:
String|null

Definition at line 201 of file ResourceLoaderContext.php.

References version.

Referenced by ResourceLoaderModule\getScriptURLsForDebug(), and ResourceLoaderModule\getStyleURLsForDebug().

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

References array().

ResourceLoaderContext::shouldIncludeMessages ( )
Returns:
bool

Definition at line 229 of file ResourceLoaderContext.php.

References only.

ResourceLoaderContext::shouldIncludeScripts ( )
Returns:
bool

Definition at line 215 of file ResourceLoaderContext.php.

References only.

ResourceLoaderContext::shouldIncludeStyles ( )
Returns:
bool

Definition at line 222 of file ResourceLoaderContext.php.

References only.

Member Data Documentation

ResourceLoaderContext::$debug [protected]

Definition at line 40 of file ResourceLoaderContext.php.

ResourceLoaderContext::$direction [protected]

Definition at line 37 of file ResourceLoaderContext.php.

ResourceLoaderContext::$hash [protected]

Definition at line 43 of file ResourceLoaderContext.php.

ResourceLoaderContext::$language [protected]

Definition at line 36 of file ResourceLoaderContext.php.

ResourceLoaderContext::$modules [protected]

Definition at line 35 of file ResourceLoaderContext.php.

Referenced by __construct(), and expandModuleNames().

ResourceLoaderContext::$only [protected]

Definition at line 41 of file ResourceLoaderContext.php.

ResourceLoaderContext::$raw [protected]

Definition at line 44 of file ResourceLoaderContext.php.

ResourceLoaderContext::$request [protected]

Definition at line 34 of file ResourceLoaderContext.php.

Referenced by __construct().

ResourceLoaderContext::$resourceLoader [protected]

Definition at line 33 of file ResourceLoaderContext.php.

Referenced by __construct().

ResourceLoaderContext::$skin [protected]

Definition at line 38 of file ResourceLoaderContext.php.

ResourceLoaderContext::$user [protected]

Definition at line 39 of file ResourceLoaderContext.php.

ResourceLoaderContext::$version [protected]

Definition at line 42 of file ResourceLoaderContext.php.

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