MediaWiki  1.30.0
PdfHandler Class Reference

Copyright © 2007 Martin Seidel (Xarax) jodel.nosp@m.di@g.nosp@m.mx.de More...

Inheritance diagram for PdfHandler:
Collaboration diagram for PdfHandler:

Public Member Functions

 doTransform ( $image, $dstPath, $dstUrl, $params, $flags=0)
 
 formatMetadata ( $image, $context=false)
 
 getImageSize ( $image, $path)
 
 getMetaArray ( $image)
 
 getMetadata ( $image, $path)
 
 getPageDimensions (File $image, $page)
 
 getPageText (File $image, $page)
 
 getParamMap ()
 
 getPdfImage ( $image, $path)
 
 getScriptParams ( $params)
 
 getThumbType ( $ext, $mime, $params=null)
 
 getWarningConfig ( $file)
 Adds a warning about PDFs being potentially dangerous to the file page. More...
 
 isEnabled ()
 
 isMetadataValid ( $image, $metadata)
 
 isMultiPage ( $file)
 
 makeParamString ( $params)
 
 mustRender ( $file)
 
 pageCount (File $image)
 
 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)
 
 sanitizeParamsForBucketing ( $params)
 Returns a normalised params array for which parameters have been cleaned up for bucketing purposes. 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...
 
 canRotate ()
 True if the handler can rotate the media. More...
 
 convertMetadataVersion ( $metadata, $version=1)
 Convert metadata version. More...
 
 filterThumbnailPurgeList (&$files, $options)
 Remove files from the purge list. More...
 
 formatMetadataHelper ( $metadataArray, $context=false)
 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...
 
 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...
 
 getMetadataType ( $image)
 Get a string describing the type of metadata, for display purposes. 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)
 
 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...
 
 isExpensiveToThumbnail ( $file)
 True if creating thumbnails from the file is large or otherwise resource-intensive. 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...
 
 supportsBucketing ()
 Returns whether or not this handler supports the chained generation of thumbnails according to buckets. More...
 
 verifyUpload ( $fileName)
 File validation hook called on upload. More...
 

Static Public Member Functions

static registerWarningModule (&$resourceLoader)
 Register a module with the warning messages in it. 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...
 

Static Public Attributes

static $messages
 

Protected Member Functions

 doThumbError ( $width, $height, $msg)
 
 getDimensionInfo (File $file)
 
- 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...
 

Additional Inherited Members

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

Copyright © 2007 Martin Seidel (Xarax) jodel.nosp@m.di@g.nosp@m.mx.de

Inspired by djvuhandler from Tim Starling Modified and written by Xarax

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.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition at line 24 of file PdfHandler_body.php.

Member Function Documentation

◆ doThumbError()

PdfHandler::doThumbError (   $width,
  $height,
  $msg 
)
protected
Parameters
$width
$height
$msg
Returns
MediaTransformError

Definition at line 133 of file PdfHandler_body.php.

References text, and wfMessage().

Referenced by doTransform().

◆ doTransform()

PdfHandler::doTransform (   $image,
  $dstPath,
  $dstUrl,
  $params,
  $flags = 0 
)
Parameters
$imageFile
$dstPathstring
$dstUrlstring
$paramsarray
$flagsint
Returns
MediaTransformError|MediaTransformOutput|ThumbnailImage|TransformParameterError

Reimplemented from MediaHandler.

Definition at line 146 of file PdfHandler_body.php.

References $flags, $image, $params, $retval, doThumbError(), PoolCounterWork\execute(), global, ImageHandler\normaliseParams(), pageCount(), MediaHandler\removeBadFile(), use, wfDebug(), wfDebugLog(), wfEscapeShellArg(), wfHostname(), wfMkdirParents(), and wfShellExecWithStderr().

◆ formatMetadata()

PdfHandler::formatMetadata (   $image,
  $context = false 
)
Parameters
$imageFile
bool | IContextSource$contextContext to use (optional)
Returns
bool|array

Reimplemented from MediaHandler.

Definition at line 333 of file PdfHandler_body.php.

References $context, $image, captcha-old\count, MediaHandler\formatMetadataHelper(), unserialize(), wfRestoreWarnings(), and wfSuppressWarnings().

◆ getDimensionInfo()

PdfHandler::getDimensionInfo ( File  $file)
protected

◆ getImageSize()

PdfHandler::getImageSize (   $image,
  $path 
)
Parameters
$imageFile
$pathstring
Returns
array|bool

Reimplemented from ImageHandler.

Definition at line 284 of file PdfHandler_body.php.

References $image, $path, and getPdfImage().

◆ getMetaArray()

PdfHandler::getMetaArray (   $image)
Parameters
$imageFile
Returns
bool

Definition at line 251 of file PdfHandler_body.php.

