Base media handler class. More...

Inheritance diagram for MediaHandler:

Public Member Functions
	canAnimateThumbnail ($file)
	If the material is animated, we can animate the thumbnail.
	canRender ($file)
	True if the handled types can be transformed.
	canRotate ()
	True if the handler can rotate the media.
	convertMetadataVersion ($metadata, $version=1)
	Convert metadata version.
	doTransform ($image, $dstPath, $dstUrl, $params, $flags=0)
	Get a MediaTransformOutput object representing the transformed output.
	filterThumbnailPurgeList (&$files, $options)
	Remove files from the purge list.
	formatMetadata ($image)
	Get an array structure that looks like this:
	formatMetadataHelper ($metadataArray)
	sorts the visible/invisible field.
	getAvailableLanguages (File $file)
	Get list of languages file can be viewed in.
	getCommonMetaArray (File $file)
	Get an array of standard (FormatMetadata type) metadata values.
	getDefaultRenderLanguage (File $file)
	On file types that support renderings in multiple languages, which language is used by default if unspecified.
	getDimensionsString ($file)
	Shown in file history box on image description page.
	getEntireText (File $file)
	Get the text of the entire document.
	getImageSize ($image, $path)
	Get an image size array like that returned by getimagesize(), or false if it can't be determined.
	getLength ($file)
	If its an audio file, return the length of the file.
	getLongDesc ($file)
	Long description.
	getMetadata ($image, $path)
	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.
	getPageDimensions ($image, $page)
	Get an associative array of page dimensions Currently "width" and "height" are understood, but this might be expanded in the future.
	getPageText ($image, $page)
	Generic getter for text layer.
	getParamMap ()
	Get an associative array mapping magic word IDs to parameter names.
	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.
	getScriptedTransform ($image, $script, $params)
	Get a MediaTransformOutput object representing an alternate of the transformed output which will call an intermediary thumbnail assist script.
	getShortDesc ($file)
	Short description.
	getStreamHeaders ($metadata)
	Get useful response headers for GET/HEAD requests for a file with the given metadata.
	getThumbType ($ext, $mime, $params=null)
	Get the thumbnail extension and MIME type for a given source MIME type.
	getTransform ($image, $dstPath, $dstUrl, $params)
	Get a MediaTransformOutput object representing the transformed output.
	isAnimatedImage ($file)
	The material is an image, and is animated.
	isEnabled ()
	False if the handler is disabled for all files.
	isExpensiveToThumbnail ($file)
	True if creating thumbnails from the file is large or otherwise resource-intensive.
	isMetadataValid ($image, $metadata)
	Check if the metadata string is valid for this handler.
	isMultiPage ($file)
	True if the type has multi-page capabilities.
	isVectorized ($file)
	The material is vectorized and thus scaling is lossless.
	makeParamString ($params)
	Merge a parameter array into a string appropriate for inclusion in filenames.
	mustRender ($file)
	True if handled types cannot be displayed directly in a browser but can be rendered.
	normaliseParams ($image, &$params)
	Changes the parameter array as necessary, ready for transformation.
	pageCount ($file)
	Page count for a multi-page document, false if unsupported or unknown.
	parseParamString ($str)
	Parse a param string made with makeParamString back into an array.
	parserTransformHook ($parser, $file)
	Modify the parser object post-transform.
	removeBadFile ($dstPath, $retval=0)
	Check for zero-sized thumbnails.
	sanitizeParamsForBucketing ($params)
	Returns a normalised params array for which parameters have been cleaned up for bucketing purposes.
	supportsBucketing ()
	Returns whether or not this handler supports the chained generation of thumbnails according to buckets.
	validateParam ($name, $value)
	Validate a thumbnail parameter at parse time.
	verifyUpload ($fileName)
	File validation hook called on upload.
Static Public Member Functions
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	resetCache ()
	Resets all static caches.
Public Attributes
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
	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 Protected Member Functions
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.
Static Protected Attributes
static	$handlers = array()

Detailed Description

Base media handler class.

Definition at line 29 of file MediaHandler.php.

Member Function Documentation

static MediaHandler::addMeta	(	&$	array,
		$	visibility,
		$	type,
		$	id,
		$	value,
		$	param = `false`
	)		`[static, protected]`

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.

Parameters:

array	&$array	An array containing elements for each type of visibility and each of those elements being an array of metadata items. This function adds a value to that array.
string	$visibility	('visible' or 'collapsed') if this value is hidden by default.
string	$type	Type of metadata tag (currently always 'exif')
string	$id	The name of the metadata tag (like 'artist' for example). its name in the table displayed is the message "$type-$id" (Ex exif-artist ).
string	$value	Thingy goes into a wikitext table; it used to be escaped but that was incompatible with previous practise of customized display with wikitext formatting via messages such as 'exif-model-value'. So the escaping is taken back out, but generally this seems a confusing interface.
bool \| string	$param	Value to pass to the message for the name of the field as $1. Currently this parameter doesn't seem to ever be used.

Note, everything here is passed through the parser later on (!)

Definition at line 580 of file MediaHandler.php.

References $name, $value, array(), wfDebug(), wfEscapeWikiText(), and wfMessage().

Referenced by SvgHandler\formatMetadata(), and formatMetadataHelper().

MediaHandler::canAnimateThumbnail ( $ file )

If the material is animated, we can animate the thumbnail.

Since:: 1.20

Parameters:

File $file

Returns:: bool If material is not animated, handler may return any value.

Reimplemented in SvgHandler, GIFHandler, and PNGHandler.

Definition at line 409 of file MediaHandler.php.

MediaHandler::canRender ( $ file )

True if the handled types can be transformed.

Parameters:

File $file

Returns:: bool

Reimplemented in XCFHandler, TiffHandler, and ImageHandler.

Definition at line 345 of file MediaHandler.php.

MediaHandler::canRotate ( )

True if the handler can rotate the media.

Since:: 1.24 non-static. From 1.21-1.23 was static

Returns:: bool

Reimplemented in TransformationalImageHandler, and BitmapHandler.

Definition at line 751 of file MediaHandler.php.

MediaHandler::convertMetadataVersion	(	$	metadata,
		$	version = `1`
	)

Convert metadata version.

By default just returns $metadata, but can be used to allow media handlers to convert between metadata versions.

Parameters:

string \| array	$metadata	Metadata array (serialized if string)
int	$version	Target version

Returns:: array Serialized metadata in specified version, or $metadata on fail.

Reimplemented in ExifBitmapHandler.

Definition at line 180 of file MediaHandler.php.

References $ret, wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by File\getBitDepth().

MediaHandler::doTransform	(	$	image,
		$	dstPath,
		$	dstUrl,
		$	params,
		$	flags = `0`
	)		`[abstract]`

Get a MediaTransformOutput object representing the transformed output.

Does the transform unless $flags contains self::TRANSFORM_LATER.

Parameters:

File	$image	The image object
string	$dstPath	Filesystem destination path
string	$dstUrl	Destination URL to use in output HTML
array	$params	Arbitrary set of parameters validated by $this->validateParam() Note: These parameters have not gone through $this->normaliseParams()
int	$flags	A bitfield, may contain self::TRANSFORM_LATER

Returns:: MediaTransformOutput

Reimplemented in SvgHandler, DjVuHandler, TransformationalImageHandler, BitmapHandler_ClientOnly, MockBitmapHandler, MockDjVuHandler, and MockSvgHandler.

Referenced by getTransform().

MediaHandler::filterThumbnailPurgeList	(	&$	files,
		$	options
	)

Remove files from the purge list.

This is used by some video handlers to prevent ?action=purge from removing a transcoded video, which is expensive to regenerate.

See also:: LocalFile::purgeThumbnails

Parameters:

array	$files
array	$options	Purge options. Currently will always be an array with a single key 'forThumbRefresh' set to true.

Definition at line 742 of file MediaHandler.php.

Referenced by LocalFile\purgeThumbList(), and ForeignAPIFile\purgeThumbnails().

static MediaHandler::fitBoxWidth	(	$	boxWidth,
		$	boxHeight,
		$	maxHeight
	)		`[static]`

Calculate the largest thumbnail width for a given original file size such that the thumbnail's height is at most $maxHeight.

Parameters:

int	$boxWidth	Width of the thumbnail box.
int	$boxHeight	Height of the thumbnail box.
int	$maxHeight	Maximum height expected for the thumbnail.

Returns:: int

Definition at line 651 of file MediaHandler.php.

Referenced by ImageHandler\normaliseParams(), and MediaHandlerTest\testFitBoxWidth().

MediaHandler::formatMetadata ( $ image )

Get an array structure that looks like this:

array( 'visible' => array( 'Human-readable name' => 'Human readable value', ... ), 'collapsed' => array( 'Human-readable name' => 'Human readable value', ... ) ) The UI will format this into a table where the visible fields are always visible, and the collapsed fields are optionally visible.

The function should return false if there is no metadata to display.

Todo:: FIXME: This interface is not very flexible.

The media handler should generate HTML instead. It can do all the formatting according to some standard. That makes it possible to do things like visual indication of grouped and chained streams in ogg container files.

Parameters:

File $image

Returns:: array|bool

Reimplemented in SvgHandler, ExifBitmapHandler, PNGHandler, and GIFHandler.

Definition at line 512 of file MediaHandler.php.

MediaHandler::formatMetadataHelper ( $ metadataArray )

sorts the visible/invisible field.

Split off from ImageHandler::formatMetadata, as used by more than one type of handler.

This is used by the media handlers that use the FormatMetadata class

Parameters:

array $metadataArray Metadata array

Returns:: array Array for use displaying metadata.

Definition at line 525 of file MediaHandler.php.

References $name, $result, $value, addMeta(), array(), as, FormatMetadata\getFormattedData(), and visibleMetadataFields().

Referenced by GIFHandler\formatMetadata(), PNGHandler\formatMetadata(), and ExifBitmapHandler\formatMetadata().

MediaHandler::getAvailableLanguages ( File $ file )

Get list of languages file can be viewed in.

Parameters:

File $file

Returns:: string[] Array of language codes, or empty array if unsupported.

Since:: 1.23

Reimplemented in SvgHandler.

Definition at line 800 of file MediaHandler.php.

References array().

MediaHandler::getCommonMetaArray ( File $ file )

Get an array of standard (FormatMetadata type) metadata values.

The returned data is largely the same as that from getMetadata(), but formatted in a standard, stable, handler-independent way. The idea being that some values like ImageDescription or Artist are universal and should be retrievable in a handler generic way.

The specific properties are the type of properties that can be handled by the FormatMetadata class. These values are exposed to the user via the filemetadata parser function.

Details of the response format of this function can be found at https://www.mediawiki.org/wiki/Manual:File_metadata_handling tl/dr: the response is an associative array of properties keyed by name, but the value can be complex. You probably want to call one of the FormatMetadata::flatten* functions on the property values before using them, or call FormatMetadata::getFormattedData() on the full response array, which transforms all values into prettified, human-readable text.

Subclasses overriding this function must return a value which is a valid API response fragment (all associative array keys are valid XML tagnames).

Note, if the file simply has no metadata, but the handler supports this interface, it should return an empty array, not false.

Parameters:

File $file

Returns:: array|bool False if interface not supported

Since:: 1.23

Reimplemented in SvgHandler, ExifBitmapHandler, PNGHandler, and GIFHandler.

Definition at line 257 of file MediaHandler.php.

MediaHandler::getDefaultRenderLanguage ( File $ file )

On file types that support renderings in multiple languages, which language is used by default if unspecified.

If getAvailableLanguages returns a non-empty array, this must return a valid language code. Otherwise can return null if files of this type do not support alternative language renderings.

Parameters:

File $file

Returns:: string|null Language code or null if multi-language not supported for filetype.

Since:: 1.23

Reimplemented in SvgHandler.

Definition at line 816 of file MediaHandler.php.

Referenced by File\canAnimateThumbIfAppropriate().

MediaHandler::getDimensionsString ( $ file )

Shown in file history box on image description page.

Parameters:

File $file

Returns:: string Dimensions

Reimplemented in ImageHandler.

Definition at line 667 of file MediaHandler.php.

Referenced by File\getRedirectedTitle().

MediaHandler::getEntireText ( File $ file )

Get the text of the entire document.

Parameters:

File $file

Returns:: bool|string The text of the document or false if unsupported.

Definition at line 466 of file MediaHandler.php.

References getPageText(), and File\pageCount().

static MediaHandler::getGeneralLongDesc ( $ file ) [static]

Used instead of getLongDesc if there is no handler registered for file.

Parameters:

File $file

Returns:: string

Definition at line 638 of file MediaHandler.php.

References $file, and wfMessage().

Referenced by getLongDesc().

static MediaHandler::getGeneralShortDesc ( $ file ) [static]

Used instead of getShortDesc if there is no handler registered for file.

