JPEG specific handler. More...

Inheritance diagram for JpegHandler:

Collaboration diagram for JpegHandler:

Public Member Functions
	getMetadata ($image, $filename)

	getScriptParams ($params)

	makeParamString ($params)

	normaliseParams ($image, &$params)

	parseParamString ($str)

	rotate ($file, $params)

	sanitizeParamsForBucketing ($params)

	supportsBucketing ()

	validateParam ($name, $value)

Public Member Functions inherited from ExifBitmapHandler
	convertMetadataVersion ($metadata, $version=1)

	formatMetadata ($image, $context=false)

	getCommonMetaArray (File $file)

	getImageSize ($image, $path)
	Wrapper for base classes ImageHandler::getImageSize() that checks for rotation reported from metadata and swaps the sizes to match. More...

	getMetadataType ($image)

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

	isMetadataValid ($image, $metadata)

	swapICCProfile ($filepath, $oldProfileString, $profileFilepath)
	Swaps an embedded ICC profile for another, if found. More...

Public Member Functions inherited from BitmapHandler
	autoRotateEnabled ()

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

	makeParamString ($params)

	normaliseParams ($image, &$params)

	parseParamString ($str)

	rotate ($file, $params)

	validateParam ($name, $value)

Public Member Functions inherited from TransformationalImageHandler
	autoRotateEnabled ()
	Should we automatically rotate an image based on exif. More...

	canRotate ()
	Returns whether the current scaler supports rotation. More...

	doTransform ($image, $dstPath, $dstUrl, $params, $flags=0)
	Create a thumbnail. More...

	escapeMagickInput ($path, $scene=false)
	Escape a string for ImageMagick's input filenames. More...

	escapeMagickOutput ($path, $scene=false)
	Escape a string for ImageMagick's output filename. More...

	escapeMagickProperty ($s)
	Escape a string for ImageMagick's property input (e.g. More...

	extractPreRotationDimensions ($params, $rotation)
	Extracts the width/height if the image will be scaled before rotating. More...

	getMediaTransformError ($params, $errMsg)
	Get a MediaTransformError with error 'thumbnail_error'. More...

	isImageAreaOkForThumbnaling ($file, &$params)
	Check if the file is smaller than the maximum image area for thumbnailing. More...

	mustRender ($file)
	Returns whether the file needs to be rendered. More...

	normaliseParams ($image, &$params)

	rotate ($file, $params)
	Rotate a thumbnail. More...

Public Member Functions inherited from ImageHandler
	canRender ($file)

	getDimensionsString ($file)

	getImageArea ($image)
	Function that returns the number of pixels to be thumbnailed. More...

	getImageSize ($image, $path)

	getLongDesc ($file)

	getParamMap ()

	getScriptedTransform ($image, $script, $params)

	getScriptParams ($params)

	getShortDesc ($file)

	makeParamString ($params)

	normaliseParams ($image, &$params)

	parseParamString ($str)

	sanitizeParamsForBucketing ($params)

	validateParam ($name, $value)

	validateThumbParams (&$width, &$height, $srcWidth, $srcHeight, $mimeType)
	Validate thumbnail parameters and fill in the correct height. More...

