Icon.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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\Utility\GeneralUtility;
 
class ‪Icon
{
    public const ‪SIZE_DEFAULT = 'default'; // 1em
 
    public const ‪SIZE_SMALL = 'small'; // 16px
 
    public const ‪SIZE_MEDIUM = 'medium'; // 32px
 
    public const ‪SIZE_LARGE = 'large'; // 48px
 
    public const ‪SIZE_MEGA = 'mega'; // 64px
 
    public const ‪SIZE_OVERLAY = 'overlay';
 
    protected string ‪$identifier;
 
    protected ?string ‪$title = null;
 
    protected ?‪Icon ‪$overlayIcon = null;
 
    protected IconSize ‪$size;
 
    protected bool ‪$spinning = false;
 
    protected ‪$state;
 
    protected ‪$dimension;
 
    protected ‪$markup;
 
    protected ‪$alternativeMarkups = [];
 
    public function ‪getMarkup(?string $alternativeMarkupIdentifier = null): string
    {
        if ($alternativeMarkupIdentifier !== null && isset($this->alternativeMarkups[$alternativeMarkupIdentifier])) {
            return $this->alternativeMarkups[$alternativeMarkupIdentifier];
        }
        return ‪$this->markup;
    }
 
    public function ‪setMarkup(string ‪$markup): self
    {
        $this->markup = ‪$markup;
        return $this;
    }
 
    public function ‪getAlternativeMarkup(string $markupIdentifier): string
    {
        return $this->alternativeMarkups[$markupIdentifier] ?: '';
    }
 
    public function ‪setAlternativeMarkup(string $markupIdentifier, string ‪$markup): self
    {
        $this->alternativeMarkups[$markupIdentifier] = ‪$markup;
        return $this;
    }
 
    public function ‪getIdentifier(): string
    {
        return ‪$this->identifier;
    }
 
    public function ‪setIdentifier(string ‪$identifier): self
    {
        $this->identifier = ‪$identifier;
        return $this;
    }
 
    public function ‪getTitle(): ?string
    {
        return ‪$this->title;
    }
 
    public function ‪setTitle(?string ‪$title): self
    {
        $this->title = ‪$title;
        return $this;
    }
 
    public function ‪getOverlayIcon(): ?‪Icon
    {
        return ‪$this->overlayIcon;
    }
 
    public function ‪setOverlayIcon(?‪Icon ‪$overlayIcon): self
    {
        $this->overlayIcon = ‪$overlayIcon;
        return $this;
    }
 
    public function ‪getSize(): string
    {
        return $this->size->value;
    }
 
    public function ‪setSize(string|IconSize ‪$size): self
    {
        if (is_string(‪$size)) {
            ‪$size = IconSize::from(‪$size);
            ‪$size->triggerDeprecation();
        }
        $this->size = ‪$size;
        $this->dimension = GeneralUtility::makeInstance(Dimension::class, ‪$size);
        return $this;
    }
 
    public function ‪isSpinning(): bool
    {
        return ‪$this->spinning;
    }
 
    public function ‪setSpinning(bool ‪$spinning): self
    {
        $this->spinning = ‪$spinning;
        return $this;
    }
 
    public function ‪getState(): ‪IconState
    {
        return ‪$this->state;
    }
 
    public function ‪setState(‪IconState ‪$state): self
    {
        $this->state = ‪$state;
        return $this;
    }
 
    public function ‪getDimension(): ‪Dimension
    {
        return ‪$this->dimension;
    }
 
    public function ‪render(?string $alternativeMarkupIdentifier = null): string
    {
        $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(): string
    {
        return $this->‪render();
    }
 
    protected function ‪wrappedIcon(?string $alternativeMarkupIdentifier = null): string
    {
        $classes = [];
        $classes[] = 't3js-icon';
        $classes[] = 'icon';
        $classes[] = 'icon-size-' . $this->‪getSize();
        $classes[] = 'icon-state-' . htmlspecialchars($this->state instanceof ‪IconState ? $this->state->value : IconState::STATE_DEFAULT->value);
        $classes[] = 'icon-' . $this->‪getIdentifier();
        if ($this->‪isSpinning()) {
            $classes[] = 'icon-spin';
        }
 
        $attributes = [];
        $attributes['title'] = $this->‪getTitle();
        $attributes['class'] = implode(' ', $classes);
        $attributes['data-identifier'] = $this->‪getIdentifier();
        $attributes['aria-hidden'] = 'true';
 
        ‪$markup = [];
        ‪$markup[] = '<span ' . GeneralUtility::implodeAttributes($attributes, true) . '>';
        ‪$markup[] = '   <span class="icon-markup">';
        ‪$markup[] = $this->‪getMarkup($alternativeMarkupIdentifier);
        ‪$markup[] = '   </span>';
        ‪$markup[] = '   {overlayMarkup}';
        ‪$markup[] = '</span>';
 
        return implode(LF, ‪$markup);
    }
}