TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper:

Public Member Functions
	initializeArguments ()
string	render ()

Protected Member Functions
string	renderImage (FileInterface $image, $width, $height, ?string $fileExtension)
ImageService	getImageService ()

Protected Attributes
string	$tagName = 'img'

Detailed Description

Render a given media file with the correct html tag.

It asks the :php:RendererRegistry for the correct Renderer class and if not found it falls back to the :php:ImageViewHelper as that is the "Renderer" class for images in Fluid context.

Examples

Image Object

::

<f:media file="{file}" width="400" height="375" />

Output::

MP4 Video Object

::

<f:media file="{file}" width="400" height="375" />

Output::

<video width="400" height="375" controls><source src="fileadmin/user_upload/my-video.mp4" type="video/mp4"></video>

MP4 Video Object with loop and autoplay option set

::

<f:media file="{file}" width="400" height="375" additionalConfig="{loop: '1', autoplay: '1'}" />

Output::

<video width="400" height="375" controls loop><source src="fileadmin/user_upload/my-video.mp4" type="video/mp4"></video>

Definition at line 68 of file MediaViewHelper.php.

Member Function Documentation

getImageService()

ImageService TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper::getImageService ( )

protected

Return an instance of ImageService

Returns

‪ImageService

Definition at line 183 of file MediaViewHelper.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper\renderImage().

initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper::initializeArguments

(

)

Initialize arguments.

Definition at line 77 of file MediaViewHelper.php.

render()

string TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper::render

(

)

Render a given media file

Returns

‪string Rendered tag

Exceptions

Definition at line 97 of file MediaViewHelper.php.

References TYPO3\CMS\Core\Resource\Rendering\RendererRegistry\getInstance(), TYPO3\CMS\Core\Resource\Rendering\RendererRegistry\getRenderer(), and TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper\renderImage().

renderImage()

string TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper::renderImage ( FileInterface  $image,   $width,   $height, ?string  $fileExtension  )

protected

Render img tag

Parameters

FileInterface	$image
string	$width
string	$height
string | null	$fileExtension

Returns

‪string Rendered img tag

Definition at line 133 of file MediaViewHelper.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\create(), TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper\getImageService(), and TYPO3\CMS\Core\Resource\FileInterface\getProperty().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper\render().

Member Data Documentation

$tagName

string TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper::$tagName = 'img'

protected

Definition at line 72 of file MediaViewHelper.php.