Module based on local JavaScript/CSS files. More...

Inherits MediaWiki\ResourceLoader\Module.

Inherited by MediaWiki\ResourceLoader\CodexModule, MediaWiki\ResourceLoader\ForeignApiModule, MediaWiki\ResourceLoader\LessVarFileModule, and MediaWiki\ResourceLoader\OOUIFileModule.

Collaboration diagram for MediaWiki\ResourceLoader\FileModule:

[legend]

Public Member Functions
	__construct (array $options=[], string $localBasePath=null, string $remoteBasePath=null)
	Construct a new module from an options array.

	enableModuleContentVersion ()
	Disable module content versioning.

	getAllStyleFiles ()
	Get all style files and all skin style files used by this module.

	getDefinitionSummary (Context $context)
	Get the definition summary for this module.

	getDependencies (Context $context=null)
	Get names of modules this module depends on.

	getFlip (Context $context)
	Get whether CSS for this module should be flipped.

	getGroup ()
	Get the name of the group this module should be loaded in.

	getMessages ()
	Get message keys used by this module.

	getPackageFiles (Context $context)
	Resolve the package files definition and generate the content of each package file.

	getScript (Context $context)
	Get all JS for this module for a given language and skin.

	getScriptURLsForDebug (Context $context)

	getSkipFunction ()

	getStyleFiles (Context $context)
	Get a list of file paths for all styles in this module, in order of proper inclusion.

	getStyles (Context $context)
	Get all styles for a given context.

	getStyleSheetLang ( $path)
	Infer the stylesheet language from a stylesheet file path.

	getStyleURLsForDebug (Context $context)

	getTemplates ()
	Get content of named templates for this module.

	getType ()
	Get the module's load type.

	readStyleFiles (array $styles, Context $context)
	Read the contents of a list of CSS files and remap and concatenate these.

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

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

	shouldSkipStructureTest ()
	Whether to skip the structure test ResourcesTest::testRespond() for this module.

	supportsURLLoading ()

Public Member Functions inherited from MediaWiki\ResourceLoader\Module
	getConfig ()

	getDeprecationInformation (Context $context)
	Get JS representing deprecation information for the current module if available.

	getDeprecationWarning ()
	Get the deprecation warning, if any.

	getHeaders (Context $context)
	Get headers to send as part of a module web response.

	getModuleContent (Context $context)
	Get an array of this module's resources.

	getName ()
	Get this module's name.

	getOrigin ()
	Get this module's origin.

	getSkins ()
	Get list of skins for which this module must be available to load.

	getSource ()
	Get the source of this module.

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

	isKnownEmpty (Context $context)
	Check whether this module is known to be empty.

	setConfig (Config $config)

	setDependencyAccessCallbacks (callable $loadCallback, callable $saveCallback)
	Inject the functions that load/save the indirect file path dependency list from storage.

	setFileDependencies (Context $context, array $paths)
	Set the indirect dependencies for this module pursuant 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.

	shouldEmbedModule (Context $context)
	Check whether this module should be embedded rather than linked.

Static Public Member Functions
static	extractBasePaths (array $options=[], $localBasePath=null, $remoteBasePath=null)
	Extract a pair of local and remote base paths from module definition information.

static	getPackageFileType ( $path)
	Infer the file type from a package file path.

Static Public Member Functions inherited from MediaWiki\ResourceLoader\Module
static	expandRelativePaths (array $filePaths)
	Expand directories relative to $IP.

static	getRelativePaths (array $filePaths)
	Make file paths relative to MediaWiki directory.

static	getVary (Context $context)
	Get vary string.

Protected Member Functions
	compileLessString ( $style, $stylePath, Context $context)
	Compile a LESS string into CSS.

	getAllSkinStyleFiles ()
	Get a list of file paths for all skin style files in the module, for all available skins.

	getLocalPath ( $path)

	getPath ( $path)

	getRemotePath ( $path)

	getSkinStyleFiles ( $skinName)
	Get a list of file paths for all skin styles in the module used by the skin.

	getVueComponentParser ()

	processStyle ( $style, $styleLang, $path, Context $context)
	Process a CSS/LESS string.

	readStyleFile ( $path, Context $context)
	Read and process a style file.

	stripBom ( $input)
	Take an input string and remove the UTF-8 BOM character if present.

