BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
ResourceLoaderModule Class Reference
Inheritance diagram for ResourceLoaderModule:
Collaboration diagram for ResourceLoaderModule:

Public Member Functions

 getName ()
 
 setName ($name)
 
 getOrigin ()
 
 getFlip ($context)
 
 getScript (ResourceLoaderContext $context)
 
 getTemplates ()
 
 getConfig ()
 
 setConfig (Config $config)
 
 setLogger (LoggerInterface $logger)
 
 getScriptURLsForDebug (ResourceLoaderContext $context)
 
 supportsURLLoading ()
 
 getStyles (ResourceLoaderContext $context)
 
 getStyleURLsForDebug (ResourceLoaderContext $context)
 
 getMessages ()
 
 getGroup ()
 
 getSource ()
 
 isRaw ()
 
 getDependencies (ResourceLoaderContext $context=null)
 
 getTargets ()
 
 getType ()
 
 getSkipFunction ()
 
 setFileDependencies (ResourceLoaderContext $context, $files)
 
 setMessageBlob ($blob, $lang)
 
 getHeaders (ResourceLoaderContext $context)
 
 getModuleContent (ResourceLoaderContext $context)
 
 getVersionHash (ResourceLoaderContext $context)
 
 enableModuleContentVersion ()
 
 getDefinitionSummary (ResourceLoaderContext $context)
 
 getModifiedTime (ResourceLoaderContext $context)
 
 getModifiedHash (ResourceLoaderContext $context)
 
 isKnownEmpty (ResourceLoaderContext $context)
 
 shouldEmbedModule (ResourceLoaderContext $context)
 

Static Public Member Functions

static getRelativePaths (array $filePaths)
 
static expandRelativePaths (array $filePaths)
 

Public Attributes

const TYPE_SCRIPTS = 'scripts'
 
const TYPE_STYLES = 'styles'
 
const TYPE_COMBINED = 'combined'
 
const LOAD_STYLES = 'styles'
 
const LOAD_GENERAL = 'general'
 
const ORIGIN_CORE_SITEWIDE = 1
 
const ORIGIN_CORE_INDIVIDUAL = 2
 
const ORIGIN_USER_SITEWIDE = 3
 
const ORIGIN_USER_INDIVIDUAL = 4
 
const ORIGIN_ALL = 10
 

Protected Member Functions

 getDeprecationInformation ()
 
 getLogger ()
 
 getFileDependencies (ResourceLoaderContext $context)
 
 saveFileDependencies (ResourceLoaderContext $context, $localFileRefs)
 
 getMessageBlob (ResourceLoaderContext $context)
 
 getPreloadLinks (ResourceLoaderContext $context)
 
 getLessVars (ResourceLoaderContext $context)
 
 buildContent (ResourceLoaderContext $context)
 
 validateScriptFile ($fileName, $contents)
 

Static Protected Member Functions

static javaScriptParser ()
 
static safeFilemtime ($filePath)
 
static safeFileHash ($filePath)
 

Protected Attributes

 $origin = self::ORIGIN_CORE_SITEWIDE
 
 $name = null
 
 $targets = [ 'desktop' ]
 
 $fileDeps = []
 
 $msgBlobs = []
 
 $versionHash = []
 
 $contents = []
 
 $config
 
 $deprecated = false
 
 $logger
 

Detailed Description

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

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
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
static ResourceLoaderModule::expandRelativePaths ( array  $filePaths)
static

Expand directories relative to $IP.

Since
1.27
Parameters
array$filePaths
Returns
array
ResourceLoaderModule::getConfig ( )
Returns
Config
Since
1.24
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().

Since
1.23
Parameters
ResourceLoaderContext$context
Returns
array|null
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
ResourceLoaderModule::getDeprecationInformation ( )
protected

Get JS representing deprecation information for the current module if available

