MediaWiki  master
XCFHandler Class Reference

Handler for the Gimp's native file format; getimagesize() doesn't support these files. More...

Inheritance diagram for XCFHandler:
Collaboration diagram for XCFHandler:

Public Member Functions

 canRender ( $file)
 Can we render this file? More...
 
 getSizeAndMetadata ( $state, $filename)
 Get image size information and metadata array. More...
 
 getThumbType ( $ext, $mime, $params=null)
 Render files as PNG. More...
 
 isFileMetadataValid ( $file)
 Should we refresh the metadata. More...
 
 mustRender ( $file)
 
- 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.
Parameters
array$paramsArray of parameters that have been through normaliseParams.
Returns
string
Stability: stable
to override
More...
 
 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|bool Array of parameters or false on failure.
Stability: stable
to override
More...
 
 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
Stability: stable
to override
More...
 
- Public Member Functions inherited from TransformationalImageHandler
 doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
 Create a thumbnail. 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...
 
- Public Member Functions inherited from ImageHandler
 getDimensionsString ( $file)
 Shown in file history box on image description page.
Stability: stable
to override
Parameters
File$file
Returns
string Dimensions
More...
 
 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...
 
 getLongDesc ( $file)
 Long description.Shown under image on image description page surounded by ().
Stability: stable
to override
Parameters
File$file
Returns
string
More...
 
 getParamMap ()
 Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters. More...
 
 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
bool|ThumbnailImage
More...
 
 getShortDesc ( $file)
 Short description.Shown on Special:Search results.
Stability: stable
to override
Parameters
File$file
Returns
string
More...
 
 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
More...
 
- Public Member Functions inherited from MediaHandler
 canAnimateThumbnail ( $file)
 If the material is animated, we can animate the thumbnail. More...
 
 convertMetadataVersion ( $metadata, $version=1)
 Convert metadata version. More...
 
 filterThumbnailPurgeList (&$files, $options)
 Remove files from the purge list. More...
 
 formatMetadata ( $image, $context=false)
 Get an array structure that looks like this: More...
 
 getAvailableLanguages (File $file)
 Get list of languages file can be viewed in. More...
 
 getCommonMetaArray (File $file)
 Get an array of standard (FormatMetadata type) metadata values. 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...
 
 getLength ( $file)
 If its an audio file, return the length of the file. More...
 
 getMatchedLanguage ( $userPreferredLanguage, array $availableLanguages)
 When overridden in a descendant class, returns a language code most suiting. More...
 
 getMetadata ( $image, $path)
 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...
 
 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...
 
 getSizeAndMetadataWithFallback ( $file, $path)
 Get the metadata array and the image size, with b/c fallback. 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...
 
 isAnimatedImage ( $file)
 The material is an image, and is animated. 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...
 
 isMetadataValid ( $image, $metadata)
 Check if the metadata string is valid for this handler. 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...
 

Protected Member Functions

 getScalerType ( $dstPath, $checkDstPath=true)
 Must use "im" for XCF. More...
 
- Protected Member Functions inherited from BitmapHandler
 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
 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...
 
 escapeMagickPath ( $path, $scene=false)
 Armour a string against ImageMagick's GetPathComponent(). More...
 
 escapeMagickProperty ( $s)
 Escape a string for ImageMagick's property input (e.g. 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 ImageHandler
 getScriptParams ( $params)
 
- Protected Member Functions inherited from MediaHandler
 formatMetadataHelper ( $metadataArray, $context=false)
 sorts the visible/invisible field. More...
 
 formatTag (string $key, $vals, $context=false)
 Override default formatting for the given metadata field. More...
 
 hasMostDerivedMethod ( $name)
 Check whether a method is implemented in the most derived class. More...
 
 logErrorForExternalProcess ( $retval, $err, $cmd)
 Log an error that occurred in an external process. More...
 
 useLegacyMetadata ()
 If this returns true, the new method getSizeAndMetadata() will not be called. More...
 
 visibleMetadataFields ()
 Get a list of metadata items which should be displayed when the metadata table is collapsed. More...
 

Static Private Member Functions

static getXCFMetaData ( $filename)
 Metadata for a given XCF file. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from BitmapHandler
static imageJpegWrapper ( $dst_image, $thumbPath, $quality=null)
 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...
 
- Public Attributes inherited from MediaHandler
const METADATA_BAD = false
 
const METADATA_COMPATIBLE = 2
 
const METADATA_GOOD = true
 
const TRANSFORM_LATER = 1
 
- 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 the Gimp's native file format; getimagesize() doesn't support these files.

Definition at line 35 of file XCFHandler.php.

Member Function Documentation

◆ canRender()

XCFHandler::canRender (   $file)

Can we render this file?

Image magick doesn't support indexed xcf files as of current writing (as of 6.8.9-3)

Parameters
File$file
Returns
bool

Reimplemented from ImageHandler.

Definition at line 187 of file XCFHandler.php.

References $file.

◆ getScalerType()

XCFHandler::getScalerType (   $dstPath,
  $checkDstPath = true 
)
protected

Must use "im" for XCF.

Parameters
string$dstPath
bool$checkDstPath
Returns
string

Reimplemented from BitmapHandler.

Definition at line 175 of file XCFHandler.php.

◆ getSizeAndMetadata()

XCFHandler::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 121 of file XCFHandler.php.

References $header, and getXCFMetaData().

◆ getThumbType()

XCFHandler::getThumbType (   $ext,
  $mime,
  $params = null 
)

Render files as PNG.

Parameters
string$ext
string$mime
array | null$params
Returns
array

Reimplemented from MediaHandler.

Definition at line 52 of file XCFHandler.php.

◆ getXCFMetaData()

static XCFHandler::getXCFMetaData (   $filename)
staticprivate

Metadata for a given XCF file.

Will return false if file magic signature is not recognized

Author
Hexmode
Hashar
Parameters
string$filenameFull path to a XCF file
Returns
array|null Metadata Array just like PHP getimagesize()

Definition at line 66 of file XCFHandler.php.

References $header, wfDebug(), and wfUnpack().

Referenced by getSizeAndMetadata().

◆ isFileMetadataValid()

XCFHandler::isFileMetadataValid (   $file)

Should we refresh the metadata.

Parameters
File$fileThe file object for the file in question
Returns
bool|int One of the self::METADATA_(BAD|GOOD|COMPATIBLE) constants

Reimplemented from MediaHandler.

Definition at line 159 of file XCFHandler.php.

References $file, MediaHandler\METADATA_BAD, and MediaHandler\METADATA_GOOD.

◆ mustRender()

XCFHandler::mustRender (   $file)
Parameters
File$file
Returns
bool

Reimplemented from TransformationalImageHandler.

Definition at line 40 of file XCFHandler.php.


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