Protected Member Functions inherited from MediaWiki\ResourceLoader\Module
	buildContent (Context $context)
	Bundle all resources attached to this module into an array.

	getFileDependencies (Context $context)
	Get the indirect dependencies for this module pursuant to the skin/language context.

	getHookRunner ()
	Get a HookRunner for running core hooks.

	getLessVars (Context $context)
	Get module-specific LESS variables, if any.

	getLogger ()

	getMessageBlob (Context $context)
	Get the hash of the message blob.

	getPreloadLinks (Context $context)
	Get a list of resources that web browsers may preload.

	saveFileDependencies (Context $context, array $curFileRefs)
	Save the indirect dependencies for this module pursuant to the skin/language context.

	validateScriptFile ( $fileName, $contents)
	Validate a user-provided JavaScript blob.

Static Protected Member Functions
static	tryForKey (array $list, $key, $fallback=null)
	Get a list of element that match a key, optionally using a fallback key.

Static Protected Member Functions inherited from MediaWiki\ResourceLoader\Module
static	safeFileHash ( $filePath)
	Compute a non-cryptographic string hash of a file's contents.

Protected Attributes
bool	$debugRaw = true
	Link to raw files in debug mode.

array< int, string\|FilePath >	$debugScripts = []
	List of paths to JavaScript files to include in debug mode.

string[]	$dependencies = []
	List of modules this module depends on.

null string	$group = null
	Name of group to load this module in.

bool	$hasGeneratedStyles = false
	Whether getStyleURLsForDebug should return raw file paths, or return load.php urls.

array< string, array< int, string\|FilePath > >	$languageScripts = []
	Lists of JavaScript files by language code.

string	$localBasePath = ''
	Local base path, see __construct()

string[]	$localFileRefs = []
	Place where readStyleFile() tracks file dependencies.

string[]	$messages = []
	List of message keys used by this module.

string[]	$missingLocalFileRefs = []
	Place where readStyleFile() tracks file dependencies for non-existent files.

bool	$noflip = false
	Whether CSSJanus flipping should be skipped for this module.

null array	$packageFiles = null
	Packaged files definition, to bundle and make available client-side via `require()`.

string	$remoteBasePath = ''
	Remote base path, see __construct()

array< int, string\|FilePath >	$scripts = []
	List of JavaScript file paths to always include.

array< string, array< int, string\|FilePath > >	$skinScripts = []
	Lists of JavaScript files by skin name.

array< string, array< int, string\|FilePath > >	$skinStyles = []
	Lists of CSS files by skin name.

null string	$skipFunction = null
	File name containing the body of the skip function.

bool	$skipStructureTest = false
	Whether to skip the structure test ResourcesTest::testRespond()

array< int, string\|FilePath >	$styles = []
	List of CSS file files to always include.

array< int\|string, string\|FilePath >	$templates = []
	List of the named templates used by this module.

VueComponentParser null	$vueComponentParser = null
	Lazy-created by getVueComponentParser()

Protected Attributes inherited from MediaWiki\ResourceLoader\Module
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[] null	$skins = null
	Skin names.

array	$versionHash = []
	Map of (context hash => cached module version hash)

Detailed Description

Module based on local JavaScript/CSS files.

The following public methods can query the database:

getDefinitionSummary / … / Module::getFileDependencies.
getVersionHash / getDefinitionSummary / … / Module::getFileDependencies.
getStyles / Module::saveFileDependencies.

See also: $wgResourceModules

Since: 1.17

Definition at line 53 of file FileModule.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\ResourceLoader\FileModule::__construct	(	array	$options = [],
		string	$localBasePath = null,
		string	$remoteBasePath = null )

