JPEG specific handler. More...

Inheritance diagram for JpegHandler:

[legend]

Collaboration diagram for JpegHandler:

[legend]

Public Member Functions
	getMetadata ( $image, $filename)
	Get handler-specific metadata which will be saved in the img_metadata field.

	getScriptParams ( $params)

	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.

	rotate ( $file, $params)

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

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

	swapICCProfile ( $filepath, array $colorSpaces, array $oldProfileStrings, $profileFilepath)
	Swaps an embedded ICC profile for another, if found.

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

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

	formatMetadata ( $image, $context=false)

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

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

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

	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.

	isMetadataValid ( $image, $metadata)

Public Member Functions inherited from BitmapHandler
	autoRotateEnabled ()

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

Public Member Functions inherited from TransformationalImageHandler
	doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
	Create a thumbnail.

	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.

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

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

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

Public Member Functions inherited from ImageHandler
	canRender ( $file)

	getDimensionsString ( $file)

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

	getLongDesc ( $file)

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

	getScriptedTransform ( $image, $script, $params)

	getShortDesc ( $file)

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

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

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

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

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

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

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

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

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

	getMatchedLanguage ( $userPreferredLanguage, array $availableLanguages)
	When overridden in a descendant class, returns a language code most suiting.

	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.

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Attributes
const	SRGB_EXIF_COLOR_SPACE = 'sRGB'

const	SRGB_ICC_PROFILE_DESCRIPTION = 'sRGB IEC61966-2.1'

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

const	OLD_BROKEN_FILE = '0'

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

const	METADATA_BAD = false

const	METADATA_COMPATIBLE = 2

const	METADATA_GOOD = true

const	TRANSFORM_LATER = 1

Protected Member Functions
	transformImageMagick ( $image, $params)
	@inheritDoc

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

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

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

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

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

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

Protected Member Functions inherited from TransformationalImageHandler
	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.

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

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

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

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

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

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.

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

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

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

static	getMetadataVersion ()
	Get metadata version.

static	getPageRangesByDimensions ( $pagesByDimensions)
	Converts a dimensions array about a potentially multipage document from an exhaustive list of ordered page numbers to a list of page ranges.

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.

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 JpegHandler.php.

Member Function Documentation

◆ getMetadata()

JpegHandler::getMetadata	(	$image,
		$path
	)

Get handler-specific metadata which will be saved in the img_metadata field.

Parameters

File \| FSFile	$image	The image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an FSFile instead of File (!)
string	$path	The filename

Returns: string A string of metadata in php serialized form (Run through serialize())

Reimplemented from MediaHandler.

Definition at line 101 of file JpegHandler.php.

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

◆ getScriptParams()

JpegHandler::getScriptParams ( $params )

Reimplemented from ImageHandler.

Definition at line 93 of file JpegHandler.php.

References $params, and $res.

◆ makeParamString()

JpegHandler::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 BitmapHandler.

Definition at line 63 of file JpegHandler.php.

References $params, and $res.

◆ normaliseParams()

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

Parameters

File	$image
array	&$params

Returns: bool

Reimplemented from BitmapHandler.

Definition at line 37 of file JpegHandler.php.

References $image, and $params.

◆ parseParamString()

JpegHandler::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 BitmapHandler.

Definition at line 72 of file JpegHandler.php.

References $res.

◆ rotate()

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|MediaTransformError

Reimplemented from BitmapHandler.

Definition at line 137 of file JpegHandler.php.

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

◆ sanitizeParamsForBucketing()

JpegHandler::sanitizeParamsForBucketing ( $params )

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

Parameters

array $params

Returns: array

Reimplemented from ImageHandler.

Definition at line 166 of file JpegHandler.php.

References $params.

◆ supportsBucketing()

JpegHandler::supportsBucketing ( )

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

Returns: bool

Since: 1.24

Reimplemented from MediaHandler.

Definition at line 162 of file JpegHandler.php.

◆ swapICCProfile()

JpegHandler::swapICCProfile	(		$filepath,
		array	$colorSpaces,
		array	$oldProfileStrings,
			$profileFilepath
	)

Swaps an embedded ICC profile for another, if found.

Depends on exiftool, no-op if not installed.

Parameters

string	$filepath	File to be manipulated (will be overwritten)
array	$colorSpaces	Only process files with this/these Color Space(s)
array	$oldProfileStrings	Exact name(s) of color profile to look for (the one that will be replaced)
string	$profileFilepath	ICC profile file to apply to the file

Since: 1.26

Returns: bool

Definition at line 234 of file JpegHandler.php.

References $output, $retval, $wgExiftool, MediaHandler\logErrorForExternalProcess(), wfEscapeShellArg(), and wfShellExecWithStderr().

Referenced by transformImageMagick().

◆ transformImageMagick()

JpegHandler::transformImageMagick	(	$image,
		$params
	)

protected

@inheritDoc

Reimplemented from BitmapHandler.

Definition at line 180 of file JpegHandler.php.

References $image, $params, $ret, $wgUseTinyRGBForJPGThumbnails, SRGB_EXIF_COLOR_SPACE, SRGB_ICC_PROFILE_DESCRIPTION, and swapICCProfile().

◆ validateParam()

JpegHandler::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 BitmapHandler.

Definition at line 47 of file JpegHandler.php.

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

◆ validateQuality()

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 59 of file JpegHandler.php.

References $value.

Referenced by validateParam().

Member Data Documentation

◆ SRGB_EXIF_COLOR_SPACE

const JpegHandler::SRGB_EXIF_COLOR_SPACE = 'sRGB'

Definition at line 34 of file JpegHandler.php.

Referenced by transformImageMagick().

◆ SRGB_ICC_PROFILE_DESCRIPTION

const JpegHandler::SRGB_ICC_PROFILE_DESCRIPTION = 'sRGB IEC61966-2.1'

Definition at line 35 of file JpegHandler.php.

Referenced by transformImageMagick().

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

includes/media/JpegHandler.php

Public Member Functions

Public Attributes

Protected Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getMetadata()

◆ getScriptParams()

◆ makeParamString()

◆ normaliseParams()

◆ parseParamString()

◆ rotate()

◆ sanitizeParamsForBucketing()

◆ supportsBucketing()

◆ swapICCProfile()

◆ transformImageMagick()

◆ validateParam()

◆ validateQuality()

Member Data Documentation

◆ SRGB_EXIF_COLOR_SPACE

◆ SRGB_ICC_PROFILE_DESCRIPTION