AudioTagRenderer.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Resource\Rendering;

/*
 * 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!
 */

use TYPO3\CMS\Core\Resource\FileInterface;
use TYPO3\CMS\Core\Resource\FileReference;

class AudioTagRenderer implements FileRendererInterface
{
    protected $possibleMimeTypes = ['audio/mpeg', 'audio/wav', 'audio/ogg'];

    public function getPriority()
    {
        return 1;
    }

    public function canRender(FileInterface $file)
    {
        return in_array($file->getMimeType(), $this->possibleMimeTypes, true);
    }

    public function render(FileInterface $file, $width, $height, array $options = [], $usedPathsRelativeToCurrentScript = false)
    {

        // If autoplay isn't set manually check if $file is a FileReference take autoplay from there
        if (!isset($options['autoplay']) && $file instanceof FileReference) {
            $autoplay = $file->getProperty('autoplay');
            if ($autoplay !== null) {
                $options['autoplay'] = $autoplay;
            }
        }

        $additionalAttributes = [];
        if (!isset($options['controls']) || !empty($options['controls'])) {
            $additionalAttributes[] = 'controls';
        }
        if (!empty($options['autoplay'])) {
            $additionalAttributes[] = 'autoplay';
        }
        if (!empty($options['muted'])) {
            $additionalAttributes[] = 'muted';
        }
        if (!empty($options['loop'])) {
            $additionalAttributes[] = 'loop';
        }
        foreach (['class', 'dir', 'id', 'lang', 'style', 'title', 'accesskey', 'tabindex', 'onclick', 'preload', 'controlsList'] as $key) {
            if (!empty($options[$key])) {
                $additionalAttributes[] = $key . '="' . htmlspecialchars($options[$key]) . '"';
            }
        }

        return sprintf(
            '<audio%s><source src="%s" type="%s"></audio>',
            empty($additionalAttributes) ? '' : ' ' . implode(' ', $additionalAttributes),
            htmlspecialchars($file->getPublicUrl($usedPathsRelativeToCurrentScript)),
            $file->getMimeType()
        );
    }
}