Handler for SVG images. More...

Inheritance diagram for SvgHandler:

Collaboration diagram for SvgHandler:

Public Member Functions
	canAnimateThumb ($file)
	We do not support making animated svg thumbnails.
	doTransform ($image, $dstPath, $dstUrl, $params, $flags=0)
	formatMetadata ($file)
	getImageSize ($file, $path, $metadata=false)
	getLongDesc ($file)
	Subtitle for the image.
	getMetadata ($file, $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.
	getThumbType ($ext, $mime, $params=null)
	Get the thumbnail extension and MIME type for a given source MIME type.
	isAnimatedImage ($file)
	isEnabled ()
	False if the handler is disabled for all files.
	isMetadataValid ($image, $metadata)
	Check if the metadata string is valid for this handler.
	isVectorized ($file)
	The material is vectorized and thus scaling is lossless.
	mustRender ($file)
	True if handled types cannot be displayed directly in a browser but can be rendered.
	normaliseParams ($image, &$params)
	rasterize ($srcPath, $dstPath, $width, $height)
	Transform an SVG file to PNG This function can be called outside of thumbnail contexts.
	unpackMetadata ($metadata)
	visibleMetadataFields ()
	Get a list of metadata items which should be displayed when the metadata table is collapsed.
Static Public Member Functions
static	rasterizeImagickExt ($srcPath, $dstPath, $width, $height)
Public Attributes
const	SVG_METADATA_VERSION = 2

Detailed Description

Handler for SVG images.

Definition at line 29 of file SVG.php.

Member Function Documentation

SvgHandler::canAnimateThumb ( $ file )

We do not support making animated svg thumbnails.

Definition at line 69 of file SVG.php.

SvgHandler::doTransform	(	$	image,
		$	dstPath,
		$	dstUrl,
		$	params,
		$	flags = `0`
	)

Parameters:

	$image	File
	$dstPath
	$dstUrl
	$params
int	$flags

Returns:: bool|MediaTransformError|ThumbnailImage|TransformParameterError

Reimplemented from MediaHandler.

Definition at line 110 of file SVG.php.

References $flags, $params, normaliseParams(), rasterize(), text, wfMessage(), and wfMkdirParents().

SvgHandler::formatMetadata ( $ file )

Parameters:

$file File

Returns:: array|bool

Reimplemented from MediaHandler.

Definition at line 299 of file SVG.php.

References $file, $name, $result, $value, MediaHandler\addMeta(), array(), as, unpackMetadata(), and visibleMetadataFields().

SvgHandler::getImageSize	(	$	file,
		$	path,
		$	metadata = `false`
	)

Parameters:

	$file	File
	$path
bool	$metadata

Returns:: array

Definition at line 208 of file SVG.php.

References $file, and array().

SvgHandler::getLongDesc ( $ file )

Subtitle for the image.

Different from the base class so it can be denoted that SVG's have a "nominal" resolution, and not a fixed one, as well as so animation can be denoted.

Parameters:

$file File

Returns:: string

Reimplemented from ImageHandler.

Definition at line 233 of file SVG.php.

References $file, $size, $wgLang, global, isAnimatedImage(), and wfMessage().

SvgHandler::getMetadata	(	$	image,
		$	path
	)

Get handler-specific metadata which will be saved in the img_metadata field.

Parameters:

$image	File: the image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an (object)array() instead (!)
$path	String: the filename

Returns:: String

Reimplemented from MediaHandler.

Definition at line 251 of file SVG.php.

References SVG_METADATA_VERSION, and wfDebug().

SvgHandler::getMetadataType ( $ image )

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

Returns:: string

Reimplemented from MediaHandler.

Definition at line 274 of file SVG.php.

SvgHandler::getThumbType	(	$	ext,
		$	mime,
		$	params = `null`
	)

Get the thumbnail extension and MIME type for a given source MIME type.

Returns:: array thumbnail extension and MIME type

Reimplemented from MediaHandler.

Definition at line 220 of file SVG.php.

References array().

SvgHandler::isAnimatedImage ( $ file )

Parameters:

$file File

Returns:: bool

Reimplemented from MediaHandler.

Definition at line 54 of file SVG.php.

References $file, and unpackMetadata().

Referenced by getLongDesc().

SvgHandler::isEnabled ( )

False if the handler is disabled for all files.

Returns:: bool

Reimplemented from MediaHandler.

Definition at line 32 of file SVG.php.

References global, and wfDebug().

SvgHandler::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).

Returns:: bool

Reimplemented from MediaHandler.

Definition at line 278 of file SVG.php.

References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, and unpackMetadata().

SvgHandler::isVectorized ( $ file )

The material is vectorized and thus scaling is lossless.

Returns:: bool

Reimplemented from MediaHandler.

Definition at line 46 of file SVG.php.

SvgHandler::mustRender ( $ file )

True if handled types cannot be displayed directly in a browser but can be rendered.

Returns:: bool

Reimplemented from MediaHandler.

Definition at line 42 of file SVG.php.

SvgHandler::normaliseParams	(	$	image,
		&$	params
	)

Parameters:

$image	File
$params

Returns:: bool

Reimplemented from ImageHandler.

Definition at line 78 of file SVG.php.

References $params, global, and File\scaleHeight().

Referenced by doTransform().

SvgHandler::rasterize	(	$	srcPath,
		$	dstPath,
		$	width,
		$	height
	)

Transform an SVG file to PNG This function can be called outside of thumbnail contexts.

Parameters:

string	$srcPath
string	$dstPath
string	$width
string	$height

Exceptions:

MWException

Returns:: bool|MediaTransformError

Definition at line 147 of file SVG.php.

References $retval, array(), global, MediaHandler\removeBadFile(), wfDebug(), wfDebugLog(), wfEscapeShellArg(), wfHostname(), wfProfileIn(), wfProfileOut(), and wfShellExec().

Referenced by doTransform().

static SvgHandler::rasterizeImagickExt	(	$	srcPath,
		$	dstPath,
		$	width,
		$	height
	)		`[static]`

Definition at line 188 of file SVG.php.

SvgHandler::unpackMetadata ( $ metadata )

Definition at line 263 of file SVG.php.

References wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by formatMetadata(), isAnimatedImage(), and isMetadataValid().

SvgHandler::visibleMetadataFields ( )

Get a list of metadata items which should be displayed when the metadata table is collapsed.

Returns:: array of strings

Access:: protected

Reimplemented from MediaHandler.

Definition at line 290 of file SVG.php.

References array().

Referenced by formatMetadata().

Member Data Documentation

const SvgHandler::SVG_METADATA_VERSION = 2

Definition at line 30 of file SVG.php.

Referenced by getMetadata().

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

includes/media/SVG.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation