MediaTransformOutput Class Reference

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

Inherited by MediaTransformError, and ThumbnailImage.

List of all members.

Public Member Functions

 getWidth ()
 Get the width of the output box.
 getHeight ()
 Get the height of the output box.
 getUrl ()
 getPath ()
 toHtml ($options=array())
 Fetch HTML for this transform output.
 isError ()
 This will be overridden to return true in error classes.
 getDescLinkAttribs ($alt=false, $params= '')

Public Attributes

 $file
 $width
 $height
 $url
 $page
 $path

Protected Member Functions

 linkWrap ($linkAttribs, $contents)
 Wrap some XHTML text in an anchor tag with the given attributes.


Detailed Description

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

Definition at line 12 of file MediaTransformOutput.php.


Member Function Documentation

MediaTransformOutput::getDescLinkAttribs ( alt = false,
params = '' 
)

Definition at line 83 of file MediaTransformOutput.php.

References $title.

Referenced by ThumbnailImage::toHtml().

MediaTransformOutput::getHeight (  ) 

Get the height of the output box.

Definition at line 25 of file MediaTransformOutput.php.

MediaTransformOutput::getPath (  ) 

Returns:
string Destination file path (local filesystem)

Definition at line 39 of file MediaTransformOutput.php.

MediaTransformOutput::getUrl (  ) 

Returns:
string The thumbnail URL

Definition at line 32 of file MediaTransformOutput.php.

MediaTransformOutput::getWidth (  ) 

Get the width of the output box.

Definition at line 18 of file MediaTransformOutput.php.

MediaTransformOutput::isError (  ) 

This will be overridden to return true in error classes.

Reimplemented in MediaTransformError.

Definition at line 68 of file MediaTransformOutput.php.

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

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

Definition at line 75 of file MediaTransformOutput.php.

References Xml::tags().

Referenced by ThumbnailImage::toHtml().

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 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 ThumbnailImage, and MediaTransformError.


Member Data Documentation

MediaTransformOutput::$file

Definition at line 13 of file MediaTransformOutput.php.

Referenced by ThumbnailImage::ThumbnailImage().

MediaTransformOutput::$height

Reimplemented in MediaTransformError.

Definition at line 13 of file MediaTransformOutput.php.

Referenced by ThumbnailImage::ThumbnailImage().

MediaTransformOutput::$page

Definition at line 13 of file MediaTransformOutput.php.

Referenced by ThumbnailImage::ThumbnailImage().

MediaTransformOutput::$path

Reimplemented in MediaTransformError.

Definition at line 13 of file MediaTransformOutput.php.

Referenced by ThumbnailImage::ThumbnailImage().

MediaTransformOutput::$url

Reimplemented in MediaTransformError.

Definition at line 13 of file MediaTransformOutput.php.

Referenced by ThumbnailImage::ThumbnailImage().

MediaTransformOutput::$width

Reimplemented in MediaTransformError.

Definition at line 13 of file MediaTransformOutput.php.

Referenced by ThumbnailImage::ThumbnailImage().


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

Generated on Sat Sep 5 02:08:42 2009 for MediaWiki by  doxygen 1.5.9