Dynamic JavaScript and CSS resource loading system. More...

Public Member Functions
	__construct ()
	Registers core modules and runs registration hooks.
	addSource ($id, $properties=null)
	Add a foreign source of modules.
	getModule ($name)
	Get the ResourceLoaderModule object for a given module name.
	getModuleNames ()
	Get a list of module names.
	getSources ()
	Get the list of sources.
	getTestModuleNames ($framework= 'all')
	Get a list of test module names for one (or all) frameworks.
	makeModuleResponse (ResourceLoaderContext $context, array $modules, $missing=array())
	Generates code for a response.
	preloadModuleInfo (array $modules, ResourceLoaderContext $context)
	Loads information stored in the database about modules.
	register ($name, $info=null)
	Registers a module with the ResourceLoader system.
	registerTestModules ()
	respond (ResourceLoaderContext $context)
	Outputs a response to a resource load-request, including a content-type header.
Static Public Member Functions
static	inDebugMode ()
	Determine whether debug mode was requested Order of priority is 1) request param, 2) cookie, 3) $wg setting.
static	isValidModuleName ($moduleName)
	Check a module name for validity.
static	makeConfigSetScript (array $configuration)
	Returns JS code which will set the MediaWiki configuration array to the given value.
static	makeCustomLoaderScript ($name, $version, $dependencies, $group, $source, $script)
	Returns JS code which calls the script given by $script.
static	makeLoaderConditionalScript ($script)
	Returns JS code which runs given JS code if the client-side framework is present.
static	makeLoaderImplementScript ($name, $scripts, $styles, $messages)
	Returns JS code to call to mw.loader.implement for a module with given properties.
static	makeLoaderQuery ($modules, $lang, $skin, $user=null, $version=null, $debug=false, $only=null, $printable=false, $handheld=false, $extraQuery=array())
	Build a query array (array representation of query string) for load.php.
static	makeLoaderRegisterScript ($name, $version=null, $dependencies=null, $group=null, $source=null)
	Returns JS code which calls mw.loader.register with the given parameters.
static	makeLoaderSourcesScript ($id, $properties=null)
	Returns JS code which calls mw.loader.addSource() with the given parameters.
static	makeLoaderStateScript ($name, $state=null)
	Returns a JS call to mw.loader.state, which sets the state of a module or modules to a given value.
static	makeLoaderURL ($modules, $lang, $skin, $user=null, $version=null, $debug=false, $only=null, $printable=false, $handheld=false, $extraQuery=array())
	Build a load.php URL.
static	makeMessageSetScript ($messages)
	Returns JS code which, when called, will register a given list of messages.
static	makePackedModulesString ($modules)
	Convert an array of module names to a packed query string.
Protected Member Functions
	filter ($filter, $data)
	Runs JavaScript or CSS data through a filter, caching the filtered result for future calls.
	formatException ($e)
	Handle exception display.
	makeComment ($text)
	sendResponseHeaders (ResourceLoaderContext $context, $mtime, $errors)
	Send content type and last modified headers to the client.
	tryRespondFromFileCache (ResourceFileCache $fileCache, ResourceLoaderContext $context)
	Send out code for a response from file cache if possible.
	tryRespondLastModified (ResourceLoaderContext $context, $mtime)
	If there's an If-Modified-Since header, respond with a 304 appropriately and clear out the output buffer.
Protected Attributes
	$moduleInfos = array()
	Associative array mapping module name to info associative array.
	$modules = array()
	Array: List of module name/ResourceLoaderModule object pairs.
	$sources = array()
	array( 'source-id' => array( 'loadScript' => 'http://.../load.php' ) )
	$testModuleNames = array()
	Associative array mapping framework ids to a list of names of test suite modules.
Static Protected Attributes
static	$filterCacheVersion = 7
static	$requiredSourceProperties = array( 'loadScript' )
Static Private Member Functions
static	makeCombinedStyles (array $stylePairs)
	Combines an associative array mapping media type to CSS into a single stylesheet with "@media" blocks.

Detailed Description

Dynamic JavaScript and CSS resource loading system.

Most of the documention is on the MediaWiki documentation wiki starting at: http://www.mediawiki.org/wiki/ResourceLoader

Definition at line 31 of file ResourceLoader.php.

Constructor & Destructor Documentation

ResourceLoader::__construct ( )

Registers core modules and runs registration hooks.

Definition at line 192 of file ResourceLoader.php.

References $IP, addSource(), array(), global, registerTestModules(), wfProfileIn(), wfProfileOut(), wfRunHooks(), and wfScript().

Member Function Documentation

