Module for ResourceLoader initialization. More...

Inheritance diagram for ResourceLoaderStartUpModule:

[legend]

Collaboration diagram for ResourceLoaderStartUpModule:

[legend]

Public Member Functions
	getDefinitionSummary (ResourceLoaderContext $context)
	Get the definition summary for this module.

	getGroup ()

	getModuleRegistrations (ResourceLoaderContext $context)
	Get registration code for all modules.

	getPreloadLinks (ResourceLoaderContext $context)

	getScript (ResourceLoaderContext $context)

	isRaw ()

	supportsURLLoading ()

Public Member Functions inherited from ResourceLoaderModule
	enableModuleContentVersion ()
	Whether to generate version hash based on module content.

	getConfig ()

	getDependencies (ResourceLoaderContext $context=null)
	Get a list of modules this module depends on.

	getFlip ( $context)

	getHeaders (ResourceLoaderContext $context)
	Get headers to send as part of a module web response.

	getMessages ()
	Get the messages needed for this module.

	getModifiedHash (ResourceLoaderContext $context)
	Helper method for providing a version hash to getVersionHash().

	getModifiedTime (ResourceLoaderContext $context)
	Get this module's last modification timestamp for a given context.

	getModuleContent (ResourceLoaderContext $context)
	Get an array of this module's resources.

	getName ()
	Get this module's name.

	getOrigin ()
	Get this module's origin.

	getScriptURLsForDebug (ResourceLoaderContext $context)
	Get the URL or URLs to load for this module's JS in debug mode.

	getSkipFunction ()
	Get the skip function.

	getSource ()
	Get the origin of this module.

	getStyles (ResourceLoaderContext $context)
	Get all CSS for this module for a given skin.

	getStyleURLsForDebug (ResourceLoaderContext $context)
	Get the URL or URLs to load for this module's CSS in debug mode.

	getTargets ()
	Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile'].

	getTemplates ()
	Takes named templates by the module and returns an array mapping.

	getType ()
	Get the module's load type.

	getVersionHash (ResourceLoaderContext $context)
	Get a string identifying the current version of this module in a given context.

	isKnownEmpty (ResourceLoaderContext $context)
	Check whether this module is known to be empty.

	setConfig (Config $config)

	setFileDependencies (ResourceLoaderContext $context, $files)
	Set in-object cache for file dependencies.

	setLogger (LoggerInterface $logger)

	setMessageBlob ( $blob, $lang)
	Set in-object cache for message blobs.

	setName ( $name)
	Set this module's name.

	shouldEmbedModule (ResourceLoaderContext $context)
	Check whether this module should be embeded rather than linked.

Static Public Member Functions
static	compileUnresolvedDependencies (array &$registryData)
	Optimize the dependency tree in $this->modules.

static	getLegacyModules ()

static	getStartupModules ()
	Base modules required for the base environment of ResourceLoader.

static	getStartupModulesUrl (ResourceLoaderContext $context)
	Get the load URL of the startup modules.

Static Public Member Functions inherited from ResourceLoaderModule
static	expandRelativePaths (array $filePaths)
	Expand directories relative to $IP.

static	getRelativePaths (array $filePaths)
	Make file paths relative to MediaWiki directory.

Protected Member Functions
	getAllModuleHashes (ResourceLoaderContext $context)
	Helper method for getDefinitionSummary().

	getConfigSettings ( $context)

Protected Member Functions inherited from ResourceLoaderModule
	buildContent (ResourceLoaderContext $context)
	Bundle all resources attached to this module into an array.

	getDeprecationInformation ()
	Get JS representing deprecation information for the current module if available.

	getFileDependencies (ResourceLoaderContext $context)
	Get the files this module depends on indirectly for a given skin.

	getLessVars (ResourceLoaderContext $context)
	Get module-specific LESS variables, if any.

	getLogger ()

	getMessageBlob (ResourceLoaderContext $context)
	Get the hash of the message blob.

	saveFileDependencies (ResourceLoaderContext $context, $localFileRefs)
	Set the files this module depends on indirectly for a given skin.

	validateScriptFile ( $fileName, $contents)
	Validate a given script file; if valid returns the original source.

Static Protected Member Functions
static	getImplicitDependencies (array $registryData, $moduleName)
	Recursively get all explicit and implicit dependencies for to the given module.

Static Protected Member Functions inherited from ResourceLoaderModule
static	javaScriptParser ()

static	safeFileHash ( $filePath)
	Compute a non-cryptographic string hash of a file's contents.

static	safeFilemtime ( $filePath)
	Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist.

Protected Attributes
	$configVars = []

	$targets = [ 'desktop', 'mobile' ]

Protected Attributes inherited from ResourceLoaderModule
Config	$config

	$contents = []

array bool	$deprecated = false

	$fileDeps = []

LoggerInterface	$logger

	$msgBlobs = []

	$name = null

	$origin = self::ORIGIN_CORE_SITEWIDE

	$targets = [ 'desktop' ]

	$versionHash = []

Additional Inherited Members
Public Attributes inherited from ResourceLoaderModule
const	LOAD_GENERAL = 'general'

const	LOAD_STYLES = 'styles'

const	ORIGIN_ALL = 10

const	ORIGIN_CORE_INDIVIDUAL = 2

const	ORIGIN_CORE_SITEWIDE = 1

const	ORIGIN_USER_INDIVIDUAL = 4

const	ORIGIN_USER_SITEWIDE = 3

const	TYPE_COMBINED = 'combined'

const	TYPE_SCRIPTS = 'scripts'

const	TYPE_STYLES = 'styles'

Detailed Description

Module for ResourceLoader initialization.

The startup module, as being called only from ResourceLoaderClientHtml, has the ability to vary based extra query parameters, in addition to those from ResourceLoaderContext:

target: Only register modules in the client allowed within this target. Default: "desktop". See also: OutputPage::setTarget(), ResourceLoaderModule::getTargets().

Definition at line 36 of file ResourceLoaderStartUpModule.php.

Member Function Documentation

◆ compileUnresolvedDependencies()

static ResourceLoaderStartUpModule::compileUnresolvedDependencies ( array & $registryData )

static

Optimize the dependency tree in $this->modules.

The optimization basically works like this: Given we have module A with the dependencies B and C and module B with the dependency C. Now we don't have to tell the client to explicitly fetch module C as that's already included in module B.

This way we can reasonably reduce the amount of module registration data send to the client.

Parameters

array

&$registryData

Modules keyed by name with properties: