MediaWiki  master
ImageHandler Class Reference

Media handler abstract base class for images. More...

Inheritance diagram for ImageHandler:
Collaboration diagram for ImageHandler:

Public Member Functions

 canRender ( $file)
 True if the handled types can be transformed.
Stability: stable
to override
Parameters
File$file
Returns
bool
More...
 
 getDimensionsString ( $file)
 Shown in file history box on image description page.
Stability: stable
to override
Parameters
File$file
Returns
string Dimensions
More...
 
 getImageArea ( $image)
 Function that returns the number of pixels to be thumbnailed. More...
 
 getImageSize ( $image, $path)
 Get an image size array like that returned by getimagesize(), or false if it can't be determined. More...
 
 getLongDesc ( $file)
 Long description.Shown under image on image description page surounded by ().
Stability: stable
to override
Parameters
File$file
Returns
string
More...
 
 getParamMap ()
 Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters. More...
 
 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().
Stability: stable
to override
Parameters
File$image
string$script
array$params
Returns
ThumbnailImage|false
More...
 
 getShortDesc ( $file)
 Short description.Shown on Special:Search results.
Stability: stable
to override
Parameters
File$file
Returns
string
More...
 
 getSizeAndMetadata ( $state, $path)
 Get image size information and metadata array. More...
 
 makeParamString ( $params)
 Merge a parameter array into a string appropriate for inclusion in filenames.
Parameters
array$paramsArray of parameters that have been through normaliseParams.
Returns
string
More...
 
 normaliseParams ( $image, &$params)
 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
More...
 
 parseParamString ( $str)
 Parse a param string made with makeParamString back into an array.
Parameters
string$strThe parameter string without file name (e.g. 122px)
Returns
array|bool Array of parameters or false on failure.
More...
 
 sanitizeParamsForBucketing ( $params)
 Returns a normalised params array for which parameters have been cleaned up for bucketing purposes.
Stability: stable
to override
Parameters
array$params
Returns
array
More...
 
 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
More...
 
- Public Member Functions inherited from MediaHandler
 canAnimateThumbnail ( $file)
 If the material is animated, we can animate the thumbnail. More...
 
 canRotate ()
 True if the handler can rotate the media. More...
 
 convertMetadataVersion ( $metadata, $version=1)
 Convert metadata version. More...
 
 doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
 Get a MediaTransformOutput object representing the transformed output. More...
 
 filterThumbnailPurgeList (&$files, $options)
 Remove files from the purge list. More...
 
 formatMetadata ( $image, $context=false)
 Get an array structure that looks like this: More...
 
 getAvailableLanguages (File $file)
 Get list of languages file can be viewed in. More...
 
 getCommonMetaArray (File $file)
 Get an array of standard (FormatMetadata type) metadata values. More...
 
 getContentHeaders ( $metadata)
 Get useful response headers for GET/HEAD requests for a file with the given metadata. More...
 
 getDefaultRenderLanguage (File $file)
 On file types that support renderings in multiple languages, which language is used by default if unspecified. More...
 
 getEntireText (File $file)
 Get the text of the entire document. More...
 
 getLength ( $file)
 If its an audio file, return the length of the file. More...
 
 getMatchedLanguage ( $userPreferredLanguage, array $availableLanguages)
 When overridden in a descendant class, returns a language code most suiting. More...
 
 getMetadata ( $image, $path)
 Get handler-specific metadata which will be saved in the img_metadata field. More...
 
 getMetadataType ( $image)
 Get a string describing the type of metadata, for display purposes. More...
 
 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. More...
 
 getPageText (File $image, $page)
 Generic getter for text layer. More...
 
 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. More...
 
 getSizeAndMetadataWithFallback ( $file, $path)
 Get the metadata array and the image size, with b/c fallback. More...
 
 getThumbType ( $ext, $mime, $params=null)
 Get the thumbnail extension and MIME type for a given source MIME type. More...
 
 getTransform ( $image, $dstPath, $dstUrl, $params)
 Get a MediaTransformOutput object representing the transformed output. More...
 
 getWarningConfig ( $file)
 Gets configuration for the file warning message. More...
 
 isAnimatedImage ( $file)
 The material is an image, and is animated. More...
 
 isEnabled ()
 False if the handler is disabled for all files. More...
 
 isExpensiveToThumbnail ( $file)
 True if creating thumbnails from the file is large or otherwise resource-intensive. More...
 
 isFileMetadataValid ( $image)
 Check if the metadata is valid for this handler. More...
 
 isMetadataValid ( $image, $metadata)
 Check if the metadata string is valid for this handler. More...
 
 isMultiPage ( $file)
 True if the type has multi-page capabilities. More...
 
 isVectorized ( $file)
 The material is vectorized and thus scaling is lossless. More...
 
 mustRender ( $file)
 True if handled types cannot be displayed directly in a browser but can be rendered. More...
 
 pageCount (File $file)
 Page count for a multi-page document, false if unsupported or unknown. More...
 
 parserTransformHook ( $parser, $file)
 Modify the parser object post-transform. More...
 
 removeBadFile ( $dstPath, $retval=0)
 Check for zero-sized thumbnails. More...
 
 supportsBucketing ()
 Returns whether or not this handler supports the chained generation of thumbnails according to buckets. More...
 
 useSplitMetadata ()
 If this returns true, LocalFile may split metadata up and store its constituent items separately. More...
 
 verifyUpload ( $fileName)
 File validation hook called on upload. More...
 

