BitmapHandler_ClientOnly Class Reference
Handler for bitmap images that will be resized by clients. More...
Inheritance diagram for BitmapHandler_ClientOnly:
Collaboration diagram for BitmapHandler_ClientOnly:
Public Member Functions | |
| doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0) | |
| normaliseParams ( $image, &$params) | |
 Public Member Functions inherited from BitmapHandler | |
| 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... | |
| escapeMagickProperty ( $s) | |
| Escape a string for ImageMagick's property input (e.g. 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... | |
| mustRender ( $file) | |
| Rerurns whether the file needs to be rendered. More... | |
| rotate ( $file, $params) | |
| Public Member Functions inherited from ImageHandler | |
| canRender ( $file) | |
| getDimensionsString ( $file) | |
| 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) | |
| getParamMap () | |
| Get an associative array mapping magic word IDs to parameter names. More... | |
| getScriptedTransform ( $image, $script, $params) | |
| getScriptParams ( $params) | |
| getShortDesc ( $file) | |
| makeParamString ( $params) | |
| Merge a parameter array into a string appropriate for inclusion in filenames. More... | |
| parseParamString ( $str) | |
| Parse a param string made with makeParamString back into an array. More... | |
| validateParam ( $name, $value) | |
| Validate a thumbnail parameter at parse time. More... | |
| validateThumbParams (&$width, &$height, $srcWidth, $srcHeight, $mimeType) | |
| Validate thumbnail parameters and fill in the correct height. 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) | |
| Get an array structure that looks like this: More... | |
| formatMetadataHelper ( $metadataArray) | |
| sorts the visible/invisible field. 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... | |
| 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... | |
| 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 ( $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 ( $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... | |
| getStreamHeaders ( $metadata) | |
| Get useful response headers for GET/HEAD requests for a file with the given metadata. 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... | |
| isAnimatedImage ( $file) | |
| The material is an image, and is animated. More... | |
| isEnabled () | |
| False if the handler is disabled for all files. 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) | |
| 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... | |
| verifyUpload ( $fileName) | |
| File validation hook called on upload. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from BitmapHandler | |
| static | autoRotateEnabled () |
| static | canRotate () |
| Returns whether the current scaler supports rotation (im and gd do) More... | |
| static | imageJpegWrapper ( $dst_image, $thumbPath) |
| 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 getShortDesc if there is no handler registered for file. More... | |
| static | getGeneralShortDesc ( $file) |
| Long description. More... | |
| static | getHandler ( $type) |
| Get a MediaHandler for a given MIME type from the instance cache. More... | |
| static | getMetadataVersion () |
| Get metadata version. More... | |
| Public Attributes inherited from MediaHandler | |
| const | MAX_ERR_LOG_SIZE = 65535 |
| Max length of error logged by logErrorForExternalProcess() More... | |
| const | METADATA_BAD = false |
| const | METADATA_COMPATIBLE = 2 |
| const | METADATA_GOOD = true |
| const | TRANSFORM_LATER = 1 |
| Protected Member Functions inherited from BitmapHandler | |
| escapeMagickPath ( $path, $scene=false) | |
| Armour a string against ImageMagick's GetPathComponent(). 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... | |
| 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 MediaHandler | |
| logErrorForExternalProcess ( $retval, $err, $cmd) | |
| Log an error that occurred in an external process. More... | |
| visibleMetadataFields () | |
| Get a list of metadata items which should be displayed when the metadata table is collapsed. More... | |
| Static Protected Member Functions inherited from BitmapHandler | |
| static | getScalerType ( $dstPath, $checkDstPath=true) |
| Returns which scaler type should be used. More... | |
| 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... | |
| Static Protected Attributes inherited from MediaHandler | |
| static | $handlers = array() |
Detailed Description
Handler for bitmap images that will be resized by clients.
This is not used by default but can be assigned to some image types using $wgMediaHandlers.
Definition at line 32 of file Bitmap_ClientOnly.php.
Member Function Documentation
◆ doTransform()
| BitmapHandler_ClientOnly::doTransform | ( | $image, | |
| $dstPath, | |||
| $dstUrl, | |||
| $params, | |||
$flags = 0 |
|||
| ) |
- Parameters
-
File $image string $dstPath string $dstUrl array $params int $flags
- Returns
- ThumbnailImage|TransformParameterError
Reimplemented from BitmapHandler.
Definition at line 50 of file Bitmap_ClientOnly.php.
References $params, and normaliseParams().
◆ normaliseParams()
| BitmapHandler_ClientOnly::normaliseParams | ( | $image, | |
| & | $params | ||
| ) |
- Parameters
-
$image File $params
- Returns
- bool
Reimplemented from BitmapHandler.
Definition at line 38 of file Bitmap_ClientOnly.php.
References $params, and ImageHandler\normaliseParams().
Referenced by doTransform().
The documentation for this class was generated from the following file:
- includes/media/Bitmap_ClientOnly.php
