MediaWiki  REL1_22
MediaTransformError Class Reference

Basic media transform error class. More...

Inheritance diagram for MediaTransformError:
Collaboration diagram for MediaTransformError:

List of all members.

Public Member Functions

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

Public Attributes

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

Detailed Description

Basic media transform error class.

Definition at line 386 of file MediaTransformOutput.php.


Constructor & Destructor Documentation

MediaTransformError::__construct ( msg,
width,
height 
)

Definition at line 389 of file MediaTransformOutput.php.

References $height, $width, and wfMessage().


Member Function Documentation

This will be overridden to return true in error classes.

Returns:
bool

Reimplemented from MediaTransformOutput.

Definition at line 417 of file MediaTransformOutput.php.

MediaTransformError::toHtml ( options = array())

Fetch HTML for this transform output.

Parameters:
array$optionsAssociative 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 from MediaTransformOutput.

Definition at line 402 of file MediaTransformOutput.php.

Definition at line 409 of file MediaTransformOutput.php.


Member Data Documentation

MediaTransformError::$height

Reimplemented from MediaTransformOutput.

Definition at line 387 of file MediaTransformOutput.php.

Referenced by __construct().

MediaTransformError::$htmlMsg

Definition at line 387 of file MediaTransformOutput.php.

MediaTransformError::$path

Reimplemented from MediaTransformOutput.

Definition at line 387 of file MediaTransformOutput.php.

MediaTransformError::$textMsg

Definition at line 387 of file MediaTransformOutput.php.

MediaTransformError::$url

Reimplemented from MediaTransformOutput.

Definition at line 387 of file MediaTransformOutput.php.

MediaTransformError::$width

Reimplemented from MediaTransformOutput.

Definition at line 387 of file MediaTransformOutput.php.

Referenced by __construct().


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