Media handler abstract base class for images. More...

Inheritance diagram for ImageHandler:

[legend]

Collaboration diagram for ImageHandler:

Public Member Functions
	canRender ( $file)

	getDimensionsString ( $file)

	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)

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

	getScriptedTransform ( $image, $script, $params)

	getScriptParams ( $params)

	getShortDesc ( $file)

	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.

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

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

	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.

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

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

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

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

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

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

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

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

	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.

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

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

	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.

	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.

	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.

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

	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.

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

Additional Inherited Members
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 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 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 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

Media handler abstract base class for images.

Definition at line 29 of file ImageHandler.php.

Member Function Documentation

◆ canRender()

ImageHandler::canRender ( $file )

Parameters

File $file

Returns: bool

Reimplemented from MediaHandler.

Reimplemented in TiffHandler, WebPHandler, and XCFHandler.

Definition at line 34 of file ImageHandler.php.

◆ getDimensionsString()

ImageHandler::getDimensionsString ( $file )

Parameters

File $file

Returns: string

Reimplemented from MediaHandler.

Definition at line 262 of file ImageHandler.php.

References wfMessage().

◆ getImageArea()

ImageHandler::getImageArea ( $image )

Function that returns the number of pixels to be thumbnailed.

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

If the file doesn't support a notion of "area" return 0.

Parameters

File $image

Returns: int

Reimplemented in GIFHandler.

Definition at line 220 of file ImageHandler.php.

References $image.

Referenced by BitmapHandler\normaliseParams(), BitmapHandler\transformImageMagick(), and BitmapHandler\transformImageMagickExt().

◆ getImageSize()

ImageHandler::getImageSize	(		$image,
			$path )

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

This function is used for determining the width, height and bitdepth directly from an image. The results are stored in the database in the img_width, img_height, img_bits fields.

Note: If this is a multipage file, return the width and height of the first page.

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: array|bool Follow the format of PHP getimagesize() internal function. See https://secure.php.net/getimagesize. MediaWiki will only ever use the first two array keys (the width and height), and the 'bits' associative key. All other array keys are ignored. Returning a 'bits' key is optional as not all formats have a notion of "bitdepth". Returns false on failure.

Reimplemented from MediaHandler.

Reimplemented in BmpHandler, XCFHandler, PdfHandler, DjVuHandler, and ExifBitmapHandler.

Definition at line 203 of file ImageHandler.php.

◆ getLongDesc()

ImageHandler::getLongDesc ( $file )

Parameters

File $file

Returns: string

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, GIFHandler, and PNGHandler.

Definition at line 241 of file ImageHandler.php.

References $wgLang, and wfMessage().

◆ getParamMap()

ImageHandler::getParamMap ( )

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

Will be used by the parser to identify parameters.

Reimplemented from MediaHandler.

Reimplemented in PdfHandler, DjVuHandler, and SvgHandler.

Definition at line 38 of file ImageHandler.php.

◆ getScriptedTransform()

ImageHandler::getScriptedTransform	(	$image,
		$script,
		$params )

Parameters

File	$image
string	$script
array	$params

Returns: bool|MediaTransformOutput

Reimplemented from MediaHandler.

Definition at line 192 of file ImageHandler.php.

References $image, $params, getScriptParams(), normaliseParams(), and wfAppendQuery().

◆ getScriptParams()

ImageHandler::getScriptParams ( $params )

Reimplemented in PdfHandler, DjVuHandler, JpegHandler, and SvgHandler.

Definition at line 77 of file ImageHandler.php.

References $params.

Referenced by getScriptedTransform().

◆ getShortDesc()

ImageHandler::getShortDesc ( $file )

Parameters

File $file

Returns: string

Reimplemented from MediaHandler.

Definition at line 228 of file ImageHandler.php.

References $wgLang, and wfMessage().

◆ makeParamString()

ImageHandler::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 MediaHandler.

Reimplemented in PdfHandler, BitmapHandler, DjVuHandler, JpegHandler, and SvgHandler.

Definition at line 54 of file ImageHandler.php.

References $params.

◆ normaliseParams()

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

Parameters

File	$image
array	&$params

Returns: bool

Reimplemented from MediaHandler.

Reimplemented in BitmapHandler, BitmapHandler_ClientOnly, JpegHandler, SvgHandler, and TransformationalImageHandler.

Definition at line 86 of file ImageHandler.php.

References $image, $params, MediaHandler\fitBoxWidth(), File\scaleHeight(), and validateThumbParams().

Referenced by PdfHandler\doTransform(), DjVuHandler\doTransform(), MockDjVuHandler\doTransform(), getScriptedTransform(), and BitmapHandler_ClientOnly\normaliseParams().

◆ parseParamString()

ImageHandler::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 MediaHandler.

Reimplemented in PdfHandler, BitmapHandler, DjVuHandler, JpegHandler, and SvgHandler.

Definition at line 68 of file ImageHandler.php.

◆ sanitizeParamsForBucketing()

ImageHandler::sanitizeParamsForBucketing ( $params )

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

Parameters

array $params

Returns: array

Reimplemented from MediaHandler.

Reimplemented in JpegHandler.

Definition at line 273 of file ImageHandler.php.

References $params.

◆ validateParam()

ImageHandler::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 MediaHandler.

Reimplemented in PdfHandler, BitmapHandler, DjVuHandler, JpegHandler, and SvgHandler.

Definition at line 42 of file ImageHandler.php.

References $value.

◆ validateThumbParams()

ImageHandler::validateThumbParams	(	&	$width,
		&	$height,
			$srcWidth,
			$srcHeight,
			$mimeType )

Validate thumbnail parameters and fill in the correct height.

Parameters

int	&$width	Specified width (input/output)
int	&$height	Height (output only)
int	$srcWidth	Width of the source image
int	$srcHeight	Height of the source image
string	$mimeType	Unused

Returns: bool False to indicate that an error should be returned to the user.

Definition at line 162 of file ImageHandler.php.

References File\scaleHeight(), and wfDebug().

Referenced by normaliseParams().

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

includes/media/ImageHandler.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canRender()

◆ getDimensionsString()

◆ getImageArea()

◆ getImageSize()

◆ getLongDesc()

◆ getParamMap()

◆ getScriptedTransform()

◆ getScriptParams()

◆ getShortDesc()

◆ makeParamString()

◆ normaliseParams()

◆ parseParamString()

◆ sanitizeParamsForBucketing()

◆ validateParam()

◆ validateThumbParams()