ExifBitmapHandler Class Reference

Stuff specific to JPEG and (built-in) TIFF handler. More...

Inherits BitmapHandler.

Inherited by JpegHandler, and TiffHandler.

Collaboration diagram for ExifBitmapHandler:

Public Member Functions
	convertMetadataVersion ( $metadata, $version=1)
	Convert metadata version.
	formatMetadata ( $image, $context=false)
	getCommonMetaArray (File $file)
	Get an array of standard (FormatMetadata type) metadata values.
	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.
	isFileMetadataValid ( $image)
Public Member Functions inherited from BitmapHandler
	autoRotateEnabled ()
	canRotate ()
	Returns whether the current scaler supports rotation (im and gd do)
	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 Stability: stable to override Exceptions MediaTransformInvalidParametersException
	normaliseParams ( $image, &$params)
	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|false Array of parameters or false on failure. Stability: stable to override
	rotate ( $file, $params)
	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 Returns bool Stability: stable to override
Public Member Functions inherited from TransformationalImageHandler
	doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
	Create a thumbnail.
	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)
	True if the handled types can be transformed. Stability: stable to override Parameters File $file Returns bool
	getDimensionsString ( $file)
	Shown in file history box on image description page. Stability: stable to override Parameters File $file Returns string Dimensions
	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)
	Long description.Shown under image on image description page surrounded by (). Stability: stable to override Parameters File $file Returns string
	getParamMap ()
	Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters. Returns string[]
	getScriptedTransform ( $image, $script, $params)
	Get a MediaTransformOutput object representing an alternate of the transformed output which will call an intermediary thumbnail assist script.Used when the repository has a thumbnailScriptUrl option configured.Return false to fall back to the regular getTransform(). Stability: stable to override Parameters File $image string $script array $params Returns ThumbnailImage|false
	getShortDesc ( $file)
	Short description.Shown on Special:Search results. Stability: stable to override Parameters File $file Returns string
	getSizeAndMetadata ( $state, $path)
	Get image size information and metadata array.
	sanitizeParamsForBucketing ( $params)
	Returns a normalised params array for which parameters have been cleaned up for bucketing purposes. Stability: stable to override Parameters array $params Returns array
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.
	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 it's 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.
	getMetadata ( $image, $path)
	Get handler-specific metadata which will be saved in the img_metadata field.
	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.
	getSizeAndMetadataWithFallback ( $file, $path)
	Get the metadata array and the image size, with b/c fallback.
	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.
	isMetadataValid ( $image, $metadata)
	Check if the metadata string is valid for this handler.
	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.
	supportsBucketing ()
	Returns whether or not this handler supports the chained generation of thumbnails according to buckets.
	useSplitMetadata ()
	If this returns true, LocalFile may split metadata up and store its constituent items separately.
	verifyUpload ( $fileName)
	File validation hook called on upload.

Public Attributes
const	BROKEN_FILE = '-1'
	Error extracting metadata.
const	OLD_BROKEN_FILE = '0'
	Outdated error extracting metadata.
Public Attributes inherited from MediaHandler
const	METADATA_BAD = false
const	METADATA_COMPATIBLE = 2
const	METADATA_GOOD = true
const	TRANSFORM_LATER = 1

Protected Member Functions
	applyExifRotation ( $info, $metadata)
	getRotationForExifFromOrientation ( $orientation)
	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.
	transformImageMagick ( $image, $params)
	Transform an image using ImageMagick.
	transformImageMagickExt ( $image, $params)
	Transform an image using the Imagick PHP extension.
Protected Member Functions inherited from TransformationalImageHandler
	escapeMagickInput ( $path, $scene=false)
	Escape a string for ImageMagick's input filenames.
	escapeMagickOutput ( $path, $scene=false)
	Escape a string for ImageMagick's output filename.
	escapeMagickPath ( $path, $scene=false)
	Armour a string against ImageMagick's GetPathComponent().
	escapeMagickProperty ( $s)
	Escape a string for ImageMagick's property input (e.g.
	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 ImageHandler
	getScriptParams ( $params)
Protected Member Functions inherited from MediaHandler
	formatMetadataHelper ( $metadataArray, $context=false)
	sorts the visible/invisible field.
	formatTag (string $key, $vals, $context=false)
	Override default formatting for the given metadata field.
	hasMostDerivedMethod ( $name)
	Check whether a method is implemented in the most derived class.
	logErrorForExternalProcess ( $retval, $err, $cmd)
	Log an error that occurred in an external process.
	useLegacyMetadata ()
	If this returns true, the new method getSizeAndMetadata() will not be called.
	visibleMetadataFields ()
	Get a list of metadata items which should be displayed when the metadata table is collapsed.

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

Stuff specific to JPEG and (built-in) TIFF handler.

All metadata related, since both JPEG and TIFF support Exif.

Stability: stable

to extend

Definition at line 35 of file ExifBitmapHandler.php.

Member Function Documentation

applyExifRotation()

ExifBitmapHandler::applyExifRotation ( $info, $metadata )

protected

Definition at line 165 of file ExifBitmapHandler.php.

References BitmapHandler\autoRotateEnabled(), and getRotationForExifFromOrientation().

Referenced by JpegHandler\getSizeAndMetadata(), and TiffHandler\getSizeAndMetadata().

convertMetadataVersion()

ExifBitmapHandler::convertMetadataVersion	(		$metadata,
			$version = 1 )

Convert metadata version.

By default just returns $metadata, but can be used to allow media handlers to convert between metadata versions.

Stability: stable

to override

Parameters

array	$metadata	Metadata array
int | string	$version	Target version

Returns

array Serialized metadata in specified version, or $metadata on fail.

Reimplemented from MediaHandler.

Definition at line 42 of file ExifBitmapHandler.php.

References FormatMetadata\collapseContactInfo().

formatMetadata()

ExifBitmapHandler::formatMetadata	(		$image,
			$context = false )

Parameters

File	$image
IContextSource | false	$context

Returns

array[]|false

Reimplemented from MediaHandler.

Definition at line 142 of file ExifBitmapHandler.php.

References MediaHandler\formatMetadataHelper(), and getCommonMetaArray().

getCommonMetaArray()

ExifBitmapHandler::getCommonMetaArray

(

File

$file

)

Get an array of standard (FormatMetadata type) metadata values.

The returned data is largely the same as that from getMetadata(), but formatted in a standard, stable, handler-independent way. The idea being that some values like ImageDescription or Artist are universal and should be retrievable in a handler generic way.

The specific properties are the type of properties that can be handled by the FormatMetadata class. These values are exposed to the user via the filemetadata parser function.

Details of the response format of this function can be found at https://www.mediawiki.org/wiki/Manual:File_metadata_handling tl/dr: the response is an associative array of properties keyed by name, but the value can be complex. You probably want to call one of the FormatMetadata::flatten* functions on the property values before using them, or call FormatMetadata::getFormattedData() on the full response array, which transforms all values into prettified, human-readable text.

Subclasses overriding this function must return a value which is a valid API response fragment (all associative array keys are valid XML tagnames).

Note, if the file simply has no metadata, but the handler supports this interface, it should return an empty array, not false.

Stability: stable

to override

Parameters

File

$file

Returns

array|false False if interface not supported

Since

1.23

Reimplemented from MediaHandler.

Definition at line 151 of file ExifBitmapHandler.php.

References $file.

Referenced by formatMetadata().

getMetadataType()

ExifBitmapHandler::getMetadataType

(

$image

)

Get a string describing the type of metadata, for display purposes.

Stability: stable

to override

Note

This method is currently unused.

Parameters

File

$image

Returns

string|false

Reimplemented from MediaHandler.

Definition at line 161 of file ExifBitmapHandler.php.

getRotation()

ExifBitmapHandler::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.

Parameters

File

$file

Returns

int 0, 90, 180 or 270

Reimplemented from MediaHandler.

Definition at line 192 of file ExifBitmapHandler.php.

References $file, BitmapHandler\autoRotateEnabled(), and getRotationForExifFromOrientation().

Referenced by JpegHandler\rotate().

getRotationForExifFromOrientation()

ExifBitmapHandler::getRotationForExifFromOrientation ( $orientation )

protected

Given a chunk of serialized Exif metadata, return the orientation as degrees of rotation.

Parameters

int | null

$orientation

Returns

int 0, 90, 180 or 270

Todo

FIXME: Orientation can include flipping as well; see if this is an issue!

Definition at line 209 of file ExifBitmapHandler.php.

Referenced by applyExifRotation(), and getRotation().

isFileMetadataValid()

ExifBitmapHandler::isFileMetadataValid

(

$image

)

Parameters

File

$image

Returns

bool|int

Reimplemented from MediaHandler.

Definition at line 95 of file ExifBitmapHandler.php.

References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, Exif\version(), and wfDebug().

Member Data Documentation

BROKEN_FILE

const ExifBitmapHandler::BROKEN_FILE = '-1'

Error extracting metadata.

Definition at line 37 of file ExifBitmapHandler.php.

Referenced by JpegHandler\getSizeAndMetadata(), and TiffHandler\getSizeAndMetadata().

OLD_BROKEN_FILE

const ExifBitmapHandler::OLD_BROKEN_FILE = '0'

Outdated error extracting metadata.

Definition at line 40 of file ExifBitmapHandler.php.

---

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

• includes/media/ExifBitmapHandler.php