TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Core\Resource\Rendering\FileRendererInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Core\Resource\Rendering\FileRendererInterface:
TYPO3\CMS\Core\SingletonInterface TYPO3\CMS\Core\Resource\Rendering\AudioTagRenderer TYPO3\CMS\Core\Resource\Rendering\VideoTagRenderer TYPO3\CMS\Core\Resource\Rendering\VimeoRenderer TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer

Public Member Functions

 getPriority ()
 
 canRender (FileInterface $file)
 
 render (FileInterface $file, $width, $height, array $options=[], $usedPathsRelativeToCurrentScript=false)
 

Detailed Description

Class FileRendererInterface

Definition at line 22 of file FileRendererInterface.php.

Member Function Documentation

◆ canRender()

TYPO3\CMS\Core\Resource\Rendering\FileRendererInterface::canRender ( FileInterface  $file)

◆ getPriority()

TYPO3\CMS\Core\Resource\Rendering\FileRendererInterface::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 TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer, TYPO3\CMS\Core\Resource\Rendering\VimeoRenderer, TYPO3\CMS\Core\Resource\Rendering\AudioTagRenderer, and TYPO3\CMS\Core\Resource\Rendering\VideoTagRenderer.

Referenced by TYPO3\CMS\Core\Resource\Rendering\RendererRegistry\compareRendererPriority().

◆ render()

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

Render for given File(Reference) HTML output

Parameters
FileInterface$file
int | string$widthTYPO3 known format; examples: 220, 200m or 200c
int | string$heightTYPO3 known format; examples: 220, 200m or 200c
array$options
bool$usedPathsRelativeToCurrentScriptSee $file->getPublicUrl()
Returns
string

Implemented in TYPO3\CMS\Core\Resource\Rendering\YouTubeRenderer, TYPO3\CMS\Core\Resource\Rendering\VimeoRenderer, TYPO3\CMS\Core\Resource\Rendering\AudioTagRenderer, and TYPO3\CMS\Core\Resource\Rendering\VideoTagRenderer.