Abstraction for ResourceLoader modules, with name registration and maxage functionality. More...

Inheritance diagram for ResourceLoaderModule:

Collaboration diagram for ResourceLoaderModule:

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

	getConfig ()

	getDefinitionMtime (ResourceLoaderContext $context)
	Back-compat dummy for old subclass implementations of getModifiedTime(). More...

	getDefinitionSummary (ResourceLoaderContext $context)
	Get the definition summary for this module. More...

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

	getFlip ($context)

	getGroup ()
	Get the group this module is in. More...

	getHashMtime (ResourceLoaderContext $context)
	Back-compat dummy for old subclass implementations of getModifiedTime(). More...

	getMessages ()
	Get the messages needed for this module. More...

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

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

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

	getName ()
	Get this module's name. More...

	getOrigin ()
	Get this module's origin. More...

	getPosition ()
	Where on the HTML page should this module's JS be loaded? More...

	getScript (ResourceLoaderContext $context)
	Get all JS for this module for a given language and skin. More...

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

	getSkipFunction ()
	Get the skip function. More...

	getSource ()
	Get the origin of this module. More...

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

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

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

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

	getType ()
	Get the module's load type. More...

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

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

	isRaw ()
	Whether this module's JS expects to work without the client-side ResourceLoader module. More...

	setConfig (Config $config)

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

	setLogger (LoggerInterface $logger)

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

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

	supportsURLLoading ()
	Whether this module supports URL loading. More...

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

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

Public Attributes
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'

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

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

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

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

	getLogger ()

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

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

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

Static Protected Member Functions
static	javaScriptParser ()

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

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

Protected Attributes
Config	$config

	$contents = []

array bool	$deprecated = false

	$fileDeps = []

LoggerInterface	$logger

	$msgBlobs = []

	$name = null

	$origin = self::ORIGIN_CORE_SITEWIDE

	$targets = [ 'desktop' ]

	$versionHash = []

Static Private Attributes
static JSParser	$jsParser
	Lazy-initialized; use self::javaScriptParser() More...

static	$parseCacheVersion = 1

Detailed Description

Abstraction for ResourceLoader modules, with name registration and maxage functionality.

Definition at line 33 of file ResourceLoaderModule.php.

Member Function Documentation

ResourceLoaderModule::buildContent ( ResourceLoaderContext $context )

finalprotected

Bundle all resources attached to this module into an array.

Since: 1.26

Parameters

ResourceLoaderContext $context

Returns: array

Definition at line 607 of file ResourceLoaderModule.php.

References $blob, $content, as, ResourceLoader\filter(), ResourceLoaderContext\getDebug(), RequestContext\getMain(), getMessageBlob(), getName(), ResourceLoaderContext\getOnly(), ResourceLoaderContext\getResourceLoader(), getScript(), getScriptURLsForDebug(), getStyles(), getStyleURLsForDebug(), getTemplates(), ResourceLoaderContext\shouldIncludeScripts(), ResourceLoaderContext\shouldIncludeStyles(), and supportsURLLoading().

Referenced by getModuleContent().

ResourceLoaderModule::enableModuleContentVersion ( )

Whether to generate version hash based on module content.

If a module requires database or file system access to build the module content, consider disabling this in favour of manually tracking relevant aspects in getDefinitionSummary(). See getVersionHash() for how this is used.

Returns: bool

Definition at line 779 of file ResourceLoaderModule.php.

Referenced by getVersionHash().

static ResourceLoaderModule::expandRelativePaths ( array $filePaths )

static

Expand directories relative to $IP.

Since: 1.27

Parameters

array $filePaths

Returns: array

Definition at line 528 of file ResourceLoaderModule.php.

References $IP, $path, global, and use.

Referenced by ResourceLoader\preloadModuleInfo().

ResourceLoaderModule::getConfig ( )

Returns: Config

Since: 1.24

Definition at line 187 of file ResourceLoaderModule.php.

References $config, and ConfigFactory\getDefaultInstance().

