MediaWiki master
TransformTooBigImageAreaError Class Reference

Shortcut class for parameter file size errors. More...

Inherits MediaTransformError.

Collaboration diagram for TransformTooBigImageAreaError:

Public Member Functions

 __construct ( $params, $maxImageArea)
 
 getHttpStatusCode ()
 
- Public Member Functions inherited from MediaTransformError
 __construct ( $msg, $width, $height,... $args)
 
 getHtmlMsg ()
 
 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

Shortcut class for parameter file size errors.

Stability: newable
Since
1.25

Definition at line 31 of file TransformTooBigImageAreaError.php.

Constructor & Destructor Documentation

◆ __construct()

TransformTooBigImageAreaError::__construct ( $params,
$maxImageArea )
Stability: stable
to call
Parameters
array$params
int$maxImageArea

Definition at line 39 of file TransformTooBigImageAreaError.php.

References $params, and wfMessage().

Member Function Documentation

◆ getHttpStatusCode()

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

Reimplemented from MediaTransformError.

Definition at line 54 of file TransformTooBigImageAreaError.php.


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