MediaWiki
1.33.0
|
Abstraction for ResourceLoader modules which pull from wiki pages. More...
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 | |
getConfig () | |
getDependencies (ResourceLoaderContext $context=null) | |
Get a list of modules this module depends on. More... | |
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... | |
Static Public Member Functions | |
static | invalidateModuleCache (Title $title, Revision $old=null, Revision $new=null, $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... | |
Protected Member Functions | |
getContent ( $titleText, ResourceLoaderContext $context=null) | |
getContentObj (Title $title, ResourceLoaderContext $context=null, $maxRedirects=null) | |
getDB () | |
Get the Database object used in getTitleInfo(). 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, $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 |
$contents = [] | |
array bool | $deprecated = false |
$fileDeps = [] | |
LoggerInterface | $logger |
$msgBlobs = [] | |
$name = null | |
$origin = self::ORIGIN_CORE_SITEWIDE | |
$targets = [ 'desktop' ] | |
$versionHash = [] | |
Private Member Functions | |
setTitleInfo ( $batchKey, array $titleInfo) | |
Static Private Member Functions | |
static | makeTitleKey (LinkTarget $title) |
Additional Inherited Members | |
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' |
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:
Definition at line 51 of file ResourceLoaderWikiModule.php.
array | null | $options | For back-compat, this can be omitted in favour of overwriting getPages. |
Reimplemented in GadgetResourceLoaderModule.
Definition at line 84 of file ResourceLoaderWikiModule.php.
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.
Reimplemented from ResourceLoaderModule.
Definition at line 320 of file ResourceLoaderWikiModule.php.
|
staticprotected |
Reimplemented in TestResourceLoaderWikiModule.
Definition at line 415 of file ResourceLoaderWikiModule.php.
References $batch, $fname, $res, $title, $titleInfo, as, makeTitleKey(), Title\newFromText(), and Wikimedia\Rdbms\IDatabase\select().
|
protected |
string | $titleText | |
ResourceLoaderContext | null | $context | (but passing null is deprecated) |
Definition at line 167 of file ResourceLoaderWikiModule.php.
References $content, $context, $handler, $title, CONTENT_FORMAT_CSS, CONTENT_FORMAT_JAVASCRIPT, getContentObj(), and Title\newFromText().
Referenced by getScript(), and getStyles().
|
protected |
Title | $title | |
ResourceLoaderContext | null | $context | (but passing null is deprecated) |
int | null | $maxRedirects | Maximum number of redirects to follow. If null, uses $wgMaxRedirects |
Definition at line 198 of file ResourceLoaderWikiModule.php.
References $content, $context, $title, DB_REPLICA, ResourceLoaderModule\getConfig(), ResourceLoaderModule\getLogger(), Revision\newKnownCurrent(), Revision\RAW, wfDeprecated(), and wfGetDB().
Referenced by getContent().
|
protected |
Get the Database object used in getTitleInfo().
Defaults to the local replica DB. Subclasses may want to override this to return a foreign database object, or null if getTitleInfo() shouldn't access the database.
NOTE: This ONLY works for getTitleInfo() and isKnownEmpty(), NOT FOR ANYTHING ELSE. In particular, it doesn't work for getContent() or getScript() etc.
Definition at line 157 of file ResourceLoaderWikiModule.php.
References DB_REPLICA, and wfGetDB().
Referenced by getTitleInfo().
ResourceLoaderWikiModule::getDefinitionSummary | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 328 of file ResourceLoaderWikiModule.php.
References $context, getPages(), and getTitleInfo().
ResourceLoaderWikiModule::getGroup | ( | ) |
Get group name.
Reimplemented from ResourceLoaderModule.
Reimplemented in GadgetResourceLoaderModule, ResourceLoaderUserStylesModule, ResourceLoaderUserModule, and ResourceLoaderSiteStylesModule.
Definition at line 142 of file ResourceLoaderWikiModule.php.
References $group.
Referenced by isKnownEmpty().
|
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.
ResourceLoaderContext | $context |
Reimplemented in GadgetResourceLoaderModule, ResourceLoaderSiteModule, ResourceLoaderSiteStylesModule, ResourceLoaderUserModule, and ResourceLoaderUserStylesModule.
Definition at line 117 of file ResourceLoaderWikiModule.php.
References ResourceLoaderModule\$config, as, Config\get(), ResourceLoaderModule\getConfig(), and scripts.
Referenced by getDefinitionSummary(), getScript(), getStyles(), getTitleInfo(), and shouldEmbedModule().
ResourceLoaderWikiModule::getScript | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 266 of file ResourceLoaderWikiModule.php.
References $context, $options, $scripts, as, getContent(), getPages(), and ResourceLoaderModule\validateScriptFile().
ResourceLoaderWikiModule::getStyles | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 285 of file ResourceLoaderWikiModule.php.
References $context, $options, $styles, as, MemoizedCallable\call(), ResourceLoaderModule\getConfig(), getContent(), ResourceLoaderModule\getFlip(), and getPages().
|
protected |
Get the information about the wiki pages for a given context.
ResourceLoaderContext | $context |
Definition at line 380 of file ResourceLoaderWikiModule.php.
References $content, $context, $dbr, $title, $titleInfo, as, getDB(), getPages(), Title\newFromText(), and wfTimestamp().
Referenced by getDefinitionSummary(), and isKnownEmpty().
ResourceLoaderWikiModule::getType | ( | ) |
Reimplemented from ResourceLoaderModule.
Reimplemented in GadgetResourceLoaderModule, ResourceLoaderUserStylesModule, and ResourceLoaderSiteStylesModule.
Definition at line 563 of file ResourceLoaderWikiModule.php.
References ResourceLoaderModule\LOAD_GENERAL, ResourceLoaderModule\LOAD_STYLES, and scripts.
|
static |
Clear the preloadTitleInfo() cache for all wiki modules on this wiki on page change if it was a JS or CSS page.
Title | $title | |
Revision | null | $old | Prior page revision |
Revision | null | $new | New page revision |
string | $domain | Database domain ID |
Definition at line 535 of file ResourceLoaderWikiModule.php.
References $cache, $title, CONTENT_FORMAT_CSS, and CONTENT_FORMAT_JAVASCRIPT.
Referenced by WikiPage\doDeleteUpdates(), MediaWiki\Storage\DerivedPageDataUpdater\doUpdates(), Title\invalidateCache(), and ResourceLoaderWikiModuleTest\testGetPreloadedTitleInfo().
ResourceLoaderWikiModule::isKnownEmpty | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 342 of file ResourceLoaderWikiModule.php.
References as, captcha-old\count, ResourceLoaderModule\getDependencies(), getGroup(), and getTitleInfo().
|
staticprivate |
Definition at line 370 of file ResourceLoaderWikiModule.php.
Referenced by fetchTitleInfo(), and preloadTitleInfo().
|
static |
ResourceLoaderContext | $context | |
IDatabase | $db | |
string[] | $moduleNames |
Definition at line 452 of file ResourceLoaderWikiModule.php.
References $cache, $context, $fname, ResourceLoaderModule\$name, $title, array(), as, class, Wikimedia\Rdbms\IDatabase\getDomainID(), makeTitleKey(), Title\newFromText(), and use.
Referenced by ResourceLoaderWikiModuleTest\testGetPreloadedBadTitle(), ResourceLoaderWikiModuleTest\testGetPreloadedTitleInfo(), and ResourceLoaderWikiModuleTest\testGetPreloadedTitleInfoEmpty().
|
private |
Definition at line 366 of file ResourceLoaderWikiModule.php.
References $titleInfo.
ResourceLoaderWikiModule::shouldEmbedModule | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 248 of file ResourceLoaderWikiModule.php.
References $context, $title, as, getPages(), ResourceLoaderModule\getSource(), and Title\newFromText().
|
protected |
Definition at line 78 of file ResourceLoaderWikiModule.php.
Referenced by getGroup(), ResourceLoaderUserModule\getPages(), and ResourceLoaderUserStylesModule\getPages().
|
protected |
Definition at line 54 of file ResourceLoaderWikiModule.php.
|
protected |
Definition at line 75 of file ResourceLoaderWikiModule.php.
Referenced by getScript().
|
protected |
Definition at line 72 of file ResourceLoaderWikiModule.php.
Referenced by getStyles().
|
protected |
Definition at line 69 of file ResourceLoaderWikiModule.php.
Referenced by fetchTitleInfo(), getTitleInfo(), and setTitleInfo().