Module for generated and embedded images. More...

Inherits MediaWiki\ResourceLoader\Module.

Inherited by MediaWiki\ResourceLoader\OOUIImageModule.

Collaboration diagram for MediaWiki\ResourceLoader\ImageModule:

[legend]

Public Member Functions
	__construct (array $options=[], $localBasePath=null)
	Constructs a new module from an options array.

	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)
	Get all CSS for this module for a given skin.

	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.

	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.

	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)

	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
	getCssDeclarations ( $primary)
	Format the CSS declaration for the image as a background-image property.

	getLocalPath ( $path)

	loadFromDefinition ()
	Parse definition and external JSON data, if referenced.

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.

	parseVueContent (Context $context, string $content)

	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.

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()

	$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)

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.

Detailed Description

Module for generated and embedded images.

Since: 1.25

Definition at line 19 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	$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:

Construction options:: [

// When set the icon will use mask-image instead of background-image for the CSS output. Using mask-image

// allows colorization of SVGs in Codex. Defaults to false for backwards compatibility.

'useMaskImage' => false,

// 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],

],

...

],

...

],

]

Wikimedia\Message\values
@ values
A comma-separated list.
Definition ListType.php:26

Definition at line 111 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	$options	Module definition
string \| null	$localBasePath	Path to use if not provided in module definition. Defaults to $IP.

Returns: string Local base path

Reimplemented in MediaWiki\ResourceLoader\OOUIIconPackModule.

Definition at line 484 of file ImageModule.php.

References $IP.

◆ getCssDeclarations()

MediaWiki\ResourceLoader\ImageModule::getCssDeclarations ( $primary )

protected

Format the CSS declaration for the image as a background-image property.

Parameters

string $primary Primary URI

Returns: string[] CSS declarations

Definition at line 393 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 426 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 295 of file ImageModule.php.

◆ getImage()

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

Get an Image object for given image.

Parameters

string	$name	Image name
Context	$context

Returns: Image|null

Definition at line 236 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 247 of file ImageModule.php.

◆ getLocalPath()

MediaWiki\ResourceLoader\ImageModule::getLocalPath ( $path )

protected

Parameters

string | FilePath $path

Returns: string

Definition at line 468 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 213 of file ImageModule.php.

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

◆ getSelectors()

MediaWiki\ResourceLoader\ImageModule::getSelectors ( )

Get CSS selector templates used by this module.

Returns: string[]

Definition at line 222 of file ImageModule.php.

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

◆ getStyles()

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

Get all CSS for this module for a given skin.

Stability: stable: to override

Parameters

Context $context

Returns: array List of CSS strings or array of CSS strings keyed by media type. like [ 'screen' => '.foo { width: 0 }' ]; or [ 'screen' => [ '.foo { width: 0 }' ] ];

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 316 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()

MediaWiki\ResourceLoader\ImageModule::loadFromDefinition ( )

protected

Parse definition and external JSON data, if referenced.

Reimplemented in MediaWiki\ResourceLoader\OOUIImageModule.

Definition at line 121 of file ImageModule.php.

References MediaWiki\ResourceLoader\ImageModule\$definition, MediaWiki\ResourceLoader\ImageModule\$prefix, MediaWiki\ResourceLoader\ImageModule\$selectorWithoutVariant, MediaWiki\ResourceLoader\ImageModule\$selectorWithVariant, and MediaWiki\ResourceLoader\ImageModule\getLocalPath().

Referenced by MediaWiki\ResourceLoader\ImageModule\getPrefix(), and MediaWiki\ResourceLoader\ImageModule\getSelectors().

◆ supportsMaskImage()

MediaWiki\ResourceLoader\ImageModule::supportsMaskImage ( )

Returns: bool

Definition at line 409 of file ImageModule.php.

◆ supportsURLLoading()

MediaWiki\ResourceLoader\ImageModule::supportsURLLoading ( )

Returns: bool

Reimplemented from MediaWiki\ResourceLoader\Module.

Definition at line 416 of file ImageModule.php.

Member Data Documentation

◆ $defaultColor

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

protected

Definition at line 39 of file ImageModule.php.

◆ $definition

array null MediaWiki\ResourceLoader\ImageModule::$definition

protected

Definition at line 23 of file ImageModule.php.

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

◆ $globalVariants

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

protected

Definition at line 43 of file ImageModule.php.

◆ $imageObjects

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

protected

Definition at line 35 of file ImageModule.php.

◆ $images

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

protected

Definition at line 37 of file ImageModule.php.

◆ $localBasePath

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

protected

Local base path, see __construct()

Definition at line 29 of file ImageModule.php.

Referenced by MediaWiki\ResourceLoader\ImageModule\__construct(), and MediaWiki\ResourceLoader\OOUIIconPackModule\__construct().

◆ $origin

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

protected

Definition at line 32 of file ImageModule.php.

◆ $prefix

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

protected

Definition at line 47 of file ImageModule.php.

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

◆ $selectorWithoutVariant

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

protected

Definition at line 49 of file ImageModule.php.

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

◆ $selectorWithVariant

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

protected

Definition at line 51 of file ImageModule.php.

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

◆ $useDataURI

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

protected

Definition at line 41 of file ImageModule.php.

◆ $variants

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

protected

Definition at line 45 of file ImageModule.php.

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

includes/ResourceLoader/ImageModule.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ extractLocalBasePath()

◆ getCssDeclarations()

◆ getDefinitionSummary()

◆ getGlobalVariants()

◆ getImage()

◆ getImages()

◆ getLocalPath()

◆ getPrefix()

◆ getSelectors()

◆ getStyles()

◆ getType()

◆ loadFromDefinition()

◆ supportsMaskImage()

◆ supportsURLLoading()

Member Data Documentation

◆ $defaultColor

◆ $definition

◆ $globalVariants

◆ $imageObjects

◆ $images

◆ $localBasePath

◆ $origin

◆ $prefix

◆ $selectorWithoutVariant

◆ $selectorWithVariant

◆ $useDataURI

◆ $variants