Construct a new module from an options array.

Parameters

array	$options	See $wgResourceModules for the available options.
string \| null	$localBasePath	Base path to prepend to all local paths in $options. Defaults to MW_INSTALL_PATH
string \| null	$remoteBasePath	Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath

Definition at line 172 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\$localBasePath, MediaWiki\ResourceLoader\FileModule\$remoteBasePath, MediaWiki\ResourceLoader\FileModule\extractBasePaths(), and MediaWiki\ResourceLoader\FileModule\getPath().

Member Function Documentation

◆ compileLessString()

MediaWiki\ResourceLoader\FileModule::compileLessString	(		$style,
			$stylePath,
		Context	$context )

protected

Compile a LESS string into CSS.

Keeps track of all used files and adds them to localFileRefs.

Since: 1.35

Parameters

string	$style	LESS source to compile
string	$stylePath	File path of LESS source, used for resolving relative file paths
Context	$context	Context in which to generate script

Returns: string CSS source

Definition at line 1089 of file FileModule.php.

References $path, CACHE_ANYTHING, MediaWiki\ResourceLoader\Context\getResourceLoader(), and MediaWiki\ResourceLoader\Context\getSkin().

◆ enableModuleContentVersion()

MediaWiki\ResourceLoader\FileModule::enableModuleContentVersion ( )

Disable module content versioning.

This class uses getDefinitionSummary() instead, to avoid filesystem overhead involved with building the full module content inside a startup request.

Returns: bool

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 529 of file FileModule.php.

◆ extractBasePaths()

static MediaWiki\ResourceLoader\FileModule::extractBasePaths	(	array	$options = [],
			$localBasePath = null,
			$remoteBasePath = null )

static

Extract a pair of local and remote base paths from module definition information.

Implementation note: the amount of global state used in this function is staggering.

Parameters

array	$options	Module definition
string \| null	$localBasePath	Path to use if not provided in module definition. Defaults to MW_INSTALL_PATH
string \| null	$remoteBasePath	Path to use if not provided in module definition. Defaults to $wgResourceBasePath

Returns: string[] [ localBasePath, remoteBasePath ]

Definition at line 277 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\$localBasePath, MediaWiki\ResourceLoader\FileModule\$remoteBasePath, MediaWiki\MainConfigNames\ExtensionAssetsPath, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\MainConfigNames\ResourceBasePath, and MediaWiki\MainConfigNames\StylePath.

Referenced by MediaWiki\ResourceLoader\FileModule\__construct(), MediaWiki\ResourceLoader\SkinModule\getFeatureFilePaths(), and MediaWiki\ResourceLoader\getThemePaths().

◆ getAllSkinStyleFiles()

MediaWiki\ResourceLoader\FileModule::getAllSkinStyleFiles ( )

protected

Get a list of file paths for all skin style files in the module, for all available skins.

Returns: array A list of file paths collated by media type

Definition at line 918 of file FileModule.php.

◆ getAllStyleFiles()

MediaWiki\ResourceLoader\FileModule::getAllStyleFiles ( )

Get all style files and all skin style files used by this module.

Returns: array

Definition at line 940 of file FileModule.php.

◆ getDefinitionSummary()

MediaWiki\ResourceLoader\FileModule::getDefinitionSummary ( Context $context )

Get the definition summary for this module.

Parameters

Context $context

Returns: array

Reimplemented from MediaWiki\ResourceLoader\Module.

Reimplemented in MediaWiki\ResourceLoader\CodexModule, and MediaWiki\ResourceLoader\SkinModule.

Definition at line 602 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\$packageFiles, MediaWiki\ResourceLoader\Module\getLessVars(), and MediaWiki\ResourceLoader\Module\getMessageBlob().

◆ getDependencies()

MediaWiki\ResourceLoader\FileModule::getDependencies ( Context $context = null )

Get names of modules this module depends on.

Parameters

Context | null $context

Returns: string[] List of module names

