MediaWiki  master
ResourceLoaderWikiModule Class Reference

Abstraction for ResourceLoader modules which pull from wiki pages. More...

Inheritance diagram for ResourceLoaderWikiModule:
Collaboration diagram for ResourceLoaderWikiModule:

Public Member Functions

 __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
 enableModuleContentVersion ()
 Whether to generate version hash based on module content. More...
 
 getConfig ()
 
 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...
 
 getDeprecationInformation (ResourceLoaderContext $context)
 Get JS representing deprecation information for the current module if available. More...
 
 getFlip (ResourceLoaderContext $context)
 
 getGroup ()
 Get the group this module is in. More...
 
 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...
 
 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 source 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...
 
 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...
 

Static Public Member Functions

static invalidateModuleCache (Title $title, ?Revision $old, ?Revision $new, $domain)
 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...
 
static getVary (ResourceLoaderContext $context)
 Get vary string. More...
 

Protected Member Functions

 getContent ( $titleText, ResourceLoaderContext $context)
 
 getContentObj (Title $title, ResourceLoaderContext $context, $maxRedirects=null)
 
 getDB ()
 Get the Database handle used for computing the module version. More...
 
 getPages (ResourceLoaderContext $context)
 Subclasses should return an associative array of resources in the module. 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, array $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...
 

Static Protected Member Functions

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

 $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) More...
 
string bool $deprecated = false
 Deprecation string or true if deprecated; false otherwise. More...
 
array $fileDeps = []
 Map of (variant => indirect file dependencies) More...
 
LoggerInterface $logger
 
array $msgBlobs = []
 Map of (language => in-object cache for message blob) More...
 
string null $name = null
 Module name. More...
 
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. More...
 
string [] $targets = [ 'desktop' ]
 What client platforms the module targets (e.g. More...
 
array $versionHash = []
 Map of (context hash => cached module version hash) More...
 

Private Member Functions

 setTitleInfo ( $batchKey, array $titleInfo)
 

Static Private Member Functions

static makeTitleKey (LinkTarget $title)
 

Detailed Description

Abstraction for ResourceLoader modules which pull from wiki pages.

This can only be used for wiki pages in the MediaWiki and User namespaces, because of its dependence on the functionality of Title::isUserConfigPage() and Title::isSiteConfigPage().

This module supports being used as a placeholder for a module on a remote wiki. To do so, getDB() must be overloaded to return a foreign database object that allows local wikis to query page metadata.

Safe for calls on local wikis are:

Since
1.17

Definition at line 54 of file ResourceLoaderWikiModule.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoaderWikiModule::__construct ( array  $options = null)
Parameters
array | null$optionsFor back-compat, this can be omitted in favour of overwriting getPages.

Definition at line 87 of file ResourceLoaderWikiModule.php.

Member Function Documentation

◆ enableModuleContentVersion()

ResourceLoaderWikiModule::enableModuleContentVersion ( )

Disable module content versioning.

This class does not support generating content outside of a module request due to foreign database support.

See getDefinitionSummary() for meta-data versioning.

Returns
bool

Definition at line 323 of file ResourceLoaderWikiModule.php.

◆ fetchTitleInfo()

static ResourceLoaderWikiModule::fetchTitleInfo ( IDatabase  $db,
array  $pages,
  $fname = __METHOD__ 
)
staticprotected
Parameters
IDatabase$db
array$pages
string$fname
Returns
array

Definition at line 420 of file ResourceLoaderWikiModule.php.

References $res, $title, $titleInfo, Title\newFromText(), and Wikimedia\Rdbms\IDatabase\select().

◆ getContent()

ResourceLoaderWikiModule::getContent (   $titleText,
ResourceLoaderContext  $context 
)
protected
Parameters
string$titleText
ResourceLoaderContext$context
Returns
null|string
Since
1.32 added the $context parameter

Definition at line 174 of file ResourceLoaderWikiModule.php.

References $content, $title, CONTENT_FORMAT_CSS, CONTENT_FORMAT_JAVASCRIPT, getContentObj(), and Title\newFromText().

Referenced by getScript(), and getStyles().

◆ getContentObj()

ResourceLoaderWikiModule::getContentObj ( Title  $title,
ResourceLoaderContext  $context,
  $maxRedirects = null 
)
protected
Parameters
Title$title
ResourceLoaderContext$context
int | null$maxRedirectsMaximum number of redirects to follow. If null, uses $wgMaxRedirects
Returns
Content|null
Since
1.32 added the $context and $maxRedirects parameters

Definition at line 205 of file ResourceLoaderWikiModule.php.

References $content, DB_REPLICA, ResourceLoaderModule\getConfig(), ResourceLoaderContext\getContentOverrideCallback(), ResourceLoaderModule\getLogger(), Title\getPrefixedText(), Revision\newKnownCurrent(), and wfGetDB().

Referenced by getContent().

◆ getDB()

ResourceLoaderWikiModule::getDB ( )
protected

Get the Database handle used for computing the module version.

Subclasses may override this to return a foreign database, which would allow them to register a module on wiki A that fetches wiki pages from wiki B.

The way this works is that the local module is a placeholder that can only computer a module version hash. The 'source' of the module must be set to the foreign wiki directly. Methods getScript() and getContent() will not use this handle and are not valid on the local wiki.

Returns
IDatabase

Definition at line 164 of file ResourceLoaderWikiModule.php.

References DB_REPLICA, and wfGetDB().

Referenced by getTitleInfo().

◆ getDefinitionSummary()

ResourceLoaderWikiModule::getDefinitionSummary ( ResourceLoaderContext  $context)
Parameters
ResourceLoaderContext$context
Returns
array

Definition at line 331 of file ResourceLoaderWikiModule.php.

References getPages(), and getTitleInfo().

◆ getGroup()

ResourceLoaderWikiModule::getGroup ( )

Get group name.

Returns
string

Definition at line 146 of file ResourceLoaderWikiModule.php.

References $group.

Referenced by isKnownEmpty().

◆ getPages()

ResourceLoaderWikiModule::getPages ( ResourceLoaderContext  $context)
protected

Subclasses should return an associative array of resources in the module.

Keys should be the title of a page in the MediaWiki or User namespace.

Values should be a nested array of options. The supported keys are 'type' and (CSS only) 'media'.

For scripts, 'type' should be 'script'.

For stylesheets, 'type' should be 'style'. There is an optional media key, the value of which can be the medium ('screen', 'print', etc.) of the stylesheet.

Parameters
ResourceLoaderContext$context
Returns
array[] -return array<string,array{type:string,media?:string}>

Definition at line 121 of file ResourceLoaderWikiModule.php.

References ResourceLoaderModule\$config, Config\get(), and ResourceLoaderModule\getConfig().

Referenced by getDefinitionSummary(), getScript(), getStyles(), getTitleInfo(), and shouldEmbedModule().

◆ getScript()

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

Definition at line 269 of file ResourceLoaderWikiModule.php.

References $scripts, getContent(), getPages(), ResourceLoader\makeComment(), and ResourceLoaderModule\validateScriptFile().

◆ getStyles()

ResourceLoaderWikiModule::getStyles ( ResourceLoaderContext  $context)

◆ getTitleInfo()

ResourceLoaderWikiModule::getTitleInfo ( ResourceLoaderContext  $context)
protected

Get the information about the wiki pages for a given context.

Parameters
ResourceLoaderContext$context
Returns
array[] Keyed by page name

Definition at line 383 of file ResourceLoaderWikiModule.php.

References $content, $dbr, $title, $titleInfo, ResourceLoaderContext\getContentOverrideCallback(), getDB(), getPages(), and Title\newFromText().

Referenced by getDefinitionSummary(), and isKnownEmpty().

◆ getType()

ResourceLoaderWikiModule::getType ( )
Since
1.28
Returns
string

Definition at line 568 of file ResourceLoaderWikiModule.php.

◆ invalidateModuleCache()

static ResourceLoaderWikiModule::invalidateModuleCache ( Title  $title,
?Revision  $old,
?Revision  $new,
  $domain 
)
static

Clear the preloadTitleInfo() cache for all wiki modules on this wiki on page change if it was a JS or CSS page.

Parameters
Title$title
Revision | null$oldPrior page revision
Revision | null$newNew page revision
string$domainDatabase domain ID
Since
1.28

Definition at line 540 of file ResourceLoaderWikiModule.php.

References $cache, CONTENT_FORMAT_CSS, CONTENT_FORMAT_JAVASCRIPT, Revision\getContentFormat(), Title\isSiteConfigPage(), and Title\isUserConfigPage().

Referenced by WikiPage\doDeleteUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), and Title\invalidateCache().

◆ isKnownEmpty()

ResourceLoaderWikiModule::isKnownEmpty ( ResourceLoaderContext  $context)
Parameters
ResourceLoaderContext$context
Returns
bool

Definition at line 345 of file ResourceLoaderWikiModule.php.

References ResourceLoaderModule\getDependencies(), getGroup(), and getTitleInfo().

◆ makeTitleKey()

static ResourceLoaderWikiModule::makeTitleKey ( LinkTarget  $title)
staticprivate

Definition at line 373 of file ResourceLoaderWikiModule.php.

◆ preloadTitleInfo()

static ResourceLoaderWikiModule::preloadTitleInfo ( ResourceLoaderContext  $context,
IDatabase  $db,
array  $moduleNames 
)
static

◆ setTitleInfo()

ResourceLoaderWikiModule::setTitleInfo (   $batchKey,
array  $titleInfo 
)
private

Definition at line 369 of file ResourceLoaderWikiModule.php.

References $titleInfo.

◆ shouldEmbedModule()

ResourceLoaderWikiModule::shouldEmbedModule ( ResourceLoaderContext  $context)

Member Data Documentation

◆ $group

ResourceLoaderWikiModule::$group
protected

◆ $origin

ResourceLoaderWikiModule::$origin = self::ORIGIN_USER_SITEWIDE
protected

Definition at line 57 of file ResourceLoaderWikiModule.php.

◆ $scripts

ResourceLoaderWikiModule::$scripts = []
protected

Definition at line 78 of file ResourceLoaderWikiModule.php.

Referenced by getScript().

◆ $styles

ResourceLoaderWikiModule::$styles = []
protected

Definition at line 75 of file ResourceLoaderWikiModule.php.

Referenced by getStyles().

◆ $titleInfo

ResourceLoaderWikiModule::$titleInfo = []
protected

Definition at line 72 of file ResourceLoaderWikiModule.php.

Referenced by fetchTitleInfo(), getTitleInfo(), and setTitleInfo().


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