MediaWiki master
MediaTransformError Class Reference

Basic media transform error class. More...

Inherits MediaTransformOutput.

Inherited by TransformParameterError, and TransformTooBigImageAreaError.

Collaboration diagram for MediaTransformError:

Public Member Functions

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

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.
 
- Protected Member Functions inherited from MediaTransformOutput
 linkWrap ( $linkAttribs, $contents)
 Wrap some XHTML text in an anchor tag with the given attributes or, fallback to a span in the absence thereof.
 
- Protected Attributes inherited from MediaTransformOutput
File $file
 
int $height
 Image height.
 
string false $lang
 Language code, false if not set.
 
string false $page
 
string null false $path
 Filesystem path to the thumb.
 
string false $storagePath = false
 Permanent storage path.
 
string false $url
 URL path to the thumb.
 
int $width
 Image width.
 

Detailed Description

Basic media transform error class.

Stability: newable
Stability: stable
to extend

Definition at line 35 of file MediaTransformError.php.

Constructor & Destructor Documentation

◆ __construct()

MediaTransformError::__construct ( $msg,
$width,
$height,
$args )
Stability: stable
to call
Parameters
string$msg
int$width
int$height
MessageParam|MessageSpecifier|string|int|float...$args

Definition at line 47 of file MediaTransformError.php.

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

Member Function Documentation

◆ getHtmlMsg()

MediaTransformError::getHtmlMsg ( )

Definition at line 66 of file MediaTransformError.php.

Referenced by toHtml().

◆ getHttpStatusCode()

MediaTransformError::getHttpStatusCode ( )
Stability: stable
to override
Returns
int

Reimplemented in TransformParameterError, and TransformTooBigImageAreaError.

Definition at line 83 of file MediaTransformError.php.

◆ getMsg()

MediaTransformError::getMsg ( )

Definition at line 70 of file MediaTransformError.php.

◆ isError()

MediaTransformError::isError ( )

This will be overridden to return true in error classes.

Returns
bool

Reimplemented from MediaTransformOutput.

Definition at line 74 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 55 of file MediaTransformError.php.

References getHtmlMsg().

◆ toText()

MediaTransformError::toText ( )

Definition at line 62 of file MediaTransformError.php.


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