MediaWiki  master
ResourceLoaderStartUpModule Class Reference

Module for ResourceLoader initialization. More...

Inheritance diagram for ResourceLoaderStartUpModule:
Collaboration diagram for ResourceLoaderStartUpModule:

Public Member Functions

 enableModuleContentVersion ()
 
 getConfigSettings (ResourceLoaderContext $context)
 
 getModuleRegistrations (ResourceLoaderContext $context)
 Get registration code for all modules. More...
 
 getScript (ResourceLoaderContext $context)
 
 supportsURLLoading ()
 
- Public Member Functions inherited from ResourceLoaderModule
 getConfig ()
 
 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...
 
 getDeprecationInformation (ResourceLoaderContext $context)
 Get JS representing deprecation information for the current module if available. More...
 
 getFlip (ResourceLoaderContext $context)
 
 getGroup ()
 Get the group this module is in. More...
 
 getHeaders (ResourceLoaderContext $context)
 Get headers to send as part of a module web response. More...
 
 getMessages ()
 Get the messages needed for this module. 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...
 
 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 source 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...
 
 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...
 
 shouldEmbedModule (ResourceLoaderContext $context)
 Check whether this module should be embeded rather than linked. More...
 

Static Public Member Functions

static compileUnresolvedDependencies (array &$registryData)
 Optimize the dependency tree in $this->modules. More...
 
- Static Public Member Functions inherited from ResourceLoaderModule
static expandRelativePaths (array $filePaths)
 Expand directories relative to $IP. More...
 
static getRelativePaths (array $filePaths)
 Make file paths relative to MediaWiki directory. More...
 
static getVary (ResourceLoaderContext $context)
 Get vary string. More...
 

Static Protected Member Functions

static getImplicitDependencies (array $registryData, string $moduleName, array $handled=[])
 Recursively get all explicit and implicit dependencies for to the given module. More...
 
- Static Protected Member Functions inherited from ResourceLoaderModule
static safeFileHash ( $filePath)
 Compute a non-cryptographic string hash of a file's contents. More...
 

Protected Attributes

 $targets = [ 'desktop', 'mobile' ]
 
- Protected Attributes inherited from ResourceLoaderModule
Config $config
 
array $contents = []
 Map of (context hash => cached module content) More...
 
string bool $deprecated = false
 Deprecation string or true if deprecated; false otherwise. More...
 
array $fileDeps = []
 Map of (variant => indirect file dependencies) More...
 
LoggerInterface $logger
 
array $msgBlobs = []
 Map of (language => in-object cache for message blob) More...
 
string null $name = null
 Module name. More...
 
int $origin = self::ORIGIN_CORE_SITEWIDE
 Script and style modules form a hierarchy of trustworthiness, with core modules like skins and jQuery as most trustworthy, and user scripts as least trustworthy. More...
 
string[] $targets = [ 'desktop' ]
 What client platforms the module targets (e.g. More...
 
array $versionHash = []
 Map of (context hash => cached module version hash) More...
 

Private Member Functions

 getBaseModules ()
 Base modules implicitly available to all modules. More...
 
 getGroupId ( $groupName)
 
 getStoreKey ()
 Get the localStorage key for the entire module store. More...
 
 getStoreVary (ResourceLoaderContext $context)
 Get the key on which the JavaScript module cache (mw.loader.store) will vary. More...
 

Private Attributes

 $groupIds
 

Additional Inherited Members

- Protected Member Functions inherited from ResourceLoaderModule
 buildContent (ResourceLoaderContext $context)
 Bundle all resources attached to this module into an array. 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...
 
 getPreloadLinks (ResourceLoaderContext $context)
 Get a list of resources that web browsers may preload. More...
 
 saveFileDependencies (ResourceLoaderContext $context, array $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...
 

Detailed Description

Module for ResourceLoader initialization.

See also https://www.mediawiki.org/wiki/ResourceLoader/Features#Startup_Module

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 intended for this target. Default: "desktop". See also: OutputPage::setTarget(), ResourceLoaderModule::getTargets().
  • safemode: Only register modules that have ORIGIN_CORE as their origin. This effectively disables ORIGIN_USER modules. (T185303) See also: OutputPage::disallowUserJs()

Definition at line 45 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[]&$registryDataModules keyed by name with properties:
  • string 'version'
  • array 'dependencies'
  • string|null 'group'
  • string 'source'

@phan-param array<string,array{version:string,dependencies:array,group:?string,source:string}> &$registryData

Definition at line 221 of file ResourceLoaderStartUpModule.php.

References ResourceLoaderModule\$name, and getImplicitDependencies().

Referenced by getModuleRegistrations().

◆ enableModuleContentVersion()

ResourceLoaderStartUpModule::enableModuleContentVersion ( )
Returns
bool

Reimplemented from ResourceLoaderModule.

Definition at line 502 of file ResourceLoaderStartUpModule.php.

◆ getBaseModules()

ResourceLoaderStartUpModule::getBaseModules ( )
private

Base modules implicitly available to all modules.

Returns
array

Definition at line 390 of file ResourceLoaderStartUpModule.php.

◆ getConfigSettings()

◆ getGroupId()

ResourceLoaderStartUpModule::getGroupId (   $groupName)
private

Definition at line 373 of file ResourceLoaderStartUpModule.php.

Referenced by getModuleRegistrations().

◆ getImplicitDependencies()

static ResourceLoaderStartUpModule::getImplicitDependencies ( array  $registryData,
string  $moduleName,
array  $handled = [] 
)
staticprotected

Recursively get all explicit and implicit dependencies for to the given module.

Parameters
array$registryData
string$moduleName
string[]$handledInternal parameter for recursion. (Optional)
Returns
array
Exceptions
ResourceLoaderCircularDependencyError

Definition at line 155 of file ResourceLoaderStartUpModule.php.

Referenced by compileUnresolvedDependencies().

◆ getModuleRegistrations()

ResourceLoaderStartUpModule::getModuleRegistrations ( ResourceLoaderContext  $context)

Get registration code for all modules.

Parameters
ResourceLoaderContext$context
Returns
string JavaScript code for registering all modules with the client loader

Definition at line 245 of file ResourceLoaderStartUpModule.php.

References $context, ResourceLoaderModule\$name, $resourceLoader, ResourceLoaderModule\$versionHash, compileUnresolvedDependencies(), ResourceLoaderModule\getConfig(), and getGroupId().

Referenced by getScript().

◆ getScript()

ResourceLoaderStartUpModule::getScript ( ResourceLoaderContext  $context)
Parameters
ResourceLoaderContext$context
Returns
string JavaScript code

Reimplemented from ResourceLoaderModule.

Definition at line 422 of file ResourceLoaderStartUpModule.php.

References $context, $IP, ResourceLoaderModule\getConfig(), getConfigSettings(), getModuleRegistrations(), and ResourceLoaderContext\getOnly().

◆ getStoreKey()

ResourceLoaderStartUpModule::getStoreKey ( )
private

Get the localStorage key for the entire module store.

The key references $wgDBname to prevent clashes between wikis under the same web domain.

Returns
string localStorage item key for JavaScript

Definition at line 400 of file ResourceLoaderStartUpModule.php.

References ResourceLoaderModule\getConfig().

◆ getStoreVary()

ResourceLoaderStartUpModule::getStoreVary ( ResourceLoaderContext  $context)
private

Get the key on which the JavaScript module cache (mw.loader.store) will vary.

Parameters
ResourceLoaderContext$context
Returns
string String of concatenated vary conditions

Definition at line 410 of file ResourceLoaderStartUpModule.php.

References $context, ResourceLoaderModule\getConfig(), and ResourceLoaderContext\getLanguage().

◆ supportsURLLoading()

ResourceLoaderStartUpModule::supportsURLLoading ( )
Returns
bool

Reimplemented from ResourceLoaderModule.

Definition at line 495 of file ResourceLoaderStartUpModule.php.

Member Data Documentation

◆ $groupIds

ResourceLoaderStartUpModule::$groupIds
private
Initial value:
= [
'user' => 0,
'private' => 1,
]

Definition at line 48 of file ResourceLoaderStartUpModule.php.

◆ $targets

ResourceLoaderStartUpModule::$targets = [ 'desktop', 'mobile' ]
protected

Definition at line 46 of file ResourceLoaderStartUpModule.php.


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