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?
	getImageSize ( $image, $filename)
	Get width and height from the XCF header.
	getMetadata ( $file, $filename)
	Store the channel type.
	getThumbType ( $ext, $mime, $params=null)
	Render files as PNG.
	isMetadataValid ( $file, $metadata)
	Should we refresh the metadata.
	mustRender ( $file)
Public Member Functions inherited from BitmapHandler
	autoRotateEnabled ()
	canRotate ()
	Returns whether the current scaler supports rotation (im and gd do) Stable to override.
	makeParamString ( $params)
	Merge a parameter array into a string appropriate for inclusion in filenames. Parameters array $params Array of parameters that have been through normaliseParams. Returns string Stable to override Stable to override
	normaliseParams ( $image, &$params)
	Stable to override.
	parseParamString ( $str)
	Parse a param string made with makeParamString back into an array. Parameters string $str The parameter string without file name (e.g. 122px) Returns array|bool Array of parameters or false on failure. Stable to override Stable to override
	rotate ( $file, $params)
	Stable to override.
	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 Stable to override Stable to override
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.
Public Member Functions inherited from ImageHandler
	getDimensionsString ( $file)
	Shown in file history box on image description page.Stable to override Parameters File $file Returns string Dimensions Stable to override
	getImageArea ( $image)
	Function that returns the number of pixels to be thumbnailed.
	getLongDesc ( $file)
	Long description.Shown under image on image description page surounded by ().Stable to override Parameters File $file Returns string Stable to override
	getParamMap ()
	Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters. Stable to override
	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().Stable to override Parameters File $image string $script array $params Returns bool|ThumbnailImage Stable to override
	getShortDesc ( $file)
	Short description.Shown on Special:Search results.Stable to override Parameters File $file Returns string Stable to override
	sanitizeParamsForBucketing ( $params)
	Returns a normalised params array for which parameters have been cleaned up for bucketing purposes Stable to override. Parameters array $params Returns array Stable to override
Public Member Functions inherited from MediaHandler
	canAnimateThumbnail ( $file)
	If the material is animated, we can animate the thumbnail.
	convertMetadataVersion ( $metadata, $version=1)
	Convert metadata version.
	filterThumbnailPurgeList (&$files, $options)
	Remove files from the purge list.
	formatMetadata ( $image, $context=false)
	Get an array structure that looks like this:
	getAvailableLanguages (File $file)
	Get list of languages file can be viewed in.
	getCommonMetaArray (File $file)
	Get an array of standard (FormatMetadata type) metadata values.
	getContentHeaders ( $metadata)
	Get useful response headers for GET/HEAD requests for a file with the given metadata Stable to override.
	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.
	getLength ( $file)
	If its an audio file, return the length of the file.
	getMatchedLanguage ( $userPreferredLanguage, array $availableLanguages)
	When overridden in a descendant class, returns a language code most suiting.
	getMetadataType ( $image)
	Get a string describing the type of metadata, for display purposes.
	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.
	getTransform ( $image, $dstPath, $dstUrl, $params)
	Get a MediaTransformOutput object representing the transformed output.
	getWarningConfig ( $file)
	Gets configuration for the file warning message.
	isAnimatedImage ( $file)
	The material is an image, and is animated.
	isEnabled ()
	False if the handler is disabled for all files Stable to override.
	isExpensiveToThumbnail ( $file)
	True if creating thumbnails from the file is large or otherwise resource-intensive.
	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.
	supportsBucketing ()
	Returns whether or not this handler supports the chained generation of thumbnails according to buckets Stable to override.
	verifyUpload ( $fileName)
	File validation hook called on upload.

Protected Member Functions
	getScalerType ( $dstPath, $checkDstPath=true)
	Must use "im" for XCF.
Protected Member Functions inherited from BitmapHandler
	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 Stable to override.
	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)
	Stable to override
Protected Member Functions inherited from MediaHandler
	formatMetadataHelper ( $metadataArray, $context=false)
	sorts the visible/invisible field.
	logErrorForExternalProcess ( $retval, $err, $cmd)
	Log an error that occurred in an external process.
	visibleMetadataFields ()
	Get a list of metadata items which should be displayed when the metadata table is collapsed.

Static Private Member Functions
static	getXCFMetaData ( $filename)
	Metadata for a given XCF file.

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
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.

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

References $file, and unserialize().

getImageSize()

XCFHandler::getImageSize	(		$image,
			$filename
	)

Get width and height from the XCF header.

Parameters

File | FSFile	$image
string	$filename

Returns

array|false

Reimplemented from ImageHandler.

Definition at line 63 of file XCFHandler.php.

References $header, and getXCFMetaData().

getMetadata()

XCFHandler::getMetadata	(		$file,
			$filename
	)

Store the channel type.

Greyscale files need different command line options.

Parameters

File | FSFile	$file	The image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an (object)array() instead (!)
string	$filename

Returns

string

Reimplemented from MediaHandler.

Definition at line 157 of file XCFHandler.php.

References $header, getXCFMetaData(), and serialize().

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

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

$filename

Full path to a XCF file

Returns

bool|array Metadata Array just like PHP getimagesize()

Definition at line 92 of file XCFHandler.php.

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

Referenced by getImageSize(), and getMetadata().

isMetadataValid()

XCFHandler::isMetadataValid	(		$file,
			$metadata
	)

Should we refresh the metadata.

Parameters

File	$file	The file object for the file in question
string	$metadata	Serialized metadata

Returns

bool|int One of the self::METADATA_(BAD|GOOD|COMPATIBLE) constants

Reimplemented from MediaHandler.

Definition at line 191 of file XCFHandler.php.

References 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:

• includes/media/XCFHandler.php