MediaWiki  master
BitmapHandler Class Reference

Generic handler for bitmap images. More...

Inheritance diagram for BitmapHandler:
Collaboration diagram for BitmapHandler:

Public Member Functions

 autoRotateEnabled ()
 
 canRotate ()
 Returns whether the current scaler supports rotation (im and gd do) 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
Stability: stable
to override
More...
 
 normaliseParams ( $image, &$params)
 
 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
More...
 
 rotate ( $file, $params)
 
 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
More...
 
- Public Member Functions inherited from TransformationalImageHandler
 doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
 Create a thumbnail. More...
 
 extractPreRotationDimensions ( $params, $rotation)
 Extracts the width/height if the image will be scaled before rotating. More...
 
 getMediaTransformError ( $params, $errMsg)
 Get a MediaTransformError with error 'thumbnail_error'. More...
 
 isImageAreaOkForThumbnaling ( $file, &$params)
 Check if the file is smaller than the maximum image area for thumbnailing. More...
 
 mustRender ( $file)
 Returns whether the file needs to be rendered. More...
 
- Public Member Functions inherited from ImageHandler
 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...
 
 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...
 
- Public Member Functions inherited from MediaHandler
 canAnimateThumbnail ( $file)
 If the material is animated, we can animate the thumbnail. More...
 
 convertMetadataVersion ( $metadata, $version=1)
 Convert metadata version. 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...
 
 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...
 

Static Public Member Functions

static imageJpegWrapper ( $dst_image, $thumbPath, $quality=null)
 Callback for transformGd when transforming jpeg images. More...
 
- 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...
 

Protected Member Functions

 getScalerType ( $dstPath, $checkDstPath=true)
 Returns which scaler type should be used. More...
 
 imageMagickSubsampling ( $pixelFormat)
 Get ImageMagick subsampling factors for the target JPEG pixel format. More...
 
 transformCustom ( $image, $params)
 Transform an image using a custom command. More...
 
 transformGd ( $image, $params)
 Transform an image using the built in GD library. More...
 
 transformImageMagick ( $image, $params)
 Transform an image using ImageMagick. More...
 
 transformImageMagickExt ( $image, $params)
 Transform an image using the Imagick PHP extension. More...
 
- Protected Member Functions inherited from TransformationalImageHandler
 escapeMagickInput ( $path, $scene=false)
 Escape a string for ImageMagick's input filenames. More...
 
 escapeMagickOutput ( $path, $scene=false)
 Escape a string for ImageMagick's output filename. More...
 
 escapeMagickPath ( $path, $scene=false)
 Armour a string against ImageMagick's GetPathComponent(). More...
 
 escapeMagickProperty ( $s)
 Escape a string for ImageMagick's property input (e.g. More...
 
 getClientScalingThumbnailImage ( $image, $scalerParams)
 Get a ThumbnailImage that respresents an image that will be scaled client side. More...
 
 getMagickVersion ()
 Retrieve the version of the installed ImageMagick You can use PHPs version_compare() to use this value Value is cached for one hour. More...
 
 getThumbnailSource ( $file, $params)
 Get the source file for the transform. More...
 
- Protected Member Functions inherited from ImageHandler
 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...
 

Additional Inherited Members

- 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

Generic handler for bitmap images.

Stability: stable
to extend

Definition at line 32 of file BitmapHandler.php.

Member Function Documentation

◆ autoRotateEnabled()

BitmapHandler::autoRotateEnabled ( )
See also
$wgEnableAutoRotation
Stability: stable
to override
Returns
bool Whether auto rotation is enabled

Reimplemented from TransformationalImageHandler.

Definition at line 549 of file BitmapHandler.php.

References $wgEnableAutoRotation, and canRotate().

Referenced by ExifBitmapHandler\applyExifRotation(), and ExifBitmapHandler\getRotation().

◆ canRotate()

BitmapHandler::canRotate ( )

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

Stability: stable
to override
Returns
bool

Reimplemented from TransformationalImageHandler.

Definition at line 525 of file BitmapHandler.php.

References getScalerType().

Referenced by autoRotateEnabled().

◆ getScalerType()

BitmapHandler::getScalerType (   $dstPath,
  $checkDstPath = true 
)
protected

Returns which scaler type should be used.

Creates parent directories for $dstPath and returns 'client' on error

Stability: stable
to override
Parameters
string$dstPath
bool$checkDstPath
Returns
string|callable One of client, im, custom, gd, imext or an array( object, method )

Reimplemented from TransformationalImageHandler.

Reimplemented in XCFHandler, and WebPHandler.

Definition at line 43 of file BitmapHandler.php.

References $wgCustomConvertCommand, $wgUseImageMagick, and $wgUseImageResize.

Referenced by canRotate(), and rotate().

◆ imageJpegWrapper()

static BitmapHandler::imageJpegWrapper (   $dst_image,
  $thumbPath,
  $quality = null 
)
static

Callback for transformGd when transforming jpeg images.

Parameters
resource$dst_imageImage resource of the original image
string$thumbPathFile path to write the thumbnail image to
int | null$qualityQuality of the thumbnail from 1-100, or null to use default quality.

Definition at line 508 of file BitmapHandler.php.

References $wgJpegQuality.

◆ imageMagickSubsampling()

BitmapHandler::imageMagickSubsampling (   $pixelFormat)
protected

Get ImageMagick subsampling factors for the target JPEG pixel format.

Parameters
string$pixelFormatone of 'yuv444', 'yuv422', 'yuv420'
Returns
string[] List of sampling factors

Definition at line 130 of file BitmapHandler.php.

Referenced by transformImageMagick(), and transformImageMagickExt().

◆ makeParamString()

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

Stability: stable
to override

Reimplemented from ImageHandler.

Reimplemented in JpegHandler.

Definition at line 70 of file BitmapHandler.php.

References $res.

◆ normaliseParams()

BitmapHandler::normaliseParams (   $image,
$params 
)
Stability: stable
to override
Parameters
File$image
array&$params
Returns
bool

Reimplemented from TransformationalImageHandler.

Reimplemented in JpegHandler, and BitmapHandler_ClientOnly.

Definition at line 111 of file BitmapHandler.php.

References $wgMaxInterlacingAreas, and ImageHandler\getImageArea().

◆ parseParamString()

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

Stability: stable
to override

Reimplemented from ImageHandler.

Reimplemented in JpegHandler.

Definition at line 83 of file BitmapHandler.php.

◆ rotate()

BitmapHandler::rotate (   $file,
  $params 
)
Stability: stable
to override
Parameters
File$file
array$paramsRotate parameters. 'rotation' clockwise rotation in degrees, allowed are multiples of 90
Since
1.21
Returns
bool|MediaTransformError

Reimplemented from TransformationalImageHandler.

Reimplemented in JpegHandler.

Definition at line 568 of file BitmapHandler.php.

References $file, $wgImageMagickConvertCommand, TransformationalImageHandler\escapeMagickInput(), TransformationalImageHandler\escapeMagickOutput(), MediaHandler\getRotation(), getScalerType(), MediaHandler\logErrorForExternalProcess(), wfDebug(), and wfShellExecWithStderr().

◆ transformCustom()

BitmapHandler::transformCustom (   $image,
  $params 
)
protected

Transform an image using a custom command.

Parameters
File$imageFile associated with this thumbnail
array$paramsArray with scaler params
Returns
MediaTransformError|false Error object if error occurred, false (=no error) otherwise

Reimplemented from TransformationalImageHandler.

Definition at line 373 of file BitmapHandler.php.

References $wgCustomConvertCommand, TransformationalImageHandler\getMediaTransformError(), MediaHandler\logErrorForExternalProcess(), wfDebug(), and wfShellExecWithStderr().

◆ transformGd()

BitmapHandler::transformGd (   $image,
  $params 
)
protected

Transform an image using the built in GD library.

Parameters
File$imageFile associated with this thumbnail
array$paramsArray with scaler params
Returns
MediaTransformError|bool Error object if error occurred, false (=no error) otherwise

Reimplemented from TransformationalImageHandler.

Definition at line 405 of file BitmapHandler.php.

References TransformationalImageHandler\extractPreRotationDimensions(), TransformationalImageHandler\getMediaTransformError(), MediaHandler\getRotation(), wfDebug(), and wfMessage().

◆ transformImageMagick()

BitmapHandler::transformImageMagick (   $image,
  $params 
)
protected

◆ transformImageMagickExt()

BitmapHandler::transformImageMagickExt (   $image,
  $params 
)
protected

Transform an image using the Imagick PHP extension.

Parameters
File$imageFile associated with this thumbnail
array$paramsArray with scaler params
Returns
MediaTransformError|false Error object if error occurred, false (=no error) otherwise

Reimplemented from TransformationalImageHandler.

Definition at line 283 of file BitmapHandler.php.

References $wgJpegPixelFormat, $wgJpegQuality, $wgMaxAnimatedGifArea, $wgSharpenParameter, $wgSharpenReductionThreshold, TransformationalImageHandler\extractPreRotationDimensions(), ImageHandler\getImageArea(), TransformationalImageHandler\getMediaTransformError(), MediaHandler\getRotation(), imageMagickSubsampling(), MediaHandler\isAnimatedImage(), and wfDebug().

◆ validateParam()

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

Stability: stable
to override

Reimplemented from ImageHandler.

Reimplemented in JpegHandler.

Definition at line 97 of file BitmapHandler.php.


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