TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:09 +02:00
commit af8cc155b5
6818 changed files with 642608 additions and 0 deletions
@@ -0,0 +1,266 @@
+<?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;
+
+/**
+ * Icon object, holds all information for one icon, identified by the "identifier" property.
+ * Is available to render itself as string.
+ */
+class Icon
+{
+    /**
+     * The identifier which the PHP code that calls the IconFactory hands over
+     */
+    protected string $identifier;
+
+    /**
+     * The title rendered to the icon
+     */
+    protected ?string $title = null;
+
+    /**
+     * The identifier for a possible overlay icon
+     */
+    protected ?Icon $overlayIcon = null;
+
+    /**
+     * Contains the size string ("large", "small" or "default")
+     */
+    protected IconSize $size;
+
+    /**
+     * Flag to indicate if the icon has a spinning animation
+     */
+    protected bool $spinning = false;
+
+    /**
+     * Flag to indicate if the icon should be mirrored in RTL mode
+     */
+    protected bool $bidi = false;
+
+    /**
+     * Contains the state information
+     *
+     * @var IconState|null
+     */
+    protected $state;
+
+    /**
+     * @var Dimension
+     */
+    protected $dimension;
+
+    /**
+     * @var string
+     */
+    protected $markup;
+
+    /**
+     * @var array
+     */
+    protected $alternativeMarkups = [];
+
+    /**
+     * @internal this method is used for internal processing, to get the prepared and final markup use render()
+     */
+    public function getMarkup(?string $alternativeMarkupIdentifier = null): string
+    {
+        if ($alternativeMarkupIdentifier !== null && isset($this->alternativeMarkups[$alternativeMarkupIdentifier])) {
+            return $this->alternativeMarkups[$alternativeMarkupIdentifier];
+        }
+        return $this->markup;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setMarkup(string $markup): self
+    {
+        $this->markup = $markup;
+        return $this;
+    }
+
+    public function getAlternativeMarkup(string $markupIdentifier): string
+    {
+        return $this->alternativeMarkups[$markupIdentifier] ?: '';
+    }
+
+    /**
+     * @return $this
+     */
+    public function setAlternativeMarkup(string $markupIdentifier, string $markup): self
+    {
+        $this->alternativeMarkups[$markupIdentifier] = $markup;
+        return $this;
+    }
+
+    public function getIdentifier(): string
+    {
+        return $this->identifier;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setIdentifier(string $identifier): self
+    {
+        $this->identifier = $identifier;
+        return $this;
+    }
+
+    public function getTitle(): ?string
+    {
+        return $this->title;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setTitle(?string $title): self
+    {
+        $this->title = $title;
+        return $this;
+    }
+
+    public function getOverlayIcon(): ?Icon
+    {
+        return $this->overlayIcon;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setOverlayIcon(?Icon $overlayIcon): self
+    {
+        $this->overlayIcon = $overlayIcon;
+        return $this;
+    }
+
+    public function getSize(): string
+    {
+        return $this->size->value;
+    }
+
+    /**
+     * Sets the size and creates the new dimension
+     */
+    public function setSize(IconSize $size): self
+    {
+        $this->size = $size;
+        $this->dimension = GeneralUtility::makeInstance(Dimension::class, $size);
+        return $this;
+    }
+
+    public function isSpinning(): bool
+    {
+        return $this->spinning;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setSpinning(bool $spinning): self
+    {
+        $this->spinning = $spinning;
+        return $this;
+    }
+
+    public function isBidi(): bool
+    {
+        return $this->bidi;
+    }
+
+    /**
+     * @return $this
+     */
+    public function setBidi(bool $bidi): self
+    {
+        $this->bidi = $bidi;
+        return $this;
+    }
+
+    public function getState(): IconState
+    {
+        return $this->state;
+    }
+
+    /**
+     * @return $this
+     */
+    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();
+    }
+
+    /**
+     * Wrap icon markup in unified HTML code
+     */
+    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';
+        }
+        if ($this->isBidi()) {
+            $classes[] = 'icon-bidi';
+        }
+
+        $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);
+    }
+}