MediaWiki  1.23.0
ResourceLoaderSiteModule Class Reference

Module for site customizations. More...

Inheritance diagram for ResourceLoaderSiteModule:
Collaboration diagram for ResourceLoaderSiteModule:

Public Member Functions

 getGroup ()
 Gets group name. More...
 
- Public Member Functions inherited from ResourceLoaderWikiModule
 getDefinitionSummary (ResourceLoaderContext $context)
 Get the definition summary for this module. More...
 
 getModifiedTime (ResourceLoaderContext $context)
 
 getScript (ResourceLoaderContext $context)
 
 getStyles (ResourceLoaderContext $context)
 
 isKnownEmpty (ResourceLoaderContext $context)
 
- Public Member Functions inherited from ResourceLoaderModule
 getDefinitionMtime (ResourceLoaderContext $context)
 Helper method for calculating when this module's definition summary was last changed. More...
 
 getDependencies ()
 Get a list of modules this module depends on. More...
 
 getFileDependencies ( $skin)
 Get the files this module depends on indirectly for a given skin. More...
 
 getFlip ( $context)
 
 getHashMtime (ResourceLoaderContext $context)
 Helper method for calculating when the module's hash (if it has one) changed. More...
 
 getLoaderScript ()
 Get the loader JS for this module, if set. More...
 
 getMessages ()
 Get the messages needed for this module. More...
 
 getModifiedHash (ResourceLoaderContext $context)
 Get the hash for whatever this module may contain. More...
 
 getMsgBlobMtime ( $lang)
 Get the last modification timestamp of the message blob for this module in a given language. 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...
 
 getScriptURLsForDebug (ResourceLoaderContext $context)
 Get the URL or URLs to load for this module's JS in debug mode. More...
 
 getSource ()
 Get the origin of this module. 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...
 
 isRaw ()
 Whether this module's JS expects to work without the client-side ResourceLoader module. More...
 
 setFileDependencies ( $skin, $deps)
 Set preloaded file dependency information. More...
 
 setMsgBlobMtime ( $lang, $mtime)
 Set a preloaded message blob last modification timestamp. More...
 
 setName ( $name)
 Set this module's name. More...
 
 setOrigin ( $origin)
 Set this module's origin. More...
 
 supportsURLLoading ()
 Whether this module supports URL loading. More...
 

Protected Member Functions

 getPages (ResourceLoaderContext $context)
 Gets list of pages used by this module. More...
 
- Protected Member Functions inherited from ResourceLoaderWikiModule
 getContent ( $title)
 
 getDB ()
 Get the Database object used in getTitleMTimes(). More...
 
 getTitleMtimes (ResourceLoaderContext $context)
 Get the modification times of all titles that would be loaded for a given context. More...
 
- Protected Member Functions inherited from ResourceLoaderModule
 validateScriptFile ( $fileName, $contents)
 Validate a given script file; if valid returns the original source. More...
 

Additional Inherited Members

- Public Attributes inherited from ResourceLoaderModule
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_MESSAGES = 'messages'
 
const TYPE_SCRIPTS = 'scripts'
 
const TYPE_STYLES = 'styles'
 
- Static Protected Member Functions inherited from ResourceLoaderModule
static javaScriptParser ()
 
static safeFilemtime ( $filename)
 Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist but returns 1 instead. More...
 
- Protected Attributes inherited from ResourceLoaderWikiModule
 $origin = self::ORIGIN_USER_SITEWIDE
 
 $titleMtimes = array()
 
- Protected Attributes inherited from ResourceLoaderModule
 $fileDeps = array()
 
 $msgBlobMtime = array()
 
 $name = null
 
 $origin = self::ORIGIN_CORE_SITEWIDE
 
 $targets = array( 'desktop' )
 

Detailed Description

Module for site customizations.

Definition at line 28 of file ResourceLoaderSiteModule.php.

Member Function Documentation

◆ getGroup()

ResourceLoaderSiteModule::getGroup ( )

Gets group name.

Returns
String: Name of group

Reimplemented from ResourceLoaderModule.

Definition at line 63 of file ResourceLoaderSiteModule.php.

◆ getPages()

ResourceLoaderSiteModule::getPages ( ResourceLoaderContext  $context)
protected

Gets list of pages used by this module.

Parameters
$contextResourceLoaderContext
Returns
Array: List of pages

Reimplemented from ResourceLoaderWikiModule.

Definition at line 39 of file ResourceLoaderSiteModule.php.

References array(), ResourceLoaderContext\getSkin(), and global.


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