Media handler abstract base class for images. More...

Inheritance diagram for ImageHandler:

Collaboration diagram for ImageHandler:

Public Member Functions
	canRender ($file)
	getDimensionsString ($file)
	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)
	isAnimatedImage ($image)
	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.

Detailed Description

Media handler abstract base class for images.

Definition at line 526 of file Generic.php.

Member Function Documentation

ImageHandler::canRender ( $ file )

Parameters:

$file File

Returns:: bool

Reimplemented from MediaHandler.

Reimplemented in TiffHandler.

Definition at line 532 of file Generic.php.

References $file.

ImageHandler::getDimensionsString ( $ file )

Parameters:

$file File

Returns:: string

Reimplemented from MediaHandler.

Definition at line 744 of file Generic.php.

References $file, and wfMessage().

Here is the call graph for this function:

ImageHandler::getImageSize	(	$	image,
		$	path
	)

Get an image size array like that returned by getimagesize(), or false if it can't be determined.

Parameters:

$image	File: the image object, or false if there isn't one
$path	String: the filename

Returns:: Array Follow the format of PHP getimagesize() internal function. See http://www.php.net/getimagesize

Reimplemented from MediaHandler.

Reimplemented in DjVuHandler, ExifBitmapHandler, XCFHandler, and BmpHandler.

Definition at line 697 of file Generic.php.

References $path, wfRestoreWarnings(), and wfSuppressWarnings().

Here is the call graph for this function:

ImageHandler::getLongDesc ( $ file )

Parameters:

$file File

Returns:: string

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, GIFHandler, and PNGHandler.

Definition at line 724 of file Generic.php.

References $file, $size, $wgLang, and wfMessage().

Here is the call graph for this function:

ImageHandler::getParamMap ( )

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 DjVuHandler.

Definition at line 536 of file Generic.php.

ImageHandler::getScriptedTransform	(	$	image,
		$	script,
		$	params
	)

Parameters:

$image	File
$script
$params

Returns:: bool|ThumbnailImage

Reimplemented from MediaHandler.

Definition at line 685 of file Generic.php.

References $page, $url, getScriptParams(), normaliseParams(), and wfArrayToCGI().

Here is the call graph for this function:

ImageHandler::getScriptParams ( $ params )

Reimplemented in DjVuHandler.

Definition at line 574 of file Generic.php.

Referenced by getScriptedTransform().

Here is the caller graph for this function:

ImageHandler::getShortDesc ( $ file )

Parameters:

$file File

Returns:: string

Reimplemented from MediaHandler.

Definition at line 712 of file Generic.php.

References $file, $wgLang, and wfMessage().

Here is the call graph for this function:

ImageHandler::isAnimatedImage ( $ image )

Reimplemented in GIFHandler, PNGHandler, and SvgHandler.

Definition at line 704 of file Generic.php.

Referenced by BitmapHandler\transformImageMagick(), and BitmapHandler\transformImageMagickExt().

Here is the caller graph for this function:

ImageHandler::makeParamString ( $ params )

Merge a parameter array into a string appropriate for inclusion in filenames.

Parameters:

$params array

Reimplemented from MediaHandler.

Reimplemented in DjVuHandler.

Definition at line 552 of file Generic.php.

ImageHandler::normaliseParams	(	$	image,
		&$	params
	)

Parameters:

$image	File
$params

Returns:: bool

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, BitmapHandler_ClientOnly, and BitmapHandler.

Definition at line 583 of file Generic.php.

References MediaHandler\fitBoxWidth(), File\scaleHeight(), and validateThumbParams().

Referenced by DjVuHandler\doTransform(), and getScriptedTransform().

Here is the call graph for this function:

Here is the caller graph for this function:

ImageHandler::parseParamString ( $ str )

Parse a param string made with makeParamString back into an array.

Parameters:

$str string

Reimplemented from MediaHandler.

Reimplemented in DjVuHandler.

Definition at line 565 of file Generic.php.

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.

Parameters:

$name
$value

Reimplemented from MediaHandler.

Reimplemented in DjVuHandler.

Definition at line 540 of file Generic.php.

ImageHandler::validateThumbParams	(	&$	width,
		&$	height,
		$	srcWidth,
		$	srcHeight,
		$	mimeType
	)

Validate thumbnail parameters and fill in the correct height.

Parameters:

$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	Unused

Returns:: false to indicate that an error should be returned to the user.

Definition at line 658 of file Generic.php.

References File\scaleHeight(), and wfDebug().

Referenced by normaliseParams().

Here is the call graph for this function:

Here is the caller graph for this function:

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

includes/media/Generic.php

Public Member Functions

Detailed Description

Member Function Documentation