ResourceLoader::addSource	(	$	id,
		$	properties = `null`
	)

Add a foreign source of modules.

Source properties: 'loadScript': URL (either fully-qualified or protocol-relative) of load.php for this source

Parameters:

	$id	Mixed: source ID (string), or array( id1 => props1, id2 => props2, ... )
array	$properties	source properties

Exceptions:

MWException

Definition at line 314 of file ResourceLoader.php.

References $value, and as.

Referenced by __construct().

ResourceLoader::filter	(	$	filter,
		$	data
	)		`[protected]`

Runs JavaScript or CSS data through a filter, caching the filtered result for future calls.

Available filters are:

minify-js
See also:
JavaScriptMinifier::minify
minify-css
See also:
CSSMin::minify
If $data is empty, only contains whitespace or the filter was unknown, $data is returned unmodified.

Parameters:

string	$filter	Name of filter to run
string	$data	Text to filter, such as JavaScript or CSS text

Returns:: String: Filtered data, or a comment containing an error message

Definition at line 134 of file ResourceLoader.php.

References $cache, $result, array(), formatException(), global, JavaScriptMinifier\minify(), CSSMin\minify(), wfGetCache(), wfMemcKey(), wfProfileIn(), and wfProfileOut().

Referenced by makeModuleResponse().

ResourceLoader::formatException ( $ e ) [protected]

Handle exception display.

Parameters:

Exception $e to be shown to the user

Returns:: string sanitized text that can be returned to the user

Definition at line 671 of file ResourceLoader.php.

References global, makeComment(), text, and wfMessage().

Referenced by filter(), makeModuleResponse(), and respond().

ResourceLoader::getModule ( $ name )

Get the ResourceLoaderModule object for a given module name.

Parameters:

string $name Module name

Returns:: ResourceLoaderModule if module has been registered, null otherwise

Definition at line 376 of file ResourceLoader.php.

References $name.

Referenced by MessageBlobStore\getFromDB(), preloadModuleInfo(), respond(), and ResourceLoaderTest\testRegisteredValidModulesAreAccessible().

ResourceLoader::getModuleNames ( )

Get a list of module names.

Returns:: Array: List of module names

Definition at line 346 of file ResourceLoader.php.

ResourceLoader::getSources ( )

Get the list of sources.

Returns:: Array: array( id => array of properties, .. )

Definition at line 407 of file ResourceLoader.php.

ResourceLoader::getTestModuleNames ( $ framework = 'all' )

Get a list of test module names for one (or all) frameworks.

If the given framework id is unknkown, or if the in-object variable is not an array, then it will return an empty array.

Parameters:

string $framework Optional. Get only the test module names for one particular framework.

Returns:: Array

Definition at line 359 of file ResourceLoader.php.

References array().

static ResourceLoader::inDebugMode ( ) [static]

Determine whether debug mode was requested Order of priority is 1) request param, 2) cookie, 3) $wg setting.

Returns:: bool

Definition at line 1092 of file ResourceLoader.php.

References $retval, and global.

static ResourceLoader::isValidModuleName ( $ moduleName ) [static]

Check a module name for validity.

Module names may not contain pipes (|), commas (,) or exclamation marks (!) and can be at most 255 bytes.

Parameters:

string $moduleName Module name to check

Returns:: bool Whether $moduleName is a valid module name

Definition at line 1172 of file ResourceLoader.php.

static ResourceLoader::makeCombinedStyles ( array $ stylePairs ) [static, private]

Combines an associative array mapping media type to CSS into a single stylesheet with "@media" blocks.

Parameters:

array $stylePairs Array keyed by media type containing (arrays of) CSS strings.

Returns:: Array

Definition at line 905 of file ResourceLoader.php.

References $out, array(), as, and OutputPage\transformCssMedia().

ResourceLoader::makeComment ( $ text ) [protected]

Definition at line 660 of file ResourceLoader.php.

Referenced by formatException(), and respond().

static ResourceLoader::makeConfigSetScript ( array $ configuration ) [static]

Returns JS code which will set the MediaWiki configuration array to the given value.

Parameters:

array $configuration List of configuration values keyed by variable name

Returns:: string

Definition at line 1057 of file ResourceLoader.php.

References array(), and Xml\encodeJsCall().

Referenced by MWDebug\getDebugHTML(), and Skin\makeVariablesScript().

static ResourceLoader::makeCustomLoaderScript	(	$	name,
		$	version,
		$	dependencies,
		$	group,
		$	source,
		$	script
	)		`[static]`

Returns JS code which calls the script given by $script.

The script will be called with local variables name, version, dependencies and group, which will have values corresponding to $name, $version, $dependencies and $group as supplied.

Parameters:

string	$name	Module name
	$version	Integer: Module version number as a timestamp
array	$dependencies	List of module names on which this module depends
string	$group	Group which the module is in.
string	$source	Source of the module, or 'local' if not foreign.
string	$script	JavaScript code

Returns:: string

Definition at line 970 of file ResourceLoader.php.

References $name, $source, array(), and Xml\encodeJsCall().

Referenced by ResourceLoaderStartUpModule\getModuleRegistrations().

static ResourceLoader::makeLoaderConditionalScript ( $ script ) [static]

Returns JS code which runs given JS code if the client-side framework is present.

Parameters:

string $script JavaScript code

Returns:: string

Definition at line 1045 of file ResourceLoader.php.

Referenced by ProtectionForm\buildCleanupScript(), MWDebug\getDebugHTML(), and Skin\makeVariablesScript().

static ResourceLoader::makeLoaderImplementScript	(	$	name,
		$	scripts,
		$	styles,
		$	messages
	)		`[static]`

Returns JS code to call to mw.loader.implement for a module with given properties.

Parameters:

string	$name	Module name
	$scripts	Mixed: List of URLs to JavaScript files or String of JavaScript code
	$styles	Mixed: Array of CSS strings keyed by media type, or an array of lists of URLs to CSS files keyed by media type
	$messages	Mixed: List of messages associated with this module. May either be an associative array mapping message key to value, or a JSON-encoded message blob containing the same data, wrapped in an XmlJsCode object.

Exceptions:

MWException

Returns:: string

Definition at line 864 of file ResourceLoader.php.

References $messages, $name, array(), and Xml\encodeJsCall().

Referenced by makeModuleResponse().

static ResourceLoader::makeLoaderQuery	(	$	modules,
		$	lang,
		$	skin,
		$	user = `null`,
		$	version = `null`,
		$	debug = `false`,
		$	only = `null`,
		$	printable = `false`,
		$	handheld = `false`,
		$	extraQuery = `array()`
	)		`[static]`

Build a query array (array representation of query string) for load.php.

Helper function for makeLoaderURL().

Returns:: array

Definition at line 1133 of file ResourceLoader.php.

References $debug, $query, $skin, $user, and array().

Referenced by makeLoaderURL().

static ResourceLoader::makeLoaderRegisterScript	(	$	name,
		$	version = `null`,
		$	dependencies = `null`,
		$	group = `null`,
		$	source = `null`
	)		`[static]`

Returns JS code which calls mw.loader.register with the given parameters.

Has three calling conventions:

ResourceLoader::makeLoaderRegisterScript( $name, $version, $dependencies, $group, $source ): Register a single module.

ResourceLoader::makeLoaderRegisterScript( array( $name1, $name2 ) ): Register modules with the given names.

ResourceLoader::makeLoaderRegisterScript( array( array( $name1, $version1, $dependencies1, $group1, $source1 ), array( $name2, $version2, $dependencies1, $group2, $source2 ), ... ) ): Registers modules with the given names and parameters.

Parameters:

string	$name	Module name
	$version	Integer: Module version number as a timestamp
array	$dependencies	List of module names on which this module depends
string	$group	group which the module is in.
string	$source	source of the module, or 'local' if not foreign

Returns:: string

Definition at line 1002 of file ResourceLoader.php.

References $name, $source, array(), and Xml\encodeJsCall().

Referenced by ResourceLoaderStartUpModule\getModuleRegistrations().

static ResourceLoader::makeLoaderSourcesScript	(	$	id,
		$	properties = `null`
	)		`[static]`

Returns JS code which calls mw.loader.addSource() with the given parameters.

Has two calling conventions:

ResourceLoader::makeLoaderSourcesScript( $id, $properties ): Register a single source

ResourceLoader::makeLoaderSourcesScript( array( $id1 => $props1, $id2 => $props2, ... ) ); Register sources with the given IDs and properties.

Parameters:

string	$id	source ID
array	$properties	source properties (see addSource())

Returns:: string

Definition at line 1029 of file ResourceLoader.php.

References array(), and Xml\encodeJsCall().

Referenced by ResourceLoaderStartUpModule\getModuleRegistrations().

static ResourceLoader::makeLoaderStateScript	(	$	name,
		$	state = `null`
	)		`[static]`

Returns a JS call to mw.loader.state, which sets the state of a module or modules to a given value.

Has two calling conventions:

ResourceLoader::makeLoaderStateScript( $name, $state ): Set the state of a single module called $name to $state

