Class encapsulating an image used in an ImageModule.
More...
|
| __construct ( $name, $module, $descriptor, $basePath, array $variants, $defaultColor=null) |
|
| getDataUri (Context $context, $variant, $format) |
| Get the data: URI that will produce this image.
|
|
| getExtension ( $format='original') |
| Get the extension of the image.
|
|
| getImageData (Context $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 (Context $context) |
| Get the path to image file for given context.
|
|
| getUrl (Context $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 (Context $context) |
| Send response headers (using the header() function) that are necessary to correctly serve the image data for this image, as returned by getImageData().
|
|
|
| getLangFallbacks (string $lang) |
|
| 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 (array $variantConf, Context $context) |
| Convert this image, which is assumed to be SVG, to given variant.
|
|
Class encapsulating an image used in an ImageModule.
- Since
- 1.25
Definition at line 42 of file Image.php.
◆ __construct()
MediaWiki\ResourceLoader\Image::__construct |
( |
| $name, |
|
|
| $module, |
|
|
| $descriptor, |
|
|
| $basePath, |
|
|
array | $variants, |
|
|
| $defaultColor = null ) |
- Parameters
-
string | $name | Self-name of the image as known to ImageModule. |
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 |
Definition at line 77 of file Image.php.
References $path, and MediaWiki\ResourceLoader\Image\getLocalPath().
◆ getDataUri()
MediaWiki\ResourceLoader\Image::getDataUri |
( |
Context | $context, |
|
|
| $variant, |
|
|
| $format ) |
Get the data: URI that will produce this image.
- Parameters
-
Context | $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 266 of file Image.php.
◆ getExtension()
MediaWiki\ResourceLoader\Image::getExtension |
( |
| $format = 'original' | ) |
|
Get the extension of the image.
- Parameters
-
string | null | $format | Format to get the extension for, 'original' or 'rasterized' |
- Returns
- string Extension without leading dot, e.g. 'png'
Definition at line 215 of file Image.php.
◆ getImageData()
MediaWiki\ResourceLoader\Image::getImageData |
( |
Context | $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
-
Context | $context | Image context, or any context if $variant and $format given. |
string | null | false | $variant | Variant to get the data for. Optional; if given, overrides the data from $context. |
string | false | $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
Definition at line 287 of file Image.php.
References $path, MediaWiki\ResourceLoader\Context\getFormat(), MediaWiki\ResourceLoader\Context\getResourceLoader(), and MediaWiki\ResourceLoader\Context\getVariant().
◆ getLangFallbacks()
MediaWiki\ResourceLoader\Image::getLangFallbacks |
( |
string | $lang | ) |
|
|
protected |
- Access: internal
- For unit testing override
- Parameters
-
- Returns
- string[]
Definition at line 159 of file Image.php.
◆ getLocalPath()
MediaWiki\ResourceLoader\Image::getLocalPath |
( |
| $path | ) |
|
|
protected |
◆ getMimeType()
MediaWiki\ResourceLoader\Image::getMimeType |
( |
| $format = 'original' | ) |
|
Get the MIME type of the image.
- Parameters
-
string | null | $format | Format to get the MIME type for, 'original' or 'rasterized' |
- Returns
- string
Definition at line 228 of file Image.php.
◆ getModule()
MediaWiki\ResourceLoader\Image::getModule |
( |
| ) |
|
Get name of the module this image belongs to.
- Returns
- string
Definition at line 141 of file Image.php.
◆ getName()
MediaWiki\ResourceLoader\Image::getName |
( |
| ) |
|
Get name of this image.
- Returns
- string
Definition at line 132 of file Image.php.
◆ getPath()
MediaWiki\ResourceLoader\Image::getPath |
( |
Context | $context | ) |
|
◆ getUrl()
MediaWiki\ResourceLoader\Image::getUrl |
( |
Context | $context, |
|
|
| $script, |
|
|
| $variant, |
|
|
| $format ) |
◆ getVariants()
MediaWiki\ResourceLoader\Image::getVariants |
( |
| ) |
|
Get the list of variants this image can be converted to.
- Returns
- string[]
Definition at line 150 of file Image.php.
◆ massageSvgPathdata()
MediaWiki\ResourceLoader\Image::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
-
- Returns
- string Massaged SVG image data
Definition at line 385 of file Image.php.
◆ rasterize()
MediaWiki\ResourceLoader\Image::rasterize |
( |
| $svg | ) |
|
|
protected |
◆ sendResponseHeaders()
MediaWiki\ResourceLoader\Image::sendResponseHeaders |
( |
Context | $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
-
Context | $context | Image context |
Definition at line 332 of file Image.php.
◆ variantize()
MediaWiki\ResourceLoader\Image::variantize |
( |
array | $variantConf, |
|
|
Context | $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 |
Context | $context | Image context |
- Returns
- string New SVG file data
Definition at line 350 of file Image.php.
The documentation for this class was generated from the following file: