Base class for the output of MediaHandler::doTransform() and File::transform(). More...

Inheritance diagram for MediaTransformOutput:

Collaboration diagram for MediaTransformOutput:

Public Member Functions
	fileIsSource ()
	Check if the output thumbnail is the same as the source.
	getDescLinkAttribs ($title=null, $params=array())
	getExtension ()
	Get the final extension of the thumbnail.
	getHeight ()
	getLocalCopyPath ()
	Get the path of a file system copy of the thumbnail.
	getStoragePath ()
	getUrl ()
	getWidth ()
	hasFile ()
	Check if an output thumbnail file actually exists.
	isError ()
	This will be overridden to return true in error classes.
	setStoragePath ($storagePath)
	streamFile ($headers=array())
	Stream the file if there were no errors.
	toHtml ($options=array())
	Fetch HTML for this transform output.
Public Attributes
File	$file
	$height
	$lang
	$page
	$path
array	$responsiveUrls = array()
	Associative array mapping optional supplementary image files from pixel density (eg 1.5 or 2) to additional URLs.
	$url
	$width
Protected Member Functions
	linkWrap ($linkAttribs, $contents)
	Wrap some XHTML text in an anchor tag with the given attributes.
Protected Attributes
	$storagePath = false

Detailed Description

Base class for the output of MediaHandler::doTransform() and File::transform().

Definition at line 29 of file MediaTransformOutput.php.

Member Function Documentation

MediaTransformOutput::fileIsSource ( )

Check if the output thumbnail is the same as the source.

This can occur if the requested width was bigger than the source.

Returns:: Bool

Definition at line 138 of file MediaTransformOutput.php.

MediaTransformOutput::getDescLinkAttribs	(	$	title = `null`,
		$	params = `array()`
	)

Parameters:

$title	string
$params	string\|array Query parameters to add

Returns:: array

Definition at line 201 of file MediaTransformOutput.php.

MediaTransformOutput::getExtension ( )

Get the final extension of the thumbnail.

Returns false for scripted transformations.

Returns:: string|false

Definition at line 62 of file MediaTransformOutput.php.

MediaTransformOutput::getHeight ( )

Returns:: integer Height of the output box

Definition at line 53 of file MediaTransformOutput.php.

MediaTransformOutput::getLocalCopyPath ( )

Get the path of a file system copy of the thumbnail.

Callers should never write to this path.

Returns:: string|bool Returns false if there isn't one

Definition at line 148 of file MediaTransformOutput.php.

MediaTransformOutput::getStoragePath ( )

Returns:: string|bool The permanent thumbnail storage path

Definition at line 76 of file MediaTransformOutput.php.

MediaTransformOutput::getUrl ( )

Returns:: string|false The thumbnail URL

Definition at line 69 of file MediaTransformOutput.php.

MediaTransformOutput::getWidth ( )

Returns:: integer Width of the output box

Definition at line 46 of file MediaTransformOutput.php.

MediaTransformOutput::hasFile ( )

Check if an output thumbnail file actually exists.

This will return false if there was an error, the thumbnail is to be handled client-side only, or if transformation was deferred via TRANSFORM_LATER.

Returns:: Bool

Definition at line 126 of file MediaTransformOutput.php.

MediaTransformOutput::isError ( )

This will be overridden to return true in error classes.

Returns:: bool

Reimplemented in MediaTransformError.

Definition at line 114 of file MediaTransformOutput.php.

MediaTransformOutput::linkWrap	(	$	linkAttribs,
		$	contents
	)		`[protected]`

Wrap some XHTML text in an anchor tag with the given attributes.

Parameters:

$linkAttribs	array
$contents	string

Returns:: string

Definition at line 188 of file MediaTransformOutput.php.

MediaTransformOutput::setStoragePath ( $ storagePath )

Parameters:

string $storagePath The permanent storage path

Returns:: void

Definition at line 84 of file MediaTransformOutput.php.

MediaTransformOutput::streamFile ( $ headers = array() )

Stream the file if there were no errors.

Parameters:

array $headers Additional HTTP headers to send on success

Returns:: Bool success

Definition at line 169 of file MediaTransformOutput.php.

MediaTransformOutput::toHtml ( $ options = array() ) [abstract]

Fetch HTML for this transform output.

Parameters:

array $options Associative array of options. Boolean options should be indicated with a value of true for true, and false or absent for false.

alt Alternate text or caption desc-link Boolean, show a description link file-link Boolean, show a file download link custom-url-link Custom URL to link to custom-title-link Custom Title object to link to valign vertical-align property, if the output is an inline element img-class Class applied to the "<img>" tag, if there is such a tag

For images, desc-link and file-link are implemented as a click-through. For sounds and videos, they may be displayed in other ways.