Parameters:

File $file

Returns:: string

Definition at line 626 of file MediaHandler.php.

References $file, $wgLang, and global.

Referenced by getShortDesc().

static MediaHandler::getHandler ( $ type ) [static]

Get a MediaHandler for a given MIME type from the instance cache.

Parameters:

string $type

Returns:: MediaHandler

Definition at line 48 of file MediaHandler.php.

References $type, global, isEnabled(), and wfDebug().

Referenced by UploadBase\verifyFile().

MediaHandler::getImageSize	(	$	image,
		$	path
	)		`[abstract]`

Get an image size array like that returned by getimagesize(), or false if it can't be determined.

This function is used for determining the width, height and bitdepth directly from an image. The results are stored in the database in the img_width, img_height, img_bits fields.

Note:: If this is a multipage file, return the width and height of the first page.

Parameters:

File	$image	The image object, or false if there isn't one
string	$path	The filename

Returns:: array Follow the format of PHP getimagesize() internal function. See http://www.php.net/getimagesize. MediaWiki will only ever use the first two array keys (the width and height), and the 'bits' associative key. All other array keys are ignored. Returning a 'bits' key is optional as not all formats have a notion of "bitdepth".

Reimplemented in DjVuHandler, ImageHandler, ExifBitmapHandler, XCFHandler, and BmpHandler.

Referenced by getPageDimensions().

MediaHandler::getLength ( $ file )

If its an audio file, return the length of the file.

Otherwise 0.

File::getLength() existed for a long time, but was calling a method that only existed in some subclasses of this class (The TMH ones).

Parameters:

File $file

Returns:: float Length in seconds

Since:: 1.23

Definition at line 830 of file MediaHandler.php.

MediaHandler::getLongDesc ( $ file )

Long description.

Shown under image on image description page surounded by ().

Parameters:

File $file

Returns:: string

Reimplemented in SvgHandler, ImageHandler, GIFHandler, and PNGHandler.

Definition at line 616 of file MediaHandler.php.

References $file, and getGeneralLongDesc().

MediaHandler::getMetadata	(	$	image,
		$	path
	)

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

Parameters:

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

Returns:: string A string of metadata in php serialized form (Run through serialize())

Reimplemented in DjVuHandler, SvgHandler, XCFHandler, JpegHandler, TiffHandler, PNGHandler, and GIFHandler.

Definition at line 144 of file MediaHandler.php.

Referenced by ExifBitmapHandler\getImageSize().

MediaHandler::getMetadataType ( $ image )

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

Note:: This method is currently unused.

Parameters:

File $image

Returns:: string

Reimplemented in SvgHandler, DjVuHandler, ExifBitmapHandler, GIFHandler, and PNGHandler.

Definition at line 201 of file MediaHandler.php.

static MediaHandler::getMetadataVersion ( ) [static]

Get metadata version.

This is not used for validating metadata, this is used for the api when returning metadata, since api content formats should stay the same over time, and so things using ForeignApiRepo can keep backwards compatibility

All core media handlers share a common version number, and extensions can use the GetMetadataVersion hook to append to the array (they should append a unique string so not to get confusing). If there was a media handler named 'foo' with metadata version 3 it might add to the end of the array the element 'foo=3'. if the core metadata version is 2, the end version string would look like '2;foo=3'.

Returns:: string Version string

Definition at line 163 of file MediaHandler.php.

References array(), and wfRunHooks().

Referenced by ForeignAPIFile\newFromTitle().

MediaHandler::getPageDimensions	(	$	image,
		$	page
	)

Get an associative array of page dimensions Currently "width" and "height" are understood, but this might be expanded in the future.

Returns false if unknown.

It is expected that handlers for paged media (e.g. DjVuHandler) will override this method so that it gives the correct results for each specific page of the file, using the $page argument.

Note:: For non-paged media, use getImageSize.

Parameters:

File	$image
int	$page	What page to get dimensions of

Returns:: array|bool

Reimplemented in DjVuHandler.

Definition at line 437 of file MediaHandler.php.

References array(), and getImageSize().

MediaHandler::getPageText	(	$	image,
		$	page
	)

Generic getter for text layer.

Currently overloaded by PDF and DjVu handlers

Parameters:

File	$image
int	$page	Page number to get information for

Returns:: bool|string Page text or false when no text found or if unsupported.

Reimplemented in DjVuHandler.

