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

Inheritance diagram for ImageHandler:

Collaboration diagram for ImageHandler:

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.
	sanitizeParamsForBucketing ($params)
	Returns a normalised params array for which parameters have been cleaned up for bucketing purposes.
	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 29 of file ImageHandler.php.

Member Function Documentation

ImageHandler::canRender ( $ file )

Parameters:

File $file

Returns:: bool

Reimplemented from MediaHandler.

Reimplemented in XCFHandler, and TiffHandler.

Definition at line 34 of file ImageHandler.php.

References $file.

ImageHandler::getDimensionsString ( $ file )

Parameters:

File $file

Returns:: string

Reimplemented from MediaHandler.

Definition at line 262 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.

Parameters:

File $image

Returns:: int

Reimplemented in GIFHandler.

Definition at line 220 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.

This function is used for determining the width, height and bitdepth directly from an image. The results are stored in the database in the img_width, img_height, img_bits fields.

Note:: If this is a multipage file, return the width and height of the first page.

Parameters:

File	$image	The image object, or false if there isn't one
string	$path	The filename

Returns:: array Follow the format of PHP getimagesize() internal function. See http://www.php.net/getimagesize. MediaWiki will only ever use the first two array keys (the width and height), and the 'bits' associative key. All other array keys are ignored. Returning a 'bits' key is optional as not all formats have a notion of "bitdepth".

Reimplemented from MediaHandler.

Reimplemented in DjVuHandler, ExifBitmapHandler, XCFHandler, and BmpHandler.

Definition at line 203 of file ImageHandler.php.

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

ImageHandler::getLongDesc ( $ file )

Parameters:

File $file

Returns:: string

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, GIFHandler, and PNGHandler.

Definition at line 241 of file ImageHandler.php.

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

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 SvgHandler, and DjVuHandler.

Definition at line 38 of file ImageHandler.php.

References array().

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

Parameters:

File	$image
string	$script
array	$params

Returns:: bool|MediaTransformOutput

Reimplemented from MediaHandler.

Definition at line 192 of file ImageHandler.php.

References $params, getScriptParams(), normaliseParams(), and wfAppendQuery().

ImageHandler::getScriptParams ( $ params )

Reimplemented in SvgHandler, DjVuHandler, and JpegHandler.

Definition at line 77 of file ImageHandler.php.

References $params, and array().

Referenced by getScriptedTransform().

ImageHandler::getShortDesc ( $ file )

Parameters:

File $file

Returns:: string

Reimplemented from MediaHandler.

Definition at line 228 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.

Parameters:

array $params Array of parameters that have been through normaliseParams.

Returns:: string

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, DjVuHandler, and JpegHandler.

Definition at line 54 of file ImageHandler.php.

References $params.

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

Parameters:

File	$image
array	$params

Returns:: bool

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, TransformationalImageHandler, BitmapHandler_ClientOnly, and JpegHandler.

Definition at line 86 of file ImageHandler.php.

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

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

ImageHandler::parseParamString ( $ str )

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

Parameters:

string $str The parameter string without file name (e.g. 122px)

Returns:: array|bool Array of parameters or false on failure.

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, DjVuHandler, and JpegHandler.

Definition at line 68 of file ImageHandler.php.

References array().

ImageHandler::sanitizeParamsForBucketing ( $ params )

Returns a normalised params array for which parameters have been cleaned up for bucketing purposes.

Parameters:

array $params

Returns:: array

Reimplemented from MediaHandler.

Reimplemented in JpegHandler.

Definition at line 273 of file ImageHandler.php.

References $params.

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:

string	$name
mixed	$value

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, DjVuHandler, and JpegHandler.

Definition at line 42 of file ImageHandler.php.

References $name, $value, and array().

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

Validate thumbnail parameters and fill in the correct height.

Parameters:

int	$width	Specified width (input/output)
int	$height	Height (output only)
int	$srcWidth	Width of the source image
int	$srcHeight	Height of the source image
string	$mimeType	Unused

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

Definition at line 162 of file ImageHandler.php.

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

Referenced by normaliseParams().

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

includes/media/ImageHandler.php

Public Member Functions

Detailed Description

Member Function Documentation