Generic handler for bitmap images. More...

Inheritance diagram for BitmapHandler:

Collaboration diagram for BitmapHandler:

Public Member Functions
	doTransform ($image, $dstPath, $dstUrl, $params, $flags=0)
	escapeMagickInput ($path, $scene=false)
	Escape a string for ImageMagick's input filenames.
	escapeMagickOutput ($path, $scene=false)
	Escape a string for ImageMagick's output filename.
	escapeMagickProperty ($s)
	Escape a string for ImageMagick's property input (e.g.
	extractPreRotationDimensions ($params, $rotation)
	Extracts the width/height if the image will be scaled before rotating.
	getImageArea ($image)
	Function that returns the number of pixels to be thumbnailed.
	getMediaTransformError ($params, $errMsg)
	Get a MediaTransformError with error 'thumbnail_error'.
	getRotation ($file)
	On supporting image formats, try to read out the low-level orientation of the file and return the angle that the file needs to be rotated to be viewed.
	mustRender ($file)
	Rerurns whether the file needs to be rendered.
	normaliseParams ($image, &$params)
Static Public Member Functions
static	canRotate ()
	Returns whether the current scaler supports rotation (im and gd do)
static	imageJpegWrapper ($dst_image, $thumbPath)
Protected Member Functions
	escapeMagickPath ($path, $scene=false)
	Armour a string against ImageMagick's GetPathComponent().
	getClientScalingThumbnailImage ($image, $scalerParams)
	Get a ThumbnailImage that respresents an image that will be scaled client side.
	getMagickVersion ()
	Retrieve the version of the installed ImageMagick You can use PHPs version_compare() to use this value Value is cached for one hour.
	logErrorForExternalProcess ($retval, $err, $cmd)
	Log an error that occurred in an external process.
	transformCustom ($image, $params)
	Transform an image using a custom command.
	transformGd ($image, $params)
	Transform an image using the built in GD library.
	transformImageMagick ($image, $params)
	Transform an image using ImageMagick.
	transformImageMagickExt ($image, $params)
	Transform an image using the Imagick PHP extension.
Static Protected Member Functions
static	getScalerType ($dstPath, $checkDstPath=true)
	Returns which scaler type should be used.

Detailed Description

Generic handler for bitmap images.

Definition at line 29 of file Bitmap.php.

Member Function Documentation

static BitmapHandler::canRotate ( ) [static]

Returns whether the current scaler supports rotation (im and gd do)

Returns:: bool

Definition at line 740 of file Bitmap.php.

References getScalerType().

Referenced by ResourceLoaderStartUpModule\getConfig(), mustRender(), ExifRotationTest\testMetadata(), and ExifRotationTest\testRotationRendering().

BitmapHandler::doTransform	(	$	image,
		$	dstPath,
		$	dstUrl,
		$	params,
		$	flags = `0`
	)

Parameters:

	$image	File
	$dstPath
	$dstUrl
	$params
int	$flags

Returns:: MediaTransformError|ThumbnailImage|TransformParameterError

Reimplemented from MediaHandler.

Reimplemented in BitmapHandler_ClientOnly.

Definition at line 123 of file Bitmap.php.

References $params, getClientScalingThumbnailImage(), getScalerType(), normaliseParams(), MediaHandler\removeBadFile(), transformCustom(), transformGd(), transformImageMagick(), transformImageMagickExt(), wfDebug(), wfMkdirParents(), and wfRunHooks().

BitmapHandler::escapeMagickInput	(	$	path,
		$	scene = `false`
	)

Escape a string for ImageMagick's input filenames.

See ExpandFilenames() and GetPathComponent() in magick/utility.c.

This won't work with an initial ~ or @, so input files should be prefixed with the directory name.

Glob character unescaping is broken in ImageMagick before 6.6.1-5, but it's broken in a way that doesn't involve trying to convert every file in a directory, so we're better off escaping and waiting for the bugfix to filter down to users.

Parameters:

$path	string The file path
$scene	string The scene specification, or false if there is none

Returns:: string

Definition at line 629 of file Bitmap.php.

References $path, and escapeMagickPath().

