Icon.php

Go to the documentation of this file.

<?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\Imaging;
 
use ‪TYPO3\CMS\Core\Type\Icon\IconState;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪Icon
{
    const ‪SIZE_SMALL = 'small'; // 16
 
    const ‪SIZE_DEFAULT = 'default'; // 32
 
    const ‪SIZE_LARGE = 'large'; // 48
 
    const ‪SIZE_OVERLAY = 'overlay';
 
    protected ‪$identifier;
 
    protected ‪$overlayIcon;
 
    protected ‪$size = '';
 
    protected ‪$spinning = false;
 
    protected ‪$state;
 
    protected ‪$dimension;
 
    protected ‪$markup;
 
    protected ‪$alternativeMarkups = [];
 
    public function ‪getMarkup($alternativeMarkupIdentifier = null)
    {
        if ($alternativeMarkupIdentifier !== null && isset($this->alternativeMarkups[$alternativeMarkupIdentifier])) {
            return $this->alternativeMarkups[$alternativeMarkupIdentifier];
        }
        return ‪$this->markup;
    }
 
    public function ‪setMarkup(‪$markup)
    {
        $this->markup = ‪$markup;
    }
 
    public function ‪getAlternativeMarkup($markupIdentifier)
    {
        return $this->alternativeMarkups[$markupIdentifier];
    }
 
    public function ‪setAlternativeMarkup($markupIdentifier, ‪$markup)
    {
        $this->alternativeMarkups[$markupIdentifier] = ‪$markup;
    }
 
    public function ‪getIdentifier()
    {
        return ‪$this->identifier;
    }
 
    public function ‪setIdentifier(‪$identifier)
    {
        $this->identifier = ‪$identifier;
    }
 
    public function ‪getOverlayIcon()
    {
        return ‪$this->overlayIcon;
    }
 
    public function ‪setOverlayIcon(‪$overlayIcon)
    {
        $this->overlayIcon = ‪$overlayIcon;
    }
 
    public function ‪getSize()
    {
        return ‪$this->size;
    }
 
    public function ‪setSize(‪$size)
    {
        $this->size = ‪$size;
        $this->dimension = GeneralUtility::makeInstance(Dimension::class, ‪$size);
    }
 
    public function ‪isSpinning()
    {
        return ‪$this->spinning;
    }
 
    public function ‪setSpinning(‪$spinning)
    {
        $this->spinning = ‪$spinning;
    }
 
    public function ‪getState()
    {
        return ‪$this->state;
    }
 
    public function ‪setState(‪IconState ‪$state)
    {
        $this->state = ‪$state;
    }
 
    public function ‪getDimension()
    {
        return ‪$this->dimension;
    }
 
    public function ‪render($alternativeMarkupIdentifier = null)
    {
        $overlayIconMarkup = '';
        if ($this->overlayIcon !== null) {
            $overlayIconMarkup = '<span class="icon-overlay icon-' . htmlspecialchars($this->overlayIcon->getIdentifier()) . '">' . $this->overlayIcon->getMarkup() . '</span>';
        }
        return str_replace('{overlayMarkup}', $overlayIconMarkup, $this->‪wrappedIcon($alternativeMarkupIdentifier));
    }
 
    public function ‪__toString()
    {
        return $this->‪render();
    }
 
    protected function ‪wrappedIcon($alternativeMarkupIdentifier = null)
    {
        $classes = [];
        $classes[] = 't3js-icon';
        $classes[] = 'icon';
        $classes[] = 'icon-size-' . ‪$this->size;
        $classes[] = 'icon-state-' . htmlspecialchars((string)$this->state);
        $classes[] = 'icon-' . $this->‪getIdentifier();
        if ($this->‪isSpinning()) {
            $classes[] = 'icon-spin';
        }
 
        ‪$markup = [];
        ‪$markup[] = '<span class="' . htmlspecialchars(implode(' ', $classes)) . '" data-identifier="' . htmlspecialchars($this->‪getIdentifier()) . '">';
        ‪$markup[] = '   <span class="icon-markup">';
        ‪$markup[] = $this->‪getMarkup($alternativeMarkupIdentifier);
        ‪$markup[] = '   </span>';
        ‪$markup[] = '   {overlayMarkup}';
        ‪$markup[] = '</span>';
 
        return implode(LF, ‪$markup);
    }
}