Definition at line 457 of file MediaHandler.php.

Referenced by getEntireText().

MediaHandler::getParamMap ( ) [abstract]

Get an associative array mapping magic word IDs to parameter names.

Will be used by the parser to identify parameters.

Reimplemented in SvgHandler, DjVuHandler, and ImageHandler.

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

This information is only useful when manipulating the original file; the width and height we normally work with is logical, and will match any produced output views.

For files we don't know, we return 0.

Parameters:

File $file

Returns:: int 0, 90, 180 or 270

Reimplemented in ExifBitmapHandler.

Definition at line 769 of file MediaHandler.php.

Referenced by TransformationalImageHandler\mustRender(), BitmapHandler\rotate(), BitmapHandler\transformGd(), BitmapHandler\transformImageMagick(), and BitmapHandler\transformImageMagickExt().

MediaHandler::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().

Parameters:

File	$image
string	$script
array	$params

Returns:: bool|ThumbnailImage

Reimplemented in ImageHandler.

Definition at line 273 of file MediaHandler.php.

MediaHandler::getShortDesc ( $ file )

Short description.

Shown on Special:Search results.

Parameters:

File $file

Returns:: string

Reimplemented in ImageHandler.

Definition at line 606 of file MediaHandler.php.

References $file, and getGeneralShortDesc().

MediaHandler::getStreamHeaders ( $ metadata )

Get useful response headers for GET/HEAD requests for a file with the given metadata.

Parameters:

mixed $metadata Result of the getMetadata() function of this handler for a file

Returns:: array

Definition at line 335 of file MediaHandler.php.

References array().

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

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

Parameters:

string	$ext	Extension of original file
string	$mime	MIME type of original file
array	$params	Handler specific rendering parameters

Returns:: array Thumbnail extension and MIME type

Reimplemented in DjVuHandler, SvgHandler, TiffHandler, XCFHandler, and BmpHandler.

Definition at line 313 of file MediaHandler.php.

References $ext, $extensions, $mime, array(), false, and MimeMagic\singleton().

MediaHandler::getTransform	(	$	image,
		$	dstPath,
		$	dstUrl,
		$	params
	)		`[final]`

Get a MediaTransformOutput object representing the transformed output.

Does not actually do the transform.

Parameters:

File	$image	The image object
string	$dstPath	Filesystem destination path
string	$dstUrl	Destination URL to use in output HTML
array	$params	Arbitrary set of parameters validated by $this->validateParam()

Returns:: MediaTransformOutput

Definition at line 287 of file MediaHandler.php.

References $params, and doTransform().

MediaHandler::isAnimatedImage ( $ file )

The material is an image, and is animated.

In particular, video material need not return true.

Note:: Before 1.20, this was a method of ImageHandler only

Parameters:

File $file

Returns:: bool

Reimplemented in GIFHandler, PNGHandler, and SvgHandler.

Definition at line 398 of file MediaHandler.php.

Referenced by BitmapHandler\transformImageMagick(), and BitmapHandler\transformImageMagickExt().

MediaHandler::isEnabled ( )

False if the handler is disabled for all files.

Returns:: bool

Reimplemented in SvgHandler, and DjVuHandler.

Definition at line 417 of file MediaHandler.php.

Referenced by getHandler().

MediaHandler::isExpensiveToThumbnail ( $ file )

True if creating thumbnails from the file is large or otherwise resource-intensive.

Parameters:

File $file

Returns:: bool

Reimplemented in TiffHandler.

Definition at line 839 of file MediaHandler.php.

MediaHandler::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, MediaHandler::METADATA_COMPATIBLE if metadata is old but backwards compatible (which may or may not trigger a metadata reload).

Note:: Returning self::METADATA_BAD will trigger a metadata reload from file on page view. Always returning this from a broken file, or suddenly triggering as bad metadata for a large number of files can cause performance problems.

Parameters:

File	$image
string	$metadata	The metadata in serialized form

Returns:: bool

Reimplemented in SvgHandler, DjVuHandler, XCFHandler, GIFHandler, PNGHandler, and ExifBitmapHandler.

Definition at line 221 of file MediaHandler.php.

References METADATA_GOOD.

MediaHandler::isMultiPage ( $ file )

True if the type has multi-page capabilities.

Parameters:

File $file

Returns:: bool

Reimplemented in DjVuHandler.

