ScalableVectorGraphicsContentObject.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Frontend\ContentObject;
 
/*
 * 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\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
class ‪ScalableVectorGraphicsContentObject extends ‪AbstractContentObject
{
    public function ‪render($conf = []): string
    {
        $renderMode = isset($conf['renderMode.'])
            ? $this->cObj->stdWrap($conf['renderMode'], $conf['renderMode.'])
            : $conf['renderMode'];
 
        if ($renderMode === 'inline') {
            return $this->‪renderInline($conf);
        }
 
        return $this->‪renderObject($conf);
    }
 
    protected function ‪renderInline(array $conf): string
    {
        $src = $this->‪resolveAbsoluteSourcePath($conf);
        list($width, $height, $isDefaultWidth, $isDefaultHeight) = $this->‪getDimensions($conf);
 
        $content = '';
        if (file_exists($src)) {
            $svgContent = file_get_contents($src);
            $svgContent = preg_replace('/<script[\s\S]*?>[\s\S]*?<\/script>/i', '', $svgContent);
            // Disables the functionality to allow external entities to be loaded when parsing the XML, must be kept
            $previousValueOfEntityLoader = libxml_disable_entity_loader();
            $svgElement = simplexml_load_string($svgContent);
            libxml_disable_entity_loader($previousValueOfEntityLoader);
 
            $domXml = dom_import_simplexml($svgElement);
            if (!$isDefaultWidth) {
                $domXml->setAttribute('width', $width);
            }
            if (!$isDefaultHeight) {
                $domXml->setAttribute('height', $height);
            }
            // remove xml version tag
            $content = $domXml->ownerDocument->saveXML($domXml->ownerDocument->documentElement);
        } else {
            $value = isset($conf['value.']) ? $this->cObj->stdWrap($conf['value'], $conf['value.']) : $conf['value'];
            if (!empty($value)) {
                $content = [];
                $content[] = '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="' . (int)$width . '" height="' . (int)$height . '">';
                $content[] = $value;
                $content[] = '</svg>';
                $content = implode(LF, $content);
            }
        }
        if (isset($conf['stdWrap.'])) {
            $content = $this->cObj->stdWrap($content, $conf['stdWrap.']);
        }
        return $content;
    }
 
    protected function ‪renderObject(array $conf): string
    {
        $src = $this->‪resolveAbsoluteSourcePath($conf);
        list($width, $height) = $this->‪getDimensions($conf);
 
        $src = $src === '' ? null : ‪PathUtility::getAbsoluteWebPath($src);
 
        $value = isset($conf['value.']) ? $this->cObj->stdWrap($conf['value'], $conf['value.']) : $conf['value'];
        $noscript = isset($conf['noscript.']) ? $this->cObj->stdWrap($conf['noscript'], $conf['noscript.']) : $conf['noscript'];
 
        // @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0 - see method usages
        if (!empty($conf['noscript.']) || !empty($conf['noscript'])) {
            trigger_error('SVG cObject: The option "noscript" will be removed in TYPO3 v10.0.', E_USER_DEPRECATED);
        }
        if (!empty($conf['value.']) || !empty($conf['value'])) {
            trigger_error('SVG cObject: The option "value" without setting renderMode=inline will be removed in TYPO3 v10.0.', E_USER_DEPRECATED);
        }
 
        $content = [];
        if ($src) {
            $content[] = '<!--[if IE]>';
            $content[] = '  <object src="' . htmlspecialchars($src) . '" classid="image/svg+xml" width="' . (int)$width . '" height="' . (int)$height . '">';
            $content[] = '<![endif]-->';
            $content[] = '<!--[if !IE]>-->';
            $content[] = '  <object data="' . htmlspecialchars($src) . '" type="image/svg+xml" width="' . (int)$width . '" height="' . (int)$height . '">';
            $content[] = '<!--<![endif]-->';
            $content[] = $noscript;
            $content[] = '</object>';
        } else {
            // @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0 - see method usages
            $content[] = '<script type="image/svg+xml">';
            $content[] = '  <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="' . (int)$width . '" height="' . (int)$height . '">';
            $content[] = $value;
            $content[] = '  </svg>';
            $content[] = '</script>';
            $content[] = '<noscript>';
            $content[] = $noscript;
            $content[] = '</noscript>';
        }
        $content = implode(LF, $content);
        if (isset($conf['stdWrap.'])) {
            $content = $this->cObj->stdWrap($content, $conf['stdWrap.']);
        }
        return $content;
    }
 
    protected function ‪resolveAbsoluteSourcePath(array $conf): string
    {
        $src = isset($conf['src.']) ? $this->cObj->stdWrap($conf['src'], $conf['src.']) : $conf['src'];
        return GeneralUtility::getFileAbsFileName($src);
    }
 
    protected function ‪getDimensions(array $conf): array
    {
        $isDefaultWidth = false;
        $isDefaultHeight = false;
        $width = isset($conf['width.']) ? $this->cObj->stdWrap($conf['width'], $conf['width.']) : $conf['width'];
        $height = isset($conf['height.']) ? $this->cObj->stdWrap($conf['height'], $conf['height.']) : $conf['height'];
 
        if (empty($width)) {
            $isDefaultWidth = true;
            $width = 600;
        }
        if (empty($height)) {
            $isDefaultHeight = true;
            $height = 400;
        }
 
        return [$width, $height, $isDefaultWidth, $isDefaultHeight];
    }
}