References $image, PoolCounterWork\execute(), isMetadataValid(), unserialize(), use, wfDebug(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by getDimensionInfo(), and getPageText().

◆ getMetadata()

PdfHandler::getMetadata (   $image,
  $path 
)
Parameters
$imageFile
$pathstring
Returns
string

Reimplemented from MediaHandler.

Definition at line 310 of file PdfHandler_body.php.

References $image, $path, getPdfImage(), and serialize().

◆ getPageDimensions()

PdfHandler::getPageDimensions ( File  $image,
  $page 
)
Parameters
$imageFile
$pageint
Returns
array|bool

Reimplemented from MediaHandler.

Definition at line 369 of file PdfHandler_body.php.

References getDimensionInfo().

◆ getPageText()

PdfHandler::getPageText ( File  $image,
  $page 
)
Parameters
$imageFile
$pageint
Returns
bool

Reimplemented from MediaHandler.

Definition at line 409 of file PdfHandler_body.php.

References getMetaArray().

◆ getParamMap()

PdfHandler::getParamMap ( )
Returns
array

Reimplemented from ImageHandler.

Definition at line 120 of file PdfHandler_body.php.

◆ getPdfImage()

PdfHandler::getPdfImage (   $image,
  $path 
)
Parameters
$imageFile
$pathstring
Returns
PdfImage

Definition at line 235 of file PdfHandler_body.php.

References $image, and $path.

Referenced by getImageSize(), and getMetadata().

◆ getScriptParams()

PdfHandler::getScriptParams (   $params)
Parameters
$paramsarray
Returns
array

Reimplemented from ImageHandler.

Definition at line 110 of file PdfHandler_body.php.

References $params.

◆ getThumbType()

PdfHandler::getThumbType (   $ext,
  $mime,
  $params = null 
)
Parameters
$ext
$mimestring
$paramsnull
Returns
array

Reimplemented from MediaHandler.

Definition at line 294 of file PdfHandler_body.php.

References $mime, global, and MimeMagic\singleton().

◆ getWarningConfig()

PdfHandler::getWarningConfig (   $file)

Adds a warning about PDFs being potentially dangerous to the file page.

Multiple messages with this base will be used.

Parameters
File$file
Returns
array

Reimplemented from MediaHandler.

Definition at line 423 of file PdfHandler_body.php.

References $messages.

◆ isEnabled()

PdfHandler::isEnabled ( )
Returns
bool

Reimplemented from MediaHandler.

Definition at line 35 of file PdfHandler_body.php.

References global, and wfDebug().

◆ isMetadataValid()

PdfHandler::isMetadataValid (   $image,
  $metadata 
)
Parameters
$imageFile
$metadatastring
Returns
bool

Reimplemented from MediaHandler.

Definition at line 319 of file PdfHandler_body.php.

References MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, MediaHandler\METADATA_GOOD, and serialize().

Referenced by getMetaArray().

◆ isMultiPage()

PdfHandler::isMultiPage (   $file)
Parameters
$file
Returns
bool

Reimplemented from MediaHandler.

Definition at line 59 of file PdfHandler_body.php.

◆ makeParamString()

PdfHandler::makeParamString (   $params)
Parameters
$paramsarray
Returns
bool|string

Reimplemented from ImageHandler.

Definition at line 84 of file PdfHandler_body.php.

References $params.

◆ mustRender()

PdfHandler::mustRender (   $file)
Parameters
$file
Returns
bool

Reimplemented from MediaHandler.

Definition at line 51 of file PdfHandler_body.php.

◆ pageCount()

PdfHandler::pageCount ( File  $image)
Parameters
File$image
Returns
bool|int

Reimplemented from MediaHandler.

Definition at line 358 of file PdfHandler_body.php.

References getDimensionInfo().

Referenced by doTransform().

◆ parseParamString()

PdfHandler::parseParamString (   $str)
Parameters
$strstring
Returns
array|bool

Reimplemented from ImageHandler.

Definition at line 96 of file PdfHandler_body.php.

◆ registerWarningModule()

static PdfHandler::registerWarningModule ( $resourceLoader)
static

Register a module with the warning messages in it.

Parameters
&$resourceLoaderResourceLoader

Definition at line 435 of file PdfHandler_body.php.

References $messages, and $resourceLoader.

◆ validateParam()

PdfHandler::validateParam (   $name,
  $value 
)
Parameters
$name
$value
Returns
bool

Reimplemented from ImageHandler.

Definition at line 68 of file PdfHandler_body.php.

References $name, and $value.

Member Data Documentation

◆ $messages

PdfHandler::$messages
static
Initial value:
= [
'main' => 'pdf-file-page-warning',
'header' => 'pdf-file-page-warning-header',
'info' => 'pdf-file-page-warning-info',
'footer' => 'pdf-file-page-warning-footer',
]

Definition at line 25 of file PdfHandler_body.php.

Referenced by getWarningConfig().


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