MediaWiki
1.23.0
|
Handler for DjVu images. More...
Public Member Functions | |
doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0) | |
getDjVuImage ( $image, $path) | |
Cache an instance of DjVuImage in an Image object, return that instance. More... | |
getImageSize ( $image, $path) | |
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... | |
getMetaTree ( $image, $gettext=false) | |
Cache a document tree for the DjVu XML metadata. 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) | |
getParamMap () | |
getScriptParams ( $params) | |
getThumbType ( $ext, $mime, $params=null) | |
Get the thumbnail extension and MIME type for a given source MIME type. More... | |
isEnabled () | |
isMetadataValid ( $image, $metadata) | |
Check if the metadata string is valid for this handler. More... | |
isMultiPage ( $file) | |
makeParamString ( $params) | |
mustRender ( $file) | |
pageCount ( $image) | |
Page count for a multi-page document, false if unsupported or unknown. More... | |
parseParamString ( $str) | |
validateParam ( $name, $value) | |
Public Member Functions inherited from ImageHandler | |
canRender ( $file) | |
getDimensionsString ( $file) | |
getImageArea ( $image) | |
Function that returns the number of pixels to be thumbnailed. More... | |
getLongDesc ( $file) | |
getScriptedTransform ( $image, $script, $params) | |
getShortDesc ( $file) | |
normaliseParams ( $image, &$params) | |
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... | |
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... | |
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... | |
isVectorized ( $file) | |
The material is vectorized and thus scaling is lossless. 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... | |
Private Member Functions | |
getUnserializedMetadata (File $file) | |
Get metadata, unserializing it if neccessary. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from MediaHandler | |
static | canRotate () |
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 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 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() |
DjVuHandler::doTransform | ( | $image, | |
$dstPath, | |||
$dstUrl, | |||
$params, | |||
$flags = 0 |
|||
) |
File | $image | |
string | $dstPath | |
string | $dstUrl | |
array | $params | |
int | $flags |
Reimplemented from MediaHandler.
Definition at line 132 of file DjVu.php.
References $flags, $params, $retval, array(), global, MediaHandler\logErrorForExternalProcess(), ImageHandler\normaliseParams(), pageCount(), MediaHandler\removeBadFile(), text, wfDebug(), wfDebugLog(), wfEscapeShellArg(), wfHostname(), wfMessage(), wfMkdirParents(), wfProfileIn(), wfProfileOut(), and wfShellExec().
DjVuHandler::getDjVuImage | ( | $image, | |
$path | |||
) |
Cache an instance of DjVuImage in an Image object, return that instance.
File | $image | |
string | $path |
Definition at line 247 of file DjVu.php.
References $path.
Referenced by getImageSize(), and getMetadata().
DjVuHandler::getImageSize | ( | $image, | |
$path | |||
) |
File | $image | |
string | $path |
Reimplemented from ImageHandler.
Definition at line 342 of file DjVu.php.
References $path, and getDjVuImage().
DjVuHandler::getMetadata | ( | $image, | |
$path | |||
) |
Get handler-specific metadata which will be saved in the img_metadata field.
File | $image | The image object, or false if there isn't one. Warning, FSFile::getPropsFromPath might pass an (object)array() instead (!) |
string | $path | The filename |
Reimplemented from MediaHandler.
Definition at line 357 of file DjVu.php.
References $path, array(), getDjVuImage(), and wfDebug().
DjVuHandler::getMetadataType | ( | $image | ) |
Get a string describing the type of metadata, for display purposes.
File | $image |
Reimplemented from MediaHandler.
DjVuHandler::getMetaTree | ( | $image, | |
$gettext = false |
|||
) |
Cache a document tree for the DjVu XML metadata.
File | $image | |
bool | $gettext | DOCUMENT (Default: false) |
Definition at line 289 of file DjVu.php.
References $e, as, getUnserializedMetadata(), isMetadataValid(), wfDebug(), wfProfileIn(), wfProfileOut(), wfRestoreWarnings(), and wfSuppressWarnings().
Referenced by getPageDimensions(), getPageText(), and pageCount().
DjVuHandler::getPageDimensions | ( | $image, | |
$page | |||
) |
Get an associative array of page dimensions Currently "width" and "height" are understood, but this might be expanded in the future.
Returns false if unknown.
It is expected that handlers for paged media (e.g. DjVuHandler) will override this method so that it gives the correct results for each specific page of the file, using the $page argument.
File | $image | |
int | $page | What page to get dimensions of |
Reimplemented from MediaHandler.
Definition at line 385 of file DjVu.php.
References array(), and getMetaTree().
DjVuHandler::getPageText | ( | $image, | |
$page | |||
) |
Reimplemented from MediaHandler.
Definition at line 407 of file DjVu.php.
References getMetaTree().
DjVuHandler::getParamMap | ( | ) |
Reimplemented from ImageHandler.
Definition at line 63 of file DjVu.php.
References array().
DjVuHandler::getScriptParams | ( | $params | ) |
array | $params |
Reimplemented from ImageHandler.
DjVuHandler::getThumbType | ( | $ext, | |
$mime, | |||
$params = null |
|||
) |
Get the thumbnail extension and MIME type for a given source MIME type.
string | $ext | Extension of original file |
string | $mime | MIME type of original file |
array | $params | Handler specific rendering parameters |
Reimplemented from MediaHandler.
|
private |
Get metadata, unserializing it if neccessary.
File | $file | The DjVu file in question |
Definition at line 265 of file DjVu.php.
References $file, wfRestoreWarnings(), and wfSuppressWarnings().
Referenced by getMetaTree().
DjVuHandler::isEnabled | ( | ) |
DjVuHandler::isMetadataValid | ( | $image, | |
$metadata | |||
) |
Check if the metadata string 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, MediaHanlder::METADATA_COMPATIBLE if metadata is old but backwards compatible (which may or may not trigger a metadata reload).
File | $image | |
array | $metadata |
Reimplemented from MediaHandler.
Definition at line 372 of file DjVu.php.
References array().
Referenced by getMetaTree().
DjVuHandler::isMultiPage | ( | $file | ) |
DjVuHandler::makeParamString | ( | $params | ) |
array | $params |
Reimplemented from ImageHandler.
Definition at line 91 of file DjVu.php.
References $params.
DjVuHandler::mustRender | ( | $file | ) |
DjVuHandler::pageCount | ( | $file | ) |
Page count for a multi-page document, false if unsupported or unknown.
File | $file |
Reimplemented from MediaHandler.
Definition at line 376 of file DjVu.php.
References getMetaTree().
Referenced by doTransform().
DjVuHandler::parseParamString | ( | $str | ) |
string | $str |
Reimplemented from ImageHandler.
Definition at line 104 of file DjVu.php.
References array().
DjVuHandler::validateParam | ( | $name, | |
$value | |||
) |