MediaWiki master
MediaWiki\Media\TransformParameterError Class Reference

Shortcut class for parameter validation errors. More...

Inherits MediaWiki\Media\MediaTransformError.

Collaboration diagram for MediaWiki\Media\TransformParameterError:

Public Member Functions

 __construct ( $params)
 
 getHttpStatusCode ()
 
Stability: stable
to override
Returns
int

 
- Public Member Functions inherited from MediaWiki\Media\MediaTransformError
 __construct ( $msg, $width, $height,... $args)
 
 getHtmlMsg ()
 
 getMsg ()
 
 isError ()
 This will be overridden to return true in error classes.
Returns
bool

 
 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 tagFor 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

 
 toText ()
 
- Public Member Functions inherited from MediaWiki\Media\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 MediaWiki\Media\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 MediaWiki\Media\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 MediaWiki\Media\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

Shortcut class for parameter validation errors.

Stability: newable

Definition at line 18 of file TransformParameterError.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Media\TransformParameterError::__construct ( $params)
Stability: stable
to call
Parameters
array$params

Definition at line 25 of file TransformParameterError.php.

References wfMessage().

Member Function Documentation

◆ getHttpStatusCode()

MediaWiki\Media\TransformParameterError::getHttpStatusCode ( )

Stability: stable
to override
Returns
int

Reimplemented from MediaWiki\Media\MediaTransformError.

Definition at line 34 of file TransformParameterError.php.


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