MediaWiki REL1_28
|
Public Member Functions | |
getDefinitionSummary (ResourceLoaderContext $context) | |
Get the definition summary for this module. | |
getGroup () | |
getModuleRegistrations (ResourceLoaderContext $context) | |
Get registration code for all modules. | |
getScript (ResourceLoaderContext $context) | |
isRaw () | |
supportsURLLoading () | |
Public Member Functions inherited from ResourceLoaderModule | |
enableModuleContentVersion () | |
Whether to generate version hash based on module content. | |
getConfig () | |
getDefinitionMtime (ResourceLoaderContext $context) | |
Back-compat dummy for old subclass implementations of getModifiedTime(). | |
getDependencies (ResourceLoaderContext $context=null) | |
Get a list of modules this module depends on. | |
getFlip ( $context) | |
getHashMtime (ResourceLoaderContext $context) | |
Back-compat dummy for old subclass implementations of getModifiedTime(). | |
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. | |
getPosition () | |
Where on the HTML page should this module's JS be loaded? | |
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. | |
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' |
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 178 of file ResourceLoaderStartUpModule.php.
References ResourceLoaderModule\$name, as, and getImplicitDependencies().
Referenced by getModuleRegistrations().
|
protected |
Helper method for getDefinitionSummary().
ResourceLoaderContext | $context |
Definition at line 392 of file ResourceLoaderStartUpModule.php.
References $context.
Referenced by getDefinitionSummary().
|
protected |
ResourceLoaderContext | $context |
Definition at line 35 of file ResourceLoaderStartUpModule.php.
References $context, ResourceLoaderModule\$name, $vars, $wgContLang, as, ResourceLoaderModule\getConfig(), getLegacyModules(), Skin\getSkinNames(), global, object, wfScript(), and wfUrlProtocols().
Referenced by getDefinitionSummary(), and getScript().
ResourceLoaderStartUpModule::getDefinitionSummary | ( | ResourceLoaderContext | $context | ) |
Get the definition summary for this module.
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 368 of file ResourceLoaderStartUpModule.php.
References $context, $IP, $summary, getAllModuleHashes(), ResourceLoaderModule\getConfig(), getConfigSettings(), and global.
ResourceLoaderStartUpModule::getGroup | ( | ) |
Reimplemented from ResourceLoaderModule.
Definition at line 410 of file ResourceLoaderStartUpModule.php.
|
staticprotected |
Recursively get all explicit and implicit dependencies for to the given module.
array | $registryData | |
string | $moduleName |
Definition at line 133 of file ResourceLoaderStartUpModule.php.
References as.
Referenced by compileUnresolvedDependencies().
|
static |
Definition at line 292 of file ResourceLoaderStartUpModule.php.
References $wgIncludeLegacyJavaScript, and global.
Referenced by getConfigSettings(), and Skin\getDefaultModules().
ResourceLoaderStartUpModule::getModuleRegistrations | ( | ResourceLoaderContext | $context | ) |
Get registration code for all modules.
ResourceLoaderContext | $context |
Definition at line 196 of file ResourceLoaderStartUpModule.php.
References $context, ResourceLoaderModule\$name, $out, $resourceLoader, ResourceLoaderModule\$versionHash, as, compileUnresolvedDependencies(), ResourceLoader\filter(), ResourceLoaderModule\getConfig(), ContextSource\getRequest(), ResourceLoader\inDebugMode(), ResourceLoader\makeHash(), ResourceLoader\makeLoaderRegisterScript(), and ResourceLoader\makeLoaderSourcesScript().
Referenced by getScript().
ResourceLoaderStartUpModule::getScript | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 328 of file ResourceLoaderStartUpModule.php.
References $context, $IP, $out, $value, ResourceLoaderModule\getConfig(), getConfigSettings(), getModuleRegistrations(), getStartupModulesUrl(), global, and ResourceLoader\inDebugMode().
|
static |
Base modules required for the base environment of ResourceLoader.
Definition at line 288 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 312 of file ResourceLoaderStartUpModule.php.
References $context.
Referenced by getScript().
ResourceLoaderStartUpModule::isRaw | ( | ) |
Reimplemented from ResourceLoaderModule.
Definition at line 279 of file ResourceLoaderStartUpModule.php.
ResourceLoaderStartUpModule::supportsURLLoading | ( | ) |
Reimplemented from ResourceLoaderModule.
Definition at line 358 of file ResourceLoaderStartUpModule.php.
|
protected |
Definition at line 28 of file ResourceLoaderStartUpModule.php.
|
protected |
Definition at line 29 of file ResourceLoaderStartUpModule.php.