MediaWiki  1.28.0
MediaTransformError Class Reference

Basic media transform error class. More...

Inheritance diagram for MediaTransformError:
Collaboration diagram for MediaTransformError:

Public Member Functions

 __construct ($msg, $width, $height)
 
 getHtmlMsg ()
 
 isError ()
 
 toHtml ($options=[])
 
 toText ()
 
- Public Member Functions inherited from MediaTransformOutput
 fileIsSource ()
 Check if the output thumbnail is the same as the source. More...
 
 getDescLinkAttribs ($title=null, $params=[])
 
 getExtension ()
 Get the final extension of the thumbnail. More...
 
 getFile ()
 
 getHeight ()
 
 getLocalCopyPath ()
 Get the path of a file system copy of the thumbnail. More...
 
 getStoragePath ()
 
 getUrl ()
 
 getWidth ()
 
 hasFile ()
 Check if an output thumbnail file actually exists. More...
 
 isError ()
 This will be overridden to return true in error classes. More...
 
 setStoragePath ($storagePath)
 
 streamFile ($headers=[])
 Stream the file if there were no errors. More...
 
 streamFileWithStatus ($headers=[])
 Stream the file if there were no errors. More...
 
 toHtml ($options=[])
 Fetch HTML for this transform output. More...
 

Private Attributes

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

Additional Inherited Members

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

Detailed Description

Basic media transform error class.

Definition at line 441 of file MediaTransformOutput.php.

Constructor & Destructor Documentation

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

Member Function Documentation

MediaTransformError::getHtmlMsg ( )

Definition at line 472 of file MediaTransformOutput.php.

References $htmlMsg.

MediaTransformError::isError ( )

Definition at line 476 of file MediaTransformOutput.php.

MediaTransformError::toHtml (   $options = [])

Definition at line 461 of file MediaTransformOutput.php.

MediaTransformError::toText ( )

Definition at line 468 of file MediaTransformOutput.php.

References $textMsg.

Member Data Documentation

string MediaTransformError::$htmlMsg
private

HTML formatted version of the error.

Definition at line 443 of file MediaTransformOutput.php.

Referenced by getHtmlMsg().

string MediaTransformError::$textMsg
private

Plain text formatted version of the error.

Definition at line 446 of file MediaTransformOutput.php.

Referenced by toText().


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