MediaWiki  REL1_24
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...

Inheritance diagram for ResourceLoaderContext:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 __construct (ResourceLoader $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 $  resourceLoader,
WebRequest $  request 
)
Parameters:
ResourceLoader$resourceLoader
WebRequest$request

Definition at line 51 of file ResourceLoaderContext.php.

References $modules, $request, $resourceLoader, array(), expandModuleNames(), ResourceLoader\getConfig(), WebRequest\getFuzzyBool(), 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$modulesPacked module name list
Returns:
array Array of module names

Definition at line 83 of file ResourceLoaderContext.php.

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

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

ResourceLoaderContext::getDebug ( )
Returns:
bool

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 184 of file ResourceLoaderContext.php.

Referenced by getHash(), ResourceLoaderStartUpModule\getStartupModulesUrl(), and ResourceLoaderFileModule\getStyleFiles().

ResourceLoaderContext::getDirection ( )
Returns:
string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 156 of file ResourceLoaderContext.php.

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

Referenced by getHash().

ResourceLoaderContext::getHash ( )
Returns:
string

Definition at line 233 of file ResourceLoaderContext.php.

References array(), getDebug(), getDirection(), getLanguage(), getOnly(), getSkin(), getUser(), and getVersion().

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

ResourceLoaderContext::getLanguage ( )
Returns:
string

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 145 of file ResourceLoaderContext.php.

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

Referenced by ResourceLoaderLanguageDataModule\getData(), ResourceLoaderLanguageNamesModule\getData(), getDirection(), getHash(), ResourceLoaderEditToolbarModule\getLessVars(), ResourceLoaderWikiModule\getModifiedTime(), ResourceLoaderLanguageNamesModule\getScript(), ResourceLoaderLanguageDataModule\getScript(), ResourceLoaderStartUpModule\getStartupModulesUrl(), and ResourceLoaderFileModule\getStyleFiles().

ResourceLoaderContext::getModules ( )
Returns:
array

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 138 of file ResourceLoaderContext.php.

Referenced by ResourceFileCache\newFromContext().

ResourceLoaderContext::getOnly ( )
Returns:
string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 191 of file ResourceLoaderContext.php.

Referenced by getHash(), ResourceLoaderStartUpModule\getScript(), ResourceFileCache\newFromContext(), shouldIncludeMessages(), shouldIncludeScripts(), and shouldIncludeStyles().

ResourceLoaderContext::getRaw ( )
Returns:
bool

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 205 of file ResourceLoaderContext.php.

ResourceLoaderContext::getRequest ( )
Returns:
WebRequest

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 131 of file ResourceLoaderContext.php.

References request.

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

ResourceLoaderContext::getResourceLoader ( )
Returns:
ResourceLoader

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 124 of file ResourceLoaderContext.php.

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

ResourceLoaderContext::getSkin ( )
Returns:
string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 170 of file ResourceLoaderContext.php.

References skin().

Referenced by getHash(), ResourceLoaderSiteModule\getPages(), ResourceLoaderUserModule\getPages(), ResourceLoaderStartUpModule\getStartupModulesUrl(), and ResourceLoaderFileModule\getStyleFiles().

ResourceLoaderContext::getUser ( )
Returns:
string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 177 of file ResourceLoaderContext.php.

References user.

Referenced by getHash(), ResourceLoaderUserGroupsModule\getPages(), and ResourceLoaderUserModule\getPages().

ResourceLoaderContext::getVersion ( )
Returns:
string|null

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 198 of file ResourceLoaderContext.php.

References version.

Referenced by getHash().

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(), and ConfigFactory\getDefaultInstance().

ResourceLoaderContext::shouldIncludeMessages ( )
Returns:
bool

Definition at line 226 of file ResourceLoaderContext.php.

References getOnly().

ResourceLoaderContext::shouldIncludeScripts ( )
Returns:
bool

Definition at line 212 of file ResourceLoaderContext.php.

References getOnly().

ResourceLoaderContext::shouldIncludeStyles ( )
Returns:
bool

Definition at line 219 of file ResourceLoaderContext.php.

References getOnly().

Member Data Documentation

ResourceLoaderContext::$debug [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 39 of file ResourceLoaderContext.php.

ResourceLoaderContext::$direction [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 36 of file ResourceLoaderContext.php.

ResourceLoaderContext::$hash [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 42 of file ResourceLoaderContext.php.

ResourceLoaderContext::$language [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 35 of file ResourceLoaderContext.php.

ResourceLoaderContext::$modules [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 34 of file ResourceLoaderContext.php.

Referenced by __construct(), and expandModuleNames().

ResourceLoaderContext::$only [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 40 of file ResourceLoaderContext.php.

ResourceLoaderContext::$raw [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 43 of file ResourceLoaderContext.php.

ResourceLoaderContext::$request [protected]

Definition at line 33 of file ResourceLoaderContext.php.

Referenced by __construct().

ResourceLoaderContext::$resourceLoader [protected]

Definition at line 32 of file ResourceLoaderContext.php.

Referenced by __construct().

ResourceLoaderContext::$skin [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 37 of file ResourceLoaderContext.php.

ResourceLoaderContext::$user [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 38 of file ResourceLoaderContext.php.

ResourceLoaderContext::$version [protected]

Reimplemented in DerivativeResourceLoaderContext.

Definition at line 41 of file ResourceLoaderContext.php.

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