MediaWiki
1.34.0
|
Allows loading arbitrary sets of OOUI icons. More...
Public Member Functions | |
__construct ( $options=[], $localBasePath=null) | |
Constructs a new module from an options array. More... | |
Public Member Functions inherited from ResourceLoaderImageModule | |
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 () | |
Public Member Functions inherited from ResourceLoaderModule | |
enableModuleContentVersion () | |
Whether to generate version hash based on module content. More... | |
getConfig () | |
getDependencies (ResourceLoaderContext $context=null) | |
Get a list of modules this module depends on. More... | |
getDeprecationInformation (ResourceLoaderContext $context=null) | |
Get JS representing deprecation information for the current module if available. More... | |
getFlip (ResourceLoaderContext $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... | |
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... | |
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... | |
Static Public Member Functions | |
static | extractLocalBasePath ( $options, $localBasePath=null) |
Extract a local base path from module definition information. More... | |
Static Public Member Functions inherited from ResourceLoaderModule | |
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... | |
Protected Member Functions | |
loadOOUIDefinition ( $theme, $unused) | |
Load the module definition from the JSON file(s) for the given theme and module. More... | |
Protected Member Functions inherited from ResourceLoaderOOUIImageModule | |
loadFromDefinition () | |
Parse definition and external JSON data, if referenced. More... | |
readJSONFile ( $dataPath) | |
Read JSON from a file, and transform all paths in it to be relative to the module's base path. More... | |
Protected Member Functions inherited from ResourceLoaderImageModule | |
getCssDeclarations ( $primary, $fallback) | |
SVG support using a transparent gradient to guarantee cross-browser compatibility (browsers able to understand gradient syntax support also SVG). More... | |
getLocalPath ( $path) | |
Protected Member Functions inherited from ResourceLoaderModule | |
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... | |
Private Member Functions | |
getIcons () | |
Additional Inherited Members | |
Static Protected Member Functions inherited from ResourceLoaderModule | |
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... | |
Protected Attributes inherited from ResourceLoaderImageModule | |
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 = [] |
Protected Attributes inherited from ResourceLoaderModule | |
Config | $config |
array | $contents = [] |
Map of (context hash => cached module content) More... | |
string bool | $deprecated = false |
Deprecation string or true if deprecated; false otherwise. More... | |
array | $fileDeps = [] |
Map of (variant => indirect file dependencies) More... | |
LoggerInterface | $logger |
array | $msgBlobs = [] |
Map of (language => in-object cache for message blob) More... | |
string null | $name = null |
Module name. More... | |
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. More... | |
string[] | $targets = [ 'desktop' ] |
What client platforms the module targets (e.g. More... | |
array | $versionHash = [] |
Map of (context hash => cached module version hash) More... | |
Allows loading arbitrary sets of OOUI icons.
Definition at line 27 of file ResourceLoaderOOUIIconPackModule.php.
ResourceLoaderOOUIIconPackModule::__construct | ( | $options = [] , |
|
$localBasePath = null |
|||
) |
Constructs a new module from an options array.
array | $options | List of options; if not given or empty, an empty module will be constructed |
string | null | $localBasePath | Base path to prepend to all local paths in $options. Defaults to $IP |
Below is a description for the $options array:
InvalidArgumentException |
Reimplemented from ResourceLoaderImageModule.
Definition at line 28 of file ResourceLoaderOOUIIconPackModule.php.
References ResourceLoaderImageModule\$localBasePath.
|
static |
Extract a local base path from module definition information.
array | $options | Module definition |
string | null | $localBasePath | Path to use if not provided in module definition. Defaults to $IP |
Reimplemented from ResourceLoaderImageModule.
Definition at line 74 of file ResourceLoaderOOUIIconPackModule.php.
References $IP, and ResourceLoaderImageModule\$localBasePath.
|
private |
Definition at line 40 of file ResourceLoaderOOUIIconPackModule.php.
Referenced by loadOOUIDefinition().
|
protected |
Load the module definition from the JSON file(s) for the given theme and module.
string | $theme | |
string | $module |
Reimplemented from ResourceLoaderOOUIImageModule.
Definition at line 44 of file ResourceLoaderOOUIIconPackModule.php.
References ResourceLoaderImageModule\$definition, $knownImagesModules, getIcons(), getThemeImagesPath(), and ResourceLoaderOOUIImageModule\readJSONFile().