MediaWiki master
GIFHandler Class Reference

Handler for GIF images. More...

Inherits BitmapHandler.

Collaboration diagram for GIFHandler:

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)
 
 getMetadataType ( $image)
 Get a string describing the type of metadata, for display purposes.
 
 getSizeAndMetadata ( $state, $filename)
 Get image size information and metadata array.
 
 isAnimatedImage ( $image)
 
 isFileMetadataValid ( $image)
 Check if the metadata is valid for this handler.
 
- 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$paramsArray 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$strThe 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

 
 getImageSize ( $image, $path)
 Get an image size array like that returned by getimagesize(), or false if it can't be determined.
 
 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

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

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.
 
 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.
 
- 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 33 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 getImageArea().

◆ formatMetadata()

GIFHandler::formatMetadata (   $image,
  $context = false 
)
Parameters
File$image
IContextSource | false$context
Returns
array[]|false

Reimplemented from MediaHandler.

Definition at line 67 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

Reimplemented from MediaHandler.

Definition at line 81 of file GIFHandler.php.

References File\getMetadataArray().

Referenced by formatMetadata().

◆ getImageArea()

GIFHandler::getImageArea (   $image)
Todo:
Add unit tests
Parameters
File$image
Returns
int

Reimplemented from ImageHandler.

Definition at line 97 of file GIFHandler.php.

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

◆ getLongDesc()

GIFHandler::getLongDesc (   $image)
Parameters
File$image
Returns
string

Reimplemented from ImageHandler.

Definition at line 162 of file GIFHandler.php.

References $wgLang, and wfMessage().

◆ getMetadataType()

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

◆ getSizeAndMetadata()

GIFHandler::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$stateAn 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$pathThe 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 ImageHandler.

Definition at line 39 of file GIFHandler.php.

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

◆ isAnimatedImage()

GIFHandler::isAnimatedImage (   $image)
Parameters
File$image
Returns
bool

Reimplemented from MediaHandler.

Definition at line 109 of file GIFHandler.php.

◆ isFileMetadataValid()

GIFHandler::isFileMetadataValid (   $image)

Check if the metadata 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.

This was introduced in 1.37 to replace isMetadataValid(), which took a serialized string as a parameter. Handlers overriding this method are expected to use accessors to get the metadata out of the File. The reasons for the change were to get rid of serialization, and to allow handlers to partially load metadata with getMetadataItem(). For example a handler could just validate a version number.

Stability: stable
to override
Since
1.37
Parameters
File$image
Returns
bool|int

Reimplemented from MediaHandler.

Definition at line 134 of file GIFHandler.php.

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


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