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

Inherits MediaWiki\Media\MediaHandler.

Inherited by MediaWiki\Media\DjVuHandler, MediaWiki\Media\SvgHandler, and MediaWiki\Media\TransformationalImageHandler.

Collaboration diagram for MediaWiki\Media\ImageHandler:

[legend]

Public Member Functions

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 (plain text)

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

Deprecated: since 1.37, override getSizeAndMetadata instead

Parameters

File \| FSFile \| false	$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|false Follow the format of PHP getimagesize() internal function. See https://www.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.

getLongDesc ( $file)

Long description.Shown under image on image description page surrounded by ().Until MediaWiki 1.45, the return value was poorly documented, and some subclasses returned HTML while others returned plain text. When overriding this method, you should return safe HTML, e.g. using Message::escaped(). When calling this method, you should treat it as returning unsafe HTML, and call Sanitizer::removeSomeTags() on the result.

Stability: stable: to override

Parameters

File $file

Returns: string HTML (possibly unsafe, call Sanitizer::removeSomeTags() on the result)

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.Until MediaWiki 1.45, the return value was poorly documented, and some subclasses returned HTML while others returned plain text. When overriding this method, you should return safe HTML, e.g. using Message::escaped(). When calling this method, you should treat it as returning unsafe HTML, and call Sanitizer::removeSomeTags() on the result.

Stability: stable: to override

Parameters

File $file

Returns: string HTML (possibly unsafe, call Sanitizer::removeSomeTags() on the result)

getSizeAndMetadata ( $state, $path)

Get image size information and metadata array.If this returns null, the caller will fall back to getImageSize() and getMetadata().If getImageSize() or getMetadata() are implemented in the most derived class, they will be used instead of this function. To override this behaviour, override useLegacyMetadata().

Stability: stable: to override

Since: 1.37

Parameters

MediaHandlerState	$state	An object for saving process-local state. This is normally a File object which will be passed back to other MediaHandler methods like pageCount(), if they are called in the same request. The handler can use this object to save its state.
string	$path	The filename

Returns

array|null Null to fall back to getImageSize(), or an array with the following keys. All keys are optional.

width: The width. If multipage, return the first page width. (optional)
height: The height. If multipage, return the first page height. (optional)
bits: The number of bits for each color (optional)
metadata: A JSON-serializable array of metadata (optional)

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

normaliseParams ( $image, &$params)

Changes the parameter array as necessary, ready for transformation.Should be idempotent. Returns false if the parameters are unacceptable and the transform should fail

Parameters

File	$image
array	&$params

Returns: bool

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.

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

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

Public Member Functions inherited from MediaWiki\Media\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:

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

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.

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.

isFileMetadataValid ( $image)

Check if the metadata is valid for this handler.

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.

useSplitMetadata ()

If this returns true, LocalFile may split metadata up and store its constituent items separately.

verifyUpload ( $fileName)

File validation hook called on upload.

Protected Member Functions
	getScriptParams ( $params)

Protected Member Functions inherited from MediaWiki\Media\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 MediaWiki\Media\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 MediaWiki\Media\MediaHandler
const	METADATA_BAD = false

const	METADATA_COMPATIBLE = 2

const	METADATA_GOOD = true

const	TRANSFORM_LATER = 1

Static Protected Member Functions inherited from MediaWiki\Media\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.

Stability: stable: to extend

Definition at line 21 of file ImageHandler.php.

Member Function Documentation

◆ canRender()

MediaWiki\Media\ImageHandler::canRender ( $file )

True if the handled types can be transformed.

Stability: stable: to override

Parameters

File $file

Returns: bool

Stability: stable: to override

Parameters

File $file

Returns: bool

Reimplemented from MediaWiki\Media\MediaHandler.

Reimplemented in MediaWiki\Media\TiffHandler, MediaWiki\Media\WebPHandler, and MediaWiki\Media\XCFHandler.

Definition at line 28 of file ImageHandler.php.

◆ getDimensionsString()

MediaWiki\Media\ImageHandler::getDimensionsString ( $file )

Shown in file history box on image description page.

Stability: stable: to override

Parameters

File $file

Returns: string Dimensions (plain text)

Stability: stable: to override

Parameters

File $file

Returns: string

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 298 of file ImageHandler.php.

References wfMessage().

◆ getImageArea()

MediaWiki\Media\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.

Stability: stable: to override

Parameters

File $image

Returns: int

Reimplemented in MediaWiki\Media\GIFHandler.

Definition at line 247 of file ImageHandler.php.

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

◆ getImageSize()

MediaWiki\Media\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.

Deprecated: since 1.37, override getSizeAndMetadata instead

Parameters

File \| FSFile \| false	$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|false Follow the format of PHP getimagesize() internal function. See https://www.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 MediaWiki\Media\MediaHandler.

Definition at line 214 of file ImageHandler.php.

References $path.

◆ getLongDesc()

MediaWiki\Media\ImageHandler::getLongDesc ( $file )

Long description.Shown under image on image description page surrounded by ().Until MediaWiki 1.45, the return value was poorly documented, and some subclasses returned HTML while others returned plain text. When overriding this method, you should return safe HTML, e.g. using Message::escaped(). When calling this method, you should treat it as returning unsafe HTML, and call Sanitizer::removeSomeTags() on the result.

Stability: stable: to override

Parameters

File $file

Returns: string HTML (possibly unsafe, call Sanitizer::removeSomeTags() on the result)

Stability: stable: to override

Parameters

File $file

Returns: string

Reimplemented from MediaWiki\Media\MediaHandler.

Reimplemented in MediaWiki\Media\SvgHandler, MediaWiki\Media\GIFHandler, and MediaWiki\Media\PNGHandler.

Definition at line 273 of file ImageHandler.php.

References wfMessage().

◆ getParamMap()

MediaWiki\Media\ImageHandler::getParamMap ( )

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

Returns: string[]

Stability: stable: to override

Returns: string[]

Reimplemented from MediaWiki\Media\MediaHandler.

Reimplemented in MediaWiki\Media\DjVuHandler, and MediaWiki\Media\SvgHandler.

Definition at line 37 of file ImageHandler.php.

◆ getScriptedTransform()

MediaWiki\Media\ImageHandler::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

Stability: stable: to override

Parameters

File	$image
string	$script
array	$params

Returns: MediaTransformOutput|false

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 202 of file ImageHandler.php.

References $url, MediaWiki\Media\ImageHandler\getScriptParams(), MediaWiki\Media\ImageHandler\normaliseParams(), and wfAppendQuery().

◆ getScriptParams()

MediaWiki\Media\ImageHandler::getScriptParams ( $params )

protected

Stability: stable: to override

Parameters

array $params

Returns: array

Reimplemented in MediaWiki\Media\DjVuHandler, MediaWiki\Media\JpegHandler, and MediaWiki\Media\SvgHandler.

Definition at line 85 of file ImageHandler.php.

Referenced by MediaWiki\Media\ImageHandler\getScriptedTransform().

◆ getShortDesc()

MediaWiki\Media\ImageHandler::getShortDesc ( $file )

Short description.Shown on Special:Search results.Until MediaWiki 1.45, the return value was poorly documented, and some subclasses returned HTML while others returned plain text. When overriding this method, you should return safe HTML, e.g. using Message::escaped(). When calling this method, you should treat it as returning unsafe HTML, and call Sanitizer::removeSomeTags() on the result.

Stability: stable: to override

Parameters

File $file

Returns: string HTML (possibly unsafe, call Sanitizer::removeSomeTags() on the result)

Stability: stable: to override

Parameters

File $file

Returns: string

Reimplemented from MediaWiki\Media\MediaHandler.

Definition at line 257 of file ImageHandler.php.

References $wgLang, and wfMessage().

◆ getSizeAndMetadata()

MediaWiki\Media\ImageHandler::getSizeAndMetadata	(		$state,
			$path )

Get image size information and metadata array.If this returns null, the caller will fall back to getImageSize() and getMetadata().If getImageSize() or getMetadata() are implemented in the most derived class, they will be used instead of this function. To override this behaviour, override useLegacyMetadata().

Stability: stable: to override

Since: 1.37

Parameters

MediaHandlerState	$state	An object for saving process-local state. This is normally a File object which will be passed back to other MediaHandler methods like pageCount(), if they are called in the same request. The handler can use this object to save its state.
string	$path	The filename

Returns

array|null Null to fall back to getImageSize(), or an array with the following keys. All keys are optional.

width: The width. If multipage, return the first page width. (optional)
height: The height. If multipage, return the first page height. (optional)
bits: The number of bits for each color (optional)
metadata: A JSON-serializable array of metadata (optional)

Reimplemented from MediaWiki\Media\MediaHandler.

Reimplemented in MediaWiki\Media\BmpHandler, MediaWiki\Media\GIFHandler, MediaWiki\Media\JpegHandler, MediaWiki\Media\PNGHandler, MediaWiki\Media\SvgHandler, MediaWiki\Media\TiffHandler, MediaWiki\Media\WebPHandler, MediaWiki\Media\XCFHandler, and MediaWiki\Media\DjVuHandler.

Definition at line 220 of file ImageHandler.php.

References $path.

◆ makeParamString()

MediaWiki\Media\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

Stability: stable: to override

Exceptions

MediaTransformInvalidParametersException

Reimplemented from MediaWiki\Media\MediaHandler.

Reimplemented in MediaWiki\Media\BitmapHandler, MediaWiki\Media\DjVuHandler, MediaWiki\Media\JpegHandler, and MediaWiki\Media\SvgHandler.

Definition at line 54 of file ImageHandler.php.

◆ normaliseParams()

MediaWiki\Media\ImageHandler::normaliseParams	(		$image,
		&	$params )

Changes the parameter array as necessary, ready for transformation.Should be idempotent. Returns false if the parameters are unacceptable and the transform should fail

Parameters

File	$image
array	&$params

Returns: bool

Stability: stable: to override

Parameters

File	$image
array	&$params

Returns: bool

Reimplemented from MediaWiki\Media\MediaHandler.

Reimplemented in MediaWiki\Media\BitmapHandler, MediaWiki\Media\BitmapHandler_ClientOnly, MediaWiki\Media\JpegHandler, MediaWiki\Media\SvgHandler, and MediaWiki\Media\TransformationalImageHandler.

Definition at line 97 of file ImageHandler.php.

References MediaWiki\Media\MediaHandler\fitBoxWidth().

Referenced by MediaWiki\Media\DjVuHandler\doTransform(), MediaWiki\Media\ImageHandler\getScriptedTransform(), and MediaWiki\Media\BitmapHandler_ClientOnly\normaliseParams().

◆ parseParamString()

MediaWiki\Media\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|false Array of parameters or false on failure.

Stability: stable: to override

Reimplemented from MediaWiki\Media\MediaHandler.

Reimplemented in MediaWiki\Media\BitmapHandler, MediaWiki\Media\DjVuHandler, MediaWiki\Media\JpegHandler, and MediaWiki\Media\SvgHandler.

Definition at line 72 of file ImageHandler.php.

◆ sanitizeParamsForBucketing()

MediaWiki\Media\ImageHandler::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

Stability: stable: to override

Reimplemented from MediaWiki\Media\MediaHandler.

Reimplemented in MediaWiki\Media\JpegHandler.

Definition at line 312 of file ImageHandler.php.

◆ validateParam()

MediaWiki\Media\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

Returns: bool

Stability: stable: to override

Reimplemented from MediaWiki\Media\MediaHandler.

Reimplemented in MediaWiki\Media\BitmapHandler, MediaWiki\Media\DjVuHandler, MediaWiki\Media\JpegHandler, and MediaWiki\Media\SvgHandler.

Definition at line 45 of file ImageHandler.php.

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

includes/Media/ImageHandler.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canRender()

◆ getDimensionsString()

◆ getImageArea()

◆ getImageSize()

◆ getLongDesc()

◆ getParamMap()

◆ getScriptedTransform()

◆ getScriptParams()

◆ getShortDesc()

◆ getSizeAndMetadata()

◆ makeParamString()

◆ normaliseParams()

◆ parseParamString()

◆ sanitizeParamsForBucketing()

◆ validateParam()