Referenced by transformImageMagick().

BitmapHandler::escapeMagickOutput	(	$	path,
		$	scene = `false`
	)

Escape a string for ImageMagick's output filename.

See InterpretImageFilename() in magick/image.c.

Returns:: string

Definition at line 647 of file Bitmap.php.

References $path, and escapeMagickPath().

Referenced by transformImageMagick().

BitmapHandler::escapeMagickPath	(	$	path,
		$	scene = `false`
	)		`[protected]`

Armour a string against ImageMagick's GetPathComponent().

This is a helper function for escapeMagickInput() and escapeMagickOutput().

Parameters:

$path	string The file path
$scene	string The scene specification, or false if there is none

Returns:: string

Definition at line 660 of file Bitmap.php.

References $path, and wfIsWindows().

Referenced by escapeMagickInput(), and escapeMagickOutput().

BitmapHandler::escapeMagickProperty ( $ s )

Escape a string for ImageMagick's property input (e.g.

-set -comment) See InterpretImageProperties() in magick/property.c

Returns:: mixed|string

Definition at line 601 of file Bitmap.php.

References $s.

Referenced by transformImageMagick().

BitmapHandler::extractPreRotationDimensions	(	$	params,
		$	rotation
	)

Extracts the width/height if the image will be scaled before rotating.

This will match the physical size/aspect ratio of the original image prior to application of the rotation -- so for a portrait image that's stored as raw landscape with 90-degress rotation, the resulting size will be wider than it is tall.

Parameters:

$params	array Parameters as returned by normaliseParams
$rotation	int The rotation angle that will be applied

Returns:: array ($width, $height) array

Definition at line 91 of file Bitmap.php.

References $params.

Referenced by transformGd(), transformImageMagick(), and transformImageMagickExt().

BitmapHandler::getClientScalingThumbnailImage	(	$	image,
		$	scalerParams
	)		`[protected]`

Get a ThumbnailImage that respresents an image that will be scaled client side.

Parameters:

$image	File File associated with this thumbnail
$scalerParams	array Array with scaler params

Returns:: ThumbnailImage

Todo:: fixme: no rotation support

Definition at line 272 of file Bitmap.php.

References $params.

Referenced by doTransform().

BitmapHandler::getImageArea ( $ image )

Function that returns the number of pixels to be thumbnailed.

Intended for animated GIFs to multiply by the number of frames.

Parameters:

File $image

Returns:: int

Reimplemented in GIFHandler.

Definition at line 111 of file Bitmap.php.

Referenced by transformImageMagick(), and transformImageMagickExt().

BitmapHandler::getMagickVersion ( ) [protected]

Retrieve the version of the installed ImageMagick You can use PHPs version_compare() to use this value Value is cached for one hour.

Returns:: String representing the IM version.

Definition at line 690 of file Bitmap.php.

References $matches, $wgMemc, wfDebug(), wfEscapeShellArg(), and wfShellExec().

Referenced by transformImageMagick().

BitmapHandler::getMediaTransformError	(	$	params,
		$	errMsg
	)

Get a MediaTransformError with error 'thumbnail_error'.

Parameters:

$params	array Parameter array as passed to the transform* functions
$errMsg	string Error message

Returns:: MediaTransformError

Definition at line 507 of file Bitmap.php.

References $params.

Referenced by transformCustom(), transformGd(), transformImageMagick(), and transformImageMagickExt().

BitmapHandler::getRotation ( $ file )

On supporting image formats, try to read out the low-level orientation of the file and return the angle that the file needs to be rotated to be viewed.

This information is only useful when manipulating the original file; the width and height we normally work with is logical, and will match any produced output views.

The base BitmapHandler doesn't understand any metadata formats, so this is left up to child classes to implement.

Parameters:

$file File

Returns:: int 0, 90, 180 or 270

Reimplemented in ExifBitmapHandler.

Definition at line 731 of file Bitmap.php.

Referenced by mustRender(), transformGd(), transformImageMagick(), and transformImageMagickExt().

static BitmapHandler::getScalerType	(	$	dstPath,
		$	checkDstPath = `true`
	)		`[static, protected]`