Returns
string JavaScript code
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
ResourceLoaderModule::getFlip (   $context)
Parameters
ResourceLoaderContext$context
Returns
bool
ResourceLoaderModule::getGroup ( )

Get the group this module is in.

Returns
string Group name
ResourceLoaderModule::getHeaders ( ResourceLoaderContext  $context)
final

Get headers to send as part of a module web response.

It is not supported to send headers through this method that are required to be unique or otherwise sent once in an HTTP response because clients may make batch requests for multiple modules (as is the default behaviour for ResourceLoader clients).

For exclusive or aggregated headers, see ResourceLoader::sendResponseHeaders().

Since
1.30
Parameters
ResourceLoaderContext$context
Returns
string[] Array of HTTP response headers
ResourceLoaderModule::getLessVars ( ResourceLoaderContext  $context)
protected

Get module-specific LESS variables, if any.

Since
1.27
Parameters
ResourceLoaderContext$context
Returns
array Module-specific LESS variables.
ResourceLoaderModule::getLogger ( )
protected
Since
1.27
Returns
LoggerInterface
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
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
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
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
Returns
int|null UNIX timestamp
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
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
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
ResourceLoaderModule::getPreloadLinks ( ResourceLoaderContext  $context)
protected

Get a list of resources that web browsers may preload.

Behaviour of rel=preload link is specified at https://www.w3.org/TR/preload/.

Use case for ResourceLoader originally part of T164299.

Example
protected function getPreloadLinks() {
return [
'https://example.org/script.js' => [ 'as' => 'script' ],
'https://example.org/image.png' => [ 'as' => 'image' ],
];
}
Example using HiDPI image variants
protected function getPreloadLinks() {
return [
'https://example.org/logo.png' => [
'as' => 'image',
'media' => 'not all and (min-resolution: 2dppx)',
],
'https://example.org/logo@2x.png' => [
'as' => 'image',
'media' => '(min-resolution: 2dppx)',
],
];
}
See Also
ResourceLoaderModule::getHeaders
Since
1.30
Parameters
ResourceLoaderContext$context
Returns
array Keyed by url, values must be an array containing at least an 'as' key. Optionally a 'media' key as well.
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
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
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
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
ResourceLoaderModule::getSource ( )

Get the origin of this module. Should only be overridden for foreign modules.

Returns
string Origin name, 'local' for local modules
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 }' ] ];
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, ... ], ... ]
ResourceLoaderModule::getTargets ( )

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

Returns
array Array of strings
ResourceLoaderModule::getTemplates ( )

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

Returns
array of templates mapping template alias to content
ResourceLoaderModule::getType ( )

Get the module's load type.

Since
1.28
Returns
string ResourceLoaderModule LOAD_* constant
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)
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
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
static ResourceLoaderModule::javaScriptParser ( )
staticprotected
Returns
JSParser
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$filePathFile path
Returns
string Hash
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$filePathFile path
Returns
int UNIX timestamp
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$localFileRefsList of files
ResourceLoaderModule::setConfig ( Config  $config)
Parameters
Config$config
Since
1.24
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
ResourceLoaderModule::setLogger ( LoggerInterface  $logger)
Since
1.27
Parameters
LoggerInterface$logger
Returns
null

Implements Psr\Log\LoggerAwareInterface.

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$blobJSON blob or null
string$langLanguage code
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
ResourceLoaderModule::shouldEmbedModule ( ResourceLoaderContext  $context)

Check whether this module should be embeded rather than linked

Modules returning true here will be embedded rather than loaded by ResourceLoaderClientHtml.

Since
1.30
Parameters
ResourceLoaderContext$context
Returns
bool
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.

Returns
bool
ResourceLoaderModule::validateScriptFile (   $fileName,
  $contents 
)
protected

Validate a given script file; if valid returns the original source. If invalid, returns replacement JS source that throws an exception.

Parameters
string$fileName
string$contents
Returns
string JS with the original, or a replacement error

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