Handler for GIF images. More...

Inheritance diagram for GIFHandler:

[legend]

Collaboration diagram for GIFHandler:

[legend]

Public Member Functions

canAnimateThumbnail ( $file)

We cannot animate thumbnails that are bigger than a particular size.

formatMetadata ( $image, $context=false)

getCommonMetaArray (File $image)

Return the standard metadata elements for #filemetadata parser func.

getImageArea ( $image)

getLength ( $file)

Return the duration of the GIF file.

getLongDesc ( $image)

getMetadata ( $image, $filename)

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.

isAnimatedImage ( $image)

isMetadataValid ( $image, $metadata)

Check if the metadata string is valid for this handler.

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.

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

Parameters

File $file

Returns: bool

Stable to override

getDimensionsString ( $file)

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

Parameters

File $file

Returns: string Dimensions

Stable to override

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

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

convertMetadataVersion ( $metadata, $version=1)

Convert metadata version.

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.

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.

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.

isEnabled ()

False if the handler is disabled for all files Stable to override.

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.

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	BROKEN_FILE = '0'
	Value to store in img_metadata if there was error extracting metadata.

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 MediaHandler
const	METADATA_BAD = false

const	METADATA_COMPATIBLE = 2

const	METADATA_GOOD = true

const	TRANSFORM_LATER = 1

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

Definition at line 29 of file GIFHandler.php.

Member Function Documentation

◆ canAnimateThumbnail()

GIFHandler::canAnimateThumbnail ( $file )

We cannot animate thumbnails that are bigger than a particular size.

Parameters

File $file

Returns: bool

Reimplemented from MediaHandler.

Definition at line 123 of file GIFHandler.php.

References $file, $wgMaxAnimatedGifArea, and getImageArea().

◆ formatMetadata()

GIFHandler::formatMetadata	(	$image,
		$context = `false`
	)

Parameters

File	$image
bool \| IContextSource	$context	Context to use (optional)

Returns: array|bool

Reimplemented from MediaHandler.

Definition at line 53 of file GIFHandler.php.

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

◆ getCommonMetaArray()

GIFHandler::getCommonMetaArray ( File $image )

Return the standard metadata elements for #filemetadata parser func.

Parameters

File $image

Returns: array|bool

Reimplemented from MediaHandler.

Definition at line 67 of file GIFHandler.php.

References File\getMetadata(), and unserialize().

Referenced by formatMetadata().

◆ getImageArea()

GIFHandler::getImageArea ( $image )

Todo:: Add unit tests

Parameters

File $image

Returns: bool

Reimplemented from ImageHandler.

Definition at line 88 of file GIFHandler.php.

References unserialize().

Referenced by canAnimateThumbnail().

◆ getLength()

GIFHandler::getLength ( $file )

Return the duration of the GIF file.

Shown in the &query=imageinfo&iiprop=size api query.

Parameters

File $file

Returns: float The duration of the file.

Reimplemented from MediaHandler.

Definition at line 204 of file GIFHandler.php.

References $file, and unserialize().

◆ getLongDesc()

GIFHandler::getLongDesc ( $image )

Parameters

File $image

Returns: string

Reimplemented from ImageHandler.

Definition at line 164 of file GIFHandler.php.

References $wgLang, unserialize(), and wfMessage().

◆ getMetadata()

GIFHandler::getMetadata	(	$image,
		$path
	)

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

Stable to override

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 35 of file GIFHandler.php.

References BROKEN_FILE, BitmapMetadataHandler\GIF(), serialize(), and wfDebug().

◆ getMetadataType()

GIFHandler::getMetadataType ( $image )

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

Stable to override

Note: This method is currently unused.

Parameters

File $image

Returns: string

Reimplemented from MediaHandler.

Definition at line 129 of file GIFHandler.php.

◆ isAnimatedImage()

GIFHandler::isAnimatedImage ( $image )

Parameters

File $image

Returns: bool

Reimplemented from MediaHandler.

Definition at line 106 of file GIFHandler.php.

References unserialize().

◆ isMetadataValid()

GIFHandler::isMetadataValid	(	$image,
		$metadata
	)

Check if the metadata string is valid for this handler.

If it returns MediaHandler::METADATA_BAD (or false), Image will reload the metadata from the file and update the database. MediaHandler::METADATA_GOOD for if the metadata is a-ok, MediaHandler::METADATA_COMPATIBLE if metadata is old but backwards compatible (which may or may not trigger a metadata reload).

Note: Returning self::METADATA_BAD will trigger a metadata reload from file on page view. Always returning this from a broken file, or suddenly triggering as bad metadata for a large number of files can cause performance problems.

Stable to override

Parameters

File	$image
string	$metadata	The metadata in serialized form

Returns: bool|int

Reimplemented from MediaHandler.

Definition at line 133 of file GIFHandler.php.

References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, unserialize(), GIFMetadataExtractor\VERSION, and wfDebug().

Member Data Documentation

◆ BROKEN_FILE

const GIFHandler::BROKEN_FILE = '0'

private

Value to store in img_metadata if there was error extracting metadata.

Definition at line 33 of file GIFHandler.php.

Referenced by getMetadata().

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

includes/media/GIFHandler.php

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canAnimateThumbnail()

◆ formatMetadata()

◆ getCommonMetaArray()

◆ getImageArea()

◆ getLength()

◆ getLongDesc()

◆ getMetadata()

◆ getMetadataType()

◆ isAnimatedImage()

◆ isMetadataValid()

Member Data Documentation

◆ BROKEN_FILE