Reimplemented from MediaWiki\ResourceLoader\Module.

Reimplemented in MediaWiki\ResourceLoader\ForeignApiModule.

Definition at line 488 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\$dependencies.

◆ getFlip()

MediaWiki\ResourceLoader\FileModule::getFlip ( Context $context )

Get whether CSS for this module should be flipped.

Parameters

Context $context

Returns: bool

Reimplemented from MediaWiki\ResourceLoader\Module.

Reimplemented in MediaWiki\ResourceLoader\CodexModule.

Definition at line 1052 of file FileModule.php.

References MediaWiki\ResourceLoader\Context\getDirection().

◆ getGroup()

MediaWiki\ResourceLoader\FileModule::getGroup ( )

Get the name of the group this module should be loaded in.

Returns: null|string Group name

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 478 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\$group.

◆ getLocalPath()

MediaWiki\ResourceLoader\FileModule::getLocalPath ( $path )

protected

Parameters

string | FilePath $path

Returns: string

Definition at line 689 of file FileModule.php.

References $path.

Referenced by MediaWiki\ResourceLoader\FileModule\getSkipFunction().

◆ getMessages()

MediaWiki\ResourceLoader\FileModule::getMessages ( )

Get message keys used by this module.

Returns: string[] List of message keys

Reimplemented from MediaWiki\ResourceLoader\Module.

Reimplemented in MediaWiki\ResourceLoader\LessVarFileModule.

Definition at line 469 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\$messages.

◆ getPackageFiles()

MediaWiki\ResourceLoader\FileModule::getPackageFiles ( Context $context )

Resolve the package files definition and generate the content of each package file.

Parameters

Context $context

Returns: array|null Package files data structure, see Module::getScript()

Reimplemented in MediaWiki\ResourceLoader\CodexModule.

Definition at line 1401 of file FileModule.php.

References MediaWiki\ResourceLoader\Context\getHash().

Referenced by MediaWiki\ResourceLoader\FileModule\getScript(), and MediaWiki\ResourceLoader\FileModule\getStyles().

◆ getPackageFileType()

static MediaWiki\ResourceLoader\FileModule::getPackageFileType ( $path )

static

Infer the file type from a package file path.

Parameters

string $path

Returns: string 'script', 'script-vue', or 'data'

Definition at line 736 of file FileModule.php.

References $path.

◆ getPath()

MediaWiki\ResourceLoader\FileModule::getPath ( $path )

protected

Parameters

string | FilePath $path

Returns: string

Definition at line 677 of file FileModule.php.

References $path.

Referenced by MediaWiki\ResourceLoader\FileModule\__construct().

◆ getRemotePath()

MediaWiki\ResourceLoader\FileModule::getRemotePath ( $path )

protected

Parameters

string | FilePath $path

Returns: string

Definition at line 704 of file FileModule.php.

References $path.

Referenced by MediaWiki\ResourceLoader\FileModule\getScriptURLsForDebug(), and MediaWiki\ResourceLoader\FileModule\getStyleURLsForDebug().

◆ getScript()

MediaWiki\ResourceLoader\FileModule::getScript ( Context $context )

Get all JS for this module for a given language and skin.

Includes all relevant JS except loader scripts.

For multi-file modules where require() is used to load one file from another file, this should return an array structured as follows: [ 'files' => [ 'file1.js' => [ 'type' => 'script', 'content' => 'JS code' ], 'file2.js' => [ 'type' => 'script', 'content' => 'JS code' ], 'data.json' => [ 'type' => 'data', 'content' => array ] ], 'main' => 'file1.js' ]

For plain concatenated scripts, this can either return a string, or an associative array similar to the one used for package files: [ 'plainScripts' => [ [ 'content' => 'JS code' ], [ 'content' => 'JS code' ], ], ]

Stability: stable: to override

Parameters

Context $context

Returns

string|array JavaScript code (string), or multi-file array with the following keys:

