MediaWiki  1.32.5
ResourceLoaderSiteModule Class Reference

Module for site customizations. More...

Inheritance diagram for ResourceLoaderSiteModule:
Collaboration diagram for ResourceLoaderSiteModule:

Public Member Functions

 getDependencies (ResourceLoaderContext $context=null)
 
- Public Member Functions inherited from ResourceLoaderWikiModule
 __construct (array $options=null)
 
 enableModuleContentVersion ()
 Disable module content versioning. More...
 
 getDefinitionSummary (ResourceLoaderContext $context)
 
 getGroup ()
 Get group name. More...
 
 getScript (ResourceLoaderContext $context)
 
 getStyles (ResourceLoaderContext $context)
 
 getType ()
 
 isKnownEmpty (ResourceLoaderContext $context)
 
 shouldEmbedModule (ResourceLoaderContext $context)
 
- Public Member Functions inherited from ResourceLoaderModule
 getConfig ()
 
 getDeprecationInformation ()
 Get JS representing deprecation information for the current module if available. More...
 
 getFlip ( $context)
 
 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...
 
 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...
 
 getVersionHash (ResourceLoaderContext $context)
 Get a string identifying the current version of this module in a given context. 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

 getPages (ResourceLoaderContext $context)
 Get list of pages used by this module. More...
 
- Protected Member Functions inherited from ResourceLoaderWikiModule
 getContent ( $titleText, ResourceLoaderContext $context=null)
 
 getContentObj (Title $title, ResourceLoaderContext $context=null, $maxRedirects=null)
 
 getDB ()
 Get the Database object used in getTitleInfo(). More...
 
 getTitleInfo (ResourceLoaderContext $context)
 Get the information about the wiki pages for a given context. More...
 
- 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from ResourceLoaderWikiModule
static invalidateModuleCache (Title $title, Revision $old=null, Revision $new=null, $wikiId)
 Clear the preloadTitleInfo() cache for all wiki modules on this wiki on page change if it was a JS or CSS page. More...
 
static preloadTitleInfo (ResourceLoaderContext $context, IDatabase $db, array $moduleNames)
 
- 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 ResourceLoaderWikiModule
static fetchTitleInfo (IDatabase $db, array $pages, $fname=__METHOD__)
 
- 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...
 
- Protected Attributes inherited from ResourceLoaderWikiModule
 $group
 
 $origin = self::ORIGIN_USER_SITEWIDE
 
 $scripts = []
 
 $styles = []
 
 $titleInfo = []
 
- 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 = []
 

Detailed Description

Module for site customizations.

Definition at line 28 of file ResourceLoaderSiteModule.php.

Member Function Documentation

◆ getDependencies()

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

Reimplemented from ResourceLoaderModule.

Definition at line 49 of file ResourceLoaderSiteModule.php.

◆ getPages()

ResourceLoaderSiteModule::getPages ( ResourceLoaderContext  $context)
protected

Get list of pages used by this module.

Parameters
ResourceLoaderContext$context
Returns
array List of pages

Reimplemented from ResourceLoaderWikiModule.

Definition at line 36 of file ResourceLoaderSiteModule.php.

References $context, and ResourceLoaderModule\getConfig().


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