MediaWiki  1.23.2
PNGHandler Class Reference

Handler for PNG images. More...

Inheritance diagram for PNGHandler:
Collaboration diagram for PNGHandler:

Public Member Functions

 canAnimateThumbnail ( $image)
 We do not support making APNG thumbnails, so always false. More...
 
 formatMetadata ( $image)
 
 getCommonMetaArray (File $image)
 Get a file type independent array of metadata. More...
 
 getLongDesc ( $image)
 
 getMetadata ( $image, $filename)
 
 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
 doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
 
 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...
 
 mustRender ( $file)
 Rerurns whether the file needs to be rendered. More...
 
 normaliseParams ( $image, &$params)
 
 rotate ( $file, $params)
 
- Public Member Functions inherited from ImageHandler
 canRender ( $file)
 
 getDimensionsString ( $file)
 
 getImageArea ( $image)
 Function that returns the number of pixels to be thumbnailed. More...
 
 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)
 
 makeParamString ( $params)
 Merge a parameter array into a string appropriate for inclusion in filenames. More...
 
 parseParamString ( $str)
 Parse a param string made with makeParamString back into an array. More...
 
 validateParam ( $name, $value)
 Validate a thumbnail parameter at parse time. 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)
 sorts the visible/invisible field. More...
 
 getAvailableLanguages (File $file)
 Get list of languages file can be viewed in. 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...
 
 getLength ( $file)
 If its an audio file, return the length of the file. More...
 
 getPageDimensions ( $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 ( $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)
 Get useful response headers for GET/HEAD requests for a file with the given metadata. More...
 
 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...
 
 isEnabled ()
 False if the handler is disabled for all files. 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)
 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...
 
 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 autoRotateEnabled ()
 
static canRotate ()
 Returns whether the current scaler supports rotation (im and gd do) More...
 
static imageJpegWrapper ( $dst_image, $thumbPath)
 
- 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 getShortDesc if there is no handler registered for file. More...
 
static getGeneralShortDesc ( $file)
 Long description. More...
 
static getHandler ( $type)
 Get a MediaHandler for a given MIME type from the instance cache. More...
 
static getMetadataVersion ()
 Get metadata version. More...
 
- Protected Member Functions inherited from BitmapHandler
 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...
 
 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 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 BitmapHandler
static getScalerType ( $dstPath, $checkDstPath=true)
 Returns which scaler type should be used. 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...
 
- Static Protected Attributes inherited from MediaHandler
static $handlers = array()
 

Detailed Description

Handler for PNG images.

Definition at line 29 of file PNG.php.

Member Function Documentation

◆ canAnimateThumbnail()

PNGHandler::canAnimateThumbnail (   $image)

We do not support making APNG thumbnails, so always false.

Parameters
File$image
Returns
bool false

Reimplemented from MediaHandler.

Definition at line 105 of file PNG.php.

◆ formatMetadata()

PNGHandler::formatMetadata (   $image)
Parameters
File$image
Returns
array|bool

Reimplemented from MediaHandler.

Definition at line 54 of file PNG.php.

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

◆ getCommonMetaArray()

PNGHandler::getCommonMetaArray ( File  $image)

Get a file type independent array of metadata.

Parameters
File$image
Returns
array The metadata array

Reimplemented from MediaHandler.

Definition at line 69 of file PNG.php.

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

Referenced by formatMetadata().

◆ getLongDesc()

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

Reimplemented from ImageHandler.

Definition at line 145 of file PNG.php.

References $wgLang, array(), global, wfMessage(), wfRestoreWarnings(), and wfSuppressWarnings().

◆ getMetadata()

PNGHandler::getMetadata (   $image,
  $filename 
)
Parameters
File$image
string$filename
Returns
string

Reimplemented from MediaHandler.

Definition at line 37 of file PNG.php.

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

◆ getMetadataType()

PNGHandler::getMetadataType (   $image)

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

Parameters
File$image
Returns
string

Reimplemented from MediaHandler.

Definition at line 109 of file PNG.php.

◆ isAnimatedImage()

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

Reimplemented from MediaHandler.

Definition at line 88 of file PNG.php.

◆ isMetadataValid()

PNGHandler::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 113 of file PNG.php.

References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, PNGMetadataExtractor\VERSION, wfDebug(), wfRestoreWarnings(), and wfSuppressWarnings().

Member Data Documentation

◆ BROKEN_FILE

const PNGHandler::BROKEN_FILE = '0'

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