MediaWiki master
|
Allows loading arbitrary sets of OOUI icons. More...
Inherits MediaWiki\ResourceLoader\OOUIImageModule.
Public Member Functions | |
__construct (array $options=[], $localBasePath=null) | |
Constructs a new module from an options array. | |
Public Member Functions inherited from MediaWiki\ResourceLoader\ImageModule | |
getDefinitionSummary (Context $context) | |
Get the definition summary for this module. | |
getGlobalVariants (Context $context) | |
Get list of variants in this module that are 'global', i.e., available for every image regardless of image options. | |
getImage ( $name, Context $context) | |
Get an Image object for given image. | |
getImages (Context $context) | |
Get Image objects for all images. | |
getPrefix () | |
Get CSS class prefix used by this module. | |
getSelectors () | |
Get CSS selector templates used by this module. | |
getStyles (Context $context) | |
getType () | |
supportsMaskImage () | |
supportsURLLoading () | |
Public Member Functions inherited from MediaWiki\ResourceLoader\Module | |
enableModuleContentVersion () | |
Whether to generate version hash based on module content. | |
getConfig () | |
getDependencies (Context $context=null) | |
Get a list of modules this module depends on. | |
getDeprecationInformation (Context $context) | |
Get JS representing deprecation information for the current module if available. | |
getDeprecationWarning () | |
Get the deprecation warning, if any. | |
getFlip (Context $context) | |
getGroup () | |
Specifies the group this module is in. | |
getHeaders (Context $context) | |
Get headers to send as part of a module web response. | |
getMessages () | |
Get the messages needed for this module. | |
getModuleContent (Context $context) | |
Get an array of this module's resources. | |
getName () | |
Get this module's name. | |
getOrigin () | |
Get this module's origin. | |
getScript (Context $context) | |
Get all JS for this module for a given language and skin. | |
getScriptURLsForDebug (Context $context) | |
Get alternative script URLs for legacy debug mode. | |
getSkins () | |
Get list of skins for which this module must be available to load. | |
getSkipFunction () | |
Get the skip function. | |
getSource () | |
Get the source of this module. | |
getStyleURLsForDebug (Context $context) | |
Get the URL or URLs to load for this module's CSS in debug mode. | |
getTemplates () | |
Takes named templates by the module and returns an array mapping. | |
getVersionHash (Context $context) | |
Get a string identifying the current version of this module in a given context. | |
isKnownEmpty (Context $context) | |
Check whether this module is known to be empty. | |
requiresES6 () | |
Whether the module requires ES6 support in the client. | |
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. | |
setSkinStylesOverride (array $moduleSkinStyles) | |
Provide overrides for skinStyles to modules that support that. | |
shouldEmbedModule (Context $context) | |
Check whether this module should be embedded rather than linked. | |
shouldSkipStructureTest () | |
Whether to skip the structure test ResourcesTest::testRespond() for this module. | |
Static Public Member Functions | |
static | extractLocalBasePath (array $options, $localBasePath=null) |
Extract a local base path from module definition information. | |
Static Public Member Functions inherited from MediaWiki\ResourceLoader\Module | |
static | expandRelativePaths (array $filePaths) |
Expand directories relative to $IP. | |
static | getRelativePaths (array $filePaths) |
Make file paths relative to MediaWiki directory. | |
static | getVary (Context $context) |
Get vary string. | |
Protected Member Functions | |
loadOOUIDefinition ( $theme, $unused) | |
Load the module definition from the JSON file(s) for the given theme and module. | |
Protected Member Functions inherited from MediaWiki\ResourceLoader\OOUIImageModule | |
loadFromDefinition () | |
Parse definition and external JSON data, if referenced. | |
readJSONFile ( $dataPath) | |
Read JSON from a file, and transform all paths in it to be relative to the module's base path. | |
Protected Member Functions inherited from MediaWiki\ResourceLoader\ImageModule | |
getCssDeclarations ( $primary) | |
Format the CSS declaration for the image as a background-image property. | |
getLocalPath ( $path) | |
Protected Member Functions inherited from MediaWiki\ResourceLoader\Module | |
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. | |
getLessVars (Context $context) | |
Get module-specific LESS variables, if any. | |
getLogger () | |
getMessageBlob (Context $context) | |
Get the hash of the message blob. | |
getPreloadLinks (Context $context) | |
Get a list of resources that web browsers may preload. | |
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. | |
Additional Inherited Members | |
Static Protected Member Functions inherited from MediaWiki\ResourceLoader\Module | |
static | safeFileHash ( $filePath) |
Compute a non-cryptographic string hash of a file's contents. | |
Protected Attributes inherited from MediaWiki\ResourceLoader\ImageModule | |
string null | $defaultColor = null |
array null | $definition |
array null | $globalVariants = null |
Image[][] null | $imageObjects = null |
array | $images = [] |
string | $localBasePath = '' |
Local base path, see __construct() | |
$origin = self::ORIGIN_CORE_SITEWIDE | |
string null | $prefix = null |
string | $selectorWithoutVariant = '.{prefix}-{name}' |
string | $selectorWithVariant = '.{prefix}-{name}-{variant}' |
bool | $useDataURI = true |
array | $variants = [] |
Protected Attributes inherited from MediaWiki\ResourceLoader\Module | |
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) | |
Allows loading arbitrary sets of OOUI icons.
Definition at line 31 of file OOUIIconPackModule.php.
MediaWiki\ResourceLoader\OOUIIconPackModule::__construct | ( | array | $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:
Reimplemented from MediaWiki\ResourceLoader\ImageModule.
Definition at line 32 of file OOUIIconPackModule.php.
References MediaWiki\ResourceLoader\ImageModule\$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 MediaWiki\ResourceLoader\ImageModule.
Definition at line 79 of file OOUIIconPackModule.php.
References $IP.
|
protected |
Load the module definition from the JSON file(s) for the given theme and module.
string | $theme | |
string | $module |
Reimplemented from MediaWiki\ResourceLoader\OOUIImageModule.
Definition at line 49 of file OOUIIconPackModule.php.
References MediaWiki\ResourceLoader\getThemeImagesPath().