MockSvgHandler Class Reference

Inheritance diagram for MockSvgHandler:

Collaboration diagram for MockSvgHandler:

Public Member Functions
	doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
Public Member Functions inherited from SvgHandler
	canAnimateThumbnail ( $file)
	We do not support making animated svg thumbnails.
	formatMetadata ( $file, $context=false)
	getAvailableLanguages (File $file)
	Which languages (systemLanguage attribute) is supported.
	getCommonMetaArray (File $file)
	Get an array of standard (FormatMetadata type) metadata values.
	getDefaultRenderLanguage (File $file)
	What language to render file in if none selected.
	getImageSize ( $file, $path, $metadata=false)
	getLongDesc ( $file)
	Subtitle for the image.
	getMatchedLanguage ( $userPreferredLanguage, array $svgLanguages)
	SVG's systemLanguage matching rules state: 'The systemLanguage attribute ... [e]valuates to "true" if one of the languages indicated by user preferences exactly equals one of the languages given in the value of this parameter, or if one of the languages indicated by user preferences exactly equals a prefix of one of the languages given in the value of this parameter such that the first tag character following the prefix is "-".
	getMetadata ( $file, $filename)
	getMetadataType ( $image)
	Get a string describing the type of metadata, for display purposes.
	getParamMap ()
	Get an associative array mapping magic word IDs to parameter names.
	getScriptParams ( $params)
	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.
	makeParamString ( $params)
	mustRender ( $file)
	True if handled types cannot be displayed directly in a browser but can be rendered.
	normaliseParams ( $image, &$params)
	parseParamString ( $str)
	Parse a param string made with makeParamString back into an array.
	rasterize ( $srcPath, $dstPath, $width, $height, $lang=false)
	Transform an SVG file to PNG This function can be called outside of thumbnail contexts.
	unpackMetadata ( $metadata)
	validateParam ( $name, $value)
Public Member Functions inherited from ImageHandler
	canRender ( $file)
	getDimensionsString ( $file)
	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.
	getScriptedTransform ( $image, $script, $params)
	getShortDesc ( $file)
	sanitizeParamsForBucketing ( $params)
	Returns a normalised params array for which parameters have been cleaned up for bucketing purposes.
	validateThumbParams (&$width, &$height, $srcWidth, $srcHeight, $mimeType)
	Validate thumbnail parameters and fill in the correct height.
Public Member Functions inherited from MediaHandler
	canRotate ()
	True if the handler can rotate the media.
	convertMetadataVersion ( $metadata, $version=1)
	Convert metadata version.
	filterThumbnailPurgeList (&$files, $options)
	Remove files from the purge list.
	formatMetadataHelper ( $metadataArray, $context=false)
	sorts the visible/invisible field.
	getContentHeaders ( $metadata)
	Get useful response headers for GET/HEAD requests for a file with the given metadata.
	getEntireText (File $file)
	Get the text of the entire document.
	getLength ( $file)
	If its an audio file, return the length of the file.
	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.
	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.
	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.
	verifyUpload ( $fileName)
	File validation hook called on upload.

Additional Inherited Members
Static Public Member Functions inherited from SvgHandler
static	rasterizeImagickExt ( $srcPath, $dstPath, $width, $height)
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 SvgHandler
const	SVG_METADATA_VERSION = 2
Public Attributes inherited from MediaHandler
const	MAX_ERR_LOG_SIZE = 65535
	Max length of error logged by logErrorForExternalProcess()
const	METADATA_BAD = false
const	METADATA_COMPATIBLE = 2
const	METADATA_GOOD = true
const	TRANSFORM_LATER = 1
Protected Member Functions inherited from SvgHandler
	visibleMetadataFields ()
	Get a list of metadata items which should be displayed when the metadata table is collapsed.
Protected Member Functions inherited from MediaHandler
	logErrorForExternalProcess ( $retval, $err, $cmd)
	Log an error that occurred in an external process.
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

Definition at line 24 of file MockSvgHandler.php.

Member Function Documentation

doTransform()

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

Parameters

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

Returns

bool|MediaTransformError|ThumbnailImage|TransformParameterError

Reimplemented from SvgHandler.

Definition at line 25 of file MockSvgHandler.php.

References $image, $params, and MockImageHandler\doFakeTransform().

---

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

• tests/phpunit/mocks/media/MockSvgHandler.php