files: An associative array mapping file name to file info structure
main: The name of the main script, a key in the files array
plainScripts: An array of file info structures to be concatenated and executed when the module is loaded. Each file info structure has the following keys:
type: May be "script", "script-vue" or "data". Optional, default "script".
content: The string content of the file
filePath: A FilePath object describing the location of the source file. This will be used to construct the source map during minification.

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 325 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\$packageFiles, and MediaWiki\ResourceLoader\FileModule\getPackageFiles().

◆ getScriptURLsForDebug()

MediaWiki\ResourceLoader\FileModule::getScriptURLsForDebug ( Context $context )

Parameters

Context $context

Returns: string[] URLs

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 348 of file FileModule.php.

References MediaWiki\ResourceLoader\Module\$config, MediaWiki\Config\Config\get(), MediaWiki\ResourceLoader\Module\getConfig(), MediaWiki\ResourceLoader\FileModule\getRemotePath(), MediaWiki\ResourceLoader\Context\getResourceLoader(), and MediaWiki\MainConfigNames\Server.

◆ getSkinStyleFiles()

MediaWiki\ResourceLoader\FileModule::getSkinStyleFiles ( $skinName )

protected

Get a list of file paths for all skin styles in the module used by the skin.

Parameters

string $skinName The name of the skin

Returns: array A list of file paths collated by media type

Definition at line 906 of file FileModule.php.

◆ getSkipFunction()

MediaWiki\ResourceLoader\FileModule::getSkipFunction ( )

Returns: null|string

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 509 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\getLocalPath().

◆ getStyleFiles()

MediaWiki\ResourceLoader\FileModule::getStyleFiles ( Context $context )

Get a list of file paths for all styles in this module, in order of proper inclusion.

Access: internal: Exposed only for use by structure phpunit tests.

Parameters

Context $context

Returns: array<string,array<int,string|FilePath>> Map from media type to list of file paths

Reimplemented in MediaWiki\ResourceLoader\CodexModule.

Definition at line 890 of file FileModule.php.

References MediaWiki\ResourceLoader\Context\getSkin().

Referenced by MediaWiki\ResourceLoader\FileModule\getStyles(), and MediaWiki\ResourceLoader\FileModule\getStyleURLsForDebug().

◆ getStyles()

MediaWiki\ResourceLoader\FileModule::getStyles ( Context $context )

Get all styles for a given context.

Parameters

Context $context

Returns: string[] CSS code for $context as an associative array mapping media type to CSS text.

Reimplemented from MediaWiki\ResourceLoader\Module.

Reimplemented in MediaWiki\ResourceLoader\SkinModule.

Definition at line 411 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\$packageFiles, MediaWiki\ResourceLoader\FileModule\$styles, MediaWiki\ResourceLoader\FileModule\getPackageFiles(), MediaWiki\ResourceLoader\FileModule\getStyleFiles(), MediaWiki\ResourceLoader\FileModule\processStyle(), MediaWiki\ResourceLoader\FileModule\readStyleFiles(), and MediaWiki\ResourceLoader\Module\saveFileDependencies().

◆ getStyleSheetLang()

MediaWiki\ResourceLoader\FileModule::getStyleSheetLang ( $path )

Infer the stylesheet language from a stylesheet file path.

Since: 1.22

Parameters

string $path

Returns: string The stylesheet language name

Definition at line 726 of file FileModule.php.

References $path.

◆ getStyleURLsForDebug()

MediaWiki\ResourceLoader\FileModule::getStyleURLsForDebug ( Context $context )

Parameters

Context $context

Returns: string[][] Lists of URLs by media type

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 443 of file FileModule.php.

References MediaWiki\ResourceLoader\Module\getConfig(), MediaWiki\ResourceLoader\FileModule\getRemotePath(), and MediaWiki\ResourceLoader\FileModule\getStyleFiles().

◆ getTemplates()

MediaWiki\ResourceLoader\FileModule::getTemplates ( )

Get content of named templates for this module.

Returns: array<string,string> Templates mapping template alias to content

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 1152 of file FileModule.php.

◆ getType()

MediaWiki\ResourceLoader\FileModule::getType ( )

Get the module's load type.

Since: 1.28

Returns: string

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 1062 of file FileModule.php.

◆ getVueComponentParser()

MediaWiki\ResourceLoader\FileModule::getVueComponentParser ( )

protected

Returns: VueComponentParser

Definition at line 666 of file FileModule.php.

References MediaWiki\ResourceLoader\FileModule\$vueComponentParser.

◆ processStyle()

MediaWiki\ResourceLoader\FileModule::processStyle	(		$style,
			$styleLang,
			$path,
		Context	$context )

protected

Process a CSS/LESS string.

This method performs the following processing steps:

LESS compilation (if $styleLang = 'less')
RTL flipping with CSSJanus (if getFlip() returns true)
Registration of references to local files in $localFileRefs and $missingLocalFileRefs
URL remapping and data URI embedding

Access: internal

Parameters

string	$style	CSS or LESS code
string	$styleLang	Language of $style code ('css' or 'less')
string \| FilePath	$path	Path to code file, used for resolving relative file paths
Context	$context

Returns: string Processed CSS code

Definition at line 1014 of file FileModule.php.

References $path.

Referenced by MediaWiki\ResourceLoader\FileModule\getStyles().

◆ readStyleFile()

MediaWiki\ResourceLoader\FileModule::readStyleFile	(		$path,
		Context	$context )

protected

Read and process a style file.

Reads a file from disk and runs it through processStyle().

This method can be used as a callback for array_map()

Access: internal

Parameters

string \| FilePath	$path	Path of style file to read
Context	$context

Returns: string CSS code

Definition at line 990 of file FileModule.php.

References $path.

◆ readStyleFiles()

MediaWiki\ResourceLoader\FileModule::readStyleFiles	(	array	$styles,
		Context	$context )

Read the contents of a list of CSS files and remap and concatenate these.

Access: internal: This is considered a private method. Exposed for internal use by WebInstallerOutput.

Parameters

	array<string,array<int,string\|FilePath>>	$styles Map of media type to file paths
Context	$context

Returns: array<string,string> Map of combined CSS code, keyed by media type

Definition at line 965 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\FileModule\getStyles().

◆ requiresES6()

MediaWiki\ResourceLoader\FileModule::requiresES6 ( )

Whether the module requires ES6 support in the client.

If the client does not support ES6, attempting to load a module that requires ES6 will result in an error.

Deprecated: since 1.41, ignored by ResourceLoader

Since: 1.36

Returns: bool

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 517 of file FileModule.php.

◆ setSkinStylesOverride()

MediaWiki\ResourceLoader\FileModule::setSkinStylesOverride ( array $moduleSkinStyles )

Provide overrides for skinStyles to modules that support that.

This MUST be called after self::setName().

Since: 1.37

See also: $wgResourceModuleSkinStyles

Parameters

array $moduleSkinStyles

Reimplemented from MediaWiki\ResourceLoader\Module.

Reimplemented in MediaWiki\ResourceLoader\OOUIFileModule.

Definition at line 848 of file FileModule.php.

References $path.

◆ shouldSkipStructureTest()

MediaWiki\ResourceLoader\FileModule::shouldSkipStructureTest ( )

Whether to skip the structure test ResourcesTest::testRespond() for this module.

Since: 1.42

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 380 of file FileModule.php.

◆ stripBom()

MediaWiki\ResourceLoader\FileModule::stripBom ( $input )

protected

Take an input string and remove the UTF-8 BOM character if present.

We need to remove these after reading a file, because we concatenate our files and the BOM character is not valid in the middle of a string. We already assume UTF-8 everywhere, so this should be safe.

Parameters

string $input

Returns: string Input minus the initial BOM char

Definition at line 1514 of file FileModule.php.

◆ supportsURLLoading()

MediaWiki\ResourceLoader\FileModule::supportsURLLoading ( )

Returns: bool

Reimplemented from MediaWiki\ResourceLoader\Module.

Reimplemented in MediaWiki\ResourceLoader\CodexModule.

Definition at line 368 of file FileModule.php.

◆ tryForKey()

static MediaWiki\ResourceLoader\FileModule::tryForKey	(	array	$list,
			$key,
			$fallback = null )

staticprotected

Get a list of element that match a key, optionally using a fallback key.

Parameters

array[]	$list	List of lists to select from
string	$key	Key to look for in $list
string \| null	$fallback	Key to look for in $list if $key doesn't exist

Returns: array List of elements from $list which matched $key or $fallback, or an empty list in case of no match

Definition at line 777 of file FileModule.php.

References $fallback.

Member Data Documentation

◆ $debugRaw

bool MediaWiki\ResourceLoader\FileModule::$debugRaw = true

protected

Link to raw files in debug mode.

Definition at line 133 of file FileModule.php.

◆ $debugScripts

array<int,string|FilePath> MediaWiki\ResourceLoader\FileModule::$debugScripts = []

protected

List of paths to JavaScript files to include in debug mode.

Definition at line 78 of file FileModule.php.

◆ $dependencies

string [] MediaWiki\ResourceLoader\FileModule::$dependencies = []

protected

List of modules this module depends on.

Definition at line 114 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\FileModule\getDependencies(), and MediaWiki\ResourceLoader\ForeignApiModule\getDependencies().

◆ $group

null string MediaWiki\ResourceLoader\FileModule::$group = null

protected

Name of group to load this module in.

Definition at line 130 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\FileModule\getGroup().

◆ $hasGeneratedStyles

bool MediaWiki\ResourceLoader\FileModule::$hasGeneratedStyles = false

protected

Whether getStyleURLsForDebug should return raw file paths, or return load.php urls.

Definition at line 145 of file FileModule.php.

◆ $languageScripts

array<string,array<int,string|FilePath> > MediaWiki\ResourceLoader\FileModule::$languageScripts = []

protected

Lists of JavaScript files by language code.

Definition at line 68 of file FileModule.php.

◆ $localBasePath

string MediaWiki\ResourceLoader\FileModule::$localBasePath = ''

protected

Local base path, see __construct()

Definition at line 55 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\CodexModule\__construct(), MediaWiki\ResourceLoader\LessVarFileModule\__construct(), MediaWiki\ResourceLoader\SkinModule\__construct(), MediaWiki\ResourceLoader\FileModule\__construct(), and MediaWiki\ResourceLoader\FileModule\extractBasePaths().

◆ $localFileRefs

string [] MediaWiki\ResourceLoader\FileModule::$localFileRefs = []

protected

Place where readStyleFile() tracks file dependencies.

Definition at line 150 of file FileModule.php.

◆ $messages

string [] MediaWiki\ResourceLoader\FileModule::$messages = []

protected

List of message keys used by this module.

Definition at line 124 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\SkinModule\__construct(), MediaWiki\ResourceLoader\SkinModule\applyFeaturesCompatibility(), and MediaWiki\ResourceLoader\FileModule\getMessages().

◆ $missingLocalFileRefs

string [] MediaWiki\ResourceLoader\FileModule::$missingLocalFileRefs = []

protected

Place where readStyleFile() tracks file dependencies for non-existent files.

Used in tests to detect missing dependencies.

Definition at line 156 of file FileModule.php.

◆ $noflip

bool MediaWiki\ResourceLoader\FileModule::$noflip = false

protected

Whether CSSJanus flipping should be skipped for this module.

Definition at line 136 of file FileModule.php.

◆ $packageFiles

null array MediaWiki\ResourceLoader\FileModule::$packageFiles = null

protected

Packaged files definition, to bundle and make available client-side via require().

See also: FileModule::expandPackageFiles()

Definition at line 97 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\FileModule\getDefinitionSummary(), MediaWiki\ResourceLoader\FileModule\getScript(), and MediaWiki\ResourceLoader\FileModule\getStyles().

