Public Member Functions | |
| 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... | |
| getScript (ResourceLoaderContext $context) | |
| Get all JS for this module for a given language and skin. More... | |
 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... | |
| 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 () | |
| From where in the page HTML should this module be loaded? 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... | |
Protected Attributes | |
| $origin = self::ORIGIN_USER_SITEWIDE | |
| $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 | |
| 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... | |
| 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' |
| Protected Member Functions inherited from ResourceLoaderModule | |
| 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 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... | |
Detailed Description
Definition at line 13 of file CiteDataModule.php.
Member Function Documentation
◆ getDefinitionSummary()
| CiteDataModule::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.
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
Reimplemented from ResourceLoaderModule.
Definition at line 64 of file CiteDataModule.php.
References $context, and getScript().
◆ getDependencies()
| CiteDataModule::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
Reimplemented from ResourceLoaderModule.
Definition at line 57 of file CiteDataModule.php.
◆ getScript()
| CiteDataModule::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
Reimplemented from ResourceLoaderModule.
Definition at line 22 of file CiteDataModule.php.
References $context, as, FormatJson\encode(), and ContextSource\msg().
Referenced by getDefinitionSummary().
Member Data Documentation
◆ $origin
|
protected |
Definition at line 17 of file CiteDataModule.php.
◆ $targets
|
protected |
Definition at line 18 of file CiteDataModule.php.
The documentation for this class was generated from the following file:
- extensions/Cite/includes/CiteDataModule.php
