MediaWiki  master
MediaWiki\ResourceLoader\ImageModule Class Reference

Module for generated and embedded images. More...

Inheritance diagram for MediaWiki\ResourceLoader\ImageModule:
Collaboration diagram for MediaWiki\ResourceLoader\ImageModule:

Public Member Functions

 __construct (array $options=[], $localBasePath=null)
 Constructs a new module from an options array. More...
 
 getDefinitionSummary (Context $context)
 Get the definition summary for this module. More...
 
 getGlobalVariants (Context $context)
 Get list of variants in this module that are 'global', i.e., available for every image regardless of image options. More...
 
 getImage ( $name, Context $context)
 Get an Image object for given image. More...
 
 getImages (Context $context)
 Get Image 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 (Context $context)
 
 getType ()
 
 supportsURLLoading ()
 
- Public Member Functions inherited from MediaWiki\ResourceLoader\Module
 enableModuleContentVersion ()
 Whether to generate version hash based on module content. More...
 
 getConfig ()
 
 getDependencies (Context $context=null)
 Get a list of modules this module depends on. More...
 
 getDeprecationInformation (Context $context)
 Get JS representing deprecation information for the current module if available. More...
 
 getFlip (Context $context)
 
 getGroup ()
 Get the group this module is in. More...
 
 getHeaders (Context $context)
 Get headers to send as part of a module web response. More...
 
 getMessages ()
 Get the messages needed for this module. More...
 
 getModuleContent (Context $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 (Context $context)
 Get all JS for this module for a given language and skin. More...
 
 getScriptURLsForDebug (Context $context)
 Get alternative script URLs for legacy debug mode. More...
 
 getSkins ()
 Get list of skins for which this module must be available to load. More...
 
 getSkipFunction ()
 Get the skip function. More...
 
 getSource ()
 Get the source of this module. More...
 
 getStyleURLsForDebug (Context $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 (Context $context)
 Get a string identifying the current version of this module in a given context. More...
 
 isKnownEmpty (Context $context)
 Check whether this module is known to be empty. More...
 
 requiresES6 ()
 Whether the module requires ES6 support in the client. More...
 
 setConfig (Config $config)
 
 setDependencyAccessCallbacks (callable $loadCallback, callable $saveCallback)
 Inject the functions that load/save the indirect file path dependency list from storage. More...
 
 setFileDependencies (Context $context, array $paths)
 Set the indirect dependencies for this module pursuant to the skin/language context. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLogger (LoggerInterface $logger)
 
 setMessageBlob ( $blob, $lang)
 Set in-object cache for message blobs. More...
 
 setName ( $name)
 Set this module's name. More...
 
 setSkinStylesOverride (array $moduleSkinStyles)
 Provide overrides for skinStyles to modules that support that. More...
 
 shouldEmbedModule (Context $context)
 Check whether this module should be embedded rather than linked. More...
 

Static Public Member Functions

static extractLocalBasePath (array $options, $localBasePath=null)
 Extract a local base path from module definition information. More...
 
- Static Public Member Functions inherited from MediaWiki\ResourceLoader\Module
static expandRelativePaths (array $filePaths)
 Expand directories relative to $IP. More...
 
static getRelativePaths (array $filePaths)
 Make file paths relative to MediaWiki directory. More...
 
static getVary (Context $context)
 Get vary string. More...
 

Protected Member Functions

 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)
 
 loadFromDefinition ()
 Parse definition and external JSON data, if referenced. More...
 
- Protected Member Functions inherited from MediaWiki\ResourceLoader\Module
 buildContent (Context $context)
 Bundle all resources attached to this module into an array. More...
 
 getFileDependencies (Context $context)
 Get the indirect dependencies for this module pursuant to the skin/language context. More...
 
 getHookRunner ()
 Get a HookRunner for running core hooks. More...
 
 getLessVars (Context $context)
 Get module-specific LESS variables, if any. More...
 
 getLogger ()
 
 getMessageBlob (Context $context)
 Get the hash of the message blob. More...
 
 getPreloadLinks (Context $context)
 Get a list of resources that web browsers may preload. More...
 
 saveFileDependencies (Context $context, array $curFileRefs)
 Save the indirect dependencies for this module pursuant to the skin/language context. More...
 
 validateScriptFile ( $fileName, $contents)
 Validate a user-provided JavaScript blob. More...
 

Protected Attributes

string null $defaultColor = null
 
array null $definition
 
array null $globalVariants = null
 
Image[][] 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 MediaWiki\ResourceLoader\Module
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[] null $skins = null
 Skin names. More...
 
string[] $targets = [ 'desktop' ]
 What client platforms the module targets (e.g. More...
 
array $versionHash = []
 Map of (context hash => cached module version hash) More...
 

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. More...
 

Detailed Description

Module for generated and embedded images.

Since
1.25

Definition at line 32 of file ImageModule.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\ResourceLoader\ImageModule::__construct ( array  $options = [],
  $localBasePath = null 
)

Constructs a new module from an options array.

Parameters
array$optionsList of options; if not given or empty, an empty module will be constructed
string | null$localBasePathBase path to prepend to all local paths in $options. Defaults to $IP

Below is a description for the $options array:

Construction options:
[
// Base path to prepend to all local paths in $options. Defaults to $IP
'localBasePath' => [base path],
// Path to JSON file that contains any of the settings below
'data' => [file path string]
// CSS class prefix to use in all style rules
'prefix' => [CSS class prefix],
// Alternatively: Format of CSS selector to use in all style rules
'selector' => [CSS selector template, variables: {prefix} {name} {variant}],
// Alternatively: When using variants
'selectorWithoutVariant' => [CSS selector template, variables: {prefix} {name}],
'selectorWithVariant' => [CSS selector template, variables: {prefix} {name} {variant}],
// List of variants that may be used for the image files
'variants' => [
// This level of nesting can be omitted if you use the same images for every skin
[skin name (or 'default')] => [
[variant name] => [
'color' => [color string, e.g. '#ffff00'],
'global' => [boolean, if true, this variant is available
for all images of this type],
],
...
],
...
],
// List of image files and their options
'images' => [
// This level of nesting can be omitted if you use the same images for every skin
[skin name (or 'default')] => [
[icon name] => [
'file' => [file path string or array whose values are file path strings
and whose keys are 'default', 'ltr', 'rtl', a single
language code like 'en', or a list of language codes like
'en,de,ar'],
'variants' => [array of variant name strings, variants
available for this image],
],
...
],
...
],
]

Reimplemented in MediaWiki\ResourceLoader\OOUIIconPackModule.

Definition at line 116 of file ImageModule.php.

References MediaWiki\ResourceLoader\ImageModule\$localBasePath.

Member Function Documentation

◆ extractLocalBasePath()

static MediaWiki\ResourceLoader\ImageModule::extractLocalBasePath ( array  $options,
  $localBasePath = null 
)
static

Extract a local base path from module definition information.

Parameters
array$optionsModule definition
string | null$localBasePathPath to use if not provided in module definition. Defaults to $IP.
Returns
string Local base path

Reimplemented in MediaWiki\ResourceLoader\OOUIIconPackModule.

Definition at line 480 of file ImageModule.php.

References $IP.

◆ getCssDeclarations()

MediaWiki\ResourceLoader\ImageModule::getCssDeclarations (   $primary,
  $fallback 
)
protected

SVG support using a transparent gradient to guarantee cross-browser compatibility (browsers able to understand gradient syntax support also SVG).

http://pauginer.tumblr.com/post/36614680636/invisible-gradient-technique

Keep synchronized with the .background-image-svg LESS mixin in /resources/src/mediawiki.less/mediawiki.mixins.less.

Parameters
string$primaryPrimary URI
string$fallbackFallback URI
Returns
string[] CSS declarations to use given URIs as background-image

Definition at line 400 of file ImageModule.php.

◆ getDefinitionSummary()

MediaWiki\ResourceLoader\ImageModule::getDefinitionSummary ( Context  $context)

Get the definition summary for this module.

Parameters
Context$context
Returns
array

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 422 of file ImageModule.php.

◆ getGlobalVariants()

MediaWiki\ResourceLoader\ImageModule::getGlobalVariants ( Context  $context)

Get list of variants in this module that are 'global', i.e., available for every image regardless of image options.

Parameters
Context$context
Returns
string[]

Definition at line 299 of file ImageModule.php.

◆ getImage()

MediaWiki\ResourceLoader\ImageModule::getImage (   $name,
Context  $context 
)

Get an Image object for given image.

Parameters
string$nameImage name
Context$context
Returns
Image|null

Definition at line 240 of file ImageModule.php.

◆ getImages()

MediaWiki\ResourceLoader\ImageModule::getImages ( Context  $context)

Get Image objects for all images.

Parameters
Context$context
Returns
Image[] Array keyed by image name

Definition at line 251 of file ImageModule.php.

◆ getLocalPath()

MediaWiki\ResourceLoader\ImageModule::getLocalPath (   $path)
protected
Parameters
string | FilePath$path
Returns
string

Definition at line 464 of file ImageModule.php.

References $path.

Referenced by MediaWiki\ResourceLoader\ImageModule\loadFromDefinition(), and MediaWiki\ResourceLoader\OOUIImageModule\readJSONFile().

◆ getPrefix()

MediaWiki\ResourceLoader\ImageModule::getPrefix ( )

Get CSS class prefix used by this module.

Returns
string

Definition at line 217 of file ImageModule.php.

References MediaWiki\ResourceLoader\ImageModule\$prefix, and MediaWiki\ResourceLoader\ImageModule\loadFromDefinition().

◆ getSelectors()

MediaWiki\ResourceLoader\ImageModule::getSelectors ( )

◆ getStyles()

MediaWiki\ResourceLoader\ImageModule::getStyles ( Context  $context)
Parameters
Context$context
Returns
array

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 324 of file ImageModule.php.

◆ getType()

MediaWiki\ResourceLoader\ImageModule::getType ( )
Returns
string

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 497 of file ImageModule.php.

◆ loadFromDefinition()

◆ supportsURLLoading()

MediaWiki\ResourceLoader\ImageModule::supportsURLLoading ( )
Returns
bool

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 412 of file ImageModule.php.

Member Data Documentation

◆ $defaultColor

string null MediaWiki\ResourceLoader\ImageModule::$defaultColor = null
protected

Definition at line 49 of file ImageModule.php.

◆ $definition

array null MediaWiki\ResourceLoader\ImageModule::$definition
protected

◆ $globalVariants

array null MediaWiki\ResourceLoader\ImageModule::$globalVariants = null
protected

Definition at line 52 of file ImageModule.php.

◆ $imageObjects

Image [][] null MediaWiki\ResourceLoader\ImageModule::$imageObjects = null
protected

Definition at line 45 of file ImageModule.php.

◆ $images

array MediaWiki\ResourceLoader\ImageModule::$images = []
protected

Definition at line 47 of file ImageModule.php.

◆ $localBasePath

string MediaWiki\ResourceLoader\ImageModule::$localBasePath = ''
protected

◆ $origin

MediaWiki\ResourceLoader\ImageModule::$origin = self::ORIGIN_CORE_SITEWIDE
protected

Definition at line 42 of file ImageModule.php.

◆ $prefix

string null MediaWiki\ResourceLoader\ImageModule::$prefix = null
protected

◆ $selectorWithoutVariant

MediaWiki\ResourceLoader\ImageModule::$selectorWithoutVariant = '.{prefix}-{name}'
protected

◆ $selectorWithVariant

MediaWiki\ResourceLoader\ImageModule::$selectorWithVariant = '.{prefix}-{name}-{variant}'
protected

◆ $targets

MediaWiki\ResourceLoader\ImageModule::$targets = [ 'desktop', 'mobile' ]
protected

Definition at line 59 of file ImageModule.php.

◆ $useDataURI

MediaWiki\ResourceLoader\ImageModule::$useDataURI = true
protected

Definition at line 50 of file ImageModule.php.

◆ $variants

array MediaWiki\ResourceLoader\ImageModule::$variants = []
protected

Definition at line 54 of file ImageModule.php.


The documentation for this class was generated from the following file: