Showing content from https://doc.wikimedia.org/mediawiki-core/master/php/classSvgHandler.html below:
MediaWiki: SvgHandler Class Reference
Handler for SVG images. More...
Inherits ImageHandler.
allowRenderingByUserAgent ( $file) canAnimateThumbnail ( $file) We do not support making animated svg thumbnails.
doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0) formatMetadata ( $file, $context=false) getAvailableLanguages (File $file) Which languages (systemLanguage attribute) is supported.
getCommonMetaArray (File $file) Get an array of standard (FormatMetadata type) metadata values.
getDefaultRenderLanguage (File $file) What language to render file in if none selected.
getLongDesc ( $file) Subtitle for the image.
getMatchedLanguage ( $userPreferredLanguage, array $svgLanguages) SVG's systemLanguage matching rules state: 'The systemLanguage attribute ... [e]valuates to "true" if one of the languages indicated by user preferences exactly equals one of the languages given in the value of this parameter, or if one of the languages indicated by user preferences exactly equals a prefix of one of the languages given in the value of this parameter such that the first tag character following the prefix is "-".
getMetadataType ( $image) Get a string describing the type of metadata, for display purposes.
getParamMap () Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters.
-
Returns
-
string[]
-
Stability: stable
-
to override
-
Returns
-
string[]
getSizeAndMetadata ( $state, $filename) getThumbType ( $ext, $mime, $params=null) Get the thumbnail extension and MIME type for a given source MIME type.
isAnimatedImage ( $file) isEnabled () False if the handler is disabled for all files.
isFileMetadataValid ( $image) Check if the metadata is valid for this handler.
isVectorized ( $file) The material is vectorized and thus scaling is lossless.
makeParamString ( $params) mustRender ( $file) True if handled types cannot be displayed directly in a browser but can be rendered.
normaliseParams ( $image, &$params) parseParamString ( $str) Parse a param string made with makeParamString back into an array.
-
Parameters
-
string $str The parameter string without file name (e.g. 122px)
-
Returns
-
array|false Array of parameters or false on failure.
-
Stability: stable
-
to override
rasterize ( $srcPath, $dstPath, $width, $height, $lang=false) Transform an SVG file to PNG This function can be called outside of thumbnail contexts.
validateParam ( $name, $value) Public Member Functions inherited from ImageHandler canRender ( $file) True if the handled types can be transformed.
-
Stability: stable
-
to override
-
Parameters
-
-
Returns
-
bool
getDimensionsString ( $file) Shown in file history box on image description page.
-
Stability: stable
-
to override
-
Parameters
-
-
Returns
-
string Dimensions (plain text)
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.
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
getShortDesc ( $file) Short description.Shown on Special:Search results.Until MediaWiki 1.45, the return value was poorly documented, and some subclasses returned HTML while others returned plain text. When overriding this method, you should return safe HTML, e.g. using Message::escaped(). When calling this method, you should treat it as returning unsafe HTML, and call Sanitizer::removeSomeTags() on the result.
-
Stability: stable
-
to override
-
Parameters
-
-
Returns
-
string HTML (possibly unsafe, call
Sanitizer::removeSomeTags() on the result)
sanitizeParamsForBucketing ( $params) Returns a normalised params array for which parameters have been cleaned up for bucketing purposes.
-
Stability: stable
-
to override
-
Parameters
-
-
Returns
-
array
Public Member Functions inherited from MediaHandler canRotate () True if the handler can rotate the media.
convertMetadataVersion ( $metadata, $version=1) Convert metadata version.
filterThumbnailPurgeList (&$files, $options) Remove files from the purge list.
getContentHeaders ( $metadata) Get useful response headers for GET/HEAD requests for a file with the given metadata.
getEntireText (File $file) Get the text of the entire document.
getLength ( $file) If it's an audio file, return the length of the file.
getMetadata ( $image, $path) Get handler-specific metadata which will be saved in the img_metadata field.
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.
getSizeAndMetadataWithFallback ( $file, $path) Get the metadata array and the image size, with b/c fallback.
getTransform ( $image, $dstPath, $dstUrl, $params) Get a MediaTransformOutput object representing the transformed output.
getWarningConfig ( $file) Gets configuration for the file warning message.
isExpensiveToThumbnail ( $file) True if creating thumbnails from the file is large or otherwise resource-intensive.
isMetadataValid ( $image, $metadata) Check if the metadata string is valid for this handler.
isMultiPage ( $file) True if the type has multi-page capabilities.
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.
useSplitMetadata () If this returns true, LocalFile may split metadata up and store its constituent items separately.
verifyUpload ( $fileName) File validation hook called on upload.
static rasterizeImagickExt ( $srcPath, $dstPath, $width, $height) 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.
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.
Handler for SVG images.
Definition at line 38 of file SvgHandler.php.
◆ allowRenderingByUserAgent() SvgHandler::allowRenderingByUserAgent ( $file ) ◆ canAnimateThumbnail() SvgHandler::canAnimateThumbnail ( $file ) ◆ doTransform() SvgHandler::doTransform ( $image, $dstPath, $dstUrl, $params, $flags = 0 )
-
Parameters
-
File $image string $dstPath string $dstUrl array $params int $flags
-
Returns
-
MediaTransformError|ThumbnailImage|TransformParameterError|false
Reimplemented from MediaHandler.
Definition at line 262 of file SvgHandler.php.
References allowRenderingByUserAgent(), getLanguageFromParams(), normaliseParams(), rasterize(), validateMetadata(), wfDebugLog(), wfHostname(), wfMessage(), wfMkdirParents(), wfRandomString(), and wfTempDir().
◆ formatMetadata() SvgHandler::formatMetadata ( $file, $context = false ) ◆ getAvailableLanguages() SvgHandler::getAvailableLanguages ( File $file ) ◆ getCommonMetaArray() SvgHandler::getCommonMetaArray ( File $file )
Get an array of standard (FormatMetadata type) metadata values.
The returned data is largely the same as that from getMetadata(), but formatted in a standard, stable, handler-independent way. The idea being that some values like ImageDescription or Artist are universal and should be retrievable in a handler generic way.
The specific properties are the type of properties that can be handled by the FormatMetadata class. These values are exposed to the user via the filemetadata parser function.
Details of the response format of this function can be found at https://www.mediawiki.org/wiki/Manual:File_metadata_handling tl/dr: the response is an associative array of properties keyed by name, but the value can be complex. You probably want to call one of the FormatMetadata::flatten* functions on the property values before using them, or call FormatMetadata::getFormattedData() on the full response array, which transforms all values into prettified, human-readable text.
Subclasses overriding this function must return a value which is a valid API response fragment (all associative array keys are valid XML tagnames).
Note, if the file simply has no metadata, but the handler supports this interface, it should return an empty array, not false.
-
Stability: stable
-
to override
-
Parameters
-
-
Returns
-
array|false False if interface not supported
-
Since
-
1.23
Reimplemented from MediaHandler.
Definition at line 645 of file SvgHandler.php.
References MediaWiki\FileRepo\File\File\getMetadataArray(), and validateMetadata().
◆ getDefaultRenderLanguage() SvgHandler::getDefaultRenderLanguage ( File $file )
What language to render file in if none selected.
-
Parameters
-
-
Returns
-
string
Reimplemented from MediaHandler.
Definition at line 192 of file SvgHandler.php.
◆ getLanguageFromParams() SvgHandler::getLanguageFromParams ( array $params ) protected ◆ getLongDesc() SvgHandler::getLongDesc ( $file ) ◆ getMatchedLanguage() SvgHandler::getMatchedLanguage ( $userPreferredLanguage, array $svgLanguages )
SVG's systemLanguage matching rules state: 'The systemLanguage attribute ... [e]valuates to "true" if one of the languages indicated by user preferences exactly equals one of the languages given in the value of this parameter, or if one of the languages indicated by user preferences exactly equals a prefix of one of the languages given in the value of this parameter such that the first tag character following the prefix is "-".
'
Return the first element of $svgLanguages that matches $userPreferredLanguage
-
See also
-
https://www.w3.org/TR/SVG/struct.html#SystemLanguageAttribute
-
Parameters
-
string $userPreferredLanguage string[] $svgLanguages
-
Returns
-
string|null
Reimplemented from MediaHandler.
Definition at line 155 of file SvgHandler.php.
◆ getMetadataType() SvgHandler::getMetadataType ( $image )
Get a string describing the type of metadata, for display purposes.
-
Stability: stable
-
to override
-
Note
-
This method is currently unused.
-
Parameters
-
-
Returns
-
string|false
Reimplemented from MediaHandler.
Definition at line 501 of file SvgHandler.php.
◆ getParamMap() SvgHandler::getParamMap ( )
Get an associative array mapping magic word IDs to parameter names.Will be used by the parser to identify parameters.
-
Returns
-
string[]
-
Stability: stable
-
to override
-
Returns
-
string[]
-
Stability: stable
-
to override
-
Returns
-
string[]
Reimplemented from ImageHandler.
Definition at line 628 of file SvgHandler.php.
◆ getScriptParams() SvgHandler::getScriptParams ( $params ) protected ◆ getSizeAndMetadata() SvgHandler::getSizeAndMetadata ( $state, $filename ) ◆ getThumbType() SvgHandler::getThumbType ( $ext, $mime, $params = null )
Get the thumbnail extension and MIME type for a given source MIME type.
-
Stability: stable
-
to override
-
Parameters
-
string $ext Extension of original file string $mime MIME type of original file array | null $params Handler specific rendering parameters
-
Returns
-
array Thumbnail extension and MIME type
Reimplemented from MediaHandler.
Definition at line 435 of file SvgHandler.php.
◆ isAnimatedImage() SvgHandler::isAnimatedImage ( $file ) ◆ isEnabled() SvgHandler::isEnabled ( )
False if the handler is disabled for all files.
-
Stability: stable
-
to override
-
Returns
-
bool
Reimplemented from MediaHandler.
Definition at line 54 of file SvgHandler.php.
References wfDebug().
◆ isFileMetadataValid() SvgHandler::isFileMetadataValid ( $image )
Check if the metadata 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.
This was introduced in 1.37 to replace isMetadataValid(), which took a serialized string as a parameter. Handlers overriding this method are expected to use accessors to get the metadata out of the File. The reasons for the change were to get rid of serialization, and to allow handlers to partially load metadata with getMetadataItem(). For example a handler could just validate a version number.
-
Stability: stable
-
to override
-
Since
-
1.37
-
Parameters
-
-
Returns
-
bool|int
Reimplemented from MediaHandler.
Definition at line 505 of file SvgHandler.php.
References validateMetadata().
◆ isVectorized() SvgHandler::isVectorized ( $file )
The material is vectorized and thus scaling is lossless.
-
Stability: stable
-
to override
-
Parameters
-
-
Returns
-
bool
Reimplemented from MediaHandler.
Definition at line 97 of file SvgHandler.php.
◆ makeParamString() SvgHandler::makeParamString ( $params ) ◆ mustRender() SvgHandler::mustRender ( $file ) ◆ normaliseParams() SvgHandler::normaliseParams ( $image, & $params ) ◆ normaliseParamsInternal() SvgHandler::normaliseParamsInternal ( $image, $params ) protected
Code taken out of normaliseParams() for testability.
-
Since
-
1.33
-
Parameters
-
File $image array $params
-
Returns
-
array Modified $params
Definition at line 228 of file SvgHandler.php.
Referenced by normaliseParams().
◆ parseParamString() SvgHandler::parseParamString ( $str )
Parse a param string made with makeParamString back into an array.
-
Parameters
-
string $str The parameter string without file name (e.g. 122px)
-
Returns
-
array|false Array of parameters or false on failure.
-
Stability: stable
-
to override
-
Stability: stable
-
to override
Reimplemented from ImageHandler.
Definition at line 613 of file SvgHandler.php.
◆ rasterize() SvgHandler::rasterize ( $srcPath, $dstPath, $width, $height, $lang = false ) ◆ rasterizeImagickExt() static SvgHandler::rasterizeImagickExt ( $srcPath, $dstPath, $width, $height ) static
-
Parameters
-
string $srcPath string $dstPath int $width int $height
-
Returns
-
string|void
Definition at line 420 of file SvgHandler.php.
◆ validateMetadata() SvgHandler::validateMetadata ( $unser ) protected ◆ validateParam() SvgHandler::validateParam ( $name, $value )
-
Parameters
-
string $name Parameter name mixed $value Parameter value
-
Returns
-
bool Validity
Reimplemented from ImageHandler.
Definition at line 571 of file SvgHandler.php.
◆ visibleMetadataFields() SvgHandler::visibleMetadataFields ( ) protected
Get a list of metadata items which should be displayed when the metadata table is collapsed.
-
Stability: stable
-
to override
-
Returns
-
string[]
Reimplemented from MediaHandler.
Definition at line 518 of file SvgHandler.php.
Referenced by formatMetadata().
◆ SVG_METADATA_VERSION const SvgHandler::SVG_METADATA_VERSION = 2
Definition at line 39 of file SvgHandler.php.
The documentation for this class was generated from the following file:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4