MediaWiki REL1_35
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.
 
 getDefinitionSummary (ResourceLoaderContext $context)
 
 getGroup ()
 Get group name.
 
 getScript (ResourceLoaderContext $context)
 
 getStyles (ResourceLoaderContext $context)
 
 getType ()
 
 isKnownEmpty (ResourceLoaderContext $context)
 
 shouldEmbedModule (ResourceLoaderContext $context)
 
- Public Member Functions inherited from ResourceLoaderModule
 getConfig ()
 
 getDeprecationInformation (ResourceLoaderContext $context)
 Get JS representing deprecation information for the current module if available.
 
 getFlip (ResourceLoaderContext $context)
 
 getHeaders (ResourceLoaderContext $context)
 Get headers to send as part of a module web response.
 
 getMessages ()
 Get the messages needed for this module.
 
 getModuleContent (ResourceLoaderContext $context)
 Get an array of this module's resources.
 
 getName ()
 Get this module's name.
 
 getOrigin ()
 Get this module's origin.
 
 getScriptURLsForDebug (ResourceLoaderContext $context)
 Get the URL or URLs to load for this module's JS in debug mode.
 
 getSkipFunction ()
 Get the skip function.
 
 getSource ()
 Get the source of this module.
 
 getStyleURLsForDebug (ResourceLoaderContext $context)
 Get the URL or URLs to load for this module's CSS in debug mode.
 
 getTargets ()
 Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile'].
 
 getTemplates ()
 Takes named templates by the module and returns an array mapping.
 
 getVersionHash (ResourceLoaderContext $context)
 Get a string identifying the current version of this module in a given context.
 
 setConfig (Config $config)
 
 setDependencyAccessCallbacks (callable $loadCallback, callable $saveCallback)
 Inject the functions that load/save the indirect file path dependency list from storage.
 
 setFileDependencies (ResourceLoaderContext $context, array $paths)
 Set the indirect dependencies for this module persuant to the skin/language context.
 
 setHookContainer (HookContainer $hookContainer)
 
 setLogger (LoggerInterface $logger)
 
 setMessageBlob ( $blob, $lang)
 Set in-object cache for message blobs.
 
 setName ( $name)
 Set this module's name.
 
 supportsURLLoading ()
 Whether this module supports URL loading.
 

Protected Member Functions

 getPages (ResourceLoaderContext $context)
 Get list of pages used by this module.
 
- Protected Member Functions inherited from ResourceLoaderWikiModule
 getContent ( $titleText, ResourceLoaderContext $context)
 
 getContentObj (Title $title, ResourceLoaderContext $context, $maxRedirects=null)
 
 getDB ()
 Get the Database handle used for computing the module version.
 
 getTitleInfo (ResourceLoaderContext $context)
 Get the information about the wiki pages for a given context.
 
- Protected Member Functions inherited from ResourceLoaderModule
 buildContent (ResourceLoaderContext $context)
 Bundle all resources attached to this module into an array.
 
 getFileDependencies (ResourceLoaderContext $context)
 Get the indirect dependencies for this module persuant to the skin/language context.
 
 getHookRunner ()
 Get a HookRunner for running core hooks.
 
 getLessVars (ResourceLoaderContext $context)
 Get module-specific LESS variables, if any.
 
 getLogger ()
 
 getMessageBlob (ResourceLoaderContext $context)
 Get the hash of the message blob.
 
 getPreloadLinks (ResourceLoaderContext $context)
 Get a list of resources that web browsers may preload.
 
 saveFileDependencies (ResourceLoaderContext $context, array $curFileRefs)
 Save the indirect dependencies for this module persuant to the skin/language context.
 
 validateScriptFile ( $fileName, $contents)
 Validate a given script file; if valid returns the original source.
 

Protected Attributes

string[] $targets = [ 'desktop', 'mobile' ]
 What client platforms the module targets (e.g.
 
- Protected Attributes inherited from ResourceLoaderWikiModule
 $group
 
 $origin = self::ORIGIN_USER_SITEWIDE
 
 $scripts = []
 
 $styles = []
 
 $titleInfo = []
 
- Protected Attributes inherited from ResourceLoaderModule
Config $config
 
array $contents = []
 Map of (context hash => cached module content)
 
string bool $deprecated = false
 Deprecation string or true if deprecated; false otherwise.
 
array $fileDeps = []
 Map of (variant => indirect file dependencies)
 
LoggerInterface $logger
 
array $msgBlobs = []
 Map of (language => in-object cache for message blob)
 
string null $name = null
 Module name.
 
int $origin = self::ORIGIN_CORE_SITEWIDE
 Script and style modules form a hierarchy of trustworthiness, with core modules like skins and jQuery as most trustworthy, and user scripts as least trustworthy.
 
string[] $targets = [ 'desktop' ]
 What client platforms the module targets (e.g.
 
array $versionHash = []
 Map of (context hash => cached module version hash)
 

Additional Inherited Members

- Static Public Member Functions inherited from ResourceLoaderWikiModule
static invalidateModuleCache (Title $title, ?RevisionRecord $old, ?RevisionRecord $new, $domain)
 Clear the preloadTitleInfo() cache for all wiki modules on this wiki on page change if it was a JS or CSS page.
 
static preloadTitleInfo (ResourceLoaderContext $context, IDatabase $db, array $moduleNames)
 
- Static Public Member Functions inherited from ResourceLoaderModule
static expandRelativePaths (array $filePaths)
 Expand directories relative to $IP.
 
static getRelativePaths (array $filePaths)
 Make file paths relative to MediaWiki directory.
 
static getVary (ResourceLoaderContext $context)
 Get vary string.
 
- Static Protected Member Functions inherited from ResourceLoaderWikiModule
static fetchTitleInfo (IDatabase $db, array $pages, $fname=__METHOD__)
 
- Static Protected Member Functions inherited from ResourceLoaderModule
static safeFileHash ( $filePath)
 Compute a non-cryptographic string hash of a file's contents.
 

Detailed Description

Module for site customizations.

Definition at line 29 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 54 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 39 of file ResourceLoaderSiteModule.php.

References ResourceLoaderModule\getConfig(), ResourceLoaderModule\getHookRunner(), and ResourceLoaderContext\getSkin().

Member Data Documentation

◆ $targets

string [] ResourceLoaderSiteModule::$targets = [ 'desktop', 'mobile' ]
protected

What client platforms the module targets (e.g.

desktop, mobile)

Definition at line 31 of file ResourceLoaderSiteModule.php.


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