MediaWiki  master
ResourceLoaderFileModule Class Reference

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

Inheritance diagram for ResourceLoaderFileModule:
Collaboration diagram for ResourceLoaderFileModule:

Public Member Functions

 __construct (array $options=[], $localBasePath=null, $remoteBasePath=null)
 Constructs a new module from an options array. More...
 
 enableModuleContentVersion ()
 Disable module content versioning. More...
 
 getAllStyleFiles ()
 Returns all style files and all skin style files used by this module. More...
 
 getDefinitionSummary (ResourceLoaderContext $context)
 Get the definition summary for this module. More...
 
 getDependencies (ResourceLoaderContext $context=null)
 Gets list of names of modules this module depends on. More...
 
 getFlip (ResourceLoaderContext $context)
 Get whether CSS for this module should be flipped. More...
 
 getGroup ()
 Gets the name of the group this module should be loaded in. More...
 
 getMessages ()
 Gets list of message keys used by this module. More...
 
 getPackageFiles (ResourceLoaderContext $context)
 Resolves the package files defintion and generates the content of each package file. More...
 
 getScript (ResourceLoaderContext $context)
 Gets all scripts for a given context concatenated together. More...
 
 getScriptURLsForDebug (ResourceLoaderContext $context)
 
 getSkipFunction ()
 Get the skip function. More...
 
 getStyleFiles (ResourceLoaderContext $context)
 Get a list of file paths for all styles in this module, in order of proper inclusion. More...
 
 getStyles (ResourceLoaderContext $context)
 Get all styles for a given context. More...
 
 getStyleSheetLang ( $path)
 Infer the stylesheet language from a stylesheet file path. More...
 
 getStyleURLsForDebug (ResourceLoaderContext $context)
 
 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...
 
 getType ()
 Get the module's load type. More...
 
 readStyleFiles (array $styles, $flip, ResourceLoaderContext $context)
 Get the contents of a list of CSS files. More...
 
 supportsURLLoading ()
 
- Public Member Functions inherited from ResourceLoaderModule
 getConfig ()
 
 getDeprecationInformation (ResourceLoaderContext $context)
 Get JS representing deprecation information for the current module if available. More...
 
 getHeaders (ResourceLoaderContext $context)
 Get headers to send as part of a module web response. 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...
 
 getSource ()
 Get the source of this module. More...
 
 getVersionHash (ResourceLoaderContext $context)
 Get a string identifying the current version of this module in a given context. More...
 
 isKnownEmpty (ResourceLoaderContext $context)
 Check whether this module is known to be empty. 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...
 
 shouldEmbedModule (ResourceLoaderContext $context)
 Check whether this module should be embeded rather than linked. More...
 

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. More...
 
static getPackageFileType ( $path)
 Infer the file type from a package file path. More...
 
- 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...
 
static getVary (ResourceLoaderContext $context)
 Get vary string. More...
 

Protected Member Functions

 compileLessFile ( $fileName, ResourceLoaderContext $context)
 Compile a LESS file into CSS. More...
 
 getAllSkinStyleFiles ()
 Gets a list of file paths for all skin style files in the module, for all available skins. More...
 
 getLocalPath ( $path)
 
 getPath ( $path)
 
 getRemotePath ( $path)
 
 getSkinStyleFiles ( $skinName)
 Gets a list of file paths for all skin styles in the module used by the skin. More...
 
 readStyleFile ( $path, $flip, ResourceLoaderContext $context)
 Reads a style file. More...
 
 stripBom ( $input)
 Takes an input string and removes the UTF-8 BOM character if present. 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, array $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 collateFilePathListByOption (array $list, $option, $default)
 Collates file paths by option (where provided). More...
 
static tryForKey (array $list, $key, $fallback=null)
 Get a list of element that match a key, optionally using a fallback key. More...
 
- 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

bool $debugRaw = true
 Link to raw files in debug mode. More...
 
array $debugScripts = []
 List of paths to JavaScript files to include in debug mode. More...
 
array $dependencies = []
 List of modules this module depends on. More...
 
string $group
 Name of group to load this module in. More...
 
bool $hasGeneratedStyles = false
 Whether getStyleURLsForDebug should return raw file paths, or return load.php urls. More...
 
array $languageScripts = []
 List of JavaScript files to include when using a specific language. More...
 
string $localBasePath = ''
 Local base path, see __construct() More...
 
array $localFileRefs = []
 Place where readStyleFile() tracks file dependencies. More...
 
array $messages = []
 List of message keys used by this module. More...
 
array $missingLocalFileRefs = []
 Place where readStyleFile() tracks file dependencies for non-existent files. More...
 
bool $noflip = false
 Whether CSSJanus flipping should be skipped for this module. More...
 
array $packageFiles = null
 List of packaged files to make available through require() More...
 
string $remoteBasePath = ''
 Remote base path, see __construct() More...
 
array $scripts = []
 List of paths to JavaScript files to always include. More...
 
array $skinScripts = []
 List of JavaScript files to include when using a specific skin. More...
 
array $skinStyles = []
 List of paths to CSS files to include when using specific skins. More...
 
string $skipFunction = null
 File name containing the body of the skip function. More...
 
array $styles = []
 List of paths to CSS files to always include. More...
 
 $targets = [ 'desktop' ]
 
array $templates = []
 Saves a list of the templates named by the modules. More...
 
- Protected Attributes inherited from ResourceLoaderModule
Config $config
 
array $contents = []
 Map of (context hash => cached module content) More...
 
string bool $deprecated = false
 Deprecation string or true if deprecated; false otherwise. More...
 
array $fileDeps = []
 Map of (variant => indirect file dependencies) More...
 
LoggerInterface $logger
 
array $msgBlobs = []
 Map of (language => in-object cache for message blob) More...
 
string null $name = null
 Module name. More...
 
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. More...
 
string[] $targets = [ 'desktop' ]
 What client platforms the module targets (e.g. More...
 
array $versionHash = []
 Map of (context hash => cached module version hash) More...
 

Private Member Functions

 expandPackageFiles (ResourceLoaderContext $context)
 Internal helper for use by getPackageFiles(), getFileHashes() and getDefinitionSummary(). More...
 
 getFileHashes (ResourceLoaderContext $context)
 Helper method for getDefinitionSummary. More...
 
 getLanguageScripts ( $lang)
 Get the set of language scripts for the given language, possibly using a fallback language. More...
 
 getScriptFiles (ResourceLoaderContext $context)
 Get a list of script file paths for this module, in order of proper execution. More...
 
 readScriptFiles (array $scripts)
 Get the contents of a list of JavaScript files. More...
 

Private Attributes

array $expandedPackageFiles = []
 Expanded versions of $packageFiles, lazy-computed by expandPackageFiles(); keyed by context hash. More...
 

Detailed Description

Module based on local JavaScript/CSS files.

The following public methods can query the database:

Since
1.17

Definition at line 35 of file ResourceLoaderFileModule.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoaderFileModule::__construct ( array  $options = [],
  $localBasePath = null,
  $remoteBasePath = null 
)

Constructs a new module from an options array.

Parameters
array$optionsList of options; if not given or empty, an empty module will be constructed
string | null$localBasePathBase path to prepend to all local paths in $options. Defaults to $IP
string | null$remoteBasePathBase path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath

Below is a description for the $options array:

Exceptions
InvalidArgumentException
Construction options:
[
// Base path to prepend to all local paths in $options. Defaults to $IP
'localBasePath' => [base path],
// Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath
'remoteBasePath' => [base path],
// Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath
'remoteExtPath' => [base path],
// Equivalent of remoteBasePath, but relative to $wgStylePath
'remoteSkinPath' => [base path],
// Scripts to always include (cannot be set if 'packageFiles' is also set, see below)
'scripts' => [file path string or array of file path strings],
// Scripts to include in specific language contexts
'languageScripts' => [
[language code] => [file path string or array of file path strings],
],
// Scripts to include in specific skin contexts
'skinScripts' => [
[skin name] => [file path string or array of file path strings],
],
// Scripts to include in debug contexts
'debugScripts' => [file path string or array of file path strings],
// For package modules: files to be made available for internal require() do not
// need to have 'type' defined; it will be inferred from the file name extension
// if omitted. 'config' can only be used when 'type' is 'data'; the variables are
// resolved with Config::get(). The first entry in 'packageFiles' is always the
// module entry point. If 'packageFiles' is set, 'scripts' cannot also be set.
'packageFiles' => [
[file path string], // or:
[ 'name' => [file name], 'file' => [file path], 'type' => 'script'|'data' ], // or:
[ 'name' => [name], 'content' => [string], 'type' => 'script'|'data' ], // or:
[ 'name' => [name], 'callback' => [callable], 'type' => 'script'|'data' ],
[ 'name' => [name], 'config' => [ [config var name], ... ], 'type' => 'data' ],
[ 'name' => [name], 'config' => [ [JS name] => [PHP name] ], 'type' => 'data' ],
],
// Modules which must be loaded before this module
'dependencies' => [module name string or array of module name strings],
'templates' => [
[template alias with file.ext] => [file path to a template file],
],
// Styles to always load
'styles' => [file path string or array of file path strings],
// Styles to include in specific skin contexts
'skinStyles' => [
[skin name] => [file path string or array of file path strings],
],
// Messages to always load
'messages' => [array of message key strings],
// Group which this module should be loaded together with
'group' => [group name string],
// Function that, if it returns true, makes the loader skip this module.
// The file must contain valid JavaScript for execution in a private function.
// The file must not contain the "function () {" and "}" wrapper though.
'skipFunction' => [file path]
]

Reimplemented in ResourceLoaderSkinModule, and ResourceLoaderLessVarFileModule.

Definition at line 240 of file ResourceLoaderFileModule.php.

References $localBasePath, $remoteBasePath, extractBasePaths(), and getPath().

Member Function Documentation

◆ collateFilePathListByOption()

static ResourceLoaderFileModule::collateFilePathListByOption ( array  $list,
  $option,
  $default 
)
staticprotected

Collates file paths by option (where provided).

Parameters
array$listList of file paths in any combination of index/path or path/options pairs
string$optionOption name
mixed$defaultDefault value if the option isn't set
Returns
array List of file paths, collated by $option

Definition at line 715 of file ResourceLoaderFileModule.php.

Referenced by getFileHashes(), and getSkinStyleFiles().

◆ compileLessFile()

ResourceLoaderFileModule::compileLessFile (   $fileName,
ResourceLoaderContext  $context 
)
protected

Compile a LESS file into CSS.

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

Since
1.22
1.27 Added $context parameter.
Exceptions
ExceptionIf less.php encounters a parse error
Parameters
string$fileNameFile path of LESS source
ResourceLoaderContext$contextContext in which to generate script
Returns
string CSS source

Definition at line 1021 of file ResourceLoaderFileModule.php.

References $cache, $context, CACHE_ANYTHING, FileContentsHasher\getFileContentsHash(), ResourceLoaderModule\getLessVars(), ObjectCache\getLocalServerInstance(), and serialize().

Referenced by readStyleFile().

◆ enableModuleContentVersion()

ResourceLoaderFileModule::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 ResourceLoaderModule.

Reimplemented in ResourceLoaderLanguageDataModule.

Definition at line 521 of file ResourceLoaderFileModule.php.

◆ expandPackageFiles()

ResourceLoaderFileModule::expandPackageFiles ( ResourceLoaderContext  $context)
private

Internal helper for use by getPackageFiles(), getFileHashes() and getDefinitionSummary().

This expands the 'packageFiles' definition into something that's (almost) the right format for getPackageFiles() to return. It expands shorthands, resolves config vars, and handles summarising any non-file data for getVersionHash(). For file-based data, getFileHashes() handles it instead, which also ends up in getDefinitionSummary().

What it does not do is reading the actual contents of any specified files, nor invoking the computation callbacks. Those things are done by getPackageFiles() instead to improve backend performance by only doing this work when the module response is needed, and not when merely computing the version hash for StartupModule, or when checking If-None-Match headers for a HTTP 304 response.

Parameters
ResourceLoaderContext$context
Returns
array|null -return array{main:string,files:string[][]}|null
Exceptions
LogicExceptionIf the 'packageFiles' definition is invalid.

Definition at line 1104 of file ResourceLoaderFileModule.php.

References $context, $file, $path, $type, ResourceLoaderModule\getConfig(), ResourceLoaderModule\getLogger(), and getPackageFileType().

Referenced by getDefinitionSummary(), getFileHashes(), and getPackageFiles().

◆ extractBasePaths()

static ResourceLoaderFileModule::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$optionsModule definition
string | null$localBasePathPath to use if not provided in module definition. Defaults to $IP
string | null$remoteBasePathPath to use if not provided in module definition. Defaults to $wgResourceBasePath
Returns
array [ localBasePath, remoteBasePath ]

Definition at line 342 of file ResourceLoaderFileModule.php.

References $IP, $localBasePath, $remoteBasePath, $wgExtensionAssetsPath, $wgResourceBasePath, and $wgStylePath.

Referenced by __construct(), ResourceLoaderSkinModule\getStyleFiles(), and getThemePaths().

◆ getAllSkinStyleFiles()

ResourceLoaderFileModule::getAllSkinStyleFiles ( )
protected

Gets 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 838 of file ResourceLoaderFileModule.php.

References Skin\getSkinNames(), and getSkinStyleFiles().

Referenced by getAllStyleFiles().

◆ getAllStyleFiles()

ResourceLoaderFileModule::getAllStyleFiles ( )

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

Returns
array

Definition at line 858 of file ResourceLoaderFileModule.php.

References getAllSkinStyleFiles(), and getLocalPath().

◆ getDefinitionSummary()

ResourceLoaderFileModule::getDefinitionSummary ( ResourceLoaderContext  $context)

Get the definition summary for this module.

Parameters
ResourceLoaderContext$context
Returns
array

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderSkinModule.

Definition at line 591 of file ResourceLoaderFileModule.php.

References $context, $packageFiles, expandPackageFiles(), getFileHashes(), ResourceLoaderModule\getLessVars(), and ResourceLoaderModule\getMessageBlob().

◆ getDependencies()

ResourceLoaderFileModule::getDependencies ( ResourceLoaderContext  $context = null)

Gets list of names of modules this module depends on.

Parameters
ResourceLoaderContext | null$context
Returns
array List of module names

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderForeignApiModule.

Definition at line 491 of file ResourceLoaderFileModule.php.

References $dependencies.

◆ getFileHashes()

◆ getFlip()

ResourceLoaderFileModule::getFlip ( ResourceLoaderContext  $context)

Get whether CSS for this module should be flipped.

Parameters
ResourceLoaderContext$context
Returns
bool

Reimplemented from ResourceLoaderModule.

Definition at line 974 of file ResourceLoaderFileModule.php.

References $context, and $noflip.

Referenced by getStyles().

◆ getGroup()

ResourceLoaderFileModule::getGroup ( )

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

Returns
string Group name

Reimplemented from ResourceLoaderModule.

Definition at line 482 of file ResourceLoaderFileModule.php.

References $group.

◆ getLanguageScripts()

ResourceLoaderFileModule::getLanguageScripts (   $lang)
private

Get the set of language scripts for the given language, possibly using a fallback language.

Parameters
string$lang
Returns
array

Definition at line 783 of file ResourceLoaderFileModule.php.

References $lang, $scripts, Language\getFallbacksFor(), and tryForKey().

Referenced by getFileHashes(), and getScriptFiles().

◆ getLocalPath()

ResourceLoaderFileModule::getLocalPath (   $path)
protected
Parameters
string | ResourceLoaderFilePath$path
Returns
string

Definition at line 663 of file ResourceLoaderFileModule.php.

References $path.

Referenced by getAllStyleFiles(), getPackageFiles(), getSkipFunction(), getTemplates(), readScriptFiles(), and readStyleFile().

◆ getMessages()

ResourceLoaderFileModule::getMessages ( )

Gets list of message keys used by this module.

Returns
array List of message keys

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderLessVarFileModule.

Definition at line 473 of file ResourceLoaderFileModule.php.

References $messages.

◆ getPackageFiles()

ResourceLoaderFileModule::getPackageFiles ( ResourceLoaderContext  $context)

Resolves the package files defintion and generates the content of each package file.

Parameters
ResourceLoaderContext$context
Returns
array Package files data structure, see ResourceLoaderModule::getScript()
Exceptions
RuntimeExceptionIf a file doesn't exist

Definition at line 1231 of file ResourceLoaderFileModule.php.

References $content, $context, $expandedPackageFiles, expandPackageFiles(), ResourceLoaderModule\getConfig(), getLocalPath(), and stripBom().

Referenced by getScript().

◆ getPackageFileType()

static ResourceLoaderFileModule::getPackageFileType (   $path)
static

Infer the file type from a package file path.

Parameters
string$path
Returns
string 'script' or 'data'

Definition at line 699 of file ResourceLoaderFileModule.php.

References $path.

Referenced by expandPackageFiles().

◆ getPath()

ResourceLoaderFileModule::getPath (   $path)
protected
Parameters
string | ResourceLoaderFilePath$path
Returns
string

Definition at line 651 of file ResourceLoaderFileModule.php.

References $path.

Referenced by __construct(), and getTemplates().

◆ getRemotePath()

ResourceLoaderFileModule::getRemotePath (   $path)
protected
Parameters
string | ResourceLoaderFilePath$path
Returns
string

Definition at line 675 of file ResourceLoaderFileModule.php.

References $path.

Referenced by getScriptURLsForDebug(), getStyleURLsForDebug(), and readStyleFile().

◆ getScript()

ResourceLoaderFileModule::getScript ( ResourceLoaderContext  $context)

Gets all scripts for a given context concatenated together.

Parameters
ResourceLoaderContext$contextContext in which to generate script
Returns
string|array JavaScript code for $context, or package files data structure

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderLanguageDataModule.

Definition at line 386 of file ResourceLoaderFileModule.php.

References $packageFiles, ResourceLoaderModule\getDeprecationInformation(), getPackageFiles(), getScriptFiles(), and readScriptFiles().

◆ getScriptFiles()

ResourceLoaderFileModule::getScriptFiles ( ResourceLoaderContext  $context)
private

Get a list of script file paths for this module, in order of proper execution.

Parameters
ResourceLoaderContext$context
Returns
array List of file paths

Definition at line 763 of file ResourceLoaderFileModule.php.

References $context, ResourceLoaderContext\getLanguage(), and getLanguageScripts().

Referenced by getScript(), and getScriptURLsForDebug().

◆ getScriptURLsForDebug()

ResourceLoaderFileModule::getScriptURLsForDebug ( ResourceLoaderContext  $context)
Parameters
ResourceLoaderContext$context
Returns
array

Reimplemented from ResourceLoaderModule.

Definition at line 405 of file ResourceLoaderFileModule.php.

References $file, ResourceLoaderModule\getConfig(), getRemotePath(), and getScriptFiles().

◆ getSkinStyleFiles()

ResourceLoaderFileModule::getSkinStyleFiles (   $skinName)
protected

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

Parameters
string$skinNameThe name of the skin
Returns
array A list of file paths collated by media type

Definition at line 824 of file ResourceLoaderFileModule.php.

References collateFilePathListByOption().

Referenced by getAllSkinStyleFiles().

◆ getSkipFunction()

ResourceLoaderFileModule::getSkipFunction ( )

Get the skip function.

Returns
null|string
Exceptions
MWException

Reimplemented from ResourceLoaderModule.

Definition at line 500 of file ResourceLoaderFileModule.php.

References ResourceLoaderModule\$contents, getLocalPath(), and stripBom().

◆ getStyleFiles()

ResourceLoaderFileModule::getStyleFiles ( ResourceLoaderContext  $context)

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

Reimplemented in ResourceLoaderSkinModule.

Definition at line 806 of file ResourceLoaderFileModule.php.

References $context.

Referenced by getStyles(), and getStyleURLsForDebug().

◆ getStyles()

ResourceLoaderFileModule::getStyles ( ResourceLoaderContext  $context)

Get all styles for a given context.

Parameters
ResourceLoaderContext$context
Returns
array CSS code for $context as an associative array mapping media type to CSS text.

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderSkinModule.

Definition at line 431 of file ResourceLoaderFileModule.php.

References $context, $styles, getFlip(), getStyleFiles(), readStyleFiles(), and ResourceLoaderModule\saveFileDependencies().

◆ getStyleSheetLang()

ResourceLoaderFileModule::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 690 of file ResourceLoaderFileModule.php.

References $path.

Referenced by readStyleFile().

◆ getStyleURLsForDebug()

ResourceLoaderFileModule::getStyleURLsForDebug ( ResourceLoaderContext  $context)
Parameters
ResourceLoaderContext$context
Returns
array

Reimplemented from ResourceLoaderModule.

Definition at line 447 of file ResourceLoaderFileModule.php.

References $context, $file, ResourceLoaderModule\getConfig(), getRemotePath(), and getStyleFiles().

◆ getTargets()

ResourceLoaderFileModule::getTargets ( )

Get target(s) for the module, eg ['desktop'] or ['desktop', 'mobile'].

Returns
array Array of strings

Reimplemented from ResourceLoaderModule.

Definition at line 983 of file ResourceLoaderFileModule.php.

References $targets.

◆ getTemplates()

ResourceLoaderFileModule::getTemplates ( )

Takes named templates by the module and returns an array mapping.

Returns
array Templates mapping template alias to content
Exceptions
RuntimeExceptionIf a file doesn't exist

Reimplemented from ResourceLoaderModule.

Definition at line 1067 of file ResourceLoaderFileModule.php.

References $content, $templates, getLocalPath(), getPath(), and stripBom().

◆ getType()

ResourceLoaderFileModule::getType ( )

Get the module's load type.

Since
1.28
Returns
string

Reimplemented from ResourceLoaderModule.

Definition at line 993 of file ResourceLoaderFileModule.php.

References $packageFiles.

◆ readScriptFiles()

ResourceLoaderFileModule::readScriptFiles ( array  $scripts)
private

Get the contents of a list of JavaScript files.

Helper for getScript().

Parameters
array$scriptsList of file paths to scripts to read, remap and concetenate
Returns
string Concatenated JavaScript data from $scripts
Exceptions
MWException

Definition at line 882 of file ResourceLoaderFileModule.php.

References ResourceLoaderModule\$contents, $scripts, getLocalPath(), and stripBom().

Referenced by getScript().

◆ readStyleFile()

ResourceLoaderFileModule::readStyleFile (   $path,
  $flip,
ResourceLoaderContext  $context 
)
protected

Reads a style file.

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

Parameters
string$pathFile path of style file to read
bool$flip
ResourceLoaderContext$context
Returns
string CSS data in script file
Exceptions
RuntimeExceptionIf the file doesn't exist

Definition at line 936 of file ResourceLoaderFileModule.php.

References $context, $file, $localFileRefs, $path, compileLessFile(), getLocalPath(), getRemotePath(), getStyleSheetLang(), and stripBom().

Referenced by readStyleFiles().

◆ readStyleFiles()

ResourceLoaderFileModule::readStyleFiles ( array  $styles,
  $flip,
ResourceLoaderContext  $context 
)

Get the contents of a list of CSS files.

Definition at line 909 of file ResourceLoaderFileModule.php.

References $context, $file, $styles, and readStyleFile().

Referenced by getStyles().

◆ stripBom()

ResourceLoaderFileModule::stripBom (   $input)
protected

Takes an input string and removes 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 intial BOM char

Definition at line 1280 of file ResourceLoaderFileModule.php.

Referenced by getPackageFiles(), getSkipFunction(), getTemplates(), readScriptFiles(), and readStyleFile().

◆ supportsURLLoading()

ResourceLoaderFileModule::supportsURLLoading ( )
Returns
bool

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderLanguageDataModule.

Definition at line 419 of file ResourceLoaderFileModule.php.

References $packageFiles.

◆ tryForKey()

static ResourceLoaderFileModule::tryForKey ( array  $list,
  $key,
  $fallback = null 
)
staticprotected

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

Parameters
array$listList of lists to select from
string$keyKey to look for in $map
string | null$fallbackKey to look for in $list if $key doesn't exist
Returns
array List of elements from $map which matched $key or $fallback, or an empty list in case of no match

Definition at line 745 of file ResourceLoaderFileModule.php.

References $fallback.

Referenced by getLanguageScripts().

Member Data Documentation

◆ $debugRaw

bool ResourceLoaderFileModule::$debugRaw = true
protected

Link to raw files in debug mode.

Definition at line 142 of file ResourceLoaderFileModule.php.

◆ $debugScripts

array ResourceLoaderFileModule::$debugScripts = []
protected

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

Usage:
[ [skin-name] => [ [file-path], [file-path], ... ], ... ]

Definition at line 80 of file ResourceLoaderFileModule.php.

◆ $dependencies

array ResourceLoaderFileModule::$dependencies = []
protected

List of modules this module depends on.

Usage:
[ [file-path], [file-path], ... ]

Definition at line 122 of file ResourceLoaderFileModule.php.

Referenced by ResourceLoaderForeignApiModule\getDependencies(), and getDependencies().

◆ $expandedPackageFiles

array ResourceLoaderFileModule::$expandedPackageFiles = []
private

Expanded versions of $packageFiles, lazy-computed by expandPackageFiles(); keyed by context hash.

Definition at line 113 of file ResourceLoaderFileModule.php.

Referenced by getFileHashes(), and getPackageFiles().

◆ $group

string ResourceLoaderFileModule::$group
protected

Name of group to load this module in.

Definition at line 139 of file ResourceLoaderFileModule.php.

Referenced by getGroup().

◆ $hasGeneratedStyles

bool ResourceLoaderFileModule::$hasGeneratedStyles = false
protected

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

Definition at line 153 of file ResourceLoaderFileModule.php.

◆ $languageScripts

array ResourceLoaderFileModule::$languageScripts = []
protected

List of JavaScript files to include when using a specific language.

Usage:
[ [language-code] => [ [file-path], [file-path], ... ], ... ]

Definition at line 62 of file ResourceLoaderFileModule.php.

◆ $localBasePath

string ResourceLoaderFileModule::$localBasePath = ''
protected

◆ $localFileRefs

array ResourceLoaderFileModule::$localFileRefs = []
protected

Place where readStyleFile() tracks file dependencies.

Usage:
[ [file-path], [file-path], ... ]

Definition at line 162 of file ResourceLoaderFileModule.php.

Referenced by readStyleFile().

◆ $messages

array ResourceLoaderFileModule::$messages = []
protected

List of message keys used by this module.

Usage:
[ [message-key], [message-key], ... ]

Definition at line 136 of file ResourceLoaderFileModule.php.

Referenced by getMessages().

◆ $missingLocalFileRefs

array ResourceLoaderFileModule::$missingLocalFileRefs = []
protected

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

Used in tests to detect missing dependencies.

Definition at line 168 of file ResourceLoaderFileModule.php.

◆ $noflip

bool ResourceLoaderFileModule::$noflip = false
protected

Whether CSSJanus flipping should be skipped for this module.

Definition at line 147 of file ResourceLoaderFileModule.php.

Referenced by getFlip().

◆ $packageFiles

array ResourceLoaderFileModule::$packageFiles = null
protected

List of packaged files to make available through require()

Usage:
[ [file-path-or-object], [file-path-or-object], ... ]

Definition at line 107 of file ResourceLoaderFileModule.php.

Referenced by getDefinitionSummary(), getFileHashes(), getScript(), getType(), and supportsURLLoading().

◆ $remoteBasePath

string ResourceLoaderFileModule::$remoteBasePath = ''
protected

◆ $scripts

array ResourceLoaderFileModule::$scripts = []
protected

List of paths to JavaScript files to always include.

Usage:
[ [file-path], [file-path], ... ]

Definition at line 53 of file ResourceLoaderFileModule.php.

Referenced by getLanguageScripts(), and readScriptFiles().

◆ $skinScripts

array ResourceLoaderFileModule::$skinScripts = []
protected

List of JavaScript files to include when using a specific skin.

Usage:
[ [skin-name] => [ [file-path], [file-path], ... ], ... ]

Definition at line 71 of file ResourceLoaderFileModule.php.

Referenced by ResourceLoaderOOUIFileModule\__construct().

◆ $skinStyles

array ResourceLoaderFileModule::$skinStyles = []
protected

List of paths to CSS files to include when using specific skins.

Usage:
[ [file-path], [file-path], ... ]

Definition at line 98 of file ResourceLoaderFileModule.php.

Referenced by ResourceLoaderOOUIFileModule\__construct().

◆ $skipFunction

string ResourceLoaderFileModule::$skipFunction = null
protected

File name containing the body of the skip function.

Definition at line 127 of file ResourceLoaderFileModule.php.

Referenced by getFileHashes().

◆ $styles

array ResourceLoaderFileModule::$styles = []
protected

List of paths to CSS files to always include.

Usage:
[ [file-path], [file-path], ... ]

Definition at line 89 of file ResourceLoaderFileModule.php.

Referenced by getFileHashes(), ResourceLoaderSkinModule\getStyleFiles(), ResourceLoaderSkinModule\getStyles(), getStyles(), ResourceLoaderSkinModule\normalizeStyles(), and readStyleFiles().

◆ $targets

ResourceLoaderFileModule::$targets = [ 'desktop' ]
protected

Definition at line 144 of file ResourceLoaderFileModule.php.

Referenced by getTargets().

◆ $templates

array ResourceLoaderFileModule::$templates = []
protected

Saves a list of the templates named by the modules.

Definition at line 44 of file ResourceLoaderFileModule.php.

Referenced by getTemplates().


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