|
| __construct (array $options=[], $localBasePath=null, $remoteBasePath=null) |
|
| generateAndAppendLogoStyles ( $featureStyles, $context) |
| Generates CSS for .mw-logo-logo styles and appends them to the skin feature styles array.
|
|
| getDefinitionSummary (Context $context) |
| Get the definition summary for this module.
|
|
| getFeatureFilePaths () |
| Get styles defined in the module definition.
|
|
| getPreloadLinks (Context $context) |
|
| getStyles (Context $context) |
|
| isKnownEmpty (Context $context) |
|
| getMessages () |
| Get message keys used by this module.- Returns
- string[] List of message keys
|
|
| __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.
|
|
| 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.
|
|
| 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.
|
|
| 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 () |
|
| 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.
|
|
| 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.
|
|
|
| getLessVars (Context $context) |
| Get language-specific LESS variables for this module.
|
|
| getLogoData (Config $conf, string $lang=null) |
|
| getMessageBlob (Context $context) |
| Get the hash of the message blob.- Stability: stable
- to override
- Since
- 1.27
- Parameters
-
- Returns
- string|null JSON blob or null if module has no messages
|
|
| 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.
|
|
| 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.
|
|
| getLogger () |
|
| 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.
|
|
|
| $lessVariables = [] |
|
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()
|
|
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)
|
|
Module for skin stylesheets.
- Access: internal
Definition at line 34 of file SkinModule.php.