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

Inheritance diagram for ResourceLoader:

[legend]

Collaboration diagram for ResourceLoader:

[legend]

Public Member Functions
	__construct (Config $config=null, LoggerInterface $logger=null)
	Register core modules and runs registration hooks.

	addSource ( $id, $loadUrl=null)
	Add a foreign source of modules.

	createLoaderURL ( $source, ResourceLoaderContext $context, $extraQuery=[])
	Build a load.php URL.

	getCombinedVersion (ResourceLoaderContext $context, array $moduleNames)
	Helper method to get and combine versions of multiple modules.

	getConfig ()

	getLessCompiler ( $extraVars=[])
	Returns LESS compiler set up for use with MediaWiki.

	getLessVars ()
	Get global LESS variables.

	getLoadScript ( $source)
	Get the URL to the load.php endpoint for the given ResourceLoader source.

	getLogger ()

	getMessageBlobStore ()

	getModule ( $name)
	Get the ResourceLoaderModule object for a given module name.

	getModuleNames ()
	Get a list of module names.

	getModulesByMessage ( $messageKey)
	Get names of modules that use a certain message.

	getSources ()
	Get the list of sources.

	getTestModuleNames ( $framework='all')
	Get a list of test module names for one (or all) frameworks.

	isModuleRegistered ( $name)
	Check whether a ResourceLoader module is registered.

	makeModuleResponse (ResourceLoaderContext $context, array $modules, array $missing=[])
	Generate code for a response.

	makeVersionQuery (ResourceLoaderContext $context)
	Get the expected value of the 'version' query parameter.

	preloadModuleInfo (array $moduleNames, ResourceLoaderContext $context)
	Load information stored in the database about modules.

	register ( $name, $info=null)
	Register a module with the ResourceLoader system.

	registerTestModules ()

	respond (ResourceLoaderContext $context)
	Output a response to a load request, including the content-type header.

	setLogger (LoggerInterface $logger)

	setMessageBlobStore (MessageBlobStore $blobStore)

Static Public Member Functions
static	clearCache ()
	Reset static members used for caching.

static	filter ( $filter, $data, array $options=[])
	Run JavaScript or CSS data through a filter, caching the filtered result for future calls.

static	formatException ( $e)
	Handle exception display.

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	makeCombinedStyles (array $stylePairs)
	Combines an associative array mapping media type to CSS into a single stylesheet with "@media" blocks.

static	makeComment ( $text)
	Generate a CSS or JS comment block.

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	makeHash ( $value)

static	makeInlineScript ( $script)
	Returns an HTML script tag that runs given JS code after startup and base modules.

static	makeLoaderConditionalScript ( $script)
	Wraps JavaScript code to run after startup and base modules.

static	makeLoaderQuery ( $modules, $lang, $skin, $user=null, $version=null, $debug=false, $only=null, $printable=false, $handheld=false, $extraQuery=[])
	Build a query array (array representation of query string) for load.php.

static	makeLoaderRegisterScript ( $name, $version=null, $dependencies=null, $group=null, $source=null, $skip=null)
	Returns JS code which calls mw.loader.register with the given parameters.

static	makeLoaderSourcesScript ( $id, $loadUrl=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	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
	isFileModule ( $name)
	Return whether the definition of a module corresponds to a simple ResourceLoaderFileModule or one of its subclasses.

	measureResponseTime (Timing $timing)

	outputErrorAndLog (Exception $e, $msg, array $context=[])
	Add an error to the 'errors' array and log it.

	sendResponseHeaders (ResourceLoaderContext $context, $etag, $errors, array $extra=[])
	Send main response headers to the client.

	tryRespondFromFileCache (ResourceFileCache $fileCache, ResourceLoaderContext $context, $etag)
	Send out code for a response from file cache if possible.

	tryRespondNotModified (ResourceLoaderContext $context, $etag)
	Respond with HTTP 304 Not Modified if appropiate.

Static Protected Member Functions
static	createLoaderQuery (ResourceLoaderContext $context, $extraQuery=[])
	Helper for createLoaderURL()

static	formatExceptionNoComment ( $e)
	Handle exception display.

static	makeLoaderImplementScript ( $name, $scripts, $styles, $messages, $templates)
	Return JS code that calls mw.loader.implement with given module properties.

Protected Attributes
MessageBlobStore	$blobStore

	$config

array	$errors = []
	Errors accumulated during current respond() call.

array	$extraHeaders = []
	List of extra HTTP response headers provided by loaded modules.

array	$moduleInfos = []
	Associative array mapping module name to info associative array.

array	$modules = []
	Module name/ResourceLoaderModule object pairs.

array	$sources = []
	E.g.

array	$testModuleNames = []
	Associative array mapping framework ids to a list of names of test suite modules like [ 'qunit' => [ 'mediawiki.tests.qunit.suites', 'ext.foo.tests', ... ], ... ].

Static Protected Attributes
static bool	$debugMode = null

static int	$filterCacheVersion = 7

Private Member Functions
	ensureNewline ( $str)
	Ensure the string is either empty or ends in a line break.

Static Private Member Functions
static	applyFilter ( $filter, $data)

static	isEmptyObject (stdClass $obj)

static	trimArray (array &$array)
	Remove empty values from the end of an array.

Private Attributes
array	$lessVars = null

LoggerInterface	$logger

Detailed Description

Dynamic JavaScript and CSS resource loading system.

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

Definition at line 38 of file ResourceLoader.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoader::__construct	(	Config	$config = `null`,
		LoggerInterface	$logger = `null`
	)

Register core modules and runs registration hooks.

Parameters

Config	$config	[optional]
LoggerInterface	$logger	[optional]

Reimplemented in EmptyResourceLoader.

Definition at line 244 of file ResourceLoader.php.

References $config, $IP, $logger, addSource(), global, registerTestModules(), and setMessageBlobStore().

Member Function Documentation

◆ addSource()

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

Add a foreign source of modules.

Source IDs are typically the same as the Wiki ID or database name (e.g. lowercase a-z).

Parameters

array \| string	$id	Source ID (string), or [ id1 => loadUrl, id2 => loadUrl, ... ]
string \| array	$loadUrl	load.php url (string), or array with loadUrl key for backwards-compatibility.

Exceptions

MWException

Definition at line 453 of file ResourceLoader.php.

References $value, and as.

Referenced by __construct(), EmptyResourceLoader\__construct(), and ResourceLoaderTest\testAddSource().

◆ applyFilter()

static ResourceLoader::applyFilter	(	$filter,
		$data
	)

staticprivate

Definition at line 224 of file ResourceLoader.php.

References $e, CSSMin\minify(), and JavaScriptMinifier\minify().

Referenced by filter().

◆ clearCache()

static ResourceLoader::clearCache ( )

static

Reset static members used for caching.

Global state and $wgRequest are evil, but we're using it right now and sometimes we need to be able to force ResourceLoader to re-evaluate the context because it has changed (e.g. in the test suite).

Definition at line 1582 of file ResourceLoader.php.

Referenced by ResourceLoaderTestCase\setUp(), and ResourceLoaderTest\testMakeLoaderImplementScript().

◆ createLoaderQuery()

static ResourceLoader::createLoaderQuery	(	ResourceLoaderContext	$context,
			$extraQuery = `[]`
	)

staticprotected

Helper for createLoaderURL()

Since: 1.24

See also: makeLoaderQuery

Parameters

ResourceLoaderContext	$context
array	$extraQuery

Returns: array

Definition at line 1613 of file ResourceLoader.php.

◆ createLoaderURL()

ResourceLoader::createLoaderURL	(		$source,
		ResourceLoaderContext	$context,
			$extraQuery = `[]`
	)

Build a load.php URL.

Since: 1.24

Parameters

string	$source	Name of the ResourceLoader source
ResourceLoaderContext	$context
array	$extraQuery

Returns: string URL to load.php. May be protocol-relative if $wgLoadScript is, too.

Definition at line 1595 of file ResourceLoader.php.

◆ ensureNewline()

ResourceLoader::ensureNewline ( $str )

private

Ensure the string is either empty or ends in a line break.

Parameters

string $str

Returns: string

Definition at line 1183 of file ResourceLoader.php.

◆ filter()

static ResourceLoader::filter	(		$filter,
			$data,
		array	$options = `[]`
	)

static

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

Available filters are:

minify-js \see JavaScriptMinifier::minify
minify-css \see 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
array	$options	Keys: (bool) cache: Whether to allow caching this data. Default: true.

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

Definition at line 189 of file ResourceLoader.php.

References $cache, $options, applyFilter(), and CACHE_ANYTHING.

Referenced by ResourceLoaderModule\buildContent(), and ResourceLoaderStartUpModule\getModuleRegistrations().

◆ formatException()

static ResourceLoader::formatException ( $e )

static

Handle exception display.

Parameters

Exception $e Exception to be shown to the user

Returns: string Sanitized text in a CSS/JS comment that can be returned to the user

Definition at line 1009 of file ResourceLoader.php.

References $e.

◆ formatExceptionNoComment()

static ResourceLoader::formatExceptionNoComment ( $e )

staticprotected

Handle exception display.

Since: 1.25

Parameters

Exception $e Exception to be shown to the user

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

Definition at line 1020 of file ResourceLoader.php.

References $e, $wgShowExceptionDetails, and global.

◆ getCombinedVersion()

ResourceLoader::getCombinedVersion	(	ResourceLoaderContext	$context,
		array	$moduleNames
	)

Helper method to get and combine versions of multiple modules.

Since: 1.26

Parameters

ResourceLoaderContext	$context
string[]	$moduleNames	List of known module names

Returns: string Hash

Definition at line 659 of file ResourceLoader.php.

References $context, $e, $hashes, and use.

◆ getConfig()

ResourceLoader::getConfig ( )

Returns: Config

Definition at line 280 of file ResourceLoader.php.

References $config.

◆ getLessCompiler()

ResourceLoader::getLessCompiler ( $extraVars = [] )

Returns LESS compiler set up for use with MediaWiki.

Since: 1.27

Parameters

array $extraVars Associative array of extra (i.e., other than the globally-configured ones) that should be used for compilation.

Exceptions

MWException

Returns: Less_Parser

Definition at line 1699 of file ResourceLoader.php.

◆ getLessVars()

ResourceLoader::getLessVars ( )

Get global LESS variables.

Since: 1.27

Returns: array Map of variable names to string CSS values.

Definition at line 1723 of file ResourceLoader.php.

◆ getLoadScript()

ResourceLoader::getLoadScript ( $source )

Get the URL to the load.php endpoint for the given ResourceLoader source.

Since: 1.24

Parameters

string $source

Exceptions

MWException On an invalid $source name

Returns: string

Definition at line 615 of file ResourceLoader.php.

References $source.

◆ getLogger()

ResourceLoader::getLogger ( )

Since: 1.27

Returns: LoggerInterface

Definition at line 296 of file ResourceLoader.php.

References $logger.

Referenced by EmptyResourceLoader\__construct().

◆ getMessageBlobStore()

ResourceLoader::getMessageBlobStore ( )

Since: 1.26

Returns: MessageBlobStore

Definition at line 304 of file ResourceLoader.php.

References $blobStore.

Referenced by preloadModuleInfo().

◆ getModule()

ResourceLoader::getModule ( $name )

Get the ResourceLoaderModule object for a given module name.

If an array of module parameters exists but a ResourceLoaderModule object has not yet been instantiated, this method will instantiate and cache that object such that subsequent calls simply return the same object.

Parameters

string $name Module name

Returns: ResourceLoaderModule|null If module has been registered, return a ResourceLoaderModule instance. Otherwise, return null.

Definition at line 538 of file ResourceLoader.php.

References $name.

Referenced by ResourceLoaderClientHtml\getData(), and preloadModuleInfo().

◆ getModuleNames()

ResourceLoader::getModuleNames ( )

Get a list of module names.

Returns: array List of module names

Definition at line 489 of file ResourceLoader.php.

◆ getModulesByMessage()

ResourceLoader::getModulesByMessage ( $messageKey )

Get names of modules that use a certain message.

Parameters

string $messageKey

Returns: array List of module names

Definition at line 1197 of file ResourceLoader.php.

◆ getSources()

ResourceLoader::getSources ( )

Get the list of sources.

Returns: array Like [ id => load.php url, ... ]

Definition at line 602 of file ResourceLoader.php.

◆ getTestModuleNames()

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 Get only the test module names for one particular framework (optional)

Returns: array

Definition at line 503 of file ResourceLoader.php.

◆ inDebugMode()

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 1565 of file ResourceLoader.php.

Referenced by SpecialJavaScriptTest\exportQUnit(), EditPage\getEditToolbar(), ResourceLoaderStartUpModule\getModuleRegistrations(), OutputPage\getRlClientContext(), ResourceLoaderLanguageDataModule\getScript(), ResourceLoaderLanguageNamesModule\getScript(), ResourceLoaderSpecialCharacterDataModule\getScript(), ResourceLoaderStartUpModule\getScript(), ResourceLoaderUserDefaultsModule\getScript(), ResourceLoaderUserOptionsModule\getScript(), ResourceLoaderUserTokensModule\getScript(), and SpecialJavaScriptTest\plainQUnit().

◆ isEmptyObject()

static ResourceLoader::isEmptyObject ( stdClass $obj )

staticprivate

Definition at line 1355 of file ResourceLoader.php.

◆ isFileModule()

ResourceLoader::isFileModule ( $name )

protected

Return whether the definition of a module corresponds to a simple ResourceLoaderFileModule or one of its subclasses.

Parameters

string $name Module name

Returns: bool

Definition at line 579 of file ResourceLoader.php.

References $name.

◆ isModuleRegistered()

ResourceLoader::isModuleRegistered ( $name )

Check whether a ResourceLoader module is registered.

Since: 1.25

Parameters

string $name

Returns: bool

Definition at line 523 of file ResourceLoader.php.

References $name.

◆ isValidModuleName()

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 1686 of file ResourceLoader.php.

◆ makeCombinedStyles()

static ResourceLoader::makeCombinedStyles ( array $stylePairs )

static

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 1273 of file ResourceLoader.php.

Referenced by WebInstallerOutput\getCSS().

◆ makeComment()

static ResourceLoader::makeComment ( $text )

static

Generate a CSS or JS comment block.

Only use this for public data, not error message details.

Parameters

string $text

Returns: string

Definition at line 998 of file ResourceLoader.php.

Referenced by ResourceLoaderWikiModule\getScript(), and ResourceLoaderWikiModule\getStyles().

◆ makeConfigSetScript()

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 JavaScript code

Definition at line 1522 of file ResourceLoader.php.

Referenced by SpecialJavaScriptTest\exportQUnit(), OutputPage\getBottomScripts(), MWDebug\getDebugHTML(), ResourceLoaderClientHtml\getHeadHtml(), ResourceLoaderMediaWikiUtilModule\getScript(), ResourceLoaderUploadDialogModule\getScript(), and Skin\makeVariablesScript().

◆ makeCustomLoaderScript()

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
string	$version	Module version hash
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 JavaScript code

Definition at line 1344 of file ResourceLoader.php.

◆ makeHash()

static ResourceLoader::makeHash ( $value )

static

Since: 1.26

Parameters

string $value

Returns: string Hash

Definition at line 627 of file ResourceLoader.php.

References $value.

Referenced by ResourceLoaderStartUpModule\getModuleRegistrations(), ResourceLoaderModule\getVersionHash(), and ResourceLoaderTest\testGetCombinedVersion().

◆ makeInlineScript()

static ResourceLoader::makeInlineScript ( $script )

static

Returns an HTML script tag that runs given JS code after startup and base modules.

The code will be wrapped in a closure, and it will be executed by ResourceLoader's startup module if the client has adequate support for MediaWiki JavaScript code.

Parameters

string $script JavaScript code

Returns: WrappedString HTML

Definition at line 1506 of file ResourceLoader.php.

Referenced by OutputPage\getBottomScripts(), MWDebug\getDebugHTML(), EditPage\getEditToolbar(), ResourceLoaderClientHtml\getHeadHtml(), ChangesListSpecialPage\includeRcFiltersApp(), ResourceLoaderClientHtml\makeLoad(), and Skin\makeVariablesScript().

◆ makeLoaderConditionalScript()

static ResourceLoader::makeLoaderConditionalScript ( $script )

static

Wraps JavaScript code to run after startup and base modules.

Parameters

string $script JavaScript code

Returns: string JavaScript code

Definition at line 1492 of file ResourceLoader.php.

Referenced by SpecialJavaScriptTest\exportQUnit().

◆ makeLoaderImplementScript()

static ResourceLoader::makeLoaderImplementScript	(	$name,
		$scripts,
		$styles,
		$messages,
		$templates
	)

staticprotected

Return JS code that calls mw.loader.implement with given module properties.

Parameters

string	$name	Module name or implement key (format "`[name]@[version]`")
XmlJsCode \| array \| string	$scripts	Code as XmlJsCode (to be wrapped in a closure), list of URLs to JavaScript files, or a string of JavaScript for `$.globalEval`.
mixed	$styles	Array of CSS strings keyed by media type, or an array of lists of URLs to CSS files keyed by media type
mixed	$messages	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.
array	$templates	Keys are name of templates and values are the source of the template.

Exceptions

MWException

Returns: string JavaScript code

Definition at line 1224 of file ResourceLoader.php.

◆ makeLoaderQuery()

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

static

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

Helper function for createLoaderURL().

Parameters

array	$modules
string	$lang
string	$skin
string	$user
string	$version
bool	$debug
string	$only
bool	$printable
bool	$handheld
array	$extraQuery

Returns: array

Definition at line 1645 of file ResourceLoader.php.

Referenced by OutputPage\getRlClientContext().

◆ makeLoaderRegisterScript()

static ResourceLoader::makeLoaderRegisterScript	(	$name,
		$version = `null`,
		$dependencies = `null`,
		$group = `null`,
		$source = `null`,
		$skip = `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, $skip ): Register a single module.
ResourceLoader::makeLoaderRegisterScript( [ $name1, $name2 ] ): Register modules with the given names.
ResourceLoader::makeLoaderRegisterScript( [ [ $name1, $version1, $dependencies1, $group1, $source1, $skip1 ], [ $name2, $version2, $dependencies1, $group2, $source2, $skip2 ], ... ] ): Registers modules with the given names and parameters.

Parameters

string	$name	Module name
string	$version	Module version hash
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	$skip	Script body of the skip function

Returns: string JavaScript code

Definition at line 1416 of file ResourceLoader.php.

Referenced by ResourceLoaderStartUpModule\getModuleRegistrations(), and ResourceLoaderTest\testMakeLoaderRegisterScript().

◆ makeLoaderSourcesScript()

static ResourceLoader::makeLoaderSourcesScript	(	$id,
		$loadUrl = `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( [ $id1 => $loadUrl, $id2 => $loadUrl, ... ] ); Register sources with the given IDs and properties.

Parameters

string	$id	Source ID
string	$loadUrl	load.php url

Returns: string JavaScript code

Definition at line 1470 of file ResourceLoader.php.

Referenced by ResourceLoaderStartUpModule\getModuleRegistrations(), and ResourceLoaderTest\testMakeLoaderSourcesScript().

◆ makeLoaderStateScript()

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( [ $name => $state, ... ] ): Set the state of modules with the given names to the given states

Parameters

string	$name
string	$state

Returns: string JavaScript code

Definition at line 1314 of file ResourceLoader.php.

Referenced by ResourceLoaderClientHtml\getHeadHtml(), and ResourceLoaderStartUpModule\getModuleRegistrations().

◆ makeMessageSetScript()

static ResourceLoader::makeMessageSetScript ( $messages )

static

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

Parameters

mixed $messages 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 JavaScript code

Definition at line 1258 of file ResourceLoader.php.

Referenced by ChangesListSpecialPage\includeRcFiltersApp().

◆ makeModuleResponse()

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

Generate code for a response.

Calling this method also populates the errors and headers members, later used by respond().

Parameters

ResourceLoaderContext	$context	Context in which to generate a response
ResourceLoaderModule[]	$modules	List of module objects keyed by module name
string[]	$missing	List of requested module names that are unregistered (optional)

Returns: string Response data

Definition at line 1043 of file ResourceLoader.php.

References $context, $e, $image, $modules, $name, $out, as, and errors.

◆ makePackedModulesString()

static ResourceLoader::makePackedModulesString ( $modules )

static

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

For example, ‘[ 'foo.bar’, 'foo.baz', 'bar.baz', 'bar.quux' ] becomes'foo.bar,baz|bar.baz,quux'`.

This process is reversed by ResourceLoaderContext::expandModuleNames(). See also mw.loader::buildModulesString() which is a port of this, used on the client-side.

Parameters

array $modules List of module names (strings)

Returns: string Packed query string

Definition at line 1543 of file ResourceLoader.php.

Referenced by ResourceLoaderTest\testMakePackedModulesString().

◆ makeVersionQuery()

ResourceLoader::makeVersionQuery ( ResourceLoaderContext $context )

Get the expected value of the 'version' query parameter.

This is used by respond() to set a short Cache-Control header for requests with information newer than the current server has. This avoids pollution of edge caches. Typically during deployment. (T117587)

This MUST match return value of mw.loader#getCombinedVersion() client-side.

Since: 1.28

Parameters

ResourceLoaderContext $context

Returns: string Hash

Definition at line 695 of file ResourceLoader.php.

References $context, $name, and as.

◆ measureResponseTime()

ResourceLoader::measureResponseTime ( Timing $timing )

protected

Definition at line 830 of file ResourceLoader.php.

References Timing\measure(), and use.

◆ outputErrorAndLog()

ResourceLoader::outputErrorAndLog	(	Exception	$e,
			$msg,
		array	$context = `[]`
	)

protected

Add an error to the 'errors' array and log it.

Should only be called from within respond().

Since: 1.29

Parameters

Exception	$e
string	$msg
array	$context

Definition at line 642 of file ResourceLoader.php.

References $context, $e, and errors.

◆ preloadModuleInfo()

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

Load 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	$moduleNames	List of module names to preload information for
ResourceLoaderContext	$context	Context to load the information within

Definition at line 118 of file ResourceLoader.php.

References $blob, $context, $dbr, $lang, $modules, $name, $res, $skin, as, DB_REPLICA, ResourceLoaderModule\expandRelativePaths(), getMessageBlobStore(), getModule(), ResourceLoaderWikiModule\preloadTitleInfo(), and wfGetDB().

◆ register()

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

Register a module with the ResourceLoader system.

Parameters

mixed	$name	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: bool False if there were any errors, in which case one or more modules were not registered

Definition at line 329 of file ResourceLoader.php.

References $name, $path, array(), as, definition, ResourceLoaderFileModule\extractBasePaths(), from, MessageBlobStore\get(), list, and or.

◆ registerTestModules()

ResourceLoader::registerTestModules ( )

Definition at line 404 of file ResourceLoader.php.

References $IP, as, and global.

Referenced by __construct().

◆ respond()

ResourceLoader::respond ( ResourceLoaderContext $context )

Output a response to a load request, including the content-type header.

Parameters

ResourceLoaderContext $context Context in which a response should be formed

Definition at line 718 of file ResourceLoader.php.

References $context, $e, $modules, $name, $response, as, errors, RequestContext\getMain(), ResourceFileCache\newFromContext(), and ResourceFileCache\useFileCache().

◆ sendResponseHeaders()

ResourceLoader::sendResponseHeaders	(	ResourceLoaderContext	$context,
			$etag,
			$errors,
		array	$extra = `[]`
	)

protected

Send main response headers to the client.

Deals with Content-Type, CORS (for stylesheets), and caching.

Parameters

ResourceLoaderContext	$context
string	$etag	ETag header value
bool	$errors	Whether there are errors in the response
string[]	$extra	Array of extra HTTP response headers

Returns: void

Definition at line 851 of file ResourceLoader.php.

References $context, $header, as, and wfTimestamp().

◆ setLogger()

ResourceLoader::setLogger ( LoggerInterface $logger )

Since: 1.26

Parameters

LoggerInterface $logger

Definition at line 288 of file ResourceLoader.php.

References $logger.

Referenced by EmptyResourceLoader\__construct().

◆ setMessageBlobStore()

ResourceLoader::setMessageBlobStore ( MessageBlobStore $blobStore )

Since: 1.25

Parameters

MessageBlobStore $blobStore

Definition at line 312 of file ResourceLoader.php.

References $blobStore.

Referenced by __construct(), and EmptyResourceLoader\__construct().

◆ trimArray()

static ResourceLoader::trimArray ( array & $array )

staticprivate

Remove empty values from the end of an array.

Values considered empty:

null
[]
new XmlJsCode( '{}' )
new stdClass() // (object) []

Parameters

Array $array

Definition at line 1374 of file ResourceLoader.php.

◆ tryRespondFromFileCache()

ResourceLoader::tryRespondFromFileCache	(	ResourceFileCache	$fileCache,
		ResourceLoaderContext	$context,
			$etag
	)

protected

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

Parameters

ResourceFileCache	$fileCache	Cache object for this request URL
ResourceLoaderContext	$context	Context in which to generate a response
string	$etag	ETag header value

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

Definition at line 945 of file ResourceLoader.php.

References $context, $e, $response, FileCacheBase\cacheTimestamp(), DB_REPLICA, FileCacheBase\fetchText(), FileCacheBase\isCacheGood(), wfGetDB(), and wfTimestamp().

◆ tryRespondNotModified()

ResourceLoader::tryRespondNotModified	(	ResourceLoaderContext	$context,
			$etag
	)

protected

Respond with HTTP 304 Not Modified if appropiate.

If there's an If-None-Match header, respond with a 304 appropriately and clear out the output buffer. If the client cache is too old then do nothing.

Parameters

ResourceLoaderContext	$context
string	$etag	ETag header value

Returns: bool True if HTTP 304 was sent and output handled

Definition at line 912 of file ResourceLoader.php.

References $context, HttpStatus\header(), and wfResetOutputBuffers().

Member Data Documentation

◆ $blobStore

MessageBlobStore ResourceLoader::$blobStore

protected

Definition at line 94 of file ResourceLoader.php.

Referenced by getMessageBlobStore(), and setMessageBlobStore().

◆ $config

Config ResourceLoader::$config

protected

Definition at line 61 of file ResourceLoader.php.

Referenced by __construct(), EmptyResourceLoader\__construct(), and getConfig().

◆ $debugMode

bool ResourceLoader::$debugMode = null

staticprotected

Definition at line 43 of file ResourceLoader.php.

◆ $errors

array ResourceLoader::$errors = []

protected

Errors accumulated during current respond() call.

Definition at line 80 of file ResourceLoader.php.

Referenced by EmptyResourceLoader\getErrors().

◆ $extraHeaders

array ResourceLoader::$extraHeaders = []

protected

List of extra HTTP response headers provided by loaded modules.

Populated by makeModuleResponse().

Definition at line 89 of file ResourceLoader.php.

◆ $filterCacheVersion

int ResourceLoader::$filterCacheVersion = 7

staticprotected

Definition at line 40 of file ResourceLoader.php.

◆ $lessVars

array ResourceLoader::$lessVars = null

private

Definition at line 46 of file ResourceLoader.php.

◆ $logger

LoggerInterface ResourceLoader::$logger

private

Definition at line 99 of file ResourceLoader.php.

Referenced by __construct(), EmptyResourceLoader\__construct(), getLogger(), and setLogger().

◆ $moduleInfos

array ResourceLoader::$moduleInfos = []

protected

Associative array mapping module name to info associative array.

Definition at line 58 of file ResourceLoader.php.

◆ $modules

array ResourceLoader::$modules = []

protected

Module name/ResourceLoaderModule object pairs.

Definition at line 52 of file ResourceLoader.php.

Referenced by preloadModuleInfo().

◆ $sources

array ResourceLoader::$sources = []

protected

E.g.

[ 'source-id' => 'http://.../load.php' ]

Definition at line 74 of file ResourceLoader.php.

◆ $testModuleNames

array ResourceLoader::$testModuleNames = []

protected

Associative array mapping framework ids to a list of names of test suite modules like [ 'qunit' => [ 'mediawiki.tests.qunit.suites', 'ext.foo.tests', ... ], ... ].

Definition at line 68 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

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSource()

◆ applyFilter()

◆ clearCache()

◆ createLoaderQuery()

◆ createLoaderURL()

◆ ensureNewline()

◆ filter()

◆ formatException()

◆ formatExceptionNoComment()

◆ getCombinedVersion()

◆ getConfig()

◆ getLessCompiler()

◆ getLessVars()

◆ getLoadScript()

◆ getLogger()

◆ getMessageBlobStore()

◆ getModule()

◆ getModuleNames()

◆ getModulesByMessage()

◆ getSources()

◆ getTestModuleNames()

◆ inDebugMode()

◆ isEmptyObject()

◆ isFileModule()

◆ isModuleRegistered()

◆ isValidModuleName()

◆ makeCombinedStyles()

◆ makeComment()

◆ makeConfigSetScript()

◆ makeCustomLoaderScript()

◆ makeHash()

◆ makeInlineScript()

◆ makeLoaderConditionalScript()

◆ makeLoaderImplementScript()

◆ makeLoaderQuery()

◆ makeLoaderRegisterScript()

◆ makeLoaderSourcesScript()

◆ makeLoaderStateScript()

◆ makeMessageSetScript()

◆ makeModuleResponse()

◆ makePackedModulesString()

◆ makeVersionQuery()

◆ measureResponseTime()

◆ outputErrorAndLog()

◆ preloadModuleInfo()

◆ register()

◆ registerTestModules()

◆ respond()

◆ sendResponseHeaders()

◆ setLogger()

◆ setMessageBlobStore()

◆ trimArray()

◆ tryRespondFromFileCache()

◆ tryRespondNotModified()

Member Data Documentation

◆ $blobStore

◆ $config

◆ $debugMode

◆ $errors

◆ $extraHeaders

◆ $filterCacheVersion

◆ $lessVars

◆ $logger

◆ $moduleInfos

◆ $modules

◆ $sources

◆ $testModuleNames