MediaWiki  master
MediaTransformOutput Class Reference

Base class for the output of MediaHandler::doTransform() and File::transform(). More...

Inheritance diagram for MediaTransformOutput:
Collaboration diagram for MediaTransformOutput:

Public Member Functions

 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...
 
 isError ()
 This will be overridden to return true in error classes. 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...
 
 toHtml ( $options=[])
 Fetch HTML for this transform output. More...
 

Public Attributes

array $responsiveUrls = []
 Associative array mapping optional supplementary image files from pixel density (eg 1.5 or 2) to additional URLs. More...
 

Protected Member Functions

 linkWrap ( $linkAttribs, $contents)
 Wrap some XHTML text in an anchor tag with the given attributes. More...
 

Protected Attributes

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

Base class for the output of MediaHandler::doTransform() and File::transform().

Stable to extend

Definition at line 30 of file MediaTransformOutput.php.

Member Function Documentation

◆ fileIsSource()

MediaTransformOutput::fileIsSource ( )

Check if the output thumbnail is the same as the source.

This can occur if the requested width was bigger than the source.

Returns
bool

Definition at line 176 of file MediaTransformOutput.php.

References isError().

◆ getDescLinkAttribs()

MediaTransformOutput::getDescLinkAttribs (   $title = null,
  $params = [] 
)
Parameters
string | null$title
string | array$paramsQuery parameters to add
Returns
array

Definition at line 253 of file MediaTransformOutput.php.

References $lang, $page, $title, and wfArrayToCgi().

Referenced by ThumbnailImage\toHtml().

◆ getExtension()

MediaTransformOutput::getExtension ( )

Get the final extension of the thumbnail.

Returns false for scripted transformations. Stable to override

Returns
string|bool

Definition at line 88 of file MediaTransformOutput.php.

References FileBackend\extensionFromPath().

◆ getFile()

MediaTransformOutput::getFile ( )
Returns
File

Definition at line 77 of file MediaTransformOutput.php.

References $file.

◆ getHeight()

MediaTransformOutput::getHeight ( )
Returns
int Height of the output box

Definition at line 70 of file MediaTransformOutput.php.

References $height.

◆ getLocalCopyPath()

MediaTransformOutput::getLocalCopyPath ( )

Get the path of a file system copy of the thumbnail.

Callers should never write to this path.

Returns
string|bool Returns false if there isn't one

Definition at line 186 of file MediaTransformOutput.php.

References $path, isError(), and FileBackend\isStoragePath().

Referenced by streamFileWithStatus().

◆ getStoragePath()

MediaTransformOutput::getStoragePath ( )

Stable to override.

Returns
string|bool The permanent thumbnail storage path

Definition at line 106 of file MediaTransformOutput.php.

References $storagePath.

◆ getUrl()

MediaTransformOutput::getUrl ( )

Stable to override.

Returns
string|bool The thumbnail URL

Definition at line 97 of file MediaTransformOutput.php.

References $url.

◆ getWidth()

MediaTransformOutput::getWidth ( )
Returns
int Width of the output box

Definition at line 63 of file MediaTransformOutput.php.

References $width.

◆ hasFile()

MediaTransformOutput::hasFile ( )

Check if an output thumbnail file actually exists.

This will return false if there was an error, the thumbnail is to be handled client-side only, or if transformation was deferred via TRANSFORM_LATER. This file may exist as a new file in /tmp, a file in permanent storage, or even refer to the original.

Returns
bool

Definition at line 164 of file MediaTransformOutput.php.

References isError().

◆ isError()

MediaTransformOutput::isError ( )

This will be overridden to return true in error classes.

Returns
bool

Reimplemented in MediaTransformError.

Definition at line 149 of file MediaTransformOutput.php.

Referenced by fileIsSource(), getLocalCopyPath(), and hasFile().

◆ linkWrap()

MediaTransformOutput::linkWrap (   $linkAttribs,
  $contents 
)
protected

Wrap some XHTML text in an anchor tag with the given attributes.

Parameters
array$linkAttribs
string$contents
Returns
string

Definition at line 240 of file MediaTransformOutput.php.

References Xml\tags().

Referenced by ThumbnailImage\toHtml().

◆ setStoragePath()

MediaTransformOutput::setStoragePath (   $storagePath)

Stable to override.

Parameters
string$storagePathThe permanent storage path
Returns
void

Definition at line 116 of file MediaTransformOutput.php.

References $storagePath.

◆ streamFile()

MediaTransformOutput::streamFile (   $headers = [])

Stream the file if there were no errors.

Deprecated:
since 1.26, use streamFileWithStatus
Parameters
array$headersAdditional HTTP headers to send on success
Returns
bool Success

Definition at line 229 of file MediaTransformOutput.php.

References streamFileWithStatus().

◆ streamFileWithStatus()

MediaTransformOutput::streamFileWithStatus (   $headers = [])

Stream the file if there were no errors.

Parameters
array$headersAdditional HTTP headers to send on success
Returns
Status
Since
1.27

Definition at line 209 of file MediaTransformOutput.php.

References $success, getLocalCopyPath(), FileBackend\isStoragePath(), StatusValue\newFatal(), StatusValue\newGood(), StreamFile\stream(), and Status\wrap().

Referenced by streamFile().

◆ toHtml()

MediaTransformOutput::toHtml (   $options = [])
abstract

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 in ThumbnailImage, and MediaTransformError.

Referenced by TraditionalImageGallery\toHTML().

Member Data Documentation

◆ $file

File MediaTransformOutput::$file
protected

Definition at line 37 of file MediaTransformOutput.php.

Referenced by ThumbnailImage\__construct(), and getFile().

◆ $height

int MediaTransformOutput::$height
protected

Image height.

Definition at line 43 of file MediaTransformOutput.php.

Referenced by MediaTransformError\__construct(), getHeight(), and ThumbnailImage\toHtml().

◆ $lang

bool string MediaTransformOutput::$lang
protected

Language code, false if not set.

Definition at line 55 of file MediaTransformOutput.php.

Referenced by getDescLinkAttribs().

◆ $page

bool string MediaTransformOutput::$page
protected

Definition at line 49 of file MediaTransformOutput.php.

Referenced by getDescLinkAttribs().

◆ $path

bool string MediaTransformOutput::$path
protected

Filesystem path to the thumb.

Definition at line 52 of file MediaTransformOutput.php.

Referenced by ThumbnailImage\__construct(), and getLocalCopyPath().

◆ $responsiveUrls

array MediaTransformOutput::$responsiveUrls = []

Associative array mapping optional supplementary image files from pixel density (eg 1.5 or 2) to additional URLs.

Definition at line 34 of file MediaTransformOutput.php.

Referenced by ThumbnailImage\toHtml().

◆ $storagePath

bool string MediaTransformOutput::$storagePath = false
protected

Permanent storage path.

Definition at line 58 of file MediaTransformOutput.php.

Referenced by getStoragePath(), and setStoragePath().

◆ $url

string MediaTransformOutput::$url
protected

URL path to the thumb.

Definition at line 46 of file MediaTransformOutput.php.

Referenced by ThumbnailImage\__construct(), getUrl(), and ThumbnailImage\toHtml().

◆ $width

int MediaTransformOutput::$width
protected

Image width.

Definition at line 40 of file MediaTransformOutput.php.

Referenced by MediaTransformError\__construct(), getWidth(), and ThumbnailImage\toHtml().


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