TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer Class Reference

Inheritance diagram for TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer:

Public Member Functions
int	getPriority ()
bool	canRender (FileInterface $file)
string	render (FileInterface $file, $width, $height, array $options=[])

Protected Member Functions
false OnlineMediaHelperInterface	getOnlineMediaHelper (FileInterface $file)
array	collectOptions (array $options, FileInterface $file)
string	createYouTubeUrl (array $options, FileInterface $file)
string	getVideoIdFromFile (FileInterface $file)
array	collectIframeAttributes ($width, $height, array $options)
	implodeAttributes (array $attributes)
	shouldIncludeFrameBorderAttribute ()

Protected Attributes
OnlineMediaHelperInterface false	$onlineMediaHelper

Detailed Description

YouTube renderer class

Definition at line 29 of file YouTubeRenderer.php.

Member Function Documentation

canRender()

bool TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::canRender

(

FileInterface

$file

)

Check if given File(Reference) can be rendered

Parameters

FileInterface

$file

‪File of FileReference to render

Returns

‪bool

Implements TYPO3\CMS\Core\Resource\Rendering\FileRendererInterface.

Definition at line 55 of file YouTubeRenderer.php.

References TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\getOnlineMediaHelper().

collectIframeAttributes()

array TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::collectIframeAttributes (   $width,   $height, array  $options  )

protected

Parameters

int | string	$width
int | string	$height

Returns

‪array pairs of key/value; not yet html-escaped

Definition at line 182 of file YouTubeRenderer.php.

References TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\shouldIncludeFrameBorderAttribute().

Referenced by TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\render().

collectOptions()

array TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::collectOptions ( array  $options, FileInterface  $file  )

protected

Returns

‪array

Definition at line 104 of file YouTubeRenderer.php.

References TYPO3\CMS\Core\Resource\FileInterface\getProperty().

Referenced by TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\render().

createYouTubeUrl()

string TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::createYouTubeUrl ( array  $options, FileInterface  $file  )

protected

Returns

‪string

Definition at line 129 of file YouTubeRenderer.php.

References TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\getVideoIdFromFile().

Referenced by TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\render().

getOnlineMediaHelper()

false OnlineMediaHelperInterface TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::getOnlineMediaHelper ( FileInterface  $file )

protected

Get online media helper

Returns

‪false|OnlineMediaHelperInterface

Definition at line 65 of file YouTubeRenderer.php.

References TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\$onlineMediaHelper.

Referenced by TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\canRender(), and TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\getVideoIdFromFile().

getPriority()

int TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::getPriority

(

)

Returns the priority of the renderer This way it is possible to define/overrule a renderer for a specific file type/context. For example create a video renderer for a certain storage/driver type. Should be between 1 and 100, 100 is more important than 1

Returns

‪int

Implements TYPO3\CMS\Core\Resource\Rendering\FileRendererInterface.

Definition at line 44 of file YouTubeRenderer.php.

getVideoIdFromFile()

string TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::getVideoIdFromFile ( FileInterface  $file )

protected

Returns

‪string

Definition at line 166 of file YouTubeRenderer.php.

References TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\getOnlineMediaHelper(), and TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface\getOnlineMediaId().

Referenced by TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\createYouTubeUrl().

implodeAttributes()

TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::implodeAttributes ( array  $attributes )

protected

Definition at line 216 of file YouTubeRenderer.php.

Referenced by TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\render().

render()

string TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::render	(	FileInterface	$file,
			$width,
			$height,
		array	$options = []
	)

Render for given File(Reference) html output

Parameters

int | string	$width	‪TYPO3 known format; examples: 220, 200m or 200c
int | string	$height	‪TYPO3 known format; examples: 220, 200m or 200c

Returns

‪string

Implements TYPO3\CMS\Core\Resource\Rendering\FileRendererInterface.

Definition at line 88 of file YouTubeRenderer.php.

References TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\collectIframeAttributes(), TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\collectOptions(), TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\createYouTubeUrl(), and TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\implodeAttributes().

Referenced by TYPO3\CMS\Core\Tests\Unit\Resource\Rendering\YouTubeRendererTest\renderOutputIsEscaped().

shouldIncludeFrameBorderAttribute()

TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::shouldIncludeFrameBorderAttribute ( )

protected

HTML5 deprecated the "frameborder" attribute as everything should be done via styling.

Definition at line 233 of file YouTubeRenderer.php.

Referenced by TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\collectIframeAttributes().

Member Data Documentation

$onlineMediaHelper

OnlineMediaHelperInterface false TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer::$onlineMediaHelper

protected

Definition at line 33 of file YouTubeRenderer.php.

Referenced by TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer\getOnlineMediaHelper().