| Current Path : /var/www/surf/TYPO3/vendor/typo3/cms-core/Classes/Resource/Rendering/ |
| Current File : /var/www/surf/TYPO3/vendor/typo3/cms-core/Classes/Resource/Rendering/FileRendererInterface.php |
<?php
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Core\Resource\Rendering;
use TYPO3\CMS\Core\Resource\FileInterface;
use TYPO3\CMS\Core\SingletonInterface;
/**
* Class FileRendererInterface
*/
interface FileRendererInterface extends SingletonInterface
{
/**
* 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
*
* @return int
*/
public function getPriority();
/**
* Check if given File(Reference) can be rendered
*
* @param FileInterface $file File or FileReference to render
* @return bool
*/
public function canRender(FileInterface $file);
/**
* Render for given File(Reference) HTML output
*
* @param int|string $width TYPO3 known format; examples: 220, 200m or 200c
* @param int|string $height TYPO3 known format; examples: 220, 200m or 200c
* @return string
*/
public function render(FileInterface $file, $width, $height, array $options = []);
}