Handler for Google's WebP format https://developers.google.com/speed/webp/ More...

Inheritance diagram for WebPHandler:

[legend]

Collaboration diagram for WebPHandler:

[legend]

Public Member Functions
	canAnimateThumbnail ( $file)
	If the material is animated, we can animate the thumbnail.

	canRender ( $file)

	getImageSize ( $file, $path, $metadata=false)

	getMetadata ( $image, $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)
	Render files as PNG.

	isAnimatedImage ( $image)

	isMetadataValid ( $image, $metadata)
	Check if the metadata string is valid for this handler.

	mustRender ( $file)

Public Member Functions inherited from BitmapHandler
	autoRotateEnabled ()

	canRotate ()
	Returns whether the current scaler supports rotation (im and gd do)

	makeParamString ( $params)
	Merge a parameter array into a string appropriate for inclusion in filenames.

	normaliseParams ( $image, &$params)

	parseParamString ( $str)
	Parse a param string made with makeParamString back into an array.

	rotate ( $file, $params)

	validateParam ( $name, $value)
	Validate a thumbnail parameter at parse time.

Public Member Functions inherited from TransformationalImageHandler
	doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
	Create a thumbnail.

	escapeMagickInput ( $path, $scene=false)
	Escape a string for ImageMagick's input filenames.

	escapeMagickOutput ( $path, $scene=false)
	Escape a string for ImageMagick's output filename.

	escapeMagickProperty ( $s)
	Escape a string for ImageMagick's property input (e.g.

	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)

	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.

	getLongDesc ( $file)

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

	getScriptedTransform ( $image, $script, $params)

	getScriptParams ( $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
	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:

	formatMetadataHelper ( $metadataArray, $context=false)
	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.

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

	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.

	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.

	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.

	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.

	verifyUpload ( $fileName)
	File validation hook called on upload.

Static Public Member Functions
static	decodeExtendedChunkHeader ( $header)
	Decodes an extended chunk header.

static	decodeLosslessChunkHeader ( $header)
	Decodes a lossless chunk header.

static	extractMetadata ( $filename)
	Extracts the image size and WebP type from a file.

static	extractMetadataFromChunks ( $chunks, $filename)
	Extracts the image size and WebP type from a file based on the chunk list.

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
const	BROKEN_FILE = '0'

const	VP8X_ALPHA = 16

const	VP8X_ANIM = 2

const	VP8X_EXIF = 8

const	VP8X_ICC = 32

const	VP8X_XMP = 4

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

	transformImageMagickExt ( $image, $params)
	Transform an image using the Imagick PHP extension.

Protected Member Functions inherited from TransformationalImageHandler
	escapeMagickPath ( $path, $scene=false)
	Armour a string against ImageMagick's GetPathComponent().

	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 MediaHandler
	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	decodeLossyChunkHeader ( $header)
	Decodes a lossy chunk header.

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 Google's WebP format https://developers.google.com/speed/webp/

Definition at line 29 of file WebPHandler.php.

Member Function Documentation

◆ canAnimateThumbnail()

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

Definition at line 283 of file WebPHandler.php.

◆ canRender()

WebPHandler::canRender ( $file )

Parameters

File $file

Returns: bool False if we are unable to render this image

Reimplemented from ImageHandler.

Definition at line 260 of file WebPHandler.php.

◆ decodeExtendedChunkHeader()

static WebPHandler::decodeExtendedChunkHeader ( $header )

static

Decodes an extended chunk header.

Parameters

string $header First few bytes of the header, expected to be at least 18 bytes long

Returns: bool|array See WebPHandler::decodeHeader

Definition at line 211 of file WebPHandler.php.

References $header, VP8X_ALPHA, and VP8X_ANIM.

◆ decodeLosslessChunkHeader()

static WebPHandler::decodeLosslessChunkHeader ( $header )

static

Decodes a lossless chunk header.

Parameters

string $header First few bytes of the header, expected to be at least 13 bytes long

Returns: bool|array See WebPHandler::decodeHeader

Definition at line 186 of file WebPHandler.php.

References $header, and wfDebugLog().

◆ decodeLossyChunkHeader()

static WebPHandler::decodeLossyChunkHeader ( $header )

staticprotected

Decodes a lossy chunk header.

Parameters

string $header First few bytes of the header, expected to be at least 18 bytes long

Returns: bool|array See WebPHandler::decodeHeader

Definition at line 160 of file WebPHandler.php.

References $header, and wfDebugLog().

◆ extractMetadata()

static WebPHandler::extractMetadata ( $filename )

static

Extracts the image size and WebP type from a file.

Parameters

string $filename

Returns: array|bool Header data array with entries 'compression', 'width' and 'height', where 'compression' can be 'lossy', 'lossless', 'animated' or 'unknown'. False if file is not a valid WebP file.

Definition at line 94 of file WebPHandler.php.

References extractMetadataFromChunks(), RiffExtractor\findChunksFromFile(), and wfDebugLog().

Referenced by getMetadata(), WebPHandlerTest\testExtractMetaData(), and WebPHandlerTest\testWithFileExtractMetaData().

◆ extractMetadataFromChunks()

static WebPHandler::extractMetadataFromChunks	(	$chunks,
		$filename
	)

static

Extracts the image size and WebP type from a file based on the chunk list.

Parameters

array	$chunks	Chunks as extracted by RiffExtractor
string	$filename

Returns: array Header data array with entries 'compression', 'width' and 'height', where 'compression' can be 'lossy', 'lossless', 'animated' or 'unknown'

Definition at line 125 of file WebPHandler.php.

References as, and wfDebugLog().

Referenced by extractMetadata().

◆ getImageSize()

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

Definition at line 230 of file WebPHandler.php.

References $path, getMetadata(), and unserialize().

◆ getMetadata()

WebPHandler::getMetadata	(	$image,
		$path
	)

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

Parameters

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

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

Reimplemented from MediaHandler.

Definition at line 46 of file WebPHandler.php.

References BROKEN_FILE, extractMetadata(), and serialize().

Referenced by getImageSize().

◆ getMetadataType()

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

Definition at line 56 of file WebPHandler.php.

◆ getScalerType()

WebPHandler::getScalerType	(	$dstPath,
		$checkDstPath = `true`
	)

protected

Must use "im" for XCF.

Parameters

string	$dstPath
bool	$checkDstPath

Returns: string

Reimplemented from BitmapHandler.

Definition at line 306 of file WebPHandler.php.

◆ getThumbType()

WebPHandler::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 295 of file WebPHandler.php.

◆ isAnimatedImage()

WebPHandler::isAnimatedImage ( $image )

Parameters

File $image

Returns: bool

Reimplemented from MediaHandler.

Definition at line 271 of file WebPHandler.php.

References $image, and unserialize().

◆ isMetadataValid()

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

Definition at line 60 of file WebPHandler.php.

References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, unserialize(), and wfDebug().

◆ mustRender()

WebPHandler::mustRender ( $file )

Parameters

File $file

Returns: bool True, not all browsers support WebP

Reimplemented from TransformationalImageHandler.

Definition at line 252 of file WebPHandler.php.

Member Data Documentation

◆ BROKEN_FILE

const WebPHandler::BROKEN_FILE = '0'

Definition at line 30 of file WebPHandler.php.

Referenced by getMetadata().

◆ VP8X_ALPHA

const WebPHandler::VP8X_ALPHA = 16

Definition at line 41 of file WebPHandler.php.

Referenced by decodeExtendedChunkHeader().

◆ VP8X_ANIM

const WebPHandler::VP8X_ANIM = 2

Definition at line 44 of file WebPHandler.php.

Referenced by decodeExtendedChunkHeader().

◆ VP8X_EXIF

const WebPHandler::VP8X_EXIF = 8

Definition at line 42 of file WebPHandler.php.

◆ VP8X_ICC

const WebPHandler::VP8X_ICC = 32

Definition at line 40 of file WebPHandler.php.

◆ VP8X_XMP

const WebPHandler::VP8X_XMP = 4

Definition at line 43 of file WebPHandler.php.

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

includes/media/WebPHandler.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ canAnimateThumbnail()

◆ canRender()

◆ decodeExtendedChunkHeader()

◆ decodeLosslessChunkHeader()

◆ decodeLossyChunkHeader()

◆ extractMetadata()

◆ extractMetadataFromChunks()

◆ getImageSize()

◆ getMetadata()

◆ getMetadataType()

◆ getScalerType()

◆ getThumbType()

◆ isAnimatedImage()

◆ isMetadataValid()

◆ mustRender()

Member Data Documentation

◆ BROKEN_FILE

◆ VP8X_ALPHA

◆ VP8X_ANIM

◆ VP8X_EXIF

◆ VP8X_ICC

◆ VP8X_XMP