Returns which scaler type should be used.

Creates parent directories for $dstPath and returns 'client' on error

Returns:: string client,im,custom,gd

Reimplemented in XCFHandler.

Definition at line 240 of file Bitmap.php.

Referenced by canRotate(), doTransform(), and normaliseParams().

static BitmapHandler::imageJpegWrapper	(	$	dst_image,
		$	thumbPath
	)		`[static]`

Definition at line 711 of file Bitmap.php.

BitmapHandler::logErrorForExternalProcess	(	$	retval,
		$	err,
		$	cmd
	)		`[protected]`

Log an error that occurred in an external process.

Parameters:

$retval	int
$err	int
$cmd	string

Definition at line 495 of file Bitmap.php.

References wfDebugLog(), and wfHostname().

Referenced by transformCustom(), and transformImageMagick().

BitmapHandler::mustRender ( $ file )

Rerurns whether the file needs to be rendered.

Returns true if the file requires rotation and we are able to rotate it.

Parameters:

$file File

Returns:: bool

Reimplemented from MediaHandler.

Reimplemented in TiffHandler, XCFHandler, and BmpHandler.

Definition at line 766 of file Bitmap.php.

References $file, canRotate(), and getRotation().

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

Parameters:

$image	File
$params	array Transform parameters. Entries with the keys 'width' and 'height' are the respective screen width and height, while the keys 'physicalWidth' and 'physicalHeight' indicate the thumbnail dimensions.

Returns:: bool

Reimplemented from ImageHandler.

Reimplemented in BitmapHandler_ClientOnly.

Definition at line 37 of file Bitmap.php.

References $params, getScalerType(), and wfRunHooks().

Referenced by doTransform(), and BitmapScalingTest\testNormaliseParams().

BitmapHandler::transformCustom	(	$	image,
		$	params
	)		`[protected]`

Transform an image using a custom command.

Parameters:

$image	File File associated with this thumbnail
$params	array Array with scaler params

Returns:: MediaTransformError Error object if error occurred, false (=no error) otherwise

Definition at line 464 of file Bitmap.php.

References $params, getMediaTransformError(), logErrorForExternalProcess(), wfDebug(), wfEscapeShellArg(), wfProfileIn(), wfProfileOut(), and wfShellExec().

Referenced by doTransform().

BitmapHandler::transformGd	(	$	image,
		$	params
	)		`[protected]`

Transform an image using the built in GD library.

Parameters:

$image	File File associated with this thumbnail
$params	array Array with scaler params

Returns:: MediaTransformError Error object if error occurred, false (=no error) otherwise

Definition at line 520 of file Bitmap.php.

References $params, extractPreRotationDimensions(), getMediaTransformError(), getRotation(), wfDebug(), and wfMessage().

Referenced by doTransform().

BitmapHandler::transformImageMagick	(	$	image,
		$	params
	)		`[protected]`

Transform an image using ImageMagick.

Parameters:

$image	File File associated with this thumbnail
$params	array Array with scaler params

Returns:: MediaTransformError Error object if error occurred, false (=no error) otherwise

Definition at line 288 of file Bitmap.php.

References $params, escapeMagickInput(), escapeMagickOutput(), escapeMagickProperty(), extractPreRotationDimensions(), getImageArea(), getMagickVersion(), getMediaTransformError(), getRotation(), MediaHandler\isAnimatedImage(), logErrorForExternalProcess(), wfDebug(), wfEscapeShellArg(), wfProfileIn(), wfProfileOut(), and wfShellExec().

Referenced by doTransform().

BitmapHandler::transformImageMagickExt	(	$	image,
		$	params
	)		`[protected]`

Transform an image using the Imagick PHP extension.

Parameters:

$image	File File associated with this thumbnail
$params	array Array with scaler params

Returns:: MediaTransformError Error object if error occurred, false (=no error) otherwise

Definition at line 387 of file Bitmap.php.

References $params, $result, extractPreRotationDimensions(), getImageArea(), getMediaTransformError(), getRotation(), MediaHandler\isAnimatedImage(), and wfDebug().

Referenced by doTransform().

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

includes/media/Bitmap.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation