MediaWiki  master
ResourceLoaderImage Class Reference

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

Inheritance diagram for ResourceLoaderImage:
Collaboration diagram for ResourceLoaderImage:

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. More...
 
 getExtension ( $format='original')
 Get the extension of the image. More...
 
 getImageData (ResourceLoaderContext $context, $variant=false, $format=false)
 Get actual image data for this image. More...
 
 getMimeType ( $format='original')
 Get the MIME type of the image. More...
 
 getModule ()
 Get name of the module this image belongs to. More...
 
 getName ()
 Get name of this image. More...
 
 getPath (ResourceLoaderContext $context)
 Get the path to image file for given context. More...
 
 getUrl (ResourceLoaderContext $context, $script, $variant, $format)
 Get the load.php URL that will produce this image. More...
 
 getVariants ()
 Get the list of variants this image can be converted to. More...
 
 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(). More...
 

Protected Member Functions

 massageSvgPathdata ( $svg)
 Massage the SVG image data for converters which don't understand some path data syntax. More...
 
 rasterize ( $svg)
 Convert passed image data, which is assumed to be SVG, to PNG. More...
 
 variantize ( $variantConf, ResourceLoaderContext $context)
 Convert this image, which is assumed to be SVG, to given variant. More...
 

Static Protected Attributes

static array $fileTypes
 Map of allowed file extensions to their MIME types. More...
 

Private Attributes

string $basePath
 
string null $defaultColor
 
string array $descriptor
 
string $extension
 
string $module
 
static array string $name
 
array $variants
 

Detailed Description

Class encapsulating an image used in a ResourceLoaderImageModule.

Since
1.25

Definition at line 30 of file ResourceLoaderImage.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoaderImage::__construct (   $name,
  $module,
  $descriptor,
  $basePath,
  $variants,
  $defaultColor = null 
)
Parameters
string$nameImage name
string$moduleModule name
string | array$descriptorPath to image file, or array structure containing paths
string$basePathDirectory to which paths in descriptor refer
array$variants
string | null$defaultColorof the base variant
Exceptions
InvalidArgumentException

Definition at line 67 of file ResourceLoaderImage.php.

References $basePath, $defaultColor, $descriptor, $ext, $module, $name, $path, $variants, array(), as, name, and use.

Member Function Documentation

◆ getDataUri()

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

Get the data: URI that will produce this image.

Parameters
ResourceLoaderContext$contextAny context
string | null$variantVariant to get the URI for
string$formatFormat to get the URI for, 'original' or 'rasterized'
Returns
string

Definition at line 228 of file ResourceLoaderImage.php.

References $type, CSSMin\encodeStringAsDataURI(), getImageData(), and getMimeType().

Referenced by ResourceLoaderImageModule\getStyleDeclarations().

◆ getExtension()

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

Get the extension of the image.

Parameters
string$formatFormat to get the extension for, 'original' or 'rasterized'
Returns
string Extension without leading dot, e.g. 'png'

Definition at line 179 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$contextImage context, or any context if $variant and $format given.
string | null$variantVariant to get the data for. Optional; if given, overrides the data from $context.
string$formatFormat 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
MWExceptionIf the image file doesn't exist

Definition at line 250 of file ResourceLoaderImage.php.

References $defaultColor, $path, getExtension(), ResourceLoaderContext\getFormat(), getPath(), ResourceLoaderContext\getVariant(), rasterize(), variantize(), and wfDebugLog().

Referenced by getDataUri().

◆ getMimeType()

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

Get the MIME type of the image.

Parameters
string$formatFormat to get the MIME type for, 'original' or 'rasterized'
Returns
string

Definition at line 192 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$contextAny context
Returns
string

Definition at line 150 of file ResourceLoaderImage.php.

References $descriptor, $lang, as, ResourceLoaderContext\getDirection(), Language\getFallbacksFor(), ResourceLoaderContext\getLanguage(), and Language\STRICT_FALLBACKS.

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$contextAny context
string$scriptURL to load.php
string | null$variantVariant to get the URL for
string$formatFormat to get the URL for, 'original' or 'rasterized'
Returns
string

Definition at line 206 of file ResourceLoaderImage.php.

References $query, ResourceLoaderContext\getLanguage(), getModule(), getName(), ResourceLoaderContext\getSkin(), ResourceLoaderContext\getVersion(), 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$svgSVG image data
Returns
string Massaged SVG image data

Definition at line 345 of file ResourceLoaderImage.php.

References as.

Referenced by rasterize().

◆ rasterize()

ResourceLoaderImage::rasterize (   $svg)
protected

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

Parameters
string$svgSVG image data
Returns
string|bool PNG image data, or false on failure

Definition at line 366 of file ResourceLoaderImage.php.

References $command, $handler, $res, $wgSVGConverter, $wgSVGConverterPath, SVGMetadataExtractor\getMetadata(), massageSvgPathdata(), null, 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$contextImage context

Definition at line 294 of file ResourceLoaderImage.php.

References getExtension(), ResourceLoaderContext\getFormat(), 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$variantConfArray with a 'color' key, its value will be used as fill color
ResourceLoaderContext$contextImage context
Returns
string New SVG file data

Definition at line 311 of file ResourceLoaderImage.php.

References getPath(), and null.

Referenced by getImageData().

Member Data Documentation

◆ $basePath

string ResourceLoaderImage::$basePath
private

Definition at line 50 of file ResourceLoaderImage.php.

Referenced by __construct().

◆ $defaultColor

string null ResourceLoaderImage::$defaultColor
private

Definition at line 54 of file ResourceLoaderImage.php.

Referenced by __construct(), and getImageData().

◆ $descriptor

string array ResourceLoaderImage::$descriptor
private

Definition at line 48 of file ResourceLoaderImage.php.

Referenced by __construct(), and getPath().

◆ $extension

string ResourceLoaderImage::$extension
private

Definition at line 56 of file ResourceLoaderImage.php.

Referenced by getExtension().

◆ $fileTypes

array ResourceLoaderImage::$fileTypes
staticprotected
Initial value:
= [
'svg' => 'image/svg+xml'

Map of allowed file extensions to their MIME types.

Definition at line 36 of file ResourceLoaderImage.php.

◆ $module

string ResourceLoaderImage::$module
private

Definition at line 46 of file ResourceLoaderImage.php.

Referenced by __construct(), and getModule().

◆ $name

array string ResourceLoaderImage::$name
private
Initial value:
=> 'image/png',
'gif' => 'image/gif',
'jpg' => 'image/jpg',
]

Definition at line 38 of file ResourceLoaderImage.php.

Referenced by __construct(), and getName().

◆ $variants

array ResourceLoaderImage::$variants
private

Definition at line 52 of file ResourceLoaderImage.php.

Referenced by __construct().


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