kitodo / kitodo-presentation

Classes/Common/KitodoFlashMessageRenderer.php

<?php

/**
 * (c) Kitodo. Key to digital objects e.V. <contact@kitodo.org>
 *
 * This file is part of the Kitodo and TYPO3 projects.
 *
 * @license GNU General Public License version 3 or later.
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */

namespace Kitodo\Dlf\Common;

use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Messaging\Renderer\FlashMessageRendererInterface;

/**
 * A class representing a bootstrap flash messages.
 * This class renders flash messages as markup, based on the
 * bootstrap HTML/CSS framework. It is used in backend context.
 * The created output contains all classes which are required for
 * the TYPO3 backend. Any kind of message contains also a nice icon.
 *
 * @package TYPO3
 * @subpackage dlf
 *
 * @access public
 */
class KitodoFlashMessageRenderer implements FlashMessageRendererInterface
{
    /**
     * @var array The message severity class names
     */
    protected static array $classes = [
        // Todo: FlashMessage constants deprecated in v12, remove when dropping v11 support
        FlashMessage::NOTICE => 'notice',
        FlashMessage::INFO => 'info',
        FlashMessage::OK => 'success',
        FlashMessage::WARNING => 'warning',
        FlashMessage::ERROR => 'danger'
    ];

    /**
     * @var array The message severity icon names
     */
    protected static array $icons = [
        // Todo: FlashMessage constants deprecated in v12, remove when dropping v11 support
        FlashMessage::NOTICE => 'lightbulb-o',
        FlashMessage::INFO => 'info',
        FlashMessage::OK => 'check',
        FlashMessage::WARNING => 'exclamation',
        FlashMessage::ERROR => 'times'
    ];

    /**
     * Render method
     * 
     * @access public
     *
     * @param FlashMessage[] $flashMessages
     *
     * @return string Representation of the flash message
     */
    public function render(array $flashMessages): string
    {
        return $this->getMessageAsMarkup($flashMessages);
    }

    /**
     * Gets the message severity as integer value for compatibility with Typo3 v12
     *
     * @access public
     *
     * @param FlashMessage $flashMessage
     *
     * @return int The message severity as integer
     */
    protected function getSeverityAsInt(FlashMessage $flashMessage): int
    {
        $severity = $flashMessage->getSeverity();
        if (is_int($severity)) {

The condition is_int($severity) is always true.

            // $severity is integer constant from FlashMessage in Typo3 v11
            return $severity;
        }
        // $severity is instance of ContextualFeedbackSeverity enum introduced in Typo3 v12
        // TODO: migrate message severity to ContextualFeedbackSeverity when dropping support for Typo3 v11
        return $severity->value;
    }

    /**
     * Gets the message severity class name
     *
     * @access public
     *
     * @param FlashMessage $flashMessage
     *
     * @return string The message severity class name
     */
    protected function getClass(FlashMessage $flashMessage): string
    {
        return 'alert-' . self::$classes[$this->getSeverityAsInt($flashMessage)];
    }

    /**
     * Gets the message severity icon name
     *
     * @access public
     *
     * @param FlashMessage $flashMessage
     *
     * @return string The message severity icon name
     */
    protected function getIconName(FlashMessage $flashMessage): string
    {
        return self::$icons[$this->getSeverityAsInt($flashMessage)];
    }

    /**
     * Gets the message rendered as clean and secure markup
     *
     * @access public
     *
     * @param FlashMessage[] $flashMessages
     *
     * @return string
     */
    protected function getMessageAsMarkup(array $flashMessages): string
    {
        // \TYPO3\CMS\Core\Messaging\FlashMessage::getMessageAsMarkup() uses htmlspecialchars()
        // on all messages, but we have messages with HTML tags. Therefore we copy the official
        // implementation and remove the htmlspecialchars() call on the message body.
        $markup = [];
        $markup[] = '<div class="typo3-messages">';
        foreach ($flashMessages as $flashMessage) {
            $messageTitle = $flashMessage->getTitle();
            $markup[] = '<div class="alert ' . htmlspecialchars($this->getClass($flashMessage)) . '">';
            $markup[] = '  <div class="media">';
            $markup[] = '    <div class="media-left">';
            $markup[] = '      <span class="fa-stack fa-lg">';
            $markup[] = '        <i class="fa fa-circle fa-stack-2x"></i>';
            $markup[] = '        <i class="fa fa-' . htmlspecialchars($this->getIconName($flashMessage)) . ' fa-stack-1x"></i>';
            $markup[] = '      </span>';
            $markup[] = '    </div>';
            $markup[] = '    <div class="media-body">';
            if ($messageTitle !== '') {
                $markup[] = '      <h4 class="alert-title">' . htmlspecialchars($messageTitle) . '</h4>';
            }
            $markup[] = '      <p class="alert-message">' . $flashMessage->getMessage() . '</p>';
            $markup[] = '    </div>';
            $markup[] = '  </div>';
            $markup[] = '</div>';
        }
        $markup[] = '</div>';
        return implode('', $markup);
    }
}