Referenced by ResourceLoaderStartUpModule\getConfigSettings(), ResourceLoaderStartUpModule\getDefinitionSummary(), getDefinitionSummary(), ResourceLoaderSkinModule\getModifiedHash(), ResourceLoaderStartUpModule\getModuleRegistrations(), ResourceLoaderUserModule\getPages(), ResourceLoaderUserStylesModule\getPages(), ResourceLoaderSiteStylesModule\getPages(), ResourceLoaderSiteModule\getPages(), ResourceLoaderWikiModule\getPages(), ResourceLoaderStartUpModule\getScript(), ResourceLoaderFileModule\getScriptURLsForDebug(), ResourceLoaderFileModule\getSkipFunction(), ResourceLoaderSkinModule\getStyles(), ResourceLoaderUserCSSPrefsModule\getStyles(), ResourceLoaderWikiModule\getStyles(), ResourceLoaderFileModule\getStyleURLsForDebug(), ResourceLoaderFileModule\readScriptFiles(), and validateScriptFile().

ResourceLoaderModule::getDefinitionMtime ( ResourceLoaderContext $context )

Back-compat dummy for old subclass implementations of getModifiedTime().

Since: 1.23

Deprecated:

since 1.26 Superseded by getVersionHash()

Parameters

ResourceLoaderContext $context

Returns: int UNIX timestamp

Definition at line 882 of file ResourceLoaderModule.php.

References getDefinitionSummary().

ResourceLoaderModule::getDefinitionSummary ( ResourceLoaderContext $context )

Get the definition summary for this module.

This is the method subclasses are recommended to use to track values in their version hash. Call this in getVersionHash() and pass it to e.g. json_encode.

Subclasses must call the parent getDefinitionSummary() and build on that. It is recommended that each subclass appends its own new array. This prevents clashes or accidental overwrites of existing keys and gives each subclass its own scope for simple array keys.

$summary = parent::getDefinitionSummary( $context );
$summary[] = [
    'foo' => 123,
    'bar' => 'quux',
];
return $summary;

Return an array containing values from all significant properties of this module's definition.

Be careful not to normalise too much. Especially preserve the order of things that carry significance in getScript and getStyles (T39812).

Avoid including things that are insiginificant (e.g. order of message keys is insignificant and should be sorted to avoid unnecessary cache invalidation).

This data structure must exclusively contain arrays and scalars as values (avoid object instances) to allow simple serialisation using json_encode.

If modules have a hash or timestamp from another source, that may be incuded as-is.

A number of utility methods are available to help you gather data. These are not called by default and must be included by the subclass' getDefinitionSummary().

getMessageBlob()

Since: 1.23

Parameters

ResourceLoaderContext $context

Returns: array|null

Definition at line 826 of file ResourceLoaderModule.php.

References getConfig().

Referenced by getDefinitionMtime(), and getVersionHash().

ResourceLoaderModule::getDependencies ( ResourceLoaderContext $context = null )

Get a list of modules this module depends on.

Dependency information is taken into account when loading a module on the client side.

Note: It is expected that $context will be made non-optional in the near future.

Parameters

ResourceLoaderContext $context

Returns: array List of module names as strings

Definition at line 366 of file ResourceLoaderModule.php.

ResourceLoaderModule::getDeprecationInformation ( )

protected

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

Returns: string JavaScript code

Definition at line 144 of file ResourceLoaderModule.php.

References $deprecated, $name, Xml\encodeJsCall(), and getName().

Referenced by ResourceLoaderFileModule\getScript().

ResourceLoaderModule::getFileDependencies ( ResourceLoaderContext $context )

protected

Get the files this module depends on indirectly for a given skin.

These are only image files referenced by the module's stylesheet.

Parameters

ResourceLoaderContext $context

Returns: array List of files

Definition at line 416 of file ResourceLoaderModule.php.

References $dbr, array(), DB_REPLICA, FormatJson\decode(), ResourceLoaderContext\getLanguage(), getName(), ResourceLoaderContext\getSkin(), and wfGetDB().

Referenced by ResourceLoaderFileModule\getFileHashes(), and saveFileDependencies().

ResourceLoaderModule::getFlip ( $context )

Parameters

ResourceLoaderContext $context

Returns: bool

Definition at line 133 of file ResourceLoaderModule.php.

References $context, $wgContLang, and global.

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

ResourceLoaderModule::getGroup ( )

Get the group this module is in.

Returns: string Group name

Definition at line 317 of file ResourceLoaderModule.php.

ResourceLoaderModule::getHashMtime ( ResourceLoaderContext $context )

Back-compat dummy for old subclass implementations of getModifiedTime().

This method used to use ObjectCache to track when a hash was first seen. That principle stems from a time that ResourceLoader could only identify module versions by timestamp. That is no longer the case. Use getDefinitionSummary() directly.

