MediaWiki
REL1_22
|
Media handler abstract base class for images. More...
Public Member Functions | |
canRender ($file) | |
getDimensionsString ($file) | |
getImageArea ($image) | |
Function that returns the number of pixels to be thumbnailed. | |
getImageSize ($image, $path) | |
Get an image size array like that returned by getimagesize(), or false if it can't be determined. | |
getLongDesc ($file) | |
getParamMap () | |
Get an associative array mapping magic word IDs to parameter names. | |
getScriptedTransform ($image, $script, $params) | |
getScriptParams ($params) | |
getShortDesc ($file) | |
makeParamString ($params) | |
Merge a parameter array into a string appropriate for inclusion in filenames. | |
normaliseParams ($image, &$params) | |
parseParamString ($str) | |
Parse a param string made with makeParamString back into an array. | |
validateParam ($name, $value) | |
Validate a thumbnail parameter at parse time. | |
validateThumbParams (&$width, &$height, $srcWidth, $srcHeight, $mimeType) | |
Validate thumbnail parameters and fill in the correct height. |
Media handler abstract base class for images.
Definition at line 29 of file ImageHandler.php.
ImageHandler::canRender | ( | $ | file | ) |
$file | File |
Reimplemented from MediaHandler.
Reimplemented in TiffHandler.
Definition at line 35 of file ImageHandler.php.
References $file.
ImageHandler::getDimensionsString | ( | $ | file | ) |
$file | File |
Reimplemented from MediaHandler.
Definition at line 254 of file ImageHandler.php.
References $file, text, and wfMessage().
ImageHandler::getImageArea | ( | $ | image | ) |
Function that returns the number of pixels to be thumbnailed.
Intended for animated GIFs to multiply by the number of frames.
If the file doesn't support a notion of "area" return 0.
File | $image |
Reimplemented in GIFHandler.
Definition at line 213 of file ImageHandler.php.
Referenced by BitmapHandler\transformImageMagick(), and BitmapHandler\transformImageMagickExt().
ImageHandler::getImageSize | ( | $ | image, |
$ | path | ||
) |
Get an image size array like that returned by getimagesize(), or false if it can't be determined.
$image | File: the image object, or false if there isn't one | |
string | $path | the filename |
Reimplemented from MediaHandler.
Reimplemented in DjVuHandler, ExifBitmapHandler, XCFHandler, and BmpHandler.
Definition at line 198 of file ImageHandler.php.
References $path, wfRestoreWarnings(), and wfSuppressWarnings().
ImageHandler::getLongDesc | ( | $ | file | ) |
$file | File |
Reimplemented from MediaHandler.
Reimplemented in SvgHandler, GIFHandler, and PNGHandler.
Definition at line 234 of file ImageHandler.php.
References $file, $size, $wgLang, global, params, and wfMessage().
Get an associative array mapping magic word IDs to parameter names.
Will be used by the parser to identify parameters.
Reimplemented from MediaHandler.
Reimplemented in SvgHandler, and DjVuHandler.
Definition at line 39 of file ImageHandler.php.
References array().
ImageHandler::getScriptedTransform | ( | $ | image, |
$ | script, | ||
$ | params | ||
) |
$image | File |
$script | |
$params |
Reimplemented from MediaHandler.
Definition at line 187 of file ImageHandler.php.
References $params, getScriptParams(), normaliseParams(), and wfAppendQuery().
ImageHandler::getScriptParams | ( | $ | params | ) |
Reimplemented in SvgHandler, and DjVuHandler.
Definition at line 77 of file ImageHandler.php.
References $params, and array().
Referenced by getScriptedTransform().
ImageHandler::getShortDesc | ( | $ | file | ) |
$file | File |
Reimplemented from MediaHandler.
Definition at line 222 of file ImageHandler.php.
References $file, $wgLang, global, and wfMessage().
ImageHandler::makeParamString | ( | $ | params | ) |
Merge a parameter array into a string appropriate for inclusion in filenames.
$params | array Array of parameters that have been through normaliseParams. |
Reimplemented from MediaHandler.
Reimplemented in SvgHandler, and DjVuHandler.
Definition at line 55 of file ImageHandler.php.
References $params.
ImageHandler::normaliseParams | ( | $ | image, |
&$ | params | ||
) |
$image | File |
$params |
Reimplemented from MediaHandler.
Reimplemented in SvgHandler, BitmapHandler_ClientOnly, and BitmapHandler.
Definition at line 86 of file ImageHandler.php.
References $params, MediaHandler\fitBoxWidth(), File\scaleHeight(), and validateThumbParams().
Referenced by DjVuHandler\doTransform(), and getScriptedTransform().
ImageHandler::parseParamString | ( | $ | str | ) |
Parse a param string made with makeParamString back into an array.
$str | string The parameter string without file name (e.g. 122px) |
Reimplemented from MediaHandler.
Reimplemented in SvgHandler, and DjVuHandler.
Definition at line 68 of file ImageHandler.php.
References array().
ImageHandler::validateParam | ( | $ | name, |
$ | value | ||
) |
Validate a thumbnail parameter at parse time.
Return true to accept the parameter, and false to reject it. If you return false, the parser will do something quiet and forgiving.
$name | |
$value |
Reimplemented from MediaHandler.
Reimplemented in SvgHandler, and DjVuHandler.
Definition at line 43 of file ImageHandler.php.
ImageHandler::validateThumbParams | ( | &$ | width, |
&$ | height, | ||
$ | srcWidth, | ||
$ | srcHeight, | ||
$ | mimeType | ||
) |
Validate thumbnail parameters and fill in the correct height.
$width | Integer: specified width (input/output) |
$height | Integer: height (output only) |
$srcWidth | Integer: width of the source image |
$srcHeight | Integer: height of the source image |
$mimeType |
Definition at line 160 of file ImageHandler.php.
References File\scaleHeight(), and wfDebug().
Referenced by normaliseParams().