ResourceLoader::makeLoaderStateScript( array( $name => $state, ... ) ): Set the state of modules with the given names to the given states

Parameters:

$name	string
$state

Returns:: string

Definition at line 947 of file ResourceLoader.php.

References $name, array(), and Xml\encodeJsCall().

Referenced by makeModuleResponse().

static ResourceLoader::makeLoaderURL	(	$	modules,
		$	lang,
		$	skin,
		$	user = `null`,
		$	version = `null`,
		$	debug = `false`,
		$	only = `null`,
		$	printable = `false`,
		$	handheld = `false`,
		$	extraQuery = `array()`
	)		`[static]`

Build a load.php URL.

Parameters:

array	$modules	of module names (strings)
string	$lang	Language code
string	$skin	Skin name
string \| null	$user	User name. If null, the &user= parameter is omitted
string \| null	$version	Versioning timestamp
bool	$debug	Whether the request should be in debug mode
string \| null	$only	&only= parameter
bool	$printable	Printable mode
bool	$handheld	Handheld mode
array	$extraQuery	Extra query parameters to add

Returns:: string URL to load.php. May be protocol-relative (if $wgLoadScript is procol-relative)

Definition at line 1116 of file ResourceLoader.php.

References $debug, $query, $skin, $user, global, makeLoaderQuery(), wfAppendQuery(), and wfExpandUrl().

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

static ResourceLoader::makeMessageSetScript ( $ messages ) [static]

Returns JS code which, when called, will register a given list of messages.

Parameters:

$messages Mixed: Either an associative array mapping message key to value, or a JSON-encoded message blob containing the same data, wrapped in an XmlJsCode object.

Returns:: string

Definition at line 893 of file ResourceLoader.php.

References $messages, array(), and Xml\encodeJsCall().

Referenced by makeModuleResponse().

ResourceLoader::makeModuleResponse	(	ResourceLoaderContext $	context,
		array $	modules,
		$	missing = `array()`
	)

Generates code for a response.

Parameters:

	$context	ResourceLoaderContext: Context in which to generate a response
array	$modules	List of module objects keyed by module name
array	$missing	List of unavailable modules (optional)

Returns:: String: Response data

Definition at line 689 of file ResourceLoader.php.

References $exceptions, $name, $out, array(), as, filter(), formatException(), MessageBlobStore\get(), ResourceLoaderContext\getDebug(), ResourceLoaderContext\getLanguage(), ResourceLoaderContext\getOnly(), ResourceLoaderContext\getRaw(), makeLoaderImplementScript(), makeLoaderStateScript(), makeMessageSetScript(), ResourceLoaderContext\shouldIncludeMessages(), ResourceLoaderContext\shouldIncludeScripts(), ResourceLoaderContext\shouldIncludeStyles(), wfProfileIn(), and wfProfileOut().

Referenced by respond().

static ResourceLoader::makePackedModulesString ( $ modules ) [static]

Convert an array of module names to a packed query string.

For example, array( 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ) becomes 'foo.bar,baz|bar.baz,quux'

Parameters:

array $modules of module names (strings)

Returns:: string Packed query string

Definition at line 1069 of file ResourceLoader.php.

References array(), and as.

Referenced by ResourceLoaderStartUpModule\getScript(), and ResourceLoaderTest\testMakePackedModulesString().

ResourceLoader::preloadModuleInfo	(	array $	modules,
		ResourceLoaderContext $	context
	)

Loads information stored in the database about modules.

This method grabs modules dependencies from the database and updates modules objects.

This is not inside the module code because it is much faster to request all of the information at once than it is to have each module requests its own information. This sacrifice of modularity yields a substantial performance improvement.

Parameters:

array	$modules	List of module names to preload information for
	$context	ResourceLoaderContext: Context to load the information within

Definition at line 66 of file ResourceLoader.php.

References $dbr, $name, $res, $skin, array(), as, FormatJson\decode(), ResourceLoaderContext\getLanguage(), getModule(), ResourceLoaderContext\getSkin(), wfGetDB(), and wfTimestamp().

Referenced by respond().

ResourceLoader::register	(	$	name,
		$	info = `null`
	)

Registers a module with the ResourceLoader system.

Parameters:

	$name	Mixed: Name of module as a string or List of name/object pairs as an array
array	$info	Module info array. For backwards compatibility with 1.17alpha, this may also be a ResourceLoaderModule object. Optional when using multiple-registration calling style.

Exceptions:

MWException,:	If a duplicate module registration is attempted
MWException,:	If a module name contains illegal characters (pipes or commas)
MWException,:	If something other than a ResourceLoaderModule is being registered

Returns:: Boolean: False if there were any errors, in which case one or more modules were not registered

Definition at line 229 of file ResourceLoader.php.

References $name, array(), as, wfProfileIn(), and wfProfileOut().

Referenced by ResourceLoaderTest\testRegisteredValidModulesAreAccessible().

ResourceLoader::registerTestModules ( )

Definition at line 272 of file ResourceLoader.php.

References $IP, array(), as, global, wfProfileIn(), wfProfileOut(), and wfRunHooks().

Referenced by __construct().

ResourceLoader::respond ( ResourceLoaderContext $ context )

Outputs a response to a resource load-request, including a content-type header.

Parameters:

$context ResourceLoaderContext: Context in which a response should be formed

Definition at line 416 of file ResourceLoader.php.

References $modules, $name, $response, array(), as, echo, formatException(), ResourceLoaderContext\getDebug(), getModule(), ResourceLoaderContext\getModules(), ResourceLoaderContext\getRequest(), global, makeComment(), makeModuleResponse(), ResourceFileCache\newFromContext(), preloadModuleInfo(), sendResponseHeaders(), tryRespondFromFileCache(), tryRespondLastModified(), ResourceFileCache\useFileCache(), wfProfileIn(), wfProfileOut(), and wfTimestamp().

ResourceLoader::sendResponseHeaders	(	ResourceLoaderContext $	context,
		$	mtime,
		$	errors
	)		`[protected]`

Send content type and last modified headers to the client.

Parameters:

	$context	ResourceLoaderContext
string	$mtime	TS_MW timestamp to use for last-modified
bool	$error	Whether there are commented-out errors in the response

Returns:: void

Definition at line 537 of file ResourceLoader.php.

References ResourceLoaderContext\getDebug(), ResourceLoaderContext\getOnly(), ResourceLoaderContext\getVersion(), global, and wfTimestamp().

Referenced by respond(), and tryRespondFromFileCache().

ResourceLoader::tryRespondFromFileCache	(	ResourceFileCache $	fileCache,
		ResourceLoaderContext $	context
	)		`[protected]`

Send out code for a response from file cache if possible.

Parameters:

$fileCache	ResourceFileCache: Cache object for this request URL
$context	ResourceLoaderContext: Context in which to generate a response

Returns:: bool If this found a cache file and handled the response

Definition at line 616 of file ResourceLoader.php.

References $response, FileCacheBase\cacheTimestamp(), echo, FileCacheBase\fetchText(), ResourceLoaderContext\getDebug(), ResourceLoaderContext\getVersion(), global, FileCacheBase\isCacheGood(), sendResponseHeaders(), tryRespondLastModified(), wfGetDB(), and wfTimestamp().

Referenced by respond().

ResourceLoader::tryRespondLastModified	(	ResourceLoaderContext $	context,
		$	mtime
	)		`[protected]`

If there's an If-Modified-Since header, respond with a 304 appropriately and clear out the output buffer.

If the client cache is too old then do nothing.

Parameters:

	$context	ResourceLoaderContext
string	$mtime	The TS_MW timestamp to check the header against

Returns:: bool True iff 304 header sent and output handled

Definition at line 575 of file ResourceLoader.php.

References ResourceLoaderContext\getDebug(), ResourceLoaderContext\getRequest(), and wfTimestamp().

Referenced by respond(), and tryRespondFromFileCache().

Member Data Documentation

ResourceLoader::$filterCacheVersion = 7 [static, protected]

Definition at line 34 of file ResourceLoader.php.

ResourceLoader::$moduleInfos = array() [protected]

Associative array mapping module name to info associative array.

Definition at line 41 of file ResourceLoader.php.

ResourceLoader::$modules = array() [protected]

Array: List of module name/ResourceLoaderModule object pairs.

Definition at line 38 of file ResourceLoader.php.

Referenced by respond().

ResourceLoader::$requiredSourceProperties = array( 'loadScript' ) [static, protected]

Definition at line 35 of file ResourceLoader.php.

ResourceLoader::$sources = array() [protected]

array( 'source-id' => array( 'loadScript' => 'http://.../load.php' ) )

Definition at line 48 of file ResourceLoader.php.

ResourceLoader::$testModuleNames = array() [protected]

Associative array mapping framework ids to a list of names of test suite modules.

like array( 'qunit' => array( 'mediawiki.tests.qunit.suites', 'ext.foo.tests', .. ), .. )

Definition at line 45 of file ResourceLoader.php.

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

includes/resourceloader/ResourceLoader.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation