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.
	getFile ()
	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
array	$responsiveUrls = array()
	Associative array mapping optional supplementary image files from pixel density (eg 1.5 or 2) to additional URLs.
Protected Member Functions
	linkWrap ($linkAttribs, $contents)
	Wrap some XHTML text in an anchor tag with the given attributes.
Protected Attributes
File	$file
	*
int	$height
	Image height *.
bool string	$lang
	Language code, false if not set *.
bool string	$page
	*
bool string	$path
	Filesystem path to the thumb *.
bool string	$storagePath = false
	Permanent storage path *.
string	$url
	URL path to the thumb *.
int	$width
	Image width *.

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 158 of file MediaTransformOutput.php.

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

Parameters:

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

Returns:: array

Definition at line 222 of file MediaTransformOutput.php.

MediaTransformOutput::getExtension ( )

Get the final extension of the thumbnail.

Returns false for scripted transformations.

Returns:: string|bool

Definition at line 76 of file MediaTransformOutput.php.

References file.

MediaTransformOutput::getFile ( )

Returns:: File

Definition at line 67 of file MediaTransformOutput.php.

MediaTransformOutput::getHeight ( )

Returns:: int Height of the output box

Definition at line 60 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 168 of file MediaTransformOutput.php.

MediaTransformOutput::getStoragePath ( )

Returns:: string|bool The permanent thumbnail storage path

Definition at line 90 of file MediaTransformOutput.php.

MediaTransformOutput::getUrl ( )

Returns:: string|bool The thumbnail URL

Definition at line 83 of file MediaTransformOutput.php.

MediaTransformOutput::getWidth ( )

Returns:: int Width of the output box

Definition at line 53 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. This file may exist as a new file in /tmp, a file in permanent storage, or even refer to the original.

Returns:: bool

Definition at line 146 of file MediaTransformOutput.php.

MediaTransformOutput::isError ( )

This will be overridden to return true in error classes.

Returns:: bool

Reimplemented in MediaTransformError.

Definition at line 131 of file MediaTransformOutput.php.

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

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

Parameters:

array	$linkAttribs
string	$contents

Returns:: string

Definition at line 209 of file MediaTransformOutput.php.

MediaTransformOutput::setStoragePath ( $ storagePath )

Parameters:

string $storagePath The permanent storage path

Returns:: void

Definition at line 98 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 190 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.

Returns:: string

Reimplemented in MediaTransformError, and ThumbnailImage.

Member Data Documentation

File MediaTransformOutput::$file [protected]

*

Definition at line 34 of file MediaTransformOutput.php.

int MediaTransformOutput::$height [protected]

Image height *.

Definition at line 38 of file MediaTransformOutput.php.

bool string MediaTransformOutput::$lang [protected]

Language code, false if not set *.

Definition at line 46 of file MediaTransformOutput.php.

bool string MediaTransformOutput::$page [protected]

*

Definition at line 42 of file MediaTransformOutput.php.

bool string MediaTransformOutput::$path [protected]

Filesystem path to the thumb *.

Definition at line 44 of file MediaTransformOutput.php.

array MediaTransformOutput::$responsiveUrls = array()

Associative array mapping optional supplementary image files from pixel density (eg 1.5 or 2) to additional URLs.

Definition at line 32 of file MediaTransformOutput.php.

bool string MediaTransformOutput::$storagePath = false [protected]

Permanent storage path *.

Definition at line 48 of file MediaTransformOutput.php.

string MediaTransformOutput::$url [protected]

URL path to the thumb *.

Definition at line 40 of file MediaTransformOutput.php.

int MediaTransformOutput::$width [protected]

Image width *.

Definition at line 36 of file MediaTransformOutput.php.

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

includes/media/MediaTransformOutput.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation