ResourceLoaderLessVarFileModule Class Reference

Module augmented with context-specific LESS variables. More...

Inheritance diagram for ResourceLoaderLessVarFileModule:

Collaboration diagram for ResourceLoaderLessVarFileModule:

Public Member Functions
	__construct (array $options=[], $localBasePath=null, $remoteBasePath=null)
	Constructs 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 $IP string | null $remoteBasePath Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath Exceptions InvalidArgumentException See also $wgResourceModules
	getMessages ()
	Gets list of message keys used by this module. Returns string[] List of message keys
Public Member Functions inherited from ResourceLoaderFileModule
	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 (ResourceLoaderContext $context)
	Get whether CSS for this module should be flipped.
	getGroup ()
	Gets the name of the group this module should be loaded in.
	getPackageFiles (ResourceLoaderContext $context)
	Resolves the package files definition and generates the content of each package file.
	getScript (ResourceLoaderContext $context)
	Gets all scripts for a given context concatenated together.
	getScriptURLsForDebug (ResourceLoaderContext $context)
	getSkipFunction ()
	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.
	readStyleFiles (array $styles, ResourceLoaderContext $context)
	Get the contents of a list of CSS files.
	requiresES6 ()
	Whether the module requires ES6 support in the client.
	setSkinStylesOverride (array $moduleSkinStyles)
	Provide overrides for skinStyles to modules that support that.
	supportsURLLoading ()
Public Member Functions inherited from ResourceLoaderModule
	getConfig ()
	getDeprecationInformation (ResourceLoaderContext $context)
	Get JS representing deprecation information for the current module if available.
	getHeaders (ResourceLoaderContext $context)
	Get headers to send as part of a module web response.
	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 source 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)
	setDependencyAccessCallbacks (callable $loadCallback, callable $saveCallback)
	Inject the functions that load/save the indirect file path dependency list from storage.
	setFileDependencies (ResourceLoaderContext $context, array $paths)
	Set the indirect dependencies for this module persuant to the skin/language context.
	setHookContainer (HookContainer $hookContainer)
	setLogger (LoggerInterface $logger)
	setMessageBlob ( $blob, $lang)
	Set in-object cache for message blobs.
	setName ( $name)
	Set this module's name.
	shouldEmbedModule (ResourceLoaderContext $context)
	Check whether this module should be embeded rather than linked.

Protected Member Functions
	getLessVars (ResourceLoaderContext $context)
	Get language-specific LESS variables for this module.
	getMessageBlob (ResourceLoaderContext $context)
	Get the hash of the message blob. Stability: stable to override Since 1.27 Parameters ResourceLoaderContext $context Returns string|null JSON blob or null if module has no messages
Protected Member Functions inherited from ResourceLoaderFileModule
	compileLessFile ( $fileName, ResourceLoaderContext $context)
	compileLessString ( $style, $stylePath, ResourceLoaderContext $context)
	Compile a LESS string into CSS.
	getAllSkinStyleFiles ()
	Gets 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)
	Gets a list of file paths for all skin styles in the module used by the skin.
	getVueComponentParser ()
	processStyle ( $style, $styleLang, $path, ResourceLoaderContext $context)
	Process a CSS/LESS string.
	readStyleFile ( $path, ResourceLoaderContext $context)
	Read and process 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.
	getFileDependencies (ResourceLoaderContext $context)
	Get the indirect dependencies for this module persuant to the skin/language context.
	getHookRunner ()
	Get a HookRunner for running core hooks.
	getLogger ()
	getPreloadLinks (ResourceLoaderContext $context)
	Get a list of resources that web browsers may preload.
	saveFileDependencies (ResourceLoaderContext $context, array $curFileRefs)
	Save the indirect dependencies for this module persuant to the skin/language context.
	validateScriptFile ( $fileName, $contents)
	Validate a user-provided JavaScript blob.

Protected Attributes
	$lessVariables = []
Protected Attributes inherited from ResourceLoaderFileModule
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.
bool	$es6 = false
	Whether this module requires the client to support ES6.
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.
array	$packageFiles = null
	List of packaged files to make available through require()
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.
string[]	$targets = [ 'desktop' ]
array	$templates = []
	Saves a list of the templates named by the modules.
VueComponentParser null	$vueComponentParser = null
	Lazy-created by getVueComponentParser()
Protected Attributes inherited from ResourceLoaderModule
Config	$config
array	$contents = []
	Map of (context hash => cached module content)
string bool	$deprecated = false
	Deprecation string or true if deprecated; false otherwise.
array	$fileDeps = []
	Map of (variant => indirect file dependencies)
LoggerInterface	$logger
array	$msgBlobs = []
	Map of (language => in-object cache for message blob)
string null	$name = null
	Module name.
int	$origin = self::ORIGIN_CORE_SITEWIDE
	Script and style modules form a hierarchy of trustworthiness, with core modules like skins and jQuery as most trustworthy, and user scripts as least trustworthy.
string[]	$targets = [ 'desktop' ]
	What client platforms the module targets (e.g.
array	$versionHash = []
	Map of (context hash => cached module version hash)

Private Member Functions
	pluckFromMessageBlob ( $blob, array $allowed)
	Return a subset of messages from a JSON string representation.

Static Private Member Functions
static	wrapAndEscapeMessage ( $msg)
	Escape and wrap a message value as literal string for LESS.

Additional Inherited Members
Static Public Member Functions inherited from ResourceLoaderFileModule
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 ResourceLoaderModule
static	expandRelativePaths (array $filePaths)
	Expand directories relative to $IP.
static	getRelativePaths (array $filePaths)
	Make file paths relative to MediaWiki directory.
static	getVary (ResourceLoaderContext $context)
	Get vary string.
Static Protected Member Functions inherited from ResourceLoaderFileModule
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	safeFileHash ( $filePath)
	Compute a non-cryptographic string hash of a file's contents.

Detailed Description

Module augmented with context-specific LESS variables.

Since

1.32

Definition at line 31 of file ResourceLoaderLessVarFileModule.php.

Constructor & Destructor Documentation

__construct()

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

Constructs 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 $IP
string | null	$remoteBasePath	Base path to prepend to all remote paths in $options. Defaults to $wgResourceBasePath

Exceptions

InvalidArgumentException

See also

$wgResourceModules

Reimplemented from ResourceLoaderFileModule.

Reimplemented in ResourceLoaderSkinModule.

Definition at line 37 of file ResourceLoaderLessVarFileModule.php.

References ResourceLoaderFileModule\$localBasePath, and ResourceLoaderFileModule\$remoteBasePath.

Member Function Documentation

getLessVars()

ResourceLoaderLessVarFileModule::getLessVars ( ResourceLoaderContext  $context )

protected

Get language-specific LESS variables for this module.

Parameters

ResourceLoaderContext

$context

Returns

array LESS variables

Reimplemented from ResourceLoaderModule.

Reimplemented in ResourceLoaderSkinModule.

Definition at line 116 of file ResourceLoaderLessVarFileModule.php.

References $blob.

getMessageBlob()

ResourceLoaderLessVarFileModule::getMessageBlob ( ResourceLoaderContext  $context )

protected

Get the hash of the message blob.

Stability: stable

to override

Since

1.27

Parameters

ResourceLoaderContext

$context

Returns

string|null JSON blob or null if module has no messages

Reimplemented from ResourceLoaderModule.

Definition at line 73 of file ResourceLoaderLessVarFileModule.php.

References $blob.

getMessages()

ResourceLoaderLessVarFileModule::getMessages

(

)

Gets list of message keys used by this module.

Returns

string[] List of message keys

Reimplemented from ResourceLoaderFileModule.

Definition at line 51 of file ResourceLoaderLessVarFileModule.php.

pluckFromMessageBlob()

ResourceLoaderLessVarFileModule::pluckFromMessageBlob (   $blob, array  $allowed  )

private

Return a subset of messages from a JSON string representation.

Parameters

string | null	$blob	JSON, or null if module has no declared messages
string[]	$allowed

Returns

array

Definition at line 63 of file ResourceLoaderLessVarFileModule.php.

wrapAndEscapeMessage()

static ResourceLoaderLessVarFileModule::wrapAndEscapeMessage (   $msg )

staticprivate

Escape and wrap a message value as literal string for LESS.

This mostly lets CSSMin escape it and wrap it, but also escape single quotes for compatibility with LESS's feature of variable interpolation into other strings. This is relatively rare for most use of LESS, but for messages it is quite common.

Example:

@x: "foo's";
.eg { content: 'Value is @{x}'; }

Produces output: ‘.eg { content: 'Value is foo's’; }`. (Tested in less.php 1.8.1, and Less.js 2.7)

Parameters

string

$msg

Returns

string wrapped LESS variable value

Definition at line 104 of file ResourceLoaderLessVarFileModule.php.

Member Data Documentation

$lessVariables

ResourceLoaderLessVarFileModule::$lessVariables = []

protected

Definition at line 32 of file ResourceLoaderLessVarFileModule.php.

---

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

• includes/resourceloader/ResourceLoaderLessVarFileModule.php