Class encapsulating an image used in a ResourceLoaderImageModule. More...

Public Member Functions
	__construct ( $name, $module, $descriptor, $basePath, $variants, $defaultColor=null)

	getDataUri (ResourceLoaderContext $context, $variant, $format)
	Get the data: URI that will produce this image.

	getExtension ( $format='original')
	Get the extension of the image.

	getImageData (ResourceLoaderContext $context, $variant=false, $format=false)
	Get actual image data for this image.

	getMimeType ( $format='original')
	Get the MIME type of the image.

	getModule ()
	Get name of the module this image belongs to.

	getName ()
	Get name of this image.

	getPath (ResourceLoaderContext $context)
	Get the path to image file for given context.

	getUrl (ResourceLoaderContext $context, $script, $variant, $format)
	Get the load.php URL that will produce this image.

	getVariants ()
	Get the list of variants this image can be converted to.

	sendResponseHeaders (ResourceLoaderContext $context)
	Send response headers (using the header() function) that are necessary to correctly serve the image data for this image, as returned by getImageData().

Protected Member Functions
	getLocalPath ( $path)

	massageSvgPathdata ( $svg)
	Massage the SVG image data for converters which don't understand some path data syntax.

	rasterize ( $svg)
	Convert passed image data, which is assumed to be SVG, to PNG.

	variantize ( $variantConf, ResourceLoaderContext $context)
	Convert this image, which is assumed to be SVG, to given variant.

Static Protected Attributes
static array	$fileTypes
	Map of allowed file extensions to their MIME types.

Private Member Functions
	varyOnLanguage ()
	Check if the image depends on the language.

Private Attributes
string	$basePath

string null	$defaultColor

string array	$descriptor

string	$extension

string	$module

string	$name

array	$variants

Detailed Description

Class encapsulating an image used in a ResourceLoaderImageModule.

Since: 1.25

Definition at line 29 of file ResourceLoaderImage.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoaderImage::__construct	(	$name,
		$module,
		$descriptor,
		$basePath,
		$variants,
		$defaultColor = null )

Parameters

string	$name	Self-name of the image as known to ResourceLoaderImageModule.
string	$module	Self-name of the module containing this image. Used to find the image in the registry e.g. through a load.php url.
string \| array	$descriptor	Path to image file, or array structure containing paths
string	$basePath	Directory to which paths in descriptor refer
array	$variants
string \| null	$defaultColor	of the base variant

Exceptions

InvalidArgumentException

Definition at line 67 of file ResourceLoaderImage.php.

References $basePath, $defaultColor, $descriptor, $ext, $module, $name, $path, $variants, and getLocalPath().

Member Function Documentation

◆ getDataUri()

ResourceLoaderImage::getDataUri	(	ResourceLoaderContext	$context,
			$variant,
			$format )

Get the data: URI that will produce this image.

Parameters

ResourceLoaderContext	$context	Any context
string \| null	$variant	Variant to get the URI for
string	$format	Format to get the URI for, 'original' or 'rasterized'

Returns: string

Definition at line 249 of file ResourceLoaderImage.php.

References $type, getImageData(), and getMimeType().

Referenced by ResourceLoaderImageModule\getStyleDeclarations().

◆ getExtension()

ResourceLoaderImage::getExtension ( $format = 'original' )

Get the extension of the image.

Parameters

string $format Format to get the extension for, 'original' or 'rasterized'

Returns: string Extension without leading dot, e.g. 'png'

Definition at line 196 of file ResourceLoaderImage.php.

References $extension.

Referenced by getImageData(), getMimeType(), and sendResponseHeaders().

◆ getImageData()

ResourceLoaderImage::getImageData	(	ResourceLoaderContext	$context,
			$variant = false,
			$format = false )

Get actual image data for this image.

This can be saved to a file or sent to the browser to produce the converted image.

Call getExtension() or getMimeType() with the same $format argument to learn what file type the returned data uses.

Parameters

ResourceLoaderContext	$context	Image context, or any context if $variant and $format given.
string \| null	$variant	Variant to get the data for. Optional; if given, overrides the data from $context.
string	$format	Format to get the data for, 'original' or 'rasterized'. Optional; if given, overrides the data from $context.

Returns: string|false Possibly binary image data, or false on failure

Exceptions

MWException If the image file doesn't exist

Definition at line 271 of file ResourceLoaderImage.php.

References $context, $defaultColor, $path, getExtension(), getPath(), rasterize(), variantize(), and wfDebugLog().

Referenced by getDataUri().

◆ getLocalPath()

ResourceLoaderImage::getLocalPath ( $path )

protected

Parameters

string | ResourceLoaderFilePath $path

Returns: string

Definition at line 182 of file ResourceLoaderImage.php.

References $path.

Referenced by __construct(), and getPath().

◆ getMimeType()

ResourceLoaderImage::getMimeType ( $format = 'original' )

Get the MIME type of the image.

Parameters

string $format Format to get the MIME type for, 'original' or 'rasterized'

Returns: string

Definition at line 209 of file ResourceLoaderImage.php.

References $ext, and getExtension().

Referenced by getDataUri(), and sendResponseHeaders().

◆ getModule()

ResourceLoaderImage::getModule ( )

Get name of the module this image belongs to.

Returns: string

Definition at line 131 of file ResourceLoaderImage.php.

References $module.

Referenced by getUrl().

◆ getName()

ResourceLoaderImage::getName ( )

Get name of this image.

Returns: string

Definition at line 122 of file ResourceLoaderImage.php.

References $name.

Referenced by getUrl(), and sendResponseHeaders().

