MediaWiki master
|
Handler for PNG images. More...
Inherits BitmapHandler.
Public Member Functions | ||||||||||
canAnimateThumbnail ( $image) | ||||||||||
We do not support making APNG thumbnails, so always false. | ||||||||||
formatMetadata ( $image, $context=false) | ||||||||||
getCommonMetaArray (File $image) | ||||||||||
Get a file type independent array of metadata. | ||||||||||
getLength ( $file) | ||||||||||
Return the duration of an APNG file. | ||||||||||
getLongDesc ( $image) | ||||||||||
getMetadataType ( $image) | ||||||||||
Get a string describing the type of metadata, for display purposes. | ||||||||||
getSizeAndMetadata ( $state, $filename) | ||||||||||
isAnimatedImage ( $image) | ||||||||||
isFileMetadataValid ( $image) | ||||||||||
Check if the metadata is valid for this handler. | ||||||||||
supportsBucketing () | ||||||||||
Returns whether or not this handler supports the chained generation of thumbnails according to buckets. | ||||||||||
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.
| ||||||||||
normaliseParams ( $image, &$params) | ||||||||||
parseParamString ( $str) | ||||||||||
Parse a param string made with makeParamString back into an array.
| ||||||||||
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.
| ||||||||||
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.
| ||||||||||
getDimensionsString ( $file) | ||||||||||
Shown in file history box on image description page.
| ||||||||||
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. | ||||||||||
getParamMap () | ||||||||||
Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters.
| ||||||||||
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().
| ||||||||||
getShortDesc ( $file) | ||||||||||
Short description.Shown on Special:Search results.
| ||||||||||
sanitizeParamsForBucketing ( $params) | ||||||||||
Returns a normalised params array for which parameters have been cleaned up for bucketing purposes.
| ||||||||||
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. | ||||||||||
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. | |
hasGDSupport () | |
Whether the php-gd extension supports this type of file. | |
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. | |
Handler for PNG images.
Definition at line 32 of file PNGHandler.php.
PNGHandler::canAnimateThumbnail | ( | $image | ) |
We do not support making APNG thumbnails, so always false.
File | $image |
Reimplemented from MediaHandler.
Definition at line 108 of file PNGHandler.php.
PNGHandler::formatMetadata | ( | $image, | |
$context = false ) |
File | $image | |
IContextSource | false | $context |
Reimplemented from MediaHandler.
Definition at line 68 of file PNGHandler.php.
References MediaHandler\formatMetadataHelper(), and getCommonMetaArray().
PNGHandler::getCommonMetaArray | ( | File | $image | ) |
Get a file type independent array of metadata.
File | $image |
Reimplemented from MediaHandler.
Definition at line 83 of file PNGHandler.php.
References File\getMetadataArray().
Referenced by formatMetadata().
PNGHandler::getLength | ( | $file | ) |
Return the duration of an APNG file.
Shown in the &query=imageinfo&iiprop=size api query.
File | $file |
Reimplemented from MediaHandler.
Definition at line 182 of file PNGHandler.php.
PNGHandler::getLongDesc | ( | $image | ) |
File | $image |
Reimplemented from ImageHandler.
Definition at line 144 of file PNGHandler.php.
References $wgLang, and wfMessage().
PNGHandler::getMetadataType | ( | $image | ) |
Get a string describing the type of metadata, for display purposes.
File | $image |
Reimplemented from MediaHandler.
Definition at line 112 of file PNGHandler.php.
PNGHandler::getSizeAndMetadata | ( | $state, | |
$filename ) |
MediaHandlerState | $state | |
string | $filename |
Reimplemented from ImageHandler.
Definition at line 40 of file PNGHandler.php.
References BitmapMetadataHandler\PNG(), and wfDebug().
PNGHandler::isAnimatedImage | ( | $image | ) |
File | $image |
Reimplemented from MediaHandler.
Definition at line 98 of file PNGHandler.php.
PNGHandler::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).
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.
File | $image |
Reimplemented from MediaHandler.
Definition at line 116 of file PNGHandler.php.
References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, PNGMetadataExtractor\VERSION, and wfDebug().
PNGHandler::supportsBucketing | ( | ) |
Returns whether or not this handler supports the chained generation of thumbnails according to buckets.
Reimplemented from MediaHandler.
Definition at line 194 of file PNGHandler.php.