FileRendererInterface extends SingletonInterface

Class FileRendererInterface

Table of Contents

Methods

canRender()  : bool
Check if given File(Reference) can be rendered
getPriority()  : int
Returns the priority of the renderer This way it is possible to define/overrule a renderer for a specific file type/context.
render()  : string
Render for given File(Reference) HTML output

Methods

canRender()

Check if given File(Reference) can be rendered

public canRender(FileInterface $file) : bool
Parameters
$file : FileInterface

File or FileReference to render

Return values
bool

getPriority()

Returns the priority of the renderer This way it is possible to define/overrule a renderer for a specific file type/context.

public getPriority() : int

For example create a video renderer for a certain storage/driver type.

Should be between 1 and 100, 100 is more important than 1

Return values
int

render()

Render for given File(Reference) HTML output

public render(FileInterface $file, int|string $width, int|string $height[, array<string|int, mixed> $options = [] ][, bool $usedPathsRelativeToCurrentScript = false ]) : string
Parameters
$file : FileInterface
$width : int|string

TYPO3 known format; examples: 220, 200m or 200c

$height : int|string

TYPO3 known format; examples: 220, 200m or 200c

$options : array<string|int, mixed> = []
$usedPathsRelativeToCurrentScript : bool = false

See $file->getPublicUrl()

Return values
string 

        

        
    




    

    

                            

            

                        
    

        On this page

        
    


            

                    

        

    

        

            
Search results