Protected Member Functions

 getScriptParams ( $params)
 
- Protected Member Functions inherited from MediaHandler
 formatMetadataHelper ( $metadataArray, $context=false)
 sorts the visible/invisible field. More...
 
 formatTag (string $key, $vals, $context=false)
 Override default formatting for the given metadata field. More...
 
 hasMostDerivedMethod ( $name)
 Check whether a method is implemented in the most derived class. More...
 
 logErrorForExternalProcess ( $retval, $err, $cmd)
 Log an error that occurred in an external process. More...
 
 useLegacyMetadata ()
 If this returns true, the new method getSizeAndMetadata() will not be called. More...
 
 visibleMetadataFields ()
 Get a list of metadata items which should be displayed when the metadata table is collapsed. More...
 

Private Member Functions

 validateThumbParams (&$width, &$height, $srcWidth, $srcHeight, $mimeType)
 Validate thumbnail parameters and fill in the correct height. More...
 

Additional Inherited Members

- 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. More...
 
static getGeneralLongDesc ( $file)
 Used instead of getLongDesc if there is no handler registered for file. More...
 
static getGeneralShortDesc ( $file)
 Used instead of getShortDesc if there is no handler registered for file. More...
 
static getHandler ( $type)
 Get a MediaHandler for a given MIME type from the instance cache. More...
 
static getMetadataVersion ()
 Get metadata version. More...
 
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. More...
 
- 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. More...
 

Detailed Description

Media handler abstract base class for images.

Stability: stable
to extend

Definition at line 31 of file ImageHandler.php.

Member Function Documentation

◆ canRender()

ImageHandler::canRender (   $file)

True if the handled types can be transformed.

Stability: stable
to override
Parameters
File$file
Returns
bool

Stability: stable
to override
Parameters
File$file
Returns
bool

Reimplemented from MediaHandler.

Reimplemented in XCFHandler, WebPHandler, and TiffHandler.

Definition at line 38 of file ImageHandler.php.

References $file.

◆ getDimensionsString()

ImageHandler::getDimensionsString (   $file)

Shown in file history box on image description page.

Stability: stable
to override
Parameters
File$file
Returns
string Dimensions

Stability: stable
to override
Parameters
File$file
Returns
string

Reimplemented from MediaHandler.

Definition at line 304 of file ImageHandler.php.

References $file, and wfMessage().

◆ getImageArea()

ImageHandler::getImageArea (   $image)

Function that returns the number of pixels to be thumbnailed.

Intended for animated GIFs to multiply by the number of frames.

If the file doesn't support a notion of "area" return 0.

Stability: stable
to override
Parameters
File$image
Returns
int

Reimplemented in GIFHandler.

Definition at line 258 of file ImageHandler.php.

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

◆ getImageSize()

ImageHandler::getImageSize (   $image,
  $path 
)

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.
Deprecated:
since 1.37, override getSizeAndMetadata instead
Parameters
File | FSFile$imageThe image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an FSFile instead of File (!)
string$pathThe filename
Returns
array|false Follow the format of PHP getimagesize() internal function. See https://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". Returns false on failure.

Reimplemented from MediaHandler.

Definition at line 223 of file ImageHandler.php.

References $path.

◆ getLongDesc()

ImageHandler::getLongDesc (   $file)

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

Stability: stable
to override
Parameters
File$file
Returns
string

Stability: stable
to override
Parameters
File$file
Returns
string

Reimplemented from MediaHandler.

Reimplemented in PNGHandler, GIFHandler, and SvgHandler.

Definition at line 283 of file ImageHandler.php.

References $file, and wfMessage().

◆ getParamMap()

ImageHandler::getParamMap ( )

Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters.

Stability: stable
to override
Returns
string[]

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, and DjVuHandler.

Definition at line 47 of file ImageHandler.php.

◆ getScriptedTransform()

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

Stability: stable
to override
Parameters
File$image
string$script
array$params
Returns
ThumbnailImage|false

Stability: stable
to override
Parameters
File$image
string$script
array$params
Returns
bool|MediaTransformOutput

Reimplemented from MediaHandler.

Definition at line 212 of file ImageHandler.php.

References getScriptParams(), normaliseParams(), and wfAppendQuery().

◆ getScriptParams()

ImageHandler::getScriptParams (   $params)
protected

Stability: stable
to override

Reimplemented in SvgHandler, JpegHandler, and DjVuHandler.

Definition at line 94 of file ImageHandler.php.

Referenced by getScriptedTransform().

◆ getShortDesc()

ImageHandler::getShortDesc (   $file)

Short description.Shown on Special:Search results.

Stability: stable
to override
Parameters
File$file
Returns
string

Stability: stable
to override
Parameters
File$file
Returns
string

Reimplemented from MediaHandler.

Definition at line 268 of file ImageHandler.php.

References $file, $wgLang, and wfMessage().

◆ getSizeAndMetadata()

ImageHandler::getSizeAndMetadata (   $state,
  $path 
)

Get image size information and metadata array.

If this returns null, the caller will fall back to getImageSize() and getMetadata().

If getImageSize() or getMetadata() are implemented in the most derived class, they will be used instead of this function. To override this behaviour, override useLegacyMetadata().

Stability: stable
to override
Since
1.37
Parameters
MediaHandlerState$stateAn object for saving process-local state. This is normally a File object which will be passed back to other MediaHandler methods like pageCount(), if they are called in the same request. The handler can use this object to save its state.
string$pathThe filename
Returns
array|null Null to fall back to getImageSize(), or an array with the following keys. All keys are optional.
  • width: The width. If multipage, return the first page width. (optional)
  • height: The height. If multipage, return the first page height. (optional)
  • bits: The number of bits for each color (optional)
  • metadata: A JSON-serializable array of metadata (optional)

Reimplemented from MediaHandler.

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

Definition at line 231 of file ImageHandler.php.

References $path.

◆ makeParamString()

ImageHandler::makeParamString (   $params)

Merge a parameter array into a string appropriate for inclusion in filenames.

Parameters
array$paramsArray of parameters that have been through normaliseParams.
Returns
string

Stability: stable
to override

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, JpegHandler, DjVuHandler, and BitmapHandler.

Definition at line 63 of file ImageHandler.php.

◆ normaliseParams()

ImageHandler::normaliseParams (   $image,
$params 
)

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

Stability: stable
to override
Parameters
File$image
array&$params
Returns
bool

Reimplemented from MediaHandler.

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

Definition at line 105 of file ImageHandler.php.

References MediaHandler\fitBoxWidth(), File\scaleHeight(), and validateThumbParams().

Referenced by DjVuHandler\doTransform(), getScriptedTransform(), and BitmapHandler_ClientOnly\normaliseParams().

◆ parseParamString()

ImageHandler::parseParamString (   $str)

Parse a param string made with makeParamString back into an array.

Parameters
string$strThe parameter string without file name (e.g. 122px)
Returns
array|bool Array of parameters or false on failure.

Stability: stable
to override

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, JpegHandler, DjVuHandler, and BitmapHandler.

Definition at line 81 of file ImageHandler.php.

◆ sanitizeParamsForBucketing()

ImageHandler::sanitizeParamsForBucketing (   $params)

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

Stability: stable
to override
Parameters
array$params
Returns
array

Stability: stable
to override

Reimplemented from MediaHandler.

Reimplemented in JpegHandler.

Definition at line 319 of file ImageHandler.php.

◆ validateParam()

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

Stability: stable
to override

Reimplemented from MediaHandler.

Reimplemented in SvgHandler, JpegHandler, DjVuHandler, and BitmapHandler.

Definition at line 55 of file ImageHandler.php.

◆ validateThumbParams()

ImageHandler::validateThumbParams ( $width,
$height,
  $srcWidth,
  $srcHeight,
  $mimeType 
)
private

Validate thumbnail parameters and fill in the correct height.

Parameters
int&$widthSpecified width (input/output)
int&$heightHeight (output only)
int$srcWidthWidth of the source image
int$srcHeightHeight of the source image
string$mimeTypeUnused
Returns
bool False to indicate that an error should be returned to the user.

Definition at line 181 of file ImageHandler.php.

References File\scaleHeight(), and wfDebug().

Referenced by normaliseParams().


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