Deprecated:

since 1.26 Superseded by getVersionHash()

Parameters

ResourceLoaderContext $context

Returns: int UNIX timestamp

Definition at line 866 of file ResourceLoaderModule.php.

References getModifiedHash().

ResourceLoaderModule::getLessVars ( ResourceLoaderContext $context )

protected

Get module-specific LESS variables, if any.

Since: 1.27

Parameters

ResourceLoaderContext $context

Returns: array Module-specific LESS variables.

Definition at line 579 of file ResourceLoaderModule.php.

Referenced by ResourceLoaderFileModule\compileLessFile().

ResourceLoaderModule::getLogger ( )

protected

Since: 1.27

Returns: LoggerInterface

Definition at line 217 of file ResourceLoaderModule.php.

References $logger.

Referenced by getMessageBlob().

ResourceLoaderModule::getMessageBlob ( ResourceLoaderContext $context )

protected

Get the hash of the message blob.

Since: 1.27

Parameters

ResourceLoaderContext $context

Returns: string|null JSON blob or null if module has no messages

Definition at line 542 of file ResourceLoaderModule.php.

References $lang, ResourceLoaderContext\getLanguage(), getLogger(), getMessages(), getName(), and ResourceLoaderContext\getResourceLoader().

Referenced by buildContent(), and ResourceLoaderFileModule\getDefinitionSummary().

ResourceLoaderModule::getMessages ( )

Get the messages needed for this module.

To get a JSON blob with messages, use MessageBlobStore::get()

Returns: array List of message keys. Keys may occur more than once

Definition at line 307 of file ResourceLoaderModule.php.

Referenced by MessageBlobStore\generateMessageBlob(), getMessageBlob(), and MessageBlobStore\makeCacheKey().

ResourceLoaderModule::getModifiedHash ( ResourceLoaderContext $context )

Helper method for providing a version hash to getVersionHash().

Deprecated:

since 1.26 Use getDefinitionSummary() instead

Parameters

ResourceLoaderContext $context

Returns: string|null Hash

Definition at line 851 of file ResourceLoaderModule.php.

Referenced by getHashMtime(), and getVersionHash().

ResourceLoaderModule::getModifiedTime ( ResourceLoaderContext $context )

Get this module's last modification timestamp for a given context.

Deprecated:

since 1.26 Use getDefinitionSummary() instead

Parameters

ResourceLoaderContext $context Context object

Returns: int|null UNIX timestamp

Definition at line 840 of file ResourceLoaderModule.php.

Referenced by getVersionHash().

ResourceLoaderModule::getModuleContent ( ResourceLoaderContext $context )

Get an array of this module's resources.

Ready for serving to the web.

Since: 1.26

Parameters

ResourceLoaderContext $context

Returns: array

Definition at line 590 of file ResourceLoaderModule.php.

References buildContent(), contents, and ResourceLoaderContext\getHash().

Referenced by getVersionHash().

ResourceLoaderModule::getName ( )

Get this module's name.

This is set when the module is registered with ResourceLoader::register()

Returns: string|null Name (string) or null if no name was set

Definition at line 104 of file ResourceLoaderModule.php.

References $name.

Referenced by buildContent(), MessageBlobStore\generateMessageBlob(), MessageBlobStore\getBlob(), getDeprecationInformation(), getFileDependencies(), ResourceLoaderImageModule\getImages(), getMessageBlob(), getScriptURLsForDebug(), getStyleURLsForDebug(), MessageBlobStore\makeCacheKey(), and saveFileDependencies().

ResourceLoaderModule::getOrigin ( )

Get this module's origin.

This is set when the module is registered with ResourceLoader::register()

Returns: int ResourceLoaderModule class constant, the subclass default if not set manually

Definition at line 125 of file ResourceLoaderModule.php.

References $origin.

Referenced by OutputPage\filterModules().

ResourceLoaderModule::getPosition ( )

Where on the HTML page should this module's JS be loaded?

'top': in the "<head>"
'bottom': at the bottom of the "<body>"

Returns: string

Definition at line 339 of file ResourceLoaderModule.php.

static ResourceLoaderModule::getRelativePaths ( array $filePaths )

static

Make file paths relative to MediaWiki directory.

This is used to make file paths safe for storing in a database without the paths becoming stale or incorrect when MediaWiki is moved or upgraded (T111481).

Since: 1.27

Parameters

array $filePaths

Returns: array

Definition at line 514 of file ResourceLoaderModule.php.

References $IP, $path, global, and use.

ResourceLoaderModule::getScript ( ResourceLoaderContext $context )

Get all JS for this module for a given language and skin.

Includes all relevant JS except loader scripts.

Parameters

ResourceLoaderContext $context

Returns: string JavaScript code

Definition at line 168 of file ResourceLoaderModule.php.

Referenced by buildContent().

ResourceLoaderModule::getScriptURLsForDebug ( ResourceLoaderContext $context )

Get the URL or URLs to load for this module's JS in debug mode.

The default behavior is to return a load.php?only=scripts URL for the module, but file-based modules will want to override this to load the files directly.

This function is called only when 1) we're in debug mode, 2) there is no only= parameter and 3) supportsURLLoading() returns true. #2 is important to prevent an infinite loop, therefore this function MUST return either an only= URL or a non-load.php URL.

Parameters

ResourceLoaderContext $context

Returns: array Array of URLs

Definition at line 238 of file ResourceLoaderModule.php.

References $resourceLoader, getName(), ResourceLoaderContext\getResourceLoader(), and getSource().

Referenced by buildContent(), and ResourceLoaderJqueryMsgModule\getScriptURLsForDebug().

ResourceLoaderModule::getSkipFunction ( )

Get the skip function.

Modules that provide fallback functionality can provide a "skip function". This function, if provided, will be passed along to the module registry on the client. When this module is loaded (either directly or as a dependency of another module), then this function is executed first. If the function returns true, the module will instantly be considered "ready" without requesting the associated module resources.

The value returned here must be valid javascript for execution in a private function. It must not contain the "function () {" and "}" wrapper though.

Returns: string|null A JavaScript function body returning a boolean value, or null

Definition at line 404 of file ResourceLoaderModule.php.

ResourceLoaderModule::getSource ( )

Get the origin of this module.

Should only be overridden for foreign modules.

Returns: string Origin name, 'local' for local modules

Definition at line 327 of file ResourceLoaderModule.php.

Referenced by getScriptURLsForDebug(), ResourceLoaderImageModule\getStyles(), and getStyleURLsForDebug().

ResourceLoaderModule::getStyles ( ResourceLoaderContext $context )

Get all CSS for this module for a given skin.

Parameters

ResourceLoaderContext $context

Returns: array List of CSS strings or array of CSS strings keyed by media type. like [ 'screen' => '.foo { width: 0 }' ]; or [ 'screen' => [ '.foo { width: 0 }' ] ];

Definition at line 271 of file ResourceLoaderModule.php.

Referenced by buildContent().

ResourceLoaderModule::getStyleURLsForDebug ( ResourceLoaderContext $context )

Get the URL or URLs to load for this module's CSS in debug mode.

The default behavior is to return a load.php?only=styles URL for the module, but file-based modules will want to override this to load the files directly. See also getScriptURLsForDebug()

Parameters

ResourceLoaderContext $context

Returns: array [ mediaType => [ URL1, URL2, ... ], ... ]

Definition at line 285 of file ResourceLoaderModule.php.

References $resourceLoader, getName(), ResourceLoaderContext\getResourceLoader(), and getSource().

Referenced by buildContent().

ResourceLoaderModule::getTargets ( )

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

Returns: array Array of strings

Definition at line 376 of file ResourceLoaderModule.php.

References $targets.

ResourceLoaderModule::getTemplates ( )

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

Returns: array of templates mapping template alias to content

Definition at line 178 of file ResourceLoaderModule.php.

Referenced by buildContent().

ResourceLoaderModule::getType ( )

Get the module's load type.

Since: 1.28

Returns: string ResourceLoaderModule LOAD_* constant

Definition at line 386 of file ResourceLoaderModule.php.

ResourceLoaderModule::getVersionHash ( ResourceLoaderContext $context )

Get a string identifying the current version of this module in a given context.

Whenever anything happens that changes the module's response (e.g. scripts, styles, and messages) this value must change. This value is used to store module responses in cache. (Both client-side and server-side.)

It is not recommended to override this directly. Use getDefinitionSummary() instead. If overridden, one must call the parent getVersionHash(), append data and re-hash.

This method should be quick because it is frequently run by ResourceLoaderStartUpModule to propagate changes to the client and effectively invalidate cache.

For backward-compatibility, the following optional data providers are automatically included:

Since: 1.26

Parameters

ResourceLoaderContext $context

Returns: string Hash (should use ResourceLoader::makeHash)

Definition at line 725 of file ResourceLoaderModule.php.

References $summary, enableModuleContentVersion(), getDefinitionSummary(), ResourceLoaderContext\getHash(), getModifiedHash(), getModifiedTime(), getModuleContent(), and ResourceLoader\makeHash().

ResourceLoaderModule::isKnownEmpty ( ResourceLoaderContext $context )

Check whether this module is known to be empty.

If a child class has an easy and cheap way to determine that this module is definitely going to be empty, it should override this method to return true in that case. Callers may optimize the request for this module away if this function returns true.

Parameters

ResourceLoaderContext $context

Returns: bool

Definition at line 899 of file ResourceLoaderModule.php.

ResourceLoaderModule::isRaw ( )

Whether this module's JS expects to work without the client-side ResourceLoader module.

Returning true from this function will prevent mw.loader.state() call from being appended to the bottom of the script.

Returns: bool

Definition at line 350 of file ResourceLoaderModule.php.

static ResourceLoaderModule::javaScriptParser ( )

staticprotected

Returns: JSParser

Definition at line 951 of file ResourceLoaderModule.php.

static ResourceLoaderModule::safeFileHash ( $filePath )

staticprotected

Compute a non-cryptographic string hash of a file's contents.

If the file does not exist or cannot be read, returns an empty string.

Since: 1.26 Uses MD4 instead of SHA1.

Parameters

string $filePath File path

Returns: string Hash

Definition at line 980 of file ResourceLoaderModule.php.

References FileContentsHasher\getFileContentsHash().

static ResourceLoaderModule::safeFilemtime ( $filePath )

staticprotected

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

Defaults to 1.

Parameters

string $filePath File path

Returns: int UNIX timestamp

Definition at line 965 of file ResourceLoaderModule.php.

ResourceLoaderModule::saveFileDependencies	(	ResourceLoaderContext	$context,
			$localFileRefs
	)

protected

Set the files this module depends on indirectly for a given skin.

Since: 1.27

Parameters

ResourceLoaderContext	$context
array	$localFileRefs	List of files

Definition at line 463 of file ResourceLoaderModule.php.

References $cache, $e, DB_MASTER, FormatJson\encode(), getFileDependencies(), ResourceLoaderContext\getLanguage(), ObjectCache\getLocalClusterInstance(), getName(), ResourceLoaderContext\getSkin(), use, wfDebugLog(), and wfGetDB().

Referenced by ResourceLoaderFileModule\getStyles().

ResourceLoaderModule::setConfig ( Config $config )

Parameters

Config $config

Since: 1.24

Definition at line 200 of file ResourceLoaderModule.php.

References $config.

ResourceLoaderModule::setFileDependencies	(	ResourceLoaderContext	$context,
			$files
	)

Set in-object cache for file dependencies.

This is used to retrieve data in batches. See ResourceLoader::preloadModuleInfo(). To save the data, use saveFileDependencies().

Parameters

ResourceLoaderContext	$context
	string[]	$files Array of file names

Definition at line 451 of file ResourceLoaderModule.php.

References $files, ResourceLoaderContext\getLanguage(), and ResourceLoaderContext\getSkin().

ResourceLoaderModule::setLogger ( LoggerInterface $logger )

Since: 1.27

Parameters

LoggerInterface $logger

Returns: null

Definition at line 209 of file ResourceLoaderModule.php.

References $logger.

ResourceLoaderModule::setMessageBlob	(	$blob,
		$lang
	)

Set in-object cache for message blobs.

Used to allow fetching of message blobs in batches. See ResourceLoader::preloadModuleInfo().

Since: 1.27

Parameters

string \| null	$blob	JSON blob or null
string	$lang	Language code

Definition at line 568 of file ResourceLoaderModule.php.

References $blob, and $lang.

ResourceLoaderModule::setName ( $name )

Set this module's name.

This is called by ResourceLoader::register() when registering the module. Other code should not call this.

Parameters

string $name Name

Definition at line 114 of file ResourceLoaderModule.php.

References $name, and name.

ResourceLoaderModule::supportsURLLoading ( )

Whether this module supports URL loading.

If this function returns false, getScript() will be used even in cases (debug mode, no only param) where getScriptURLsForDebug() would normally be used instead.