TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper Class Reference

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

Public Member Functions
	initializeArguments ()
	render ($file, $additionalConfig=[], $width=null, $height=null)
Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
	__construct ()
	initialize ()
Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	setArguments (array $arguments)
	setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
	isEscapingInterceptorEnabled ()
	setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)
	setRenderChildrenClosure (\Closure $renderChildrenClosure)
	initializeArgumentsAndRender ()
	initialize ()
	renderChildren ()
	prepareArguments ()
	validateArguments ()
	initializeArguments ()
	compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
	resetState ()

Protected Member Functions
	renderImage (FileInterface $image, $width, $height)
	getImageService ()
Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
	registerTagAttribute ($name, $type, $description, $required=false, $default=null)
	registerUniversalTagAttributes ()
Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	registerArgument ($name, $type, $description, $required=false, $defaultValue=null)
	overrideArgument ($name, $type, $description, $required=false, $defaultValue=null)
	callRenderMethod ()
	getLogger ()
	buildRenderChildrenClosure ()
	hasArgument ($argumentName)

Protected Attributes
	$tagName = 'img'
Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
	$tag = null
	$tagName = 'div'
Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	$arguments
	$templateVariableContainer
	$controllerContext
	$renderingContext
	$renderChildrenClosure = null
	$viewHelperVariableContainer
	$objectManager
	$escapingInterceptorEnabled = true

Additional Inherited Members
Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)

Detailed Description

Render a given media file with the correct html tag.

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

= Examples =

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

</output>

<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> </output>

<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> </output>

Definition at line 53 of file MediaViewHelper.php.

Member Function Documentation

getImageService()

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

protected

Return an instance of ImageService

Returns

ImageService

Definition at line 144 of file MediaViewHelper.php.

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

initializeArguments()

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

(

)

Initialize arguments.

Returns

void

Definition at line 65 of file MediaViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper\registerTagAttribute(), and TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper\registerUniversalTagAttributes().

render()

TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper::render	(		$file,
			$additionalConfig = [],
			$width = null,
			$height = null
	)

Render a given media file

Parameters

FileInterface | AbstractFileFolder	$file
array	$additionalConfig	This array can hold additional configuration that is passed though to the Renderer object
string	$width	This can be a numeric value representing the fixed width of in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options.
string	$height	This can be a numeric value representing the fixed height in pixels. But you can also perform simple calculations by adding "m" or "c" to the value. See imgResource.width for possible options.

Returns

string Rendered tag

Definition at line 81 of file MediaViewHelper.php.

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

renderImage()

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

protected

Render img tag

Parameters

FileInterface	$image
string	$width
string	$height

Returns

string Rendered img tag

Definition at line 109 of file MediaViewHelper.php.

References 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

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

protected

Definition at line 58 of file MediaViewHelper.php.