Public Member Functions inherited from MediaHandler
	canAnimateThumbnail ($file)
	If the material is animated, we can animate the thumbnail. More...

	canRender ($file)
	True if the handled types can be transformed. More...

	canRotate ()
	True if the handler can rotate the media. More...

	convertMetadataVersion ($metadata, $version=1)
	Convert metadata version. More...

	doTransform ($image, $dstPath, $dstUrl, $params, $flags=0)
	Get a MediaTransformOutput object representing the transformed output. More...

	filterThumbnailPurgeList (&$files, $options)
	Remove files from the purge list. More...

	formatMetadata ($image, $context=false)
	Get an array structure that looks like this: More...

	formatMetadataHelper ($metadataArray, $context=false)
	sorts the visible/invisible field. More...

	getAvailableLanguages (File $file)
	Get list of languages file can be viewed in. More...

	getCommonMetaArray (File $file)
	Get an array of standard (FormatMetadata type) metadata values. More...

	getDefaultRenderLanguage (File $file)
	On file types that support renderings in multiple languages, which language is used by default if unspecified. More...

	getDimensionsString ($file)
	Shown in file history box on image description page. More...

	getEntireText (File $file)
	Get the text of the entire document. More...

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

	getLength ($file)
	If its an audio file, return the length of the file. More...

	getLongDesc ($file)
	Long description. More...

	getMetadata ($image, $path)
	Get handler-specific metadata which will be saved in the img_metadata field. More...

	getMetadataType ($image)
	Get a string describing the type of metadata, for display purposes. More...

	getPageDimensions (File $image, $page)
	Get an associative array of page dimensions Currently "width" and "height" are understood, but this might be expanded in the future. More...

	getPageText (File $image, $page)
	Generic getter for text layer. More...

	getParamMap ()
	Get an associative array mapping magic word IDs to parameter names. More...

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

	getScriptedTransform ($image, $script, $params)
	Get a MediaTransformOutput object representing an alternate of the transformed output which will call an intermediary thumbnail assist script. More...

	getShortDesc ($file)
	Short description. More...

	getStreamHeaders ($metadata)
	Get useful response headers for GET/HEAD requests for a file with the given metadata. More...

	getThumbType ($ext, $mime, $params=null)
	Get the thumbnail extension and MIME type for a given source MIME type. More...

	getTransform ($image, $dstPath, $dstUrl, $params)
	Get a MediaTransformOutput object representing the transformed output. More...

	getWarningConfig ($file)
	Gets configuration for the file warning message. More...

	isAnimatedImage ($file)
	The material is an image, and is animated. More...

	isEnabled ()
	False if the handler is disabled for all files. More...

	isExpensiveToThumbnail ($file)
	True if creating thumbnails from the file is large or otherwise resource-intensive. More...

	isMetadataValid ($image, $metadata)
	Check if the metadata string is valid for this handler. More...

	isMultiPage ($file)
	True if the type has multi-page capabilities. More...

	isVectorized ($file)
	The material is vectorized and thus scaling is lossless. More...

	makeParamString ($params)
	Merge a parameter array into a string appropriate for inclusion in filenames. More...

	mustRender ($file)
	True if handled types cannot be displayed directly in a browser but can be rendered. More...

	normaliseParams ($image, &$params)
	Changes the parameter array as necessary, ready for transformation. More...

	pageCount (File $file)
	Page count for a multi-page document, false if unsupported or unknown. More...

	parseParamString ($str)
	Parse a param string made with makeParamString back into an array. More...

	parserTransformHook ($parser, $file)
	Modify the parser object post-transform. More...

	removeBadFile ($dstPath, $retval=0)
	Check for zero-sized thumbnails. More...

	sanitizeParamsForBucketing ($params)
	Returns a normalised params array for which parameters have been cleaned up for bucketing purposes. More...

	supportsBucketing ()
	Returns whether or not this handler supports the chained generation of thumbnails according to buckets. More...

	validateParam ($name, $value)
	Validate a thumbnail parameter at parse time. More...

	verifyUpload ($fileName)
	File validation hook called on upload. More...

Static Private Member Functions
static	validateQuality ($value)
	Validate and normalize quality value to be between 1 and 100 (inclusive). More...

Additional Inherited Members
Static Public Member Functions inherited from BitmapHandler
static	imageJpegWrapper ($dst_image, $thumbPath, $quality=95)
	Callback for transformGd when transforming jpeg images. More...

Static Public Member Functions inherited from MediaHandler
static	fitBoxWidth ($boxWidth, $boxHeight, $maxHeight)
	Calculate the largest thumbnail width for a given original file size such that the thumbnail's height is at most $maxHeight. More...

static	getGeneralLongDesc ($file)
	Used instead of getLongDesc if there is no handler registered for file. More...

static	getGeneralShortDesc ($file)
	Used instead of getShortDesc if there is no handler registered for file. More...

static	getHandler ($type)
	Get a MediaHandler for a given MIME type from the instance cache. More...

static	getMetadataVersion ()
	Get metadata version. More...

Public Attributes inherited from ExifBitmapHandler
const	BROKEN_FILE = '-1'

const	OLD_BROKEN_FILE = '0'

const	SRGB_ICC_PROFILE_NAME = 'IEC 61966-2.1 Default RGB colour space - sRGB'

Public Attributes inherited from MediaHandler
const	MAX_ERR_LOG_SIZE = 65535
	Max length of error logged by logErrorForExternalProcess() More...

const	METADATA_BAD = false

const	METADATA_COMPATIBLE = 2

const	METADATA_GOOD = true

const	TRANSFORM_LATER = 1

Protected Member Functions inherited from ExifBitmapHandler
	getRotationForExif ($data)
	Given a chunk of serialized Exif metadata, return the orientation as degrees of rotation. More...

	transformImageMagick ($image, $params)

Protected Member Functions inherited from BitmapHandler
	getScalerType ($dstPath, $checkDstPath=true)
	Returns which scaler type should be used. More...

	imageMagickSubsampling ($pixelFormat)
	Get ImageMagick subsampling factors for the target JPEG pixel format. More...

	transformCustom ($image, $params)
	Transform an image using a custom command. More...

	transformGd ($image, $params)
	Transform an image using the built in GD library. More...

	transformImageMagick ($image, $params)
	Transform an image using ImageMagick. More...

	transformImageMagickExt ($image, $params)
	Transform an image using the Imagick PHP extension. More...

Protected Member Functions inherited from TransformationalImageHandler
	escapeMagickPath ($path, $scene=false)
	Armour a string against ImageMagick's GetPathComponent(). More...

	getClientScalingThumbnailImage ($image, $scalerParams)
	Get a ThumbnailImage that respresents an image that will be scaled client side. More...

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

	getScalerType ($dstPath, $checkDstPath=true)
	Returns what sort of scaler type should be used. More...

	getThumbnailSource ($file, $params)
	Get the source file for the transform. More...

	transformCustom ($image, $params)
	Transform an image using a custom command. More...

	transformGd ($image, $params)
	Transform an image using the built in GD library. More...

	transformImageMagick ($image, $params)
	Transform an image using ImageMagick. More...

	transformImageMagickExt ($image, $params)
	Transform an image using the Imagick PHP extension. More...

Protected Member Functions inherited from MediaHandler
	logErrorForExternalProcess ($retval, $err, $cmd)
	Log an error that occurred in an external process. More...

	visibleMetadataFields ()
	Get a list of metadata items which should be displayed when the metadata table is collapsed. More...

Static Protected Member Functions inherited from MediaHandler
static	addMeta (&$array, $visibility, $type, $id, $value, $param=false)
	This is used to generate an array element for each metadata value That array is then used to generate the table of metadata values on the image page. More...

Detailed Description

JPEG specific handler.

Inherits most stuff from BitmapHandler, just here to do the metadata handler differently.

Metadata stuff common to Jpeg and built-in Tiff (not PagedTiffHandler) is in ExifBitmapHandler.

Definition at line 33 of file Jpeg.php.

Member Function Documentation

JpegHandler::getMetadata	(	$image,
		$filename
	)

Definition at line 99 of file Jpeg.php.

References $e, ExifBitmapHandler\BROKEN_FILE, BitmapMetadataHandler\Jpeg(), serialize(), Exif\version(), and wfDebug().

JpegHandler::getScriptParams ( $params )

Definition at line 91 of file Jpeg.php.

References $params, and $res.

JpegHandler::makeParamString ( $params )

Definition at line 61 of file Jpeg.php.

References $params, and $res.

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

Definition at line 35 of file Jpeg.php.

References $image, and $params.

JpegHandler::parseParamString ( $str )

Definition at line 70 of file Jpeg.php.

References $res.

JpegHandler::rotate	(	$file,
		$params
	)

Parameters

File	$file
array	$params	Rotate parameters. 'rotation' clockwise rotation in degrees, allowed are multiples of 90

Since: 1.21

Returns: bool

Definition at line 135 of file Jpeg.php.

References $params, $retval, $wgJpegTran, ExifBitmapHandler\getRotation(), global, MediaHandler\logErrorForExternalProcess(), wfDebug(), wfEscapeShellArg(), and wfShellExecWithStderr().

JpegHandler::sanitizeParamsForBucketing ( $params )

Definition at line 164 of file Jpeg.php.

References $params.

JpegHandler::supportsBucketing ( )

Definition at line 160 of file Jpeg.php.

JpegHandler::validateParam	(	$name,
		$value
	)

Definition at line 45 of file Jpeg.php.

References $name, and $value.

static JpegHandler::validateQuality ( $value )

staticprivate

Validate and normalize quality value to be between 1 and 100 (inclusive).

Parameters

int $value Quality value, will be converted to integer or 0 if invalid

Returns: bool True if the value is valid

Definition at line 57 of file Jpeg.php.

References $value.

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

includes/media/Jpeg.php

Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation