MediaWiki  master
MediaTransformError Class Reference

Basic media transform error class. More...

Inheritance diagram for MediaTransformError:
Collaboration diagram for MediaTransformError:

Public Member Functions

 __construct ( $msg, $width, $height,... $args)
 Stable to call. More...
 
 getHtmlMsg ()
 
 getHttpStatusCode ()
 Stable to override. More...
 
 getMsg ()
 
 isError ()
 This will be overridden to return true in error classes. More...
 
 toHtml ( $options=[])
 Fetch HTML for this transform output. More...
 
 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 ()
 Stable to override. More...
 
 getUrl ()
 Stable to override. More...
 
 getWidth ()
 
 hasFile ()
 Check if an output thumbnail file actually exists. More...
 
 setStoragePath ( $storagePath)
 Stable to override. More...
 
 streamFile ( $headers=[])
 Stream the file if there were no errors. More...
 
 streamFileWithStatus ( $headers=[])
 Stream the file if there were no errors. More...
 

Private Attributes

Message $msg
 

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.

@newable Stable to extend

Definition at line 31 of file MediaTransformError.php.

Constructor & Destructor Documentation

◆ __construct()

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

Stable to call.

Parameters
string$msg
int$width
int$height
mixed...$args

Definition at line 43 of file MediaTransformError.php.

References $args, MediaTransformOutput\$height, $msg, MediaTransformOutput\$width, and wfMessage().

Member Function Documentation

◆ getHtmlMsg()

MediaTransformError::getHtmlMsg ( )

Definition at line 62 of file MediaTransformError.php.

Referenced by toHtml().

◆ getHttpStatusCode()

MediaTransformError::getHttpStatusCode ( )

Stable to override.

Returns
int

Reimplemented in TransformTooBigImageAreaError, and TransformParameterError.

Definition at line 79 of file MediaTransformError.php.

◆ getMsg()

MediaTransformError::getMsg ( )

Definition at line 66 of file MediaTransformError.php.

References $msg.

◆ isError()

MediaTransformError::isError ( )

This will be overridden to return true in error classes.

Returns
bool

Reimplemented from MediaTransformOutput.

Definition at line 70 of file MediaTransformError.php.

◆ toHtml()

MediaTransformError::toHtml (   $options = [])

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 51 of file MediaTransformError.php.

References getHtmlMsg().

◆ toText()

MediaTransformError::toText ( )

Definition at line 58 of file MediaTransformError.php.

Member Data Documentation

◆ $msg

Message MediaTransformError::$msg
private

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