Handler for GIF images. More...
Public Member Functions | |
| canAnimateThumbnail ($file) | |
| We cannot animate thumbnails that are bigger than a particular size. | |
| formatMetadata ($image) | |
| getCommonMetaArray (File $image) | |
| Return the standard metadata elements for #filemetadata parser func. | |
| getImageArea ($image) | |
| 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 Attributes | |
| const | BROKEN_FILE = '0' |
Detailed Description
Member Function Documentation
| 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 116 of file GIF.php.
References $file, getImageArea(), and global.
| GIFHandler::formatMetadata | ( | $ | image | ) |
- Parameters:
-
File $image
- Returns:
- array|bool
Reimplemented from MediaHandler.
Definition at line 49 of file GIF.php.
References MediaHandler\formatMetadataHelper(), and 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 63 of file GIF.php.
References array(), and File\getMetadata().
Referenced by formatMetadata().
| GIFHandler::getImageArea | ( | $ | image | ) |
- Todo:
- Add unit tests
- Parameters:
-
File $image
- Returns:
- bool
Reimplemented from ImageHandler.
Definition at line 84 of file GIF.php.
Referenced by canAnimateThumbnail().
| GIFHandler::getLongDesc | ( | $ | image | ) |
- Parameters:
-
File $image
- Returns:
- string
Reimplemented from ImageHandler.
Definition at line 158 of file GIF.php.
References $wgLang, array(), global, wfMessage(), wfRestoreWarnings(), and wfSuppressWarnings().
| GIFHandler::getMetadata | ( | $ | image, |
| $ | path | ||
| ) |
Get handler-specific metadata which will be saved in the img_metadata field.
- Parameters:
-
File $image The image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an (object)array() instead (!) string $path The filename
- Returns:
- string
Reimplemented from MediaHandler.
Definition at line 32 of file GIF.php.
References $e, BROKEN_FILE, BitmapMetadataHandler\GIF(), and wfDebug().
| GIFHandler::getMetadataType | ( | $ | image | ) |
Get a string describing the type of metadata, for display purposes.
- Parameters:
-
File $image
- Returns:
- string
Reimplemented from MediaHandler.
| GIFHandler::isAnimatedImage | ( | $ | image | ) |
| 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, MediaHanlder::METADATA_COMPATIBLE if metadata is old but backwards compatible (which may or may not trigger a metadata reload).
- Parameters:
-
File $image array $metadata
- Returns:
- bool
Reimplemented from MediaHandler.
Definition at line 127 of file GIF.php.
References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, GIFMetadataExtractor\VERSION, wfDebug(), wfRestoreWarnings(), and wfSuppressWarnings().
Member Data Documentation
| const GIFHandler::BROKEN_FILE = '0' |
Definition at line 30 of file GIF.php.
Referenced by getMetadata(), and GIFHandlerTest\testInvalidFile().
The documentation for this class was generated from the following file:
- includes/media/GIF.php
