FileRendererInterface Interface Reference

Inheritance diagram for FileRendererInterface:

Public Member Functions
	getPriority ()
	canRender (FileInterface $file)
	render (FileInterface $file, $width, $height, array $options=array(), $usedPathsRelativeToCurrentScript=false)

Detailed Description

Class FileRendererInterface

Definition at line 22 of file FileRendererInterface.php.

Member Function Documentation

canRender

(

FileInterface

$file

)

Check if given File(Reference) can be rendered

Parameters

FileInterface

$file

File or FileReference to render

Returns

bool

Implemented in YouTubeRenderer, VimeoRenderer, AudioTagRenderer, and VideoTagRenderer.

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

Implemented in YouTubeRenderer, VimeoRenderer, AudioTagRenderer, and VideoTagRenderer.

Referenced by RendererRegistry\compareRendererPriority().

render	(	FileInterface	$file,
			$width,
			$height,
		array	$options = array(),
			$usedPathsRelativeToCurrentScript = false
	)

Render for given File(Reference) HTML output

Parameters

FileInterface	$file
int | string	$width	TYPO3 known format; examples: 220, 200m or 200c
int | string	$height	TYPO3 known format; examples: 220, 200m or 200c
array	$options
bool	$usedPathsRelativeToCurrentScript	See $file->getPublicUrl()

Returns

string

Implemented in YouTubeRenderer, VimeoRenderer, AudioTagRenderer, and VideoTagRenderer.