◆ $remoteBasePath

string MediaWiki\ResourceLoader\FileModule::$remoteBasePath = ''

protected

Remote base path, see __construct()

Definition at line 58 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\CodexModule\__construct(), MediaWiki\ResourceLoader\LessVarFileModule\__construct(), MediaWiki\ResourceLoader\SkinModule\__construct(), MediaWiki\ResourceLoader\FileModule\__construct(), and MediaWiki\ResourceLoader\FileModule\extractBasePaths().

◆ $scripts

array<int,string|FilePath> MediaWiki\ResourceLoader\FileModule::$scripts = []

protected

List of JavaScript file paths to always include.

Definition at line 63 of file FileModule.php.

◆ $skinScripts

array<string,array<int,string|FilePath> > MediaWiki\ResourceLoader\FileModule::$skinScripts = []

protected

Lists of JavaScript files by skin name.

Definition at line 73 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\OOUIFileModule\__construct().

◆ $skinStyles

array<string,array<int,string|FilePath> > MediaWiki\ResourceLoader\FileModule::$skinStyles = []

protected

Lists of CSS files by skin name.

Definition at line 88 of file FileModule.php.

◆ $skipFunction

null string MediaWiki\ResourceLoader\FileModule::$skipFunction = null

protected

File name containing the body of the skip function.

Definition at line 119 of file FileModule.php.

◆ $skipStructureTest

bool MediaWiki\ResourceLoader\FileModule::$skipStructureTest = false

protected

Whether to skip the structure test ResourcesTest::testRespond()

Definition at line 139 of file FileModule.php.

◆ $styles

array<int,string|FilePath> MediaWiki\ResourceLoader\FileModule::$styles = []

protected

List of CSS file files to always include.

Definition at line 83 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\FileModule\getStyles().

◆ $templates

array<int|string,string|FilePath> MediaWiki\ResourceLoader\FileModule::$templates = []

protected

List of the named templates used by this module.

Definition at line 127 of file FileModule.php.

◆ $vueComponentParser

VueComponentParser null MediaWiki\ResourceLoader\FileModule::$vueComponentParser = null

protected

Lazy-created by getVueComponentParser()

Definition at line 161 of file FileModule.php.

Referenced by MediaWiki\ResourceLoader\FileModule\getVueComponentParser().

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

includes/ResourceLoader/FileModule.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ compileLessString()

◆ enableModuleContentVersion()

◆ extractBasePaths()

◆ getAllSkinStyleFiles()

◆ getAllStyleFiles()

◆ getDefinitionSummary()

◆ getDependencies()

◆ getFlip()

◆ getGroup()

◆ getLocalPath()

◆ getMessages()

◆ getPackageFiles()

◆ getPackageFileType()

◆ getPath()

◆ getRemotePath()

◆ getScript()

◆ getScriptURLsForDebug()

◆ getSkinStyleFiles()

◆ getSkipFunction()

◆ getStyleFiles()

◆ getStyles()

◆ getStyleSheetLang()

◆ getStyleURLsForDebug()

◆ getTemplates()

◆ getType()

◆ getVueComponentParser()

◆ processStyle()

◆ readStyleFile()

◆ readStyleFiles()

◆ requiresES6()

◆ setSkinStylesOverride()

◆ shouldSkipStructureTest()

◆ stripBom()

◆ supportsURLLoading()

◆ tryForKey()

Member Data Documentation

◆ $debugRaw

◆ $debugScripts

◆ $dependencies

◆ $group

◆ $hasGeneratedStyles

◆ $languageScripts

◆ $localBasePath

◆ $localFileRefs

◆ $messages

◆ $missingLocalFileRefs

◆ $noflip

◆ $packageFiles

◆ $remoteBasePath

◆ $scripts

◆ $skinScripts

◆ $skinStyles

◆ $skipFunction

◆ $skipStructureTest

◆ $styles

◆ $templates

◆ $vueComponentParser