MediaWiki
master
|
Class encapsulating an image used in a ResourceLoaderImageModule. More...
Public Member Functions | |
__construct ( $name, $module, $descriptor, $basePath, array $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 | |
getLangFallbacks (string $lang) | |
getLocalPath ( $path) | |
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 (array $variantConf, ResourceLoaderContext $context) | |
Convert this image, which is assumed to be SVG, to given variant. More... | |
Private Member Functions | |
varyOnLanguage () | |
Check if the image depends on the language. More... | |
Private Attributes | |
string | $basePath |
string null | $defaultColor |
string array | $descriptor |
string | $extension |
string | $module |
string | $name |
array | $variants |
Class encapsulating an image used in a ResourceLoaderImageModule.
Definition at line 33 of file ResourceLoaderImage.php.
ResourceLoaderImage::__construct | ( | $name, | |
$module, | |||
$descriptor, | |||
$basePath, | |||
array | $variants, | ||
$defaultColor = null |
|||
) |
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 |
InvalidArgumentException |
Definition at line 70 of file ResourceLoaderImage.php.
References $basePath, $defaultColor, $descriptor, $ext, $module, $name, $path, $variants, and getLocalPath().
ResourceLoaderImage::getDataUri | ( | ResourceLoaderContext | $context, |
$variant, | |||
$format | |||
) |
Get the data: URI that will produce this image.
ResourceLoaderContext | $context | Any context |
string | null | $variant | Variant to get the URI for |
string | $format | Format to get the URI for, 'original' or 'rasterized' |
Definition at line 263 of file ResourceLoaderImage.php.
References $type.
Referenced by ResourceLoaderImageModule\getStyleDeclarations().
ResourceLoaderImage::getExtension | ( | $format = 'original' | ) |
Get the extension of the image.
string | null | $format | Format to get the extension for, 'original' or 'rasterized' |
Definition at line 210 of file ResourceLoaderImage.php.
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.
ResourceLoaderContext | $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. |
MWException | If the image file doesn't exist |
Definition at line 285 of file ResourceLoaderImage.php.
References $path, ResourceLoaderContext\getFormat(), ResourceLoaderContext\getVariant(), and wfDebugLog().
|
protected |
string | $lang |
Definition at line 152 of file ResourceLoaderImage.php.
|
protected |
string | ResourceLoaderFilePath | $path |
Definition at line 196 of file ResourceLoaderImage.php.
References $path.
Referenced by __construct().
ResourceLoaderImage::getMimeType | ( | $format = 'original' | ) |
Get the MIME type of the image.
string | null | $format | Format to get the MIME type for, 'original' or 'rasterized' |
Definition at line 223 of file ResourceLoaderImage.php.
References $ext.
ResourceLoaderImage::getModule | ( | ) |
Get name of the module this image belongs to.
Definition at line 134 of file ResourceLoaderImage.php.
References $module.
ResourceLoaderImage::getName | ( | ) |
Get name of this image.
Definition at line 125 of file ResourceLoaderImage.php.
References $name.
ResourceLoaderImage::getPath | ( | ResourceLoaderContext | $context | ) |
Get the path to image file for given context.
ResourceLoaderContext | $context | Any context |
MWException | If no matching path is found |
Definition at line 165 of file ResourceLoaderImage.php.
References $lang, ResourceLoaderContext\getDirection(), and ResourceLoaderContext\getLanguage().
ResourceLoaderImage::getUrl | ( | ResourceLoaderContext | $context, |
$script, | |||
$variant, | |||
$format | |||
) |
Get the load.php URL that will produce this image.
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' |
Definition at line 237 of file ResourceLoaderImage.php.
References ResourceLoaderContext\getLanguage(), ResourceLoaderContext\getResourceLoader(), ResourceLoaderContext\getSkin(), and wfAppendQuery().
Referenced by ResourceLoaderImageModule\getStyleDeclarations().
ResourceLoaderImage::getVariants | ( | ) |
Get the list of variants this image can be converted to.
Definition at line 143 of file ResourceLoaderImage.php.
|
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)
string | $svg | SVG image data |
Definition at line 381 of file ResourceLoaderImage.php.
|
protected |
Convert passed image data, which is assumed to be SVG, to PNG.
string | $svg | SVG image data |
Definition at line 402 of file ResourceLoaderImage.php.
References $command, $res, and wfTempDir().
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.
ResourceLoaderContext | $context | Image context |
Definition at line 329 of file ResourceLoaderImage.php.
|
protected |
Convert this image, which is assumed to be SVG, to given variant.
array | $variantConf | Array with a 'color' key, its value will be used as fill color |
ResourceLoaderContext | $context | Image context |
Definition at line 346 of file ResourceLoaderImage.php.
|
private |
Check if the image depends on the language.
Definition at line 485 of file ResourceLoaderImage.php.
|
private |
Definition at line 52 of file ResourceLoaderImage.php.
Referenced by __construct().
|
private |
Definition at line 56 of file ResourceLoaderImage.php.
Referenced by __construct().
|
private |
Definition at line 50 of file ResourceLoaderImage.php.
Referenced by __construct().
|
private |
Definition at line 58 of file ResourceLoaderImage.php.
|
private |
Definition at line 48 of file ResourceLoaderImage.php.
Referenced by __construct(), and getModule().
|
private |
Definition at line 46 of file ResourceLoaderImage.php.
Referenced by __construct(), and getName().
|
private |
Definition at line 54 of file ResourceLoaderImage.php.
Referenced by __construct().