MediaWiki
master
|
Loads the module definition from JSON files in the format that OOUI uses, converting it to the format we use. More...
Protected Member Functions | |
loadFromDefinition () | |
loadOOUIDefinition ( $theme, $module) | |
Load the module definition from the JSON file(s) for the given theme and module. More... | |
readJSONFile ( $dataPath) | |
Read JSON from a file, and transform all paths in it to be relative to the module's base path. More... | |
![]() | |
getCssDeclarations ( $primary, $fallback) | |
SVG support using a transparent gradient to guarantee cross-browser compatibility (browsers able to understand gradient syntax support also SVG). More... | |
loadFromDefinition () | |
Parse definition and external JSON data, if referenced. More... | |
![]() | |
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, $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... | |
Additional Inherited Members | |
![]() | |
__construct ( $options=[], $localBasePath=null) | |
Constructs a new module from an options array. More... | |
getDefinitionSummary (ResourceLoaderContext $context) | |
Get the definition summary for this module. More... | |
getGlobalVariants (ResourceLoaderContext $context) | |
Get list of variants in this module that are 'global', i.e., available for every image regardless of image options. More... | |
getImage ( $name, ResourceLoaderContext $context) | |
Get a ResourceLoaderImage object for given image. More... | |
getImages (ResourceLoaderContext $context) | |
Get ResourceLoaderImage objects for all images. More... | |
getPrefix () | |
Get CSS class prefix used by this module. More... | |
getSelectors () | |
Get CSS selector templates used by this module. More... | |
getStyles (ResourceLoaderContext $context) | |
getType () | |
supportsURLLoading () | |
![]() | |
enableModuleContentVersion () | |
Whether to generate version hash based on module content. More... | |
getConfig () | |
getDefinitionSummary (ResourceLoaderContext $context) | |
Get the definition summary for this module. More... | |
getDependencies (ResourceLoaderContext $context=null) | |
Get a list of modules this module depends on. More... | |
getDeprecationInformation () | |
Get JS representing deprecation information for the current module if available. More... | |
getFlip ( $context) | |
getGroup () | |
Get the group this module is in. More... | |
getHeaders (ResourceLoaderContext $context) | |
Get headers to send as part of a module web response. More... | |
getMessages () | |
Get the messages needed for this module. 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... | |
getScript (ResourceLoaderContext $context) | |
Get all JS for this module for a given language and skin. More... | |
getScriptURLsForDebug (ResourceLoaderContext $context) | |
Get the URL or URLs to load for this module's JS in debug mode. More... | |
getSkipFunction () | |
Get the skip function. More... | |
getSource () | |
Get the source of this module. More... | |
getStyles (ResourceLoaderContext $context) | |
Get all CSS for this module for a given skin. More... | |
getStyleURLsForDebug (ResourceLoaderContext $context) | |
Get the URL or URLs to load for this module's CSS in debug mode. More... | |
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... | |
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... | |
supportsURLLoading () | |
Whether this module supports URL loading. More... | |
![]() | |
static | extractLocalBasePath ( $options, $localBasePath=null) |
Extract a local base path from module definition information. More... | |
![]() | |
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... | |
![]() | |
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' |
![]() | |
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... | |
![]() | |
string null | $defaultColor = null |
array null | $definition = null |
array null | $globalVariants = null |
ResourceLoaderImage [][] null | $imageObjects = null |
array | $images = [] |
string | $localBasePath = '' |
Local base path, see __construct() More... | |
$origin = self::ORIGIN_CORE_SITEWIDE | |
string null | $prefix = null |
$selectorWithoutVariant = '.{prefix}-{name}' | |
$selectorWithVariant = '.{prefix}-{name}-{variant}' | |
$targets = [ 'desktop', 'mobile' ] | |
$useDataURI = true | |
array | $variants = [] |
![]() | |
Config | $config |
$contents = [] | |
array bool | $deprecated = false |
$fileDeps = [] | |
LoggerInterface | $logger |
$msgBlobs = [] | |
$name = null | |
$origin = self::ORIGIN_CORE_SITEWIDE | |
$targets = [ 'desktop' ] | |
$versionHash = [] | |
Loads the module definition from JSON files in the format that OOUI uses, converting it to the format we use.
(Previously known as secret special sauce.)
Definition at line 27 of file ResourceLoaderOOUIImageModule.php.
|
protected |
Definition at line 30 of file ResourceLoaderOOUIImageModule.php.
References ResourceLoaderImageModule\$definition, $skin, $value, as, definition, getSkinThemeMap(), loadOOUIDefinition(), and null.
|
protected |
Load the module definition from the JSON file(s) for the given theme and module.
string | $theme | |
string | $module |
Definition at line 96 of file ResourceLoaderOOUIImageModule.php.
References definition, getThemeImagesPath(), and readJSONFile().
Referenced by loadFromDefinition().
|
protected |
Read JSON from a file, and transform all paths in it to be relative to the module's base path.
string | $dataPath | Path relative to the module's base bath |
Definition at line 118 of file ResourceLoaderOOUIImageModule.php.
References $path, $value, and use.
Referenced by ResourceLoaderOOUIIconPackModule\loadOOUIDefinition(), and loadOOUIDefinition().