|
MediaWiki
master
|


Public Member Functions | |
| getDefinitionSummary (ResourceLoaderContext $context) | |
| Get the definition summary for this module. More... | |
| getGroup () | |
| getModuleRegistrations (ResourceLoaderContext $context) | |
| Get registration code for all modules. More... | |
| getScript (ResourceLoaderContext $context) | |
| isRaw () | |
| supportsURLLoading () | |
Public Member Functions inherited from ResourceLoaderModule | |
| 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 | compileUnresolvedDependencies (array &$registryData) |
| Optimize the dependency tree in $this->modules. More... | |
| static | getLegacyModules () |
| static | getStartupModules () |
| Base modules required for the base environment of ResourceLoader. More... | |
| static | getStartupModulesUrl (ResourceLoaderContext $context) |
| Get the load URL of the startup 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... | |
Protected Member Functions | |
| getAllModuleHashes (ResourceLoaderContext $context) | |
| Helper method for getDefinitionSummary(). More... | |
| getConfigSettings ($context) | |
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... | |
| 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 | getImplicitDependencies (array $registryData, $moduleName) |
| Recursively get all explicit and implicit dependencies for to the given module. More... | |
Static Protected Member Functions inherited from ResourceLoaderModule | |
| 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 | |
| $configVars = [] | |
| $targets = [ 'desktop', 'mobile' ] | |
Protected Attributes inherited from ResourceLoaderModule | |
| Config | $config |
| $contents = [] | |
| $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' |
Definition at line 25 of file ResourceLoaderStartUpModule.php.
|
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.
| array | &$registryData | Modules keyed by name with properties:
|
Definition at line 175 of file ResourceLoaderStartUpModule.php.
References ResourceLoaderModule\$name, and as.
|
protected |
Helper method for getDefinitionSummary().
| ResourceLoaderContext | $context |
Definition at line 394 of file ResourceLoaderStartUpModule.php.
References $context, ResourceLoaderContext\getHash(), and ResourceLoaderContext\getResourceLoader().
Referenced by getDefinitionSummary().
|
protected |
| ResourceLoaderContext | $context |
Definition at line 35 of file ResourceLoaderStartUpModule.php.
References $context, ResourceLoaderModule\$name, $vars, $wgContLang, as, Title\convertByteClassToUnicodeClass(), MWNamespace\getCanonicalNamespaces(), ResourceLoaderModule\getConfig(), MWNamespace\getContentNamespaces(), Skin\getSkinNames(), global, MWNamespace\isCapitalized(), Title\legalChars(), Title\newFromText(), object, Hooks\run(), wfScript(), and wfUrlProtocols().
Referenced by getDefinitionSummary(), and getScript().
| ResourceLoaderStartUpModule::getDefinitionSummary | ( | ResourceLoaderContext | $context | ) |
Get the definition summary for this module.
| ResourceLoaderContext | $context |
Definition at line 370 of file ResourceLoaderStartUpModule.php.
References $IP, $summary, getAllModuleHashes(), ResourceLoaderModule\getConfig(), getConfigSettings(), and global.
| ResourceLoaderStartUpModule::getGroup | ( | ) |
Definition at line 412 of file ResourceLoaderStartUpModule.php.
|
staticprotected |
Recursively get all explicit and implicit dependencies for to the given module.
| array | $registryData | |
| string | $moduleName |
Definition at line 130 of file ResourceLoaderStartUpModule.php.
References as.
|
static |
Definition at line 289 of file ResourceLoaderStartUpModule.php.
References $wgIncludeLegacyJavaScript, and global.
Referenced by Skin\getDefaultModules().
| ResourceLoaderStartUpModule::getModuleRegistrations | ( | ResourceLoaderContext | $context | ) |
Get registration code for all modules.
| ResourceLoaderContext | $context |
Definition at line 193 of file ResourceLoaderStartUpModule.php.
References ResourceLoaderModule\$name, $out, $resourceLoader, ResourceLoaderModule\$versionHash, as, ResourceLoader\filter(), ResourceLoaderModule\getConfig(), ResourceLoaderContext\getLogger(), ResourceLoaderContext\getRequest(), ResourceLoaderContext\getResourceLoader(), ResourceLoader\inDebugMode(), ResourceLoader\makeHash(), ResourceLoader\makeLoaderRegisterScript(), and ResourceLoader\makeLoaderSourcesScript().
Referenced by getScript().
| ResourceLoaderStartUpModule::getScript | ( | ResourceLoaderContext | $context | ) |
| ResourceLoaderContext | $context |
Definition at line 330 of file ResourceLoaderStartUpModule.php.
References $IP, $out, $value, FormatJson\ALL_OK, FormatJson\encode(), ResourceLoaderModule\getConfig(), getConfigSettings(), getModuleRegistrations(), ResourceLoaderContext\getOnly(), global, and ResourceLoader\inDebugMode().
|
static |
Base modules required for the base environment of ResourceLoader.
Definition at line 285 of file ResourceLoaderStartUpModule.php.
|
static |
Get the load URL of the startup modules.
This is a helper for getScript(), but can also be called standalone, such as when generating an AppCache manifest.
| ResourceLoaderContext | $context |
Definition at line 309 of file ResourceLoaderStartUpModule.php.
References $query, ResourceLoaderContext\getDebug(), ResourceLoaderContext\getLanguage(), ResourceLoaderContext\getResourceLoader(), ResourceLoaderContext\getSkin(), ResourceLoader\makePackedModulesString(), wfAppendQuery(), and wfScript().
| ResourceLoaderStartUpModule::isRaw | ( | ) |
Definition at line 276 of file ResourceLoaderStartUpModule.php.
| ResourceLoaderStartUpModule::supportsURLLoading | ( | ) |
Definition at line 360 of file ResourceLoaderStartUpModule.php.
|
protected |
Definition at line 28 of file ResourceLoaderStartUpModule.php.
|
protected |
Definition at line 29 of file ResourceLoaderStartUpModule.php.