MediaWiki  1.28.0
ResourceLoaderLanguageNamesModule Class Reference

ResourceLoader module for populating language specific data. More...

Inheritance diagram for ResourceLoaderLanguageNamesModule:
Collaboration diagram for ResourceLoaderLanguageNamesModule:

Public Member Functions

 enableModuleContentVersion ()
 
 getDependencies (ResourceLoaderContext $context=null)
 
 getScript (ResourceLoaderContext $context)
 
- 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...
 

Protected Member Functions

 getData (ResourceLoaderContext $context)
 
- 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...
 

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'
 
- 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 language specific data.

Definition at line 31 of file ResourceLoaderLanguageNamesModule.php.

Member Function Documentation

ResourceLoaderLanguageNamesModule::enableModuleContentVersion ( )
Returns
bool

Definition at line 73 of file ResourceLoaderLanguageNamesModule.php.

ResourceLoaderLanguageNamesModule::getData ( ResourceLoaderContext  $context)
protected
Parameters
ResourceLoaderContext$context
Returns
array

Definition at line 39 of file ResourceLoaderLanguageNamesModule.php.

References Language\fetchLanguageNames(), and ResourceLoaderContext\getLanguage().

Referenced by getScript().

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

Definition at line 66 of file ResourceLoaderLanguageNamesModule.php.

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

Definition at line 50 of file ResourceLoaderLanguageNamesModule.php.

References Xml\encodeJsCall(), getData(), ResourceLoaderContext\getLanguage(), and ResourceLoader\inDebugMode().

Member Data Documentation

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

Definition at line 33 of file ResourceLoaderLanguageNamesModule.php.


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