CiteDataModule Class Reference
Resource loader module providing extra data from the server to Cite. More...
Inheritance diagram for CiteDataModule:
Collaboration diagram for CiteDataModule:
Public Member Functions | |
| getDefinitionSummary (ResourceLoaderContext $context) | |
| @inheritDoc More... | |
| getDependencies (ResourceLoaderContext $context=null) | |
| @inheritDoc More... | |
| getScript (ResourceLoaderContext $context) | |
| @inheritDoc More... | |
 Public Member Functions inherited from ResourceLoaderModule | |
| enableModuleContentVersion () | |
| Whether to generate version hash based on module content. More... | |
| getConfig () | |
| getDeprecationInformation () | |
| Get JS representing deprecation information for the current module if available. More... | |
| getFlip ( $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... | |
| 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... | |
| shouldEmbedModule (ResourceLoaderContext $context) | |
| Check whether this module should be embeded rather than linked. More... | |
| supportsURLLoading () | |
| Whether this module supports URL loading. More... | |
Protected Attributes | |
| $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... | |
| 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, $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
Resource loader module providing extra data from the server to Cite.
Temporary hack for T93800
- Note
- 2011-2018 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
- MIT
Definition at line 11 of file CiteDataModule.php.
Member Function Documentation
◆ getDefinitionSummary()
| CiteDataModule::getDefinitionSummary | ( | ResourceLoaderContext | $context | ) |
@inheritDoc
Reimplemented from ResourceLoaderModule.
Definition at line 59 of file CiteDataModule.php.
References $context, and getScript().
◆ getDependencies()
| CiteDataModule::getDependencies | ( | ResourceLoaderContext | $context = null | ) |
@inheritDoc
Reimplemented from ResourceLoaderModule.
Definition at line 51 of file CiteDataModule.php.
◆ getScript()
| CiteDataModule::getScript | ( | ResourceLoaderContext | $context | ) |
@inheritDoc
Reimplemented from ResourceLoaderModule.
Definition at line 16 of file CiteDataModule.php.
References $context, as, and FormatJson\encode().
Referenced by getDefinitionSummary().
Member Data Documentation
◆ $targets
|
protected |
Definition at line 13 of file CiteDataModule.php.
The documentation for this class was generated from the following file:
- extensions/Cite/includes/CiteDataModule.php
