Inheritance diagram for PdfHandler:

[legend]

Collaboration diagram for PdfHandler:

[legend]

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.

	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.

	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.

	validateThumbParams (&$width, &$height, $srcWidth, $srcHeight, $mimeType)
	Validate thumbnail parameters and fill in the correct height.

Public Member Functions inherited from MediaHandler
	canAnimateThumbnail ( $file)
	If the material is animated, we can animate the thumbnail.

	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.

	formatMetadataHelper ( $metadataArray, $context=false)
	sorts the visible/invisible field.

	getAvailableLanguages (File $file)
	Get list of languages file can be viewed in.

	getCommonMetaArray (File $file)
	Get an array of standard (FormatMetadata type) metadata values.

	getContentHeaders ( $metadata)
	Get useful response headers for GET/HEAD requests for a file with the given metadata.

	getDefaultRenderLanguage (File $file)
	On file types that support renderings in multiple languages, which language is used by default if unspecified.

	getEntireText (File $file)
	Get the text of the entire document.

	getLength ( $file)
	If its an audio file, return the length of the file.

	getMatchedLanguage ( $userPreferredLanguage, array $availableLanguages)
	When overridden in a descendant class, returns a language code most suiting.

	getMetadataType ( $image)
	Get a string describing the type of metadata, for display purposes.

	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.

	getTransform ( $image, $dstPath, $dstUrl, $params)
	Get a MediaTransformOutput object representing the transformed output.

	isAnimatedImage ( $file)
	The material is an image, and is animated.

	isExpensiveToThumbnail ( $file)
	True if creating thumbnails from the file is large or otherwise resource-intensive.

	isVectorized ( $file)
	The material is vectorized and thus scaling is lossless.

	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.

	verifyUpload ( $fileName)
	File validation hook called on upload.

Static Public Member Functions
static	registerWarningModule (&$resourceLoader)
	Register a module with the warning messages in it.

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

	visibleMetadataFields ()
	Get a list of metadata items which should be displayed when the metadata table is collapsed.

Additional Inherited Members
Public Attributes inherited from MediaHandler
const	MAX_ERR_LOG_SIZE = 65535
	Max length of error logged by logErrorForExternalProcess()

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.

Detailed Description

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

Member Function Documentation

◆ doThumbError()

PdfHandler::doThumbError	(	$width,
		$height,
		$msg )

protected

Parameters

int	$width
int	$height
string	$msg

Returns: MediaTransformError

Definition at line 133 of file PdfHandler.php.

References text, and wfMessage().

Referenced by doTransform().

◆ doTransform()

PdfHandler::doTransform	(	$image,
		$dstPath,
		$dstUrl,
		$params,
		$flags = 0 )

Parameters

File	$image
string	$dstPath
string	$dstUrl
array	$params
int	$flags

Returns: MediaTransformError|MediaTransformOutput|ThumbnailImage|TransformParameterError

Reimplemented from MediaHandler.

Definition at line 146 of file PdfHandler.php.

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

◆ formatMetadata()

PdfHandler::formatMetadata	(		$image,
			$context = false )

Parameters

File	$image
bool \| IContextSource	$context	Context to use (optional)

Returns: bool|array

Reimplemented from MediaHandler.

Definition at line 346 of file PdfHandler.php.

References $context, $image, MediaHandler\formatMetadataHelper(), unserialize(), wfRestoreWarnings(), and wfSuppressWarnings().

◆ getDimensionInfo()

PdfHandler::getDimensionInfo ( File $file )

protected

Definition at line 393 of file PdfHandler.php.

References $cache, function, getMetaArray(), and PdfImage\getPageSize().

Referenced by getPageDimensions(), and pageCount().

◆ getImageSize()

PdfHandler::getImageSize	(		$image,
			$path )

Parameters

File	$image
string	$path

Returns: array|bool

Reimplemented from ImageHandler.

Definition at line 297 of file PdfHandler.php.

References $image, and getPdfImage().

◆ getMetaArray()

PdfHandler::getMetaArray ( $image )

Parameters

File $image

Returns: bool|array @suppress PhanUndeclaredProperty

Definition at line 261 of file PdfHandler.php.

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

Referenced by getDimensionInfo(), and getPageText().

◆ getMetadata()

PdfHandler::getMetadata	(		$image,
			$path )

Parameters

File	$image
string	$path

Returns: string

Reimplemented from MediaHandler.

Definition at line 323 of file PdfHandler.php.

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

◆ getPageDimensions()

PdfHandler::getPageDimensions	(	File	$image,
			$page )

Parameters

File	$image
int	$page

Returns: array|bool

Reimplemented from MediaHandler.

Definition at line 382 of file PdfHandler.php.

References getDimensionInfo().

◆ getPageText()

PdfHandler::getPageText	(	File	$image,
			$page )

Parameters

File	$image
int	$page

Returns: bool

Reimplemented from MediaHandler.

Definition at line 422 of file PdfHandler.php.

References getMetaArray().

◆ getParamMap()

PdfHandler::getParamMap ( )

Returns: array

Reimplemented from ImageHandler.

Definition at line 120 of file PdfHandler.php.

◆ getPdfImage()

PdfHandler::getPdfImage	(		$image,
			$path )

Parameters

File	$image
string	$path

Returns: PdfImage @suppress PhanUndeclaredProperty

Definition at line 244 of file PdfHandler.php.

References $image.

Referenced by getImageSize(), and getMetadata().

◆ getScriptParams()

PdfHandler::getScriptParams ( $params )

Parameters

array $params

Returns: array

Reimplemented from ImageHandler.

Definition at line 110 of file PdfHandler.php.

References $params.

◆ getThumbType()

PdfHandler::getThumbType	(	$ext,
		$mime,
		$params = null )

Parameters

string	$ext
string	$mime
null	$params

Returns: array

Reimplemented from MediaHandler.

Definition at line 307 of file PdfHandler.php.

References $mime.

◆ 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 436 of file PdfHandler.php.

References $messages.

◆ isEnabled()

PdfHandler::isEnabled ( )

Returns: bool

Reimplemented from MediaHandler.

Definition at line 35 of file PdfHandler.php.

References wfDebug().

◆ isMetadataValid()

PdfHandler::isMetadataValid	(		$image,
			$metadata )

Parameters

File	$image
string	$metadata

Returns: bool

Reimplemented from MediaHandler.

Definition at line 332 of file PdfHandler.php.

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

Referenced by getMetaArray().

◆ isMultiPage()

PdfHandler::isMultiPage ( $file )

Parameters

File $file

Returns: bool

Reimplemented from MediaHandler.

Definition at line 59 of file PdfHandler.php.

◆ makeParamString()

PdfHandler::makeParamString ( $params )

Parameters

array $params

Returns: bool|string

Reimplemented from ImageHandler.

Definition at line 84 of file PdfHandler.php.

References $params.

◆ mustRender()

PdfHandler::mustRender ( $file )

Parameters

File $file

Returns: bool

Reimplemented from MediaHandler.

Definition at line 51 of file PdfHandler.php.

◆ pageCount()

PdfHandler::pageCount ( File $image )

Parameters

File $image

Returns: bool|int

Reimplemented from MediaHandler.

Definition at line 371 of file PdfHandler.php.

References getDimensionInfo().

Referenced by doTransform().

◆ parseParamString()

PdfHandler::parseParamString ( $str )

Parameters

string $str

Returns: array|bool

Reimplemented from ImageHandler.

Definition at line 96 of file PdfHandler.php.

◆ registerWarningModule()

static PdfHandler::registerWarningModule ( & $resourceLoader )

static

Register a module with the warning messages in it.

Parameters

ResourceLoader &$resourceLoader

Definition at line 448 of file PdfHandler.php.

References $resourceLoader.

◆ validateParam()

PdfHandler::validateParam	(		$name,
			$value )

Parameters

string	$name
string	$value

Returns: bool

Reimplemented from ImageHandler.

Definition at line 68 of file PdfHandler.php.

References $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.php.

Referenced by getWarningConfig().

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

extensions/PdfHandler/includes/PdfHandler.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ doThumbError()

◆ doTransform()

◆ formatMetadata()

◆ getDimensionInfo()

◆ getImageSize()

◆ getMetaArray()

◆ getMetadata()

◆ getPageDimensions()

◆ getPageText()

◆ getParamMap()

◆ getPdfImage()

◆ getScriptParams()

◆ getThumbType()

◆ getWarningConfig()

◆ isEnabled()

◆ isMetadataValid()

◆ isMultiPage()

◆ makeParamString()

◆ mustRender()

◆ pageCount()

◆ parseParamString()

◆ registerWarningModule()

◆ validateParam()

Member Data Documentation

◆ $messages