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)

Public Member Functions inherited from ResourceLoaderModule
	getConfig ()

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

	getFlip ( $context)

	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.

	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 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.

	getVersionHash (ResourceLoaderContext $context)
	Get a string identifying the current version of this module in a given context.

	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
	buildContent (ResourceLoaderContext $context)
	Bundle all resources attached to this module into an array.

	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.

	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, $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'

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

Definition at line 48 of file ResourceLoaderWikiModule.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoaderWikiModule::__construct ( array $options = null )

Parameters

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

Reimplemented in GadgetResourceLoaderModule.

Definition at line 68 of file ResourceLoaderWikiModule.php.

References $options.

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

◆ fetchTitleInfo()

static ResourceLoaderWikiModule::fetchTitleInfo	(	IDatabase	$db,
		array	$pages,
			$fname = __METHOD__ )

staticprotected

Reimplemented in TestResourceLoaderWikiModule.

Definition at line 323 of file ResourceLoaderWikiModule.php.

References $batch, $fname, $res, $titleInfo, and Wikimedia\Rdbms\IDatabase\select().

◆ getContent()

ResourceLoaderWikiModule::getContent ( $titleText )

protected

Parameters

string $titleText

Returns: null|string

Definition at line 149 of file ResourceLoaderWikiModule.php.

References $handler, CONTENT_FORMAT_CSS, CONTENT_FORMAT_JAVASCRIPT, and getContentObj().

Referenced by getScript(), and getStyles().

◆ getContentObj()

ResourceLoaderWikiModule::getContentObj ( Title $title )

protected

Parameters

Title $title

Returns: Content|null

Definition at line 185 of file ResourceLoaderWikiModule.php.

References DB_REPLICA, wfDebugLog(), and wfGetDB().

Referenced by getContent().

◆ getDB()

ResourceLoaderWikiModule::getDB ( )

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.

Returns: IDatabase|null

Definition at line 141 of file ResourceLoaderWikiModule.php.

References DB_REPLICA, and wfGetDB().

Referenced by getTitleInfo().

◆ getDefinitionSummary()

ResourceLoaderWikiModule::getDefinitionSummary ( ResourceLoaderContext $context )

Parameters

ResourceLoaderContext $context

Returns: array

Reimplemented from ResourceLoaderModule.

Definition at line 264 of file ResourceLoaderWikiModule.php.

References $context, getPages(), and getTitleInfo().

◆ getGroup()

ResourceLoaderWikiModule::getGroup ( )

Get group name.

Returns: string

Reimplemented from ResourceLoaderModule.

Reimplemented in GadgetResourceLoaderModule, ResourceLoaderSiteStylesModule, ResourceLoaderUserModule, and ResourceLoaderUserStylesModule.

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