◆ getPath()

ResourceLoaderImage::getPath ( ResourceLoaderContext $context )

Get the path to image file for given context.

Parameters

ResourceLoaderContext $context Any context

Returns: string

Exceptions

MWException If no matching path is found

Definition at line 151 of file ResourceLoaderImage.php.

References $context, $descriptor, $lang, and getLocalPath().

Referenced by getImageData(), and variantize().

◆ getUrl()

ResourceLoaderImage::getUrl	(	ResourceLoaderContext	$context,
			$script,
			$variant,
			$format )

Get the load.php URL that will produce this image.

Parameters

ResourceLoaderContext	$context	Any context
string	$script	URL to load.php
string \| null	$variant	Variant to get the URL for
string	$format	Format to get the URL for, 'original' or 'rasterized'

Returns: string URL

Definition at line 223 of file ResourceLoaderImage.php.

References $context, getModule(), getName(), varyOnLanguage(), and wfAppendQuery().

Referenced by ResourceLoaderImageModule\getStyleDeclarations().

◆ getVariants()

ResourceLoaderImage::getVariants ( )

Get the list of variants this image can be converted to.

Returns: string[]

Definition at line 140 of file ResourceLoaderImage.php.

◆ massageSvgPathdata()

ResourceLoaderImage::massageSvgPathdata ( $svg )

protected

Massage the SVG image data for converters which don't understand some path data syntax.

This is necessary for rsvg and ImageMagick when compiled with rsvg support. Upstream bug is https://bugzilla.gnome.org/show_bug.cgi?id=620923, fixed 2014-11-10, so this will be needed for a while. (T76852)

Parameters

string $svg SVG image data

Returns: string Massaged SVG image data

Definition at line 367 of file ResourceLoaderImage.php.

Referenced by rasterize().

◆ rasterize()

ResourceLoaderImage::rasterize ( $svg )

protected

Convert passed image data, which is assumed to be SVG, to PNG.

Parameters

string $svg SVG image data

Returns: string|bool PNG image data, or false on failure

Definition at line 388 of file ResourceLoaderImage.php.

References $command, $res, $wgSVGConverter, $wgSVGConverterPath, massageSvgPathdata(), SvgHandler\rasterize(), and wfTempDir().

Referenced by getImageData().

◆ sendResponseHeaders()

ResourceLoaderImage::sendResponseHeaders ( ResourceLoaderContext $context )

Send response headers (using the header() function) that are necessary to correctly serve the image data for this image, as returned by getImageData().

Note that the headers are independent of the language or image variant.

Parameters

ResourceLoaderContext $context Image context

Definition at line 315 of file ResourceLoaderImage.php.

References $context, getExtension(), getMimeType(), getName(), and FileBackend\makeContentDisposition().

◆ variantize()

ResourceLoaderImage::variantize	(		$variantConf,
		ResourceLoaderContext	$context )

protected

Convert this image, which is assumed to be SVG, to given variant.

Parameters

array	$variantConf	Array with a 'color' key, its value will be used as fill color
ResourceLoaderContext	$context	Image context

Returns: string New SVG file data

Definition at line 332 of file ResourceLoaderImage.php.

References getPath().

Referenced by getImageData().

◆ varyOnLanguage()

ResourceLoaderImage::varyOnLanguage ( )

private

Check if the image depends on the language.

Returns: bool

Definition at line 473 of file ResourceLoaderImage.php.

Referenced by getUrl().

Member Data Documentation

◆ $basePath

string ResourceLoaderImage::$basePath

private

Definition at line 49 of file ResourceLoaderImage.php.

Referenced by __construct().

◆ $defaultColor

string null ResourceLoaderImage::$defaultColor

private

Definition at line 53 of file ResourceLoaderImage.php.

Referenced by __construct(), and getImageData().

◆ $descriptor

string array ResourceLoaderImage::$descriptor

private

Definition at line 47 of file ResourceLoaderImage.php.

Referenced by __construct(), and getPath().

◆ $extension

string ResourceLoaderImage::$extension

private

Definition at line 55 of file ResourceLoaderImage.php.

Referenced by getExtension().

◆ $fileTypes

array ResourceLoaderImage::$fileTypes

staticprotected

Initial value:

= [
        'svg' => 'image/svg+xml',
        'png' => 'image/png',
        'gif' => 'image/gif',
        'jpg' => 'image/jpg',
    ]

Map of allowed file extensions to their MIME types.

Definition at line 35 of file ResourceLoaderImage.php.

◆ $module

string ResourceLoaderImage::$module

private

Definition at line 45 of file ResourceLoaderImage.php.

Referenced by __construct(), and getModule().

◆ $name

string ResourceLoaderImage::$name

private

Definition at line 43 of file ResourceLoaderImage.php.

Referenced by __construct(), and getName().

◆ $variants

array ResourceLoaderImage::$variants

private

Definition at line 51 of file ResourceLoaderImage.php.

Referenced by __construct().

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

includes/resourceloader/ResourceLoaderImage.php

Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDataUri()

◆ getExtension()

◆ getImageData()

◆ getLocalPath()

◆ getMimeType()

◆ getModule()

◆ getName()

◆ getPath()

◆ getUrl()

◆ getVariants()

◆ massageSvgPathdata()

◆ rasterize()

◆ sendResponseHeaders()

◆ variantize()

◆ varyOnLanguage()

Member Data Documentation

◆ $basePath

◆ $defaultColor

◆ $descriptor

◆ $extension

◆ $fileTypes

◆ $module

◆ $name

◆ $variants