[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/media/ -> SVG.php (summary)

Handler for SVG images. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 554 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SvgHandler:: (26 methods):
  isEnabled()
  mustRender()
  isVectorized()
  isAnimatedImage()
  getAvailableLanguages()
  getDefaultRenderLanguage()
  canAnimateThumbnail()
  normaliseParams()
  doTransform()
  rasterize()
  rasterizeImagickExt()
  getImageSize()
  getThumbType()
  getLongDesc()
  getMetadata()
  unpackMetadata()
  getMetadataType()
  isMetadataValid()
  visibleMetadataFields()
  formatMetadata()
  validateParam()
  makeParamString()
  parseParamString()
  getParamMap()
  getScriptParams()
  getCommonMetaArray()


Class: SvgHandler  - X-Ref

Handler for SVG images.

isEnabled()   X-Ref
No description

mustRender( $file )   X-Ref
No description

isVectorized( $file )   X-Ref
No description

isAnimatedImage( $file )   X-Ref

param: File $file
return: bool

getAvailableLanguages( File $file )   X-Ref
Which languages (systemLanguage attribute) is supported.

param: File $file
return: array Array of language codes, or empty if no language switching supported.

getDefaultRenderLanguage( File $file )   X-Ref
What language to render file in if none selected.

param: File $file
return: string Language code.

canAnimateThumbnail( $file )   X-Ref
We do not support making animated svg thumbnails

param: File $file
return: bool

normaliseParams( $image, &$params )   X-Ref

param: File $image
param: array $params
return: bool

doTransform( $image, $dstPath, $dstUrl, $params, $flags = 0 )   X-Ref

param: File $image
param: string $dstPath
param: string $dstUrl
param: array $params
param: int $flags
return: bool|MediaTransformError|ThumbnailImage|TransformParameterError

rasterize( $srcPath, $dstPath, $width, $height, $lang = false )   X-Ref
Transform an SVG file to PNG
This function can be called outside of thumbnail contexts

param: string $srcPath
param: string $dstPath
param: string $width
param: string $height
param: bool|string $lang Language code of the language to render the SVG in
return: bool|MediaTransformError

rasterizeImagickExt( $srcPath, $dstPath, $width, $height )   X-Ref
No description

getImageSize( $file, $path, $metadata = false )   X-Ref

param: File $file
param: string $path Unused
param: bool|array $metadata
return: array

getThumbType( $ext, $mime, $params = null )   X-Ref
No description

getLongDesc( $file )   X-Ref
Subtitle for the image. Different from the base
class so it can be denoted that SVG's have
a "nominal" resolution, and not a fixed one,
as well as so animation can be denoted.

param: File $file
return: string

getMetadata( $file, $filename )   X-Ref

param: File $file
param: string $filename
return: string Serialised metadata

unpackMetadata( $metadata )   X-Ref
No description

getMetadataType( $image )   X-Ref
No description

isMetadataValid( $image, $metadata )   X-Ref
No description

visibleMetadataFields()   X-Ref
No description

formatMetadata( $file )   X-Ref

param: File $file
return: array|bool

validateParam( $name, $value )   X-Ref

param: string $name Parameter name
param: mixed $value Parameter value
return: bool Validity

makeParamString( $params )   X-Ref

param: array $params Name=>value pairs of parameters
return: string Filename to use

parseParamString( $str )   X-Ref
No description

getParamMap()   X-Ref
No description

getScriptParams( $params )   X-Ref

param: array $params
return: array

getCommonMetaArray( File $file )   X-Ref
No description



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1