ResourceLoader module based on local JavaScript/CSS files. More...

Inheritance diagram for ResourceLoaderFileModule:

[legend]

Collaboration diagram for ResourceLoaderFileModule:

[legend]

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

	enableModuleContentVersion ()
	Disable module content versioning.

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

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

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

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

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

	getMessages ()
	Gets list of message keys used by this module.

	getScript (ResourceLoaderContext $context)
	Gets all scripts for a given context concatenated together.

	getScriptURLsForDebug (ResourceLoaderContext $context)

	getSkipFunction ()
	Get the skip function.

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

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

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

	getStyleURLsForDebug (ResourceLoaderContext $context)

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

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

	getType ()
	Get the module's load type.

	isRaw ()

	readStyleFiles (array $styles, $flip, $context=null)
	Gets the contents of a list of CSS files.

	supportsURLLoading ()

Public Member Functions inherited from ResourceLoaderModule
	getConfig ()

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

	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.

	getSource ()
	Get the origin of this module.

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

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

	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.

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

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
	compileLessFile ( $fileName, ResourceLoaderContext $context)
	Compile a LESS file into CSS.

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

	getFileHashes (ResourceLoaderContext $context)
	Helper method to gather file hashes for getDefinitionSummary.

	getLocalPath ( $path)

	getRemotePath ( $path)

	getScriptFiles (ResourceLoaderContext $context)
	Get a list of file paths for all scripts in this module, in order of proper execution.

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

	readScriptFiles (array $scripts)
	Gets the contents of a list of JavaScript files.

	readStyleFile ( $path, $flip, $context)
	Reads a style file.

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

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	collateFilePathListByOption (array $list, $option, $default)
	Collates file paths by option (where provided).

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 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
bool	$debugRaw = true
	Link to raw files in debug mode.

array	$debugScripts = []
	List of paths to JavaScript files to include in debug mode.

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

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

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

array	$languageScripts = []
	List of JavaScript files to include when using a specific language.

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

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

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

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

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

bool	$raw = false
	Whether mw.loader.state() call should be omitted.

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

array	$scripts = []
	List of paths to JavaScript files to always include.

array	$skinScripts = []
	List of JavaScript files to include when using a specific skin.

array	$skinStyles = []
	List of paths to CSS files to include when using specific skins.

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

array	$styles = []
	List of paths to CSS files to always include.

	$targets = [ 'desktop' ]

array	$templates = []
	Saves a list of the templates named by the modules.

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
	getLanguageScripts ( $lang)
	Get the set of language scripts for the given language, possibly using a fallback language.

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

ResourceLoader module based on local JavaScript/CSS files.

Definition at line 28 of file ResourceLoaderFileModule.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructs a new module from an options array.

Parameters

array	$options	List of options; if not given or empty, an empty module will be constructed
string	$localBasePath	Base path to prepend to all local paths in $options. Defaults to $IP
string	$remoteBasePath	Base 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

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

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

]

or
or
Definition APACHE-LICENSE-2.0.txt:114

skin
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a skin(according to that user 's preference)

name
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition design.txt:12

key
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
Definition design.txt:26

strings
it sets a lot of them automatically from query strings
Definition design.txt:93

of
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
database rows
Definition globals.txt:10

array
the array() calling protocol came about after MediaWiki 1.4rc1.

string
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition hooks.txt:181

message
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a message
Definition hooks.txt:2163

code
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and local administrators to define code that will be run at certain points in the mainline code
Definition hooks.txt:28

file
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition hooks.txt:106

Definition at line 208 of file ResourceLoaderFileModule.php.

References $localBasePath, $options, $remoteBasePath, $value, array(), as, extractBasePaths(), list, and string.

Member Function Documentation

◆ collateFilePathListByOption()

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

staticprotected

Collates file paths by option (where provided).

Parameters

array	$list	List of file paths in any combination of index/path or path/options pairs
string	$option	Option name
mixed	$default	Default value if the option isn't set

Returns: array List of file paths, collated by $option

Definition at line 633 of file ResourceLoaderFileModule.php.

References $value, array(), and as.

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

Exceptions

Exception If less.php encounters a parse error

Parameters

string	$fileName	File path of LESS source
ResourceLoaderContext	$context	Context in which to generate script

Returns: string CSS source

Definition at line 955 of file ResourceLoaderFileModule.php.

References $cache, $context, $css, $vars, CACHE_ANYTHING, FileContentsHasher\getFileContentsHash(), ResourceLoaderModule\getLessVars(), 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 ResourceLoaderJqueryMsgModule, and ResourceLoaderMediaWikiUtilModule.

Definition at line 484 of file ResourceLoaderFileModule.php.

◆ extractBasePaths()

static ResourceLoaderFileModule::extractBasePaths	(	$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	$localBasePath	Path to use if not provided in module definition. Defaults to $IP
string	$remoteBasePath	Path to use if not provided in module definition. Defaults to $wgResourceBasePath

Returns: array Array( localBasePath, remoteBasePath )

Definition at line 307 of file ResourceLoaderFileModule.php.

References $IP, $localBasePath, $options, $remoteBasePath, $wgExtensionAssetsPath, $wgResourceBasePath, $wgStylePath, global, and string.

Referenced by __construct(), and ResourceLoader\register().

◆ 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 755 of file ResourceLoaderFileModule.php.

References as, 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 775 of file ResourceLoaderFileModule.php.

References as, 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 548 of file ResourceLoaderFileModule.php.

References $context, $options, as, 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 444 of file ResourceLoaderFileModule.php.

References $dependencies.

◆ getFileHashes()

ResourceLoaderFileModule::getFileHashes ( ResourceLoaderContext $context )

protected

Helper method to gather file hashes for getDefinitionSummary.

This function is context-sensitive, only computing hashes of files relevant to the given language, skin, etc.

See also: ResourceLoaderModule::getFileDependencies

Parameters

ResourceLoaderContext $context

Returns: array

Definition at line 498 of file ResourceLoaderFileModule.php.

References $context, $skipFunction, $styles, as, collateFilePathListByOption(), ResourceLoaderModule\getFileDependencies(), ResourceLoaderContext\getLanguage(), getLanguageScripts(), scripts, and tryForKey().

Referenced by getDefinitionSummary().

◆ getFlip()

ResourceLoaderFileModule::getFlip ( $context )

Get whether CSS for this module should be flipped.

Parameters

ResourceLoaderContext $context

Returns: bool

Reimplemented from ResourceLoaderModule.

Definition at line 908 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 435 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 701 of file ResourceLoaderFileModule.php.

References $lang, $scripts, as, and tryForKey().

Referenced by getFileHashes(), and getScriptFiles().

◆ getLocalPath()

ResourceLoaderFileModule::getLocalPath ( $path )

protected

Parameters

string | ResourceLoaderFilePath $path

Returns: string

Definition at line 593 of file ResourceLoaderFileModule.php.

References $path.

Referenced by getAllStyleFiles(), 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.

Definition at line 426 of file ResourceLoaderFileModule.php.

References $messages.

◆ getRemotePath()

ResourceLoaderFileModule::getRemotePath ( $path )

protected

Parameters

string | ResourceLoaderFilePath $path

Returns: string

Definition at line 605 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 $context Context in which to generate script

Returns: string JavaScript code for $context

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderJqueryMsgModule, ResourceLoaderMediaWikiUtilModule, and ResourceLoaderRawFileModule.

Definition at line 351 of file ResourceLoaderFileModule.php.

References ResourceLoaderModule\getDeprecationInformation(), getScriptFiles(), and readScriptFiles().

◆ getScriptFiles()

ResourceLoaderFileModule::getScriptFiles ( ResourceLoaderContext $context )

protected

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

Parameters

ResourceLoaderContext $context

Returns: array List of file paths

Definition at line 681 of file ResourceLoaderFileModule.php.

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

Referenced by getScript(), and getScriptURLsForDebug().

◆ getScriptURLsForDebug()

ResourceLoaderFileModule::getScriptURLsForDebug ( ResourceLoaderContext $context )

Parameters

ResourceLoaderContext $context

Returns: array

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderJqueryMsgModule.

Definition at line 360 of file ResourceLoaderFileModule.php.

References $urls, as, 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 $skinName The name of the skin

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

Definition at line 741 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 453 of file ResourceLoaderFileModule.php.

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

◆ getStyleFiles()

ResourceLoaderFileModule::getStyleFiles ( ResourceLoaderContext $context )

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

Parameters

ResourceLoaderContext $context

Returns: array List of file paths

Definition at line 723 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 384 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 620 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 400 of file ResourceLoaderFileModule.php.

References $context, $urls, as, 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 917 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

MWException

Reimplemented from ResourceLoaderModule.

Definition at line 1001 of file ResourceLoaderFileModule.php.

References $templates, as, getLocalPath(), stripBom(), and wfDebugLog().

◆ getType()

ResourceLoaderFileModule::getType ( )

Get the module's load type.

Since: 1.28

Returns: string

Reimplemented from ResourceLoaderModule.

Definition at line 927 of file ResourceLoaderFileModule.php.

References $raw, ResourceLoaderModule\LOAD_GENERAL, ResourceLoaderModule\LOAD_STYLES, messages, and scripts.

◆ isRaw()

ResourceLoaderFileModule::isRaw ( )

Returns: bool

Reimplemented from ResourceLoaderModule.

Definition at line 472 of file ResourceLoaderFileModule.php.

References $raw.

◆ readScriptFiles()

ResourceLoaderFileModule::readScriptFiles ( array $scripts )

protected

Gets the contents of a list of JavaScript files.

Parameters

array $scripts List of file paths to scripts to read, remap and concetenate

Exceptions

MWException

Returns: string Concatenated and remapped JavaScript data from $scripts

Definition at line 799 of file ResourceLoaderFileModule.php.

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

Referenced by getScript().

◆ readStyleFile()

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

protected

Reads a style file.

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

Parameters

string	$path	File path of style file to read
bool	$flip
ResourceLoaderContext	$context

Returns: string CSS data in script file

Exceptions

MWException If the file doesn't exist

Definition at line 868 of file ResourceLoaderFileModule.php.

References $context, $localFileRefs, $path, as, compileLessFile(), CSSMin\getLocalFileReferences(), getLocalPath(), getRemotePath(), getStyleSheetLang(), CSSMin\remap(), stripBom(), and wfDebugLog().

Referenced by readStyleFiles().

◆ readStyleFiles()

ResourceLoaderFileModule::readStyleFiles	(	array	$styles,
			$flip,
			$context = `null`
	)

Gets the contents of a list of CSS files.

Parameters

array	$styles	List of media type/list of file paths pairs, to read, remap and concetenate
bool	$flip
ResourceLoaderContext	$context

Exceptions

MWException

Returns: array List of concatenated and remapped CSS data from $styles, keyed by media type

Since: 1.27 Calling this method without a ResourceLoaderContext instance is deprecated.

Definition at line 836 of file ResourceLoaderFileModule.php.

References $context, $styles, as, ResourceLoaderContext\newDummyContext(), readStyleFile(), and wfDeprecated().

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