MediaWiki  1.30.0
ResourceLoaderSpecialCharacterDataModule Class Reference

ResourceLoader module for populating special characters data for some editing extensions to use. More...

Inheritance diagram for ResourceLoaderSpecialCharacterDataModule:
Collaboration diagram for ResourceLoaderSpecialCharacterDataModule:

Public Member Functions

 enableModuleContentVersion ()
 
 getDependencies (ResourceLoaderContext $context=null)
 
 getMessages ()
 
 getScript (ResourceLoaderContext $context)
 
- Public Member Functions inherited from ResourceLoaderModule
 getConfig ()
 
 getDefinitionMtime (ResourceLoaderContext $context)
 Back-compat dummy for old subclass implementations of getModifiedTime(). More...
 
 getDefinitionSummary (ResourceLoaderContext $context)
 Get a list of resources that web browsers may preload. 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...
 
 getHeaders (ResourceLoaderContext $context)
 Get headers to send as part of a module web response. 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...
 
 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...
 
 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 Member Functions

 getData ()
 Get all the dynamic data. More...
 
- Protected Member Functions inherited from ResourceLoaderModule
 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...
 
 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...
 

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 = []
 

Private Attributes

 $path = "resources/src/mediawiki.language/specialcharacters.json"
 

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'
 
- 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

ResourceLoader module for populating special characters data for some editing extensions to use.

Definition at line 28 of file ResourceLoaderSpecialCharacterDataModule.php.

Member Function Documentation

◆ enableModuleContentVersion()

ResourceLoaderSpecialCharacterDataModule::enableModuleContentVersion ( )
Returns
bool

Definition at line 59 of file ResourceLoaderSpecialCharacterDataModule.php.

◆ getData()

ResourceLoaderSpecialCharacterDataModule::getData ( )
protected

Get all the dynamic data.

Returns
array

Definition at line 37 of file ResourceLoaderSpecialCharacterDataModule.php.

References $IP, and global.

Referenced by getScript().

◆ getDependencies()

ResourceLoaderSpecialCharacterDataModule::getDependencies ( ResourceLoaderContext  $context = null)
Parameters
ResourceLoaderContext$context
Returns
array

Reimplemented from ResourceLoaderModule.

Definition at line 67 of file ResourceLoaderSpecialCharacterDataModule.php.

◆ getMessages()

ResourceLoaderSpecialCharacterDataModule::getMessages ( )
Returns
array

Reimplemented from ResourceLoaderModule.

Definition at line 74 of file ResourceLoaderSpecialCharacterDataModule.php.

◆ getScript()

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

Reimplemented from ResourceLoaderModule.

Definition at line 46 of file ResourceLoaderSpecialCharacterDataModule.php.

References Xml\encodeJsCall(), and getData().

Member Data Documentation

◆ $path

ResourceLoaderSpecialCharacterDataModule::$path = "resources/src/mediawiki.language/specialcharacters.json"
private

Definition at line 29 of file ResourceLoaderSpecialCharacterDataModule.php.

◆ $targets

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

Definition at line 30 of file ResourceLoaderSpecialCharacterDataModule.php.


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