Definition at line 366 of file MediaHandler.php.

MediaHandler::isVectorized ( $ file )

The material is vectorized and thus scaling is lossless.

Parameters:

File $file

Returns:: bool

Reimplemented in SvgHandler.

Definition at line 386 of file MediaHandler.php.

MediaHandler::logErrorForExternalProcess	(	$	retval,
		$	err,
		$	cmd
	)		`[protected]`

Log an error that occurred in an external process.

Moved from BitmapHandler to MediaHandler with MediaWiki 1.23

Since:: 1.23

Parameters:

int	$retval
string	$err	Error reported by command. Anything longer than MediaHandler::MAX_ERR_LOG_SIZE is stripped off.
string	$cmd

Definition at line 784 of file MediaHandler.php.

References $retval, wfDebugLog(), and wfHostname().

Referenced by DjVuHandler\doTransform(), SvgHandler\rasterize(), JpegHandler\rotate(), BitmapHandler\rotate(), BitmapHandler\transformCustom(), and BitmapHandler\transformImageMagick().

MediaHandler::makeParamString ( $ params ) [abstract]

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

Reimplemented in SvgHandler, DjVuHandler, JpegHandler, and ImageHandler.

MediaHandler::mustRender ( $ file )

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

Parameters:

File $file

Returns:: bool

Reimplemented in TransformationalImageHandler, TiffHandler, SvgHandler, DjVuHandler, XCFHandler, and BmpHandler.

Definition at line 356 of file MediaHandler.php.

MediaHandler::normaliseParams	(	$	image,
		&$	params
	)		`[abstract]`

Changes the parameter array as necessary, ready for transformation.

Should be idempotent. Returns false if the parameters are unacceptable and the transform should fail

Parameters:

File	$image
array	$params

Reimplemented in SvgHandler, ImageHandler, TransformationalImageHandler, BitmapHandler_ClientOnly, and JpegHandler.

MediaHandler::pageCount ( $ file )

Page count for a multi-page document, false if unsupported or unknown.

Parameters:

File $file

Returns:: bool

Reimplemented in DjVuHandler.

Definition at line 376 of file MediaHandler.php.

MediaHandler::parseParamString ( $ str ) [abstract]

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.

Reimplemented in SvgHandler, DjVuHandler, JpegHandler, and ImageHandler.

MediaHandler::parserTransformHook	(	$	parser,
		$	file
	)

Modify the parser object post-transform.

This is often used to do $parser->addOutputHook(), in order to add some javascript to render a viewer. See TimedMediaHandler or OggHandler for an example.

Parameters:

Parser	$parser
File	$file

Definition at line 681 of file MediaHandler.php.

MediaHandler::removeBadFile	(	$	dstPath,
		$	retval = `0`
	)

Check for zero-sized thumbnails.

These can be generated when no disk space is available or some other error occurs

Parameters:

string	$dstPath	The location of the suspect file
int	$retval	Return value of some shell process, file will be deleted if this is non-zero

Returns:: bool True if removed, false otherwise

Definition at line 706 of file MediaHandler.php.

References $result, $retval, and wfDebugLog().

Referenced by TransformationalImageHandler\doTransform(), DjVuHandler\doTransform(), and SvgHandler\rasterize().

static MediaHandler::resetCache ( ) [static]

Resets all static caches.

Definition at line 70 of file MediaHandler.php.

References array().

MediaHandler::sanitizeParamsForBucketing ( $ params )

Returns a normalised params array for which parameters have been cleaned up for bucketing purposes.

Parameters:

array $params

Returns:: array

Reimplemented in ImageHandler, and JpegHandler.

Definition at line 859 of file MediaHandler.php.

References $params.

MediaHandler::supportsBucketing ( )

Returns whether or not this handler supports the chained generation of thumbnails according to buckets.

Returns:: bool

Since:: 1.24

Reimplemented in PNGHandler, and JpegHandler.

Definition at line 849 of file MediaHandler.php.

MediaHandler::validateParam	(	$	name,
		$	value
	)		`[abstract]`

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

Reimplemented in SvgHandler, DjVuHandler, JpegHandler, and ImageHandler.

MediaHandler::verifyUpload ( $ fileName )

File validation hook called on upload.

If the file at the given local path is not valid, or its MIME type does not match the handler class, a Status object should be returned containing relevant errors.

Parameters:

string $fileName The local path to the file.