MediaWiki REL1_30
|
Abstraction for ResourceLoader modules which pull from wiki pages. More...
Public Member Functions | |
__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) | |
Public Member Functions inherited from ResourceLoaderModule | |
getConfig () | |
getDefinitionMtime (ResourceLoaderContext $context) | |
Back-compat dummy for old subclass implementations of getModifiedTime(). | |
getDependencies (ResourceLoaderContext $context=null) | |
Get a list of modules this module depends on. | |
getFlip ( $context) | |
getHashMtime (ResourceLoaderContext $context) | |
Back-compat dummy for old subclass implementations of getModifiedTime(). | |
getHeaders (ResourceLoaderContext $context) | |
Get headers to send as part of a module web response. | |
getMessages () | |
Get the messages needed for this module. | |
getModifiedHash (ResourceLoaderContext $context) | |
Helper method for providing a version hash to getVersionHash(). | |
getModifiedTime (ResourceLoaderContext $context) | |
Get this module's last modification timestamp for a given context. | |
getName () | |
Get this module's name. | |
getOrigin () | |
Get this module's origin. | |
getPosition () | |
From where in the page HTML should this module be loaded? | |
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 origin 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. | |
isRaw () | |
Whether this module's JS expects to work without the client-side ResourceLoader module. | |
setConfig (Config $config) | |
setFileDependencies (ResourceLoaderContext $context, $files) | |
Set in-object cache for file dependencies. | |
setLogger (LoggerInterface $logger) | |
setMessageBlob ( $blob, $lang) | |
Set in-object cache for message blobs. | |
setName ( $name) | |
Set this module's name. | |
shouldEmbedModule (ResourceLoaderContext $context) | |
Check whether this module should be embeded rather than linked. | |
supportsURLLoading () | |
Whether this module supports URL loading. | |
Static Public Member Functions | |
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. | |
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. | |
Protected Member Functions | |
getContent ( $titleText) | |
getContentObj (Title $title) | |
getDB () | |
Get the Database object used in getTitleInfo(). | |
getPages (ResourceLoaderContext $context) | |
Subclasses should return an associative array of resources in the module. | |
getTitleInfo (ResourceLoaderContext $context) | |
Get the information about the wiki pages for a given context. | |
Protected Member Functions inherited from ResourceLoaderModule | |
getDeprecationInformation () | |
Get JS representing deprecation information for the current module if available. | |
getFileDependencies (ResourceLoaderContext $context) | |
Get the files this module depends on indirectly for a given skin. | |
getLogger () | |
getMessageBlob (ResourceLoaderContext $context) | |
Get the hash of the message blob. | |
saveFileDependencies (ResourceLoaderContext $context, $localFileRefs) | |
Set the files this module depends on indirectly for a given skin. | |
validateScriptFile ( $fileName, $contents) | |
Validate a given script file; if valid returns the original source. | |
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. | |
static | safeFilemtime ( $filePath) |
Safe version of filemtime(), which doesn't throw a PHP warning if the file doesn't exist. | |
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 ( $key, array $titleInfo) | |
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::isCssJsSubpage and Title::isCssOrJsPage().
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 48 of file ResourceLoaderWikiModule.php.
ResourceLoaderWikiModule::__construct | ( | array | $options = null | ) |
array | $options | For back-compat, this can be omitted in favour of overwriting getPages. |
Definition at line 68 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.
Definition at line 258 of file ResourceLoaderWikiModule.php.
|
staticprotected |
Reimplemented in TestResourceLoaderWikiModule.
Definition at line 325 of file ResourceLoaderWikiModule.php.
References $batch, $fname, $res, $title, $titleInfo, as, and Wikimedia\Rdbms\IDatabase\select().
|
protected |
string | $titleText |
Definition at line 149 of file ResourceLoaderWikiModule.php.
References $handler, $title, CONTENT_FORMAT_CSS, CONTENT_FORMAT_JAVASCRIPT, getContentObj(), and ContentHandler\getForTitle().
Referenced by getScript(), and getStyles().
|
protected |
Title | $title |
Definition at line 185 of file ResourceLoaderWikiModule.php.
References $title, DB_REPLICA, Revision\newKnownCurrent(), Revision\RAW, wfDebugLog(), 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 141 of file ResourceLoaderWikiModule.php.
References DB_REPLICA, and wfGetDB().
Referenced by getTitleInfo().
ResourceLoaderWikiModule::getDefinitionSummary | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 266 of file ResourceLoaderWikiModule.php.
References $context, getPages(), and getTitleInfo().
ResourceLoaderWikiModule::getGroup | ( | ) |
Get group name.
Reimplemented from ResourceLoaderModule.
Reimplemented in ResourceLoaderSiteStylesModule, ResourceLoaderUserModule, and ResourceLoaderUserStylesModule.
Definition at line 126 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 ResourceLoaderSiteModule, ResourceLoaderSiteStylesModule, ResourceLoaderUserModule, and ResourceLoaderUserStylesModule.
Definition at line 101 of file ResourceLoaderWikiModule.php.
References ResourceLoaderModule\$config, as, ResourceLoaderModule\getConfig(), and scripts.
Referenced by getDefinitionSummary(), getScript(), getStyles(), and getTitleInfo().
ResourceLoaderWikiModule::getScript | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 204 of file ResourceLoaderWikiModule.php.
References $options, $scripts, as, getContent(), getPages(), ResourceLoader\makeComment(), and ResourceLoaderModule\validateScriptFile().
ResourceLoaderWikiModule::getStyles | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 223 of file ResourceLoaderWikiModule.php.
References $options, $styles, as, MemoizedCallable\call(), ResourceLoaderModule\getConfig(), getContent(), ResourceLoaderModule\getFlip(), getPages(), and ResourceLoader\makeComment().
|
protected |
Get the information about the wiki pages for a given context.
ResourceLoaderContext | $context |
Definition at line 309 of file ResourceLoaderWikiModule.php.
References $dbr, getDB(), and getPages().
Referenced by getDefinitionSummary(), and isKnownEmpty().
ResourceLoaderWikiModule::getType | ( | ) |
Reimplemented from ResourceLoaderModule.
Reimplemented in ResourceLoaderSiteStylesModule, and ResourceLoaderUserStylesModule.
Definition at line 469 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 | $wikiId |
Definition at line 445 of file ResourceLoaderWikiModule.php.
References $cache, $title, CONTENT_FORMAT_CSS, and CONTENT_FORMAT_JAVASCRIPT.
Referenced by WikiPage\doDeleteUpdates(), WikiPage\doEditUpdates(), Title\invalidateCache(), and ResourceLoaderWikiModuleTest\testGetPreloadedTitleInfo().
ResourceLoaderWikiModule::isKnownEmpty | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 280 of file ResourceLoaderWikiModule.php.
References as, getGroup(), and getTitleInfo().
|
static |
ResourceLoaderContext | $context | |
IDatabase | $db | |
string[] | $moduleNames |
Definition at line 362 of file ResourceLoaderWikiModule.php.
References $cache, $context, $fname, ResourceLoaderModule\$name, $title, array(), as, function, Wikimedia\Rdbms\IDatabase\getDomainID(), and use.
Referenced by OutputPage\getRlClient(), ResourceLoader\preloadModuleInfo(), ResourceLoaderWikiModuleTest\testGetPreloadedBadTitle(), ResourceLoaderWikiModuleTest\testGetPreloadedTitleInfo(), and ResourceLoaderWikiModuleTest\testGetPreloadedTitleInfoEmpty().
|
private |
Definition at line 300 of file ResourceLoaderWikiModule.php.
References $titleInfo.
|
protected |
Definition at line 63 of file ResourceLoaderWikiModule.php.
Referenced by getGroup(), ResourceLoaderUserModule\getPages(), and ResourceLoaderUserStylesModule\getPages().
|
protected |
Definition at line 51 of file ResourceLoaderWikiModule.php.
|
protected |
Definition at line 60 of file ResourceLoaderWikiModule.php.
Referenced by getScript().
|
protected |
Definition at line 57 of file ResourceLoaderWikiModule.php.
Referenced by getStyles().
|
protected |
Definition at line 54 of file ResourceLoaderWikiModule.php.
Referenced by fetchTitleInfo(), and setTitleInfo().