Basic media transform error class. More...
Public Member Functions | |
| __construct ( $msg, $width, $height) | |
| getHtmlMsg () | |
| getHttpStatusCode () | |
| 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 () | |
| getUrl () | |
| getWidth () | |
| hasFile () | |
| Check if an output thumbnail file actually exists. 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... | |
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.
Definition at line 441 of file MediaTransformOutput.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaTransformError::__construct | ( | $msg, | |
| $width, | |||
| $height | |||
| ) |
Definition at line 445 of file MediaTransformOutput.php.
References $args, MediaTransformOutput\$height, $msg, MediaTransformOutput\$width, wfMessage(), and width.
Member Function Documentation
◆ getHtmlMsg()
| MediaTransformError::getHtmlMsg | ( | ) |
Definition at line 465 of file MediaTransformOutput.php.
Referenced by toHtml().
◆ getHttpStatusCode()
| MediaTransformError::getHttpStatusCode | ( | ) |
Reimplemented in TransformTooBigImageAreaError, and TransformParameterError.
Definition at line 477 of file MediaTransformOutput.php.
◆ getMsg()
| MediaTransformError::getMsg | ( | ) |
Definition at line 469 of file MediaTransformOutput.php.
References $msg.
◆ isError()
| MediaTransformError::isError | ( | ) |
This will be overridden to return true in error classes.
- Returns
- bool
Reimplemented from MediaTransformOutput.
Definition at line 473 of file MediaTransformOutput.php.
◆ toHtml()
| MediaTransformError::toHtml | ( | $options = [] | ) |
Fetch HTML for this transform output.
- Parameters
-
array $options Associative 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 454 of file MediaTransformOutput.php.
References getHtmlMsg().
◆ toText()
| MediaTransformError::toText | ( | ) |
Definition at line 461 of file MediaTransformOutput.php.
Member Data Documentation
◆ $msg
|
private |
Definition at line 443 of file MediaTransformOutput.php.
Referenced by __construct(), TransformTooBigImageAreaError\__construct(), and getMsg().
The documentation for this class was generated from the following file:
- includes/media/MediaTransformOutput.php
