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

Inheritance diagram for ResourceLoaderWikiModule:

[legend]

Collaboration diagram for ResourceLoaderWikiModule:

[legend]

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)

	shouldEmbedModule (ResourceLoaderContext $context)

Public Member Functions inherited from ResourceLoaderModule
	getConfig ()

	getDependencies (ResourceLoaderContext $context=null)
	Get a list of modules this module depends on.

	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.

	requiresES6 ()
	Whether the module requires ES6 support in the client.

	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.

	setSkinStylesOverride (array $moduleSkinStyles)
	Provide overrides for skinStyles to modules that support that.

	supportsURLLoading ()
	Whether this module supports URL loading.

Static Public Member Functions
static	invalidateModuleCache (PageIdentity $page, ?RevisionRecord $old, ?RevisionRecord $new, string $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.

Protected Member Functions
	getContent ( $titleText, ResourceLoaderContext $context)

	getContentObj (PageIdentity $page, ResourceLoaderContext $context, $maxRedirects=null)

	getDB ()
	Get the Database handle used for computing the module version.

	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
	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 user-provided JavaScript blob.

Static Protected Member Functions
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.

Protected Attributes
string null	$group
	Group of module.

string	$origin = self::ORIGIN_USER_SITEWIDE
	Origin defaults to users with sitewide authority.

array	$scripts = []
	List of page names that contain JavaScript.

array	$styles = []
	List of page names that contain CSS.

array	$titleInfo = []
	In-process cache for title info, structured as an array [ <batchKey> // Pipe-separated list of sorted keys from getPages => [ <titleKey> => [ // Normalised title key 'page_len' => .., 'page_latest' => .., 'page_touched' => .., ] ] ].

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)

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:

Option getters:
- getGroup()
- getPages()
Basic methods that strictly involve the foreign database
- getDB()
- isKnownEmpty()
- getTitleInfo()

Since: 1.17

Definition at line 56 of file ResourceLoaderWikiModule.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoaderWikiModule::__construct ( array $options = null )

Parameters

array | null $options For back-compat, this can be omitted in favour of overwriting getPages.

Definition at line 91 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

Reimplemented from ResourceLoaderModule.

Definition at line 342 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 439 of file ResourceLoaderWikiModule.php.

References $res, $title, 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 178 of file ResourceLoaderWikiModule.php.

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

Referenced by getScript(), and getStyles().

◆ getContentObj()

ResourceLoaderWikiModule::getContentObj	(	PageIdentity	$page,
		ResourceLoaderContext	$context,
			$maxRedirects = `null`
	)

protected

Parameters

PageIdentity	$page
ResourceLoaderContext	$context
int \| null	$maxRedirects	Maximum number of redirects to follow. If null, uses $wgMaxRedirects

Returns: Content|null

Since: 1.32 added the $context and $maxRedirects parameters

Definition at line 210 of file ResourceLoaderWikiModule.php.

References $content, ResourceLoaderModule\getConfig(), getContentObj(), ResourceLoaderContext\getContentOverrideCallback(), and ResourceLoaderModule\getLogger().

Referenced by getContent(), and getContentObj().

◆ 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 168 of file ResourceLoaderWikiModule.php.

References DB_REPLICA, and wfGetDB().

◆ getDefinitionSummary()

ResourceLoaderWikiModule::getDefinitionSummary ( ResourceLoaderContext $context )

Parameters

ResourceLoaderContext $context

Returns: array

Reimplemented from ResourceLoaderModule.

Definition at line 350 of file ResourceLoaderWikiModule.php.

References getPages(), and getTitleInfo().

◆ getGroup()

ResourceLoaderWikiModule::getGroup ( )

Get group name.

Returns: string|null

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderSiteStylesModule, ResourceLoaderUserModule, and ResourceLoaderUserStylesModule.

Definition at line 150 of file ResourceLoaderWikiModule.php.

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[]

Reimplemented in ResourceLoaderSiteModule, ResourceLoaderSiteStylesModule, ResourceLoaderUserModule, and ResourceLoaderUserStylesModule.

Definition at line 125 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

Reimplemented from ResourceLoaderModule.

Definition at line 276 of file ResourceLoaderWikiModule.php.

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

◆ getStyles()

ResourceLoaderWikiModule::getStyles ( ResourceLoaderContext $context )

Parameters

ResourceLoaderContext $context

Returns: array

Reimplemented from ResourceLoaderModule.

Definition at line 295 of file ResourceLoaderWikiModule.php.

References MemoizedCallable\call(), ResourceLoaderModule\getConfig(), getContent(), ResourceLoaderModule\getFlip(), getPages(), and ResourceLoader\makeComment().

◆ 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 402 of file ResourceLoaderWikiModule.php.

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

Referenced by getDefinitionSummary(), and isKnownEmpty().

◆ getType()

ResourceLoaderWikiModule::getType ( )

Since: 1.28

Returns: string

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderSiteStylesModule, and ResourceLoaderUserStylesModule.

Definition at line 601 of file ResourceLoaderWikiModule.php.

◆ invalidateModuleCache()

static ResourceLoaderWikiModule::invalidateModuleCache	(	PageIdentity	$page,
		?RevisionRecord	$old,
		?RevisionRecord	$new,
		string	$domain
	)

static

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

Access: internal

Parameters

PageIdentity	$page
RevisionRecord \| null	$old	Prior page revision
RevisionRecord \| null	$new	New page revision
string	$domain	Database domain ID

Definition at line 560 of file ResourceLoaderWikiModule.php.

References $cache, $title, CONTENT_MODEL_CSS, CONTENT_MODEL_JAVASCRIPT, and MediaWiki\Revision\RevisionRecord\getSlot().

◆ isKnownEmpty()

ResourceLoaderWikiModule::isKnownEmpty ( ResourceLoaderContext $context )

Parameters

ResourceLoaderContext $context

Returns: bool

Reimplemented from ResourceLoaderModule.

Definition at line 364 of file ResourceLoaderWikiModule.php.

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

◆ makeTitleKey()

static ResourceLoaderWikiModule::makeTitleKey ( LinkTarget $title )

staticprivate

Definition at line 392 of file ResourceLoaderWikiModule.php.

◆ preloadTitleInfo()

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

static

Since: 1.28

Parameters

ResourceLoaderContext	$context
IDatabase	$db
string[]	$moduleNames

Definition at line 477 of file ResourceLoaderWikiModule.php.

References $cache, ResourceLoaderModule\$name, $title, Wikimedia\Rdbms\IDatabase\getDomainID(), and ResourceLoaderContext\getResourceLoader().

◆ setTitleInfo()

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

private

Definition at line 388 of file ResourceLoaderWikiModule.php.

◆ shouldEmbedModule()

ResourceLoaderWikiModule::shouldEmbedModule ( ResourceLoaderContext $context )

Parameters

ResourceLoaderContext $context

Returns: bool

Reimplemented from ResourceLoaderModule.

Definition at line 258 of file ResourceLoaderWikiModule.php.

References $title, ResourceLoaderContext\getContentOverrideCallback(), getPages(), and ResourceLoaderModule\getSource().

Member Data Documentation

◆ $group

string null ResourceLoaderWikiModule::$group

protected

Group of module.

Definition at line 85 of file ResourceLoaderWikiModule.php.

Referenced by ResourceLoaderUserModule\getPages(), and ResourceLoaderUserStylesModule\getPages().

◆ $origin

string ResourceLoaderWikiModule::$origin = self::ORIGIN_USER_SITEWIDE

protected

Origin defaults to users with sitewide authority.

Definition at line 58 of file ResourceLoaderWikiModule.php.

◆ $scripts

array ResourceLoaderWikiModule::$scripts = []

protected

List of page names that contain JavaScript.

Definition at line 82 of file ResourceLoaderWikiModule.php.

◆ $styles

array ResourceLoaderWikiModule::$styles = []

protected

List of page names that contain CSS.

Definition at line 79 of file ResourceLoaderWikiModule.php.

◆ $titleInfo

array ResourceLoaderWikiModule::$titleInfo = []

protected

In-process cache for title info, structured as an array [ <batchKey> // Pipe-separated list of sorted keys from getPages => [ <titleKey> => [ // Normalised title key 'page_len' => .., 'page_latest' => .., 'page_touched' => .., ] ] ].

See also: self::fetchTitleInfo(); self::makeTitleKey()

Definition at line 76 of file ResourceLoaderWikiModule.php.

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

includes/resourceloader/ResourceLoaderWikiModule.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ enableModuleContentVersion()

◆ fetchTitleInfo()

◆ getContent()

◆ getContentObj()

◆ getDB()

◆ getDefinitionSummary()

◆ getGroup()

◆ getPages()

◆ getScript()

◆ getStyles()

◆ getTitleInfo()

◆ getType()

◆ invalidateModuleCache()

◆ isKnownEmpty()

◆ makeTitleKey()

◆ preloadTitleInfo()

◆ setTitleInfo()

◆ shouldEmbedModule()

Member Data Documentation

◆ $group

◆ $origin

◆ $scripts

◆ $styles

◆ $titleInfo