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

Inherited by MediaWiki\Media\MediaTransformError, and MediaWiki\Media\ThumbnailImage.

Collaboration diagram for MediaWiki\Media\MediaTransformOutput:

[legend]

Public Member Functions
	fileIsSource ()
	Check if the output thumbnail is the same as the source.

	getAttribs (array $options=[])
	Return extra attributes that should be present on the media tag in the HTML.

	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.

	isError ()
	This will be overridden to return true in error classes.

	setStoragePath ( $storagePath)

	streamFile ( $headers=[])
	Stream the file if there were no errors.

	streamFileWithStatus ( $headers=[])
	Stream the file if there were no errors.

	toHtml ( $options=[])
	Fetch HTML for this transform output.

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

Protected Member Functions
	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
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

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

Stability: stable: to extend

Definition at line 25 of file MediaTransformOutput.php.

Member Function Documentation

◆ fileIsSource()

MediaWiki\Media\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 188 of file MediaTransformOutput.php.

◆ getAttribs()

MediaWiki\Media\MediaTransformOutput::getAttribs ( array $options = [] )

Return extra attributes that should be present on the media tag in the HTML.

Takes the same option array as ::toHtml() (and should be used by the implementation of ::toHtml()).

Parameters

array $options See options parameter of ::toHtml()

Returns: array An attribute array

Reimplemented in MediaWiki\Media\ThumbnailImage.

Definition at line 131 of file MediaTransformOutput.php.

◆ getDescLinkAttribs()

MediaWiki\Media\MediaTransformOutput::getDescLinkAttribs	(		$title = null,
			$params = [] )

Parameters

string \| null	$title
string \| array	$params	Query parameters to add

Returns: array

Definition at line 283 of file MediaTransformOutput.php.

References wfArrayToCgi().

◆ getExtension()

MediaWiki\Media\MediaTransformOutput::getExtension ( )

Get the final extension of the thumbnail.

Returns false for scripted transformations.

Stability: stable: to override

Returns: string|false

Definition at line 83 of file MediaTransformOutput.php.

References Wikimedia\FileBackend\FileBackend\extensionFromPath().

◆ getFile()

MediaWiki\Media\MediaTransformOutput::getFile ( )

Returns: File

Definition at line 72 of file MediaTransformOutput.php.

References MediaWiki\Media\MediaTransformOutput\$file.

Referenced by MediaWiki\Media\MediaTransformOutput\getUrl().

◆ getHeight()

MediaWiki\Media\MediaTransformOutput::getHeight ( )

Returns: int Height of the output box

Definition at line 65 of file MediaTransformOutput.php.

References MediaWiki\Media\MediaTransformOutput\$height.

◆ getLocalCopyPath()

MediaWiki\Media\MediaTransformOutput::getLocalCopyPath ( )

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

Callers should never write to this path.

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

Definition at line 198 of file MediaTransformOutput.php.

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

◆ getStoragePath()

MediaWiki\Media\MediaTransformOutput::getStoragePath ( )

Stability: stable: to override

Returns: string|false The permanent thumbnail storage path

Definition at line 107 of file MediaTransformOutput.php.

References MediaWiki\Media\MediaTransformOutput\$storagePath.

◆ getUrl()

MediaWiki\Media\MediaTransformOutput::getUrl ( )

Stability: stable: to override

Returns: string|false The thumbnail URL

Definition at line 92 of file MediaTransformOutput.php.

References MediaWiki\Media\MediaTransformOutput\getFile().

◆ getWidth()

MediaWiki\Media\MediaTransformOutput::getWidth ( )

Returns: int Width of the output box

Definition at line 58 of file MediaTransformOutput.php.

References MediaWiki\Media\MediaTransformOutput\$width.

◆ hasFile()

MediaWiki\Media\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 176 of file MediaTransformOutput.php.

◆ isError()

MediaWiki\Media\MediaTransformOutput::isError ( )

This will be overridden to return true in error classes.

Returns: bool

Reimplemented in MediaWiki\Media\MediaTransformError.

Definition at line 161 of file MediaTransformOutput.php.

◆ linkWrap()

MediaWiki\Media\MediaTransformOutput::linkWrap	(		$linkAttribs,
			$contents )

protected

Wrap some XHTML text in an anchor tag with the given attributes or, fallback to a span in the absence thereof.

Parameters

array	$linkAttribs
string	$contents

Returns: string

Definition at line 271 of file MediaTransformOutput.php.

◆ setStoragePath()

MediaWiki\Media\MediaTransformOutput::setStoragePath ( $storagePath )

Stability: stable: to override

Parameters

string $storagePath The permanent storage path

Returns: void

Definition at line 117 of file MediaTransformOutput.php.

References MediaWiki\Media\MediaTransformOutput\$storagePath.

◆ streamFile()

MediaWiki\Media\MediaTransformOutput::streamFile ( $headers = [] )

Stream the file if there were no errors.

Deprecated: since 1.26, use streamFileWithStatus; hard-deprecated since 1.47

Parameters

array $headers Additional HTTP headers to send on success

Returns: bool Success

Definition at line 258 of file MediaTransformOutput.php.

References wfDeprecated().

◆ streamFileWithStatus()

MediaWiki\Media\MediaTransformOutput::streamFileWithStatus ( $headers = [] )

Stream the file if there were no errors.

Parameters

array $headers Additional HTTP headers to send on success

Returns: Status

Since: 1.27

Definition at line 225 of file MediaTransformOutput.php.

References $success, Wikimedia\FileBackend\FileBackend\isStoragePath(), and Wikimedia\FileBackend\HTTPFileStreamer\stream().

◆ toHtml()

MediaWiki\Media\MediaTransformOutput::toHtml ( $options = [] )

abstract

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

Member Data Documentation

◆ $file

File MediaWiki\Media\MediaTransformOutput::$file

protected

Definition at line 32 of file MediaTransformOutput.php.

Referenced by MediaWiki\Media\ThumbnailImage\__construct(), and MediaWiki\Media\MediaTransformOutput\getFile().

◆ $height

int MediaWiki\Media\MediaTransformOutput::$height

protected

Image height.

Definition at line 38 of file MediaTransformOutput.php.

Referenced by MediaWiki\Media\MediaTransformError\__construct(), and MediaWiki\Media\MediaTransformOutput\getHeight().

◆ $lang

string false MediaWiki\Media\MediaTransformOutput::$lang

protected

Language code, false if not set.

Definition at line 50 of file MediaTransformOutput.php.

◆ $page

string false MediaWiki\Media\MediaTransformOutput::$page

protected

Definition at line 44 of file MediaTransformOutput.php.

◆ $path

string null false MediaWiki\Media\MediaTransformOutput::$path

protected

Filesystem path to the thumb.

Definition at line 47 of file MediaTransformOutput.php.

Referenced by MediaWiki\Media\ThumbnailImage\__construct().

◆ $responsiveUrls

array MediaWiki\Media\MediaTransformOutput::$responsiveUrls = []

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

Definition at line 29 of file MediaTransformOutput.php.

◆ $storagePath

string false MediaWiki\Media\MediaTransformOutput::$storagePath = false

protected

Permanent storage path.

Definition at line 53 of file MediaTransformOutput.php.

Referenced by MediaWiki\Media\MediaTransformOutput\getStoragePath(), and MediaWiki\Media\MediaTransformOutput\setStoragePath().

◆ $url

string false MediaWiki\Media\MediaTransformOutput::$url

protected

URL path to the thumb.

Definition at line 41 of file MediaTransformOutput.php.

Referenced by MediaWiki\Media\ThumbnailImage\__construct().

◆ $width

int MediaWiki\Media\MediaTransformOutput::$width

protected

Image width.

Definition at line 35 of file MediaTransformOutput.php.

Referenced by MediaWiki\Media\MediaTransformError\__construct(), and MediaWiki\Media\MediaTransformOutput\getWidth().

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

includes/Media/MediaTransformOutput.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ fileIsSource()

◆ getAttribs()

◆ getDescLinkAttribs()

◆ getExtension()

◆ getFile()

◆ getHeight()

◆ getLocalCopyPath()

◆ getStoragePath()

◆ getUrl()

◆ getWidth()

◆ hasFile()

◆ isError()

◆ linkWrap()

◆ setStoragePath()

◆ streamFile()

◆ streamFileWithStatus()

◆ toHtml()

Member Data Documentation

◆ $file

◆ $height

◆ $lang

◆ $page

◆ $path

◆ $responsiveUrls

◆ $storagePath

◆ $url

◆ $width