MediaTransformError Class Reference

Basic media transform error class. More...

Inherits MediaTransformOutput.

Inherited by TransformParameterError.

List of all members.

Public Member Functions

 __construct ($msg, $width, $height)
 toHtml ($options=array())
 Fetch HTML for this transform output.
 toText ()
 getHtmlMsg ()
 isError ()
 This will be overridden to return true in error classes.

Public Attributes

 $htmlMsg
 $textMsg
 $width
 $height
 $url
 $path


Detailed Description

Basic media transform error class.

Definition at line 195 of file MediaTransformOutput.php.


Constructor & Destructor Documentation

MediaTransformError::__construct ( msg,
width,
height 
)


Member Function Documentation

MediaTransformError::getHtmlMsg (  ) 

Definition at line 222 of file MediaTransformOutput.php.

MediaTransformError::isError (  ) 

This will be overridden to return true in error classes.

Reimplemented from MediaTransformOutput.

Definition at line 226 of file MediaTransformOutput.php.

MediaTransformError::toHtml ( options = array()  ) 

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

Definition at line 211 of file MediaTransformOutput.php.

MediaTransformError::toText (  ) 

Definition at line 218 of file MediaTransformOutput.php.


Member Data Documentation

MediaTransformError::$height

Reimplemented from MediaTransformOutput.

Definition at line 196 of file MediaTransformOutput.php.

Referenced by __construct().

MediaTransformError::$htmlMsg

Definition at line 196 of file MediaTransformOutput.php.

MediaTransformError::$path

Reimplemented from MediaTransformOutput.

Definition at line 196 of file MediaTransformOutput.php.

MediaTransformError::$textMsg

Definition at line 196 of file MediaTransformOutput.php.

MediaTransformError::$url

Reimplemented from MediaTransformOutput.

Definition at line 196 of file MediaTransformOutput.php.

MediaTransformError::$width

Reimplemented from MediaTransformOutput.

Definition at line 196 of file MediaTransformOutput.php.

Referenced by __construct().


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