Handler for Tiff images. More...

Inheritance diagram for TiffHandler:

[legend]

Collaboration diagram for TiffHandler:

[legend]

Public Member Functions

canRender ( $file)

Conversion to PNG for inline display can be disabled here... Note scaling should work with ImageMagick, but may not with GD scaling.

getMetadata ( $image, $filename)

getThumbType ( $ext, $mime, $params=null)

isExpensiveToThumbnail ( $file)

True if creating thumbnails from the file is large or otherwise resource-intensive.

mustRender ( $file)

Browsers don't support TIFF inline generally... For inline display, we need to convert to PNG.

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) Stable to override.

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

Stable to override Stable to override

normaliseParams ( $image, &$params)

Stable to override.

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.

Stable to override Stable to override

rotate ( $file, $params)

Stable to override.

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

Stable to override 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.

Public Member Functions inherited from ImageHandler

getDimensionsString ( $file)

Shown in file history box on image description page.Stable to override

Parameters

File $file

Returns: string Dimensions

Stable to override

getImageArea ( $image)

Function that returns the number of pixels to be thumbnailed.

getLongDesc ( $file)

Long description.Shown under image on image description page surounded by ().Stable to override

Parameters

File $file

Returns: string

Stable to override

getParamMap ()

Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters. Stable to override

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().Stable to override

Parameters

File	$image
string	$script
array	$params

Returns: bool|ThumbnailImage

Stable to override

getShortDesc ( $file)

Short description.Shown on Special:Search results.Stable to override

Parameters

File $file

Returns: string

Stable to override

sanitizeParamsForBucketing ( $params)

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

Parameters

array $params

Returns: array

Stable to override

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 Stable to override.

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.

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 Stable to override.

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 Stable to override.

verifyUpload ( $fileName)

File validation hook called on upload.

Private Attributes
const	EXPENSIVE_SIZE_LIMIT = 10485760
	TIFF files over 10M are considered expensive to thumbnail.

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.

Public Attributes inherited from ExifBitmapHandler
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 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.

	transformImageMagick ( $image, $params)
	Transform an image using ImageMagick Stable to override.

	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)
	Stable to override

Protected Member Functions inherited from MediaHandler
	formatMetadataHelper ( $metadataArray, $context=false)
	sorts the visible/invisible field.

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

Handler for Tiff images.

Definition at line 29 of file TiffHandler.php.

Member Function Documentation

◆ canRender()

TiffHandler::canRender ( $file )

Conversion to PNG for inline display can be disabled here... Note scaling should work with ImageMagick, but may not with GD scaling.

Files pulled from an another MediaWiki instance via ForeignAPIRepo / InstantCommons will have thumbnails managed from the remote instance, so we can skip this check.

Parameters

File $file

Returns: bool

Reimplemented from ImageHandler.

Definition at line 46 of file TiffHandler.php.

References $file, and $wgTiffThumbnailType.

◆ getMetadata()

TiffHandler::getMetadata	(		$image,
			$filename )

Parameters

File \| FSFile	$image
string	$filename

Exceptions

MWException

Returns: string

Reimplemented from MediaHandler.

Definition at line 82 of file TiffHandler.php.

References $wgShowEXIF, ExifBitmapHandler\BROKEN_FILE, serialize(), BitmapMetadataHandler\Tiff(), Exif\version(), and wfDebug().

◆ getThumbType()

TiffHandler::getThumbType	(	$ext,
		$mime,
		$params = null )

Parameters

string	$ext
string	$mime
array \| null	$params

Returns: array

Reimplemented from MediaHandler.

Definition at line 70 of file TiffHandler.php.

References $wgTiffThumbnailType.

◆ isExpensiveToThumbnail()

TiffHandler::isExpensiveToThumbnail ( $file )

True if creating thumbnails from the file is large or otherwise resource-intensive.

Stable to override

Parameters

File $file

Returns: bool

Reimplemented from MediaHandler.

Definition at line 107 of file TiffHandler.php.

References $file.

◆ mustRender()

TiffHandler::mustRender ( $file )

Browsers don't support TIFF inline generally... For inline display, we need to convert to PNG.

Parameters

File $file

Returns: bool

Reimplemented from TransformationalImageHandler.

Definition at line 60 of file TiffHandler.php.

Member Data Documentation

◆ EXPENSIVE_SIZE_LIMIT

const TiffHandler::EXPENSIVE_SIZE_LIMIT = 10485760

private

TIFF files over 10M are considered expensive to thumbnail.

Definition at line 33 of file TiffHandler.php.

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

includes/media/TiffHandler.php

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canRender()

◆ getMetadata()

◆ getThumbType()

◆ isExpensiveToThumbnail()

◆ mustRender()

Member Data Documentation

◆ EXPENSIVE_SIZE_LIMIT