MediaWiki  REL1_24
Public Member Functions | Private Attributes
MediaTransformError Class Reference

Basic media transform error class. More...

Inheritance diagram for MediaTransformError:
Inheritance graph
[legend]
Collaboration diagram for MediaTransformError:
Collaboration graph
[legend]

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 ()

Private Attributes

string $htmlMsg
 HTML formatted version of the error *.
string $textMsg
 Plain text formatted version of the error *.

Detailed Description

Basic media transform error class.

Definition at line 415 of file MediaTransformOutput.php.

Constructor & Destructor Documentation

MediaTransformError::__construct ( $  msg,
$  width,
$  height 
)

Definition at line 420 of file MediaTransformOutput.php.

Member Function Documentation

MediaTransformError::getHtmlMsg ( )

Definition at line 444 of file MediaTransformOutput.php.

MediaTransformError::isError ( )

This will be overridden to return true in error classes.

Returns:
bool

Reimplemented from MediaTransformOutput.

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

MediaTransformError::toText ( )

Definition at line 440 of file MediaTransformOutput.php.

Member Data Documentation

string MediaTransformError::$htmlMsg [private]

HTML formatted version of the error *.

Definition at line 416 of file MediaTransformOutput.php.

string MediaTransformError::$textMsg [private]

Plain text formatted version of the error *.

Definition at line 418 of file MediaTransformOutput.php.

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