MediaWiki REL1_37
|
Module for skin stylesheets. More...
Public Member Functions | |
__construct (array $options=[], $localBasePath=null, $remoteBasePath=null) | |
getDefinitionSummary (ResourceLoaderContext $context) | |
Get the definition summary for this module. | |
getPreloadLinks (ResourceLoaderContext $context) | |
getStyleFiles (ResourceLoaderContext $context) | |
Get styles defined in the module definition, plus any enabled feature styles. | |
getStyles (ResourceLoaderContext $context) | |
isKnownEmpty (ResourceLoaderContext $context) | |
![]() | |
getMessages () | |
Gets list of message keys used by this module.
| |
![]() | |
enableModuleContentVersion () | |
Disable module content versioning. | |
getAllStyleFiles () | |
Returns all style files and all skin style files used by 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 () | |
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 () | |
![]() | |
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. | |
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. | |
Static Public Member Functions | |
static | getAvailableLogos ( $conf) |
Return an array of all available logos that a skin may use. | |
![]() | |
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 | 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. | |
Public Attributes | |
$targets = [ 'desktop', 'mobile' ] | |
All skins are assumed to be compatible with mobile. | |
Protected Member Functions | ||||
getLessVars (ResourceLoaderContext $context) | ||||
Get language-specific LESS variables for this module. | ||||
getLogoData (Config $conf) | ||||
![]() | ||||
getMessageBlob (ResourceLoaderContext $context) | ||||
Get the hash of the message blob.
| ||||
![]() | ||||
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. | ||||
![]() | ||||
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 () | ||||
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. | ||||
Static Protected Member Functions | |
static | applyFeaturesCompatibility (array $features, &$messages='') |
![]() | |
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 | safeFileHash ( $filePath) |
Compute a non-cryptographic string hash of a file's contents. | |
Private Member Functions | |
getLogoPreloadlinks () | |
Helper method for getPreloadLinks() | |
normalizeStyles (array &$styles) | |
Ensure all media keys use array values. | |
Static Private Member Functions | |
static | getRelativeSizedLogo (array $logoElement) |
Modifies configured logo width/height to ensure they are present and scaleable with different font-sizes. | |
Private Attributes | |
string[] | $features |
const | FEATURE_FILES |
Every skin should define which features it would like to reuse for core inside a ResourceLoader module that has set the class to ResourceLoaderSkinModule. | |
const | LESS_MESSAGES |
Additional Inherited Members | |
![]() | |
$lessVariables = [] | |
![]() | |
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() | |
![]() | |
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) | |
Module for skin stylesheets.
Definition at line 28 of file ResourceLoaderSkinModule.php.
ResourceLoaderSkinModule::__construct | ( | array | $options = [] , |
$localBasePath = null , |
|||
$remoteBasePath = null |
|||
) |
array | $options |
|
string | null | $localBasePath | |
string | null | $remoteBasePath |
Reimplemented from ResourceLoaderLessVarFileModule.
Definition at line 233 of file ResourceLoaderSkinModule.php.
References $features, ResourceLoaderFileModule\$localBasePath, ResourceLoaderFileModule\$messages, ResourceLoaderFileModule\$remoteBasePath, and applyFeaturesCompatibility().
|
staticprotected |
array | $features | |
string | &$messages | to report deprecations |
Definition at line 280 of file ResourceLoaderSkinModule.php.
References $features, and ResourceLoaderFileModule\$messages.
Referenced by __construct().
|
static |
Return an array of all available logos that a skin may use.
Config | $conf |
icon
and wordmark
(required)tagline
message in certain skins. Must declare width and height fields defined in pixels, which are converted to ems based on 16px font-size.Definition at line 563 of file ResourceLoaderSkinModule.php.
Referenced by ApiQuerySiteinfo\appendGeneralInfo(), Skin\getLogo(), Skin\logoText(), and SkinTemplate\prepareQuickTemplate().
ResourceLoaderSkinModule::getDefinitionSummary | ( | ResourceLoaderContext | $context | ) |
Get the definition summary for this module.
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderFileModule.
Definition at line 691 of file ResourceLoaderSkinModule.php.
|
protected |
Get language-specific LESS variables for this module.
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderLessVarFileModule.
Definition at line 675 of file ResourceLoaderSkinModule.php.
|
protected |
Config | $conf |
Definition at line 622 of file ResourceLoaderSkinModule.php.
|
private |
Helper method for getPreloadLinks()
Definition at line 441 of file ResourceLoaderSkinModule.php.
ResourceLoaderSkinModule::getPreloadLinks | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 433 of file ResourceLoaderSkinModule.php.
|
staticprivate |
Modifies configured logo width/height to ensure they are present and scaleable with different font-sizes.
array | $logoElement | with width, height and src keys. |
Definition at line 539 of file ResourceLoaderSkinModule.php.
ResourceLoaderSkinModule::getStyleFiles | ( | ResourceLoaderContext | $context | ) |
Get styles defined in the module definition, plus any enabled feature styles.
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderFileModule.
Definition at line 333 of file ResourceLoaderSkinModule.php.
References ResourceLoaderFileModule\extractBasePaths().
ResourceLoaderSkinModule::getStyles | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderFileModule.
Definition at line 383 of file ResourceLoaderSkinModule.php.
ResourceLoaderSkinModule::isKnownEmpty | ( | ResourceLoaderContext | $context | ) |
ResourceLoaderContext | $context |
Reimplemented from ResourceLoaderModule.
Definition at line 663 of file ResourceLoaderSkinModule.php.
|
private |
Ensure all media keys use array values.
Normalises arrays returned by the ResourceLoaderFileModule::getStyles() method.
array | &$styles | Associative array, keys are strings (media queries), values are strings or arrays |
Definition at line 525 of file ResourceLoaderSkinModule.php.
|
private |
Definition at line 180 of file ResourceLoaderSkinModule.php.
Referenced by __construct(), and applyFeaturesCompatibility().
ResourceLoaderSkinModule::$targets = [ 'desktop', 'mobile' ] |
All skins are assumed to be compatible with mobile.
Definition at line 32 of file ResourceLoaderSkinModule.php.
|
private |
Every skin should define which features it would like to reuse for core inside a ResourceLoader module that has set the class to ResourceLoaderSkinModule.
For a feature to be valid it must be listed here along with the associated resources
The following features are available:
"logo": Adds CSS to style an element with class mw-wiki-logo
using the value of wgLogos['1x']. This is enabled by default if no features are added.
"normalize": Styles needed to normalize rendering across different browser rendering engines. All to address bugs and common browser inconsistencies for skins and extensions. Inspired by necolas' normalize.css. This is meant to be kept lean, basic styling beyond normalization should live in one of the following modules.
"elements": The base level that only contains the most basic of common skin styles. Only styles for single elements are included, no styling for complex structures like the TOC is present. This level is for skins that want to implement the entire style of even content area structures like the TOC themselves.
"content": Deprecated. Alias for "content-media".
"content-thumbnails": Deprecated. Alias for "content-media".
"content-media": Styles for thumbnails and floated elements. Will add styles for the new media structure on wikis where $wgParserEnableLegacyMediaDOM is disabled. See https://www.mediawiki.org/wiki/Parsing/Media_structure
"content-links": The skin will apply optional styling rules for links that should be styled differently to the rules in elements
and normalize
. It provides support for .mw-selflink, a.new (red links), a.stub (stub links) and some basic styles for external links. It also provides rules supporting the underline user preference.
"content-links-external": The skin will apply optional styling rules to links to provide icons for different file types.
"content-body": Styles for the mw-parser-output class.
"content-tables": Styles .wikitable style tables.
"interface": The highest level, this stylesheet contains extra common styles for classes like .firstHeading, #contentSub, et cetera which are not outputted by MediaWiki but are common to skins like MonoBook, Vector, etc... Essentially this level is for styles that are common to MonoBook clones.
"interface-category": Styles used for styling the categories in a horizontal bar at the bottom of the content.
"interface-message-box": Styles for message boxes.
"i18n-ordered-lists": Styles for ordered lists elements that support mixed language content.
"i18n-all-lists-margins": Styles for margins of list elements where LTR and RTL are mixed.
"i18n-headings": Styles for line-heights of headings across different languages.
"legacy": For backwards compatibility a legacy feature is provided. New skins should not use this if they can avoid doing so. This feature also contains interface-message-box
and all i18n-
prefixed features.
"toc" Styling rules for the table of contents.
NOTE: The order of the keys defines the order in which the styles are output.
Definition at line 115 of file ResourceLoaderSkinModule.php.
|
private |
Definition at line 207 of file ResourceLoaderSkinModule.php.