MediaWiki  REL1_31
GIFHandler Class Reference

Handler for GIF images. More...

Inheritance diagram for GIFHandler:
Collaboration diagram for GIFHandler:

Public Member Functions

 canAnimateThumbnail ( $file)
 We cannot animate thumbnails that are bigger than a particular size. More...
 
 formatMetadata ( $image, $context=false)
 
 getCommonMetaArray (File $image)
 Return the standard metadata elements for #filemetadata parser func. More...
 
 getImageArea ( $image)
 
 getLength ( $file)
 Return the duration of the GIF file. More...
 
 getLongDesc ( $image)
 
 getMetadata ( $image, $filename)
 Get handler-specific metadata which will be saved in the img_metadata field. More...
 
 getMetadataType ( $image)
 Get a string describing the type of metadata, for display purposes. More...
 
 isAnimatedImage ( $image)
 
 isMetadataValid ( $image, $metadata)
 Check if the metadata string is valid for this handler. More...
 
- Public Member Functions inherited from BitmapHandler
 autoRotateEnabled ()
 
 canRotate ()
 Returns whether the current scaler supports rotation (im and gd do) More...
 
 makeParamString ( $params)
 Merge a parameter array into a string appropriate for inclusion in filenames. More...
 
 normaliseParams ( $image, &$params)
 
 parseParamString ( $str)
 Parse a param string made with makeParamString back into an array. More...
 
 rotate ( $file, $params)
 
 validateParam ( $name, $value)
 Validate a thumbnail parameter at parse time. More...
 
- Public Member Functions inherited from TransformationalImageHandler
 doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
 Create a thumbnail. More...
 
 escapeMagickInput ( $path, $scene=false)
 Escape a string for ImageMagick's input filenames. More...
 
 escapeMagickOutput ( $path, $scene=false)
 Escape a string for ImageMagick's output filename. More...
 
 escapeMagickProperty ( $s)
 Escape a string for ImageMagick's property input (e.g. More...
 
 extractPreRotationDimensions ( $params, $rotation)
 Extracts the width/height if the image will be scaled before rotating. More...
 
 getMediaTransformError ( $params, $errMsg)
 Get a MediaTransformError with error 'thumbnail_error'. More...
 
 isImageAreaOkForThumbnaling ( $file, &$params)
 Check if the file is smaller than the maximum image area for thumbnailing. More...
 
 mustRender ( $file)
 Returns whether the file needs to be rendered. More...
 
- Public Member Functions inherited from ImageHandler
 canRender ( $file)
 
 getDimensionsString ( $file)
 
 getImageSize ( $image, $path)
 Get an image size array like that returned by getimagesize(), or false if it can't be determined. More...
 
 getParamMap ()
 Get an associative array mapping magic word IDs to parameter names. More...
 
 getScriptedTransform ( $image, $script, $params)
 
 getScriptParams ( $params)
 
 getShortDesc ( $file)
 
 sanitizeParamsForBucketing ( $params)
 Returns a normalised params array for which parameters have been cleaned up for bucketing purposes. More...
 
 validateThumbParams (&$width, &$height, $srcWidth, $srcHeight, $mimeType)
 Validate thumbnail parameters and fill in the correct height. More...
 
- Public Member Functions inherited from MediaHandler
 convertMetadataVersion ( $metadata, $version=1)
 Convert metadata version. More...
 
 filterThumbnailPurgeList (&$files, $options)
 Remove files from the purge list. More...
 
 formatMetadataHelper ( $metadataArray, $context=false)
 sorts the visible/invisible field. More...
 
 getAvailableLanguages (File $file)
 Get list of languages file can be viewed in. More...
 
 getContentHeaders ( $metadata)
 Get useful response headers for GET/HEAD requests for a file with the given metadata. More...
 
 getDefaultRenderLanguage (File $file)
 On file types that support renderings in multiple languages, which language is used by default if unspecified. More...
 
 getEntireText (File $file)
 Get the text of the entire document. More...
 
 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. More...
 
 getPageText (File $image, $page)
 Generic getter for text layer. More...
 
 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. More...
 
 getStreamHeaders ( $metadata)
 
 getThumbType ( $ext, $mime, $params=null)
 Get the thumbnail extension and MIME type for a given source MIME type. More...
 
 getTransform ( $image, $dstPath, $dstUrl, $params)
 Get a MediaTransformOutput object representing the transformed output. More...
 
 getWarningConfig ( $file)
 Gets configuration for the file warning message. More...
 
 isEnabled ()
 False if the handler is disabled for all files. More...
 
 isExpensiveToThumbnail ( $file)
 True if creating thumbnails from the file is large or otherwise resource-intensive. More...
 
 isMultiPage ( $file)
 True if the type has multi-page capabilities. More...
 
 isVectorized ( $file)
 The material is vectorized and thus scaling is lossless. More...
 
 pageCount (File $file)
 Page count for a multi-page document, false if unsupported or unknown. More...
 
 parserTransformHook ( $parser, $file)
 Modify the parser object post-transform. More...
 
 removeBadFile ( $dstPath, $retval=0)
 Check for zero-sized thumbnails. More...
 
 supportsBucketing ()
 Returns whether or not this handler supports the chained generation of thumbnails according to buckets. More...
 
 verifyUpload ( $fileName)
 File validation hook called on upload. More...
 

Public Attributes

const BROKEN_FILE = '0'
 
- Public Attributes inherited from MediaHandler
const MAX_ERR_LOG_SIZE = 65535
 Max length of error logged by logErrorForExternalProcess() More...
 
const METADATA_BAD = false
 
const METADATA_COMPATIBLE = 2
 
const METADATA_GOOD = true
 
const TRANSFORM_LATER = 1
 

Additional Inherited Members

- Static Public Member Functions inherited from BitmapHandler
static imageJpegWrapper ( $dst_image, $thumbPath, $quality=95)
 Callback for transformGd when transforming jpeg images. More...
 
- 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. More...
 
static getGeneralLongDesc ( $file)
 Used instead of getLongDesc if there is no handler registered for file. More...
 
static getGeneralShortDesc ( $file)
 Used instead of getShortDesc if there is no handler registered for file. More...
 
static getHandler ( $type)
 Get a MediaHandler for a given MIME type from the instance cache. More...
 
static getMetadataVersion ()
 Get metadata version. More...
 
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. More...
 
- Protected Member Functions inherited from BitmapHandler
 getScalerType ( $dstPath, $checkDstPath=true)
 Returns which scaler type should be used. More...
 
 imageMagickSubsampling ( $pixelFormat)
 Get ImageMagick subsampling factors for the target JPEG pixel format. More...
 
 transformCustom ( $image, $params)
 Transform an image using a custom command. More...
 
 transformGd ( $image, $params)
 Transform an image using the built in GD library. More...
 
 transformImageMagick ( $image, $params)
 Transform an image using ImageMagick. More...
 
 transformImageMagickExt ( $image, $params)
 Transform an image using the Imagick PHP extension. More...
 
- Protected Member Functions inherited from TransformationalImageHandler
 escapeMagickPath ( $path, $scene=false)
 Armour a string against ImageMagick's GetPathComponent(). More...
 
 getClientScalingThumbnailImage ( $image, $scalerParams)
 Get a ThumbnailImage that respresents an image that will be scaled client side. More...
 
 getMagickVersion ()
 Retrieve the version of the installed ImageMagick You can use PHPs version_compare() to use this value Value is cached for one hour. More...
 
 getThumbnailSource ( $file, $params)
 Get the source file for the transform. More...
 
- Protected Member Functions inherited from MediaHandler
 logErrorForExternalProcess ( $retval, $err, $cmd)
 Log an error that occurred in an external process. More...
 
 visibleMetadataFields ()
 Get a list of metadata items which should be displayed when the metadata table is collapsed. More...
 
- 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. More...
 

Detailed Description

Handler for GIF images.

Definition at line 29 of file GIF.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 117 of file GIF.php.

References $wgMaxAnimatedGifArea, getImageArea(), and global.

◆ formatMetadata()

GIFHandler::formatMetadata (   $image,
  $context = false 
)
Parameters
File$image
bool | IContextSource$contextContext to use (optional)
Returns
array|bool

Reimplemented from MediaHandler.

Definition at line 50 of file GIF.php.

References $context, $image, 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 64 of file GIF.php.

References $image, and unserialize().

Referenced by formatMetadata().

◆ getImageArea()

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

Reimplemented from ImageHandler.

Definition at line 85 of file GIF.php.

References $image, and 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 199 of file GIF.php.

References unserialize().

◆ getLongDesc()

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

Reimplemented from ImageHandler.

Definition at line 159 of file GIF.php.

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

◆ getMetadata()

GIFHandler::getMetadata (   $image,
  $path 
)

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

Parameters
File | FSFile$imageThe image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an FSFile instead of File (!)
string$pathThe filename
Returns
string A string of metadata in php serialized form (Run through serialize())

Reimplemented from MediaHandler.

Definition at line 32 of file GIF.php.

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

◆ getMetadataType()

GIFHandler::getMetadataType (   $image)

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

Note
This method is currently unused.
Parameters
File$image
Returns
string

Reimplemented from MediaHandler.

Definition at line 124 of file GIF.php.

◆ isAnimatedImage()

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

Reimplemented from MediaHandler.

Definition at line 100 of file GIF.php.

References $image, and 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.
Parameters
File$image
string$metadataThe metadata in serialized form
Returns
bool

Reimplemented from MediaHandler.

Definition at line 128 of file GIF.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'

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