FlashMessage.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Messaging;

/*
 * 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;

class FlashMessage extends AbstractMessage
{
    protected $storeInSession = false;

    protected $classes = [
        self::NOTICE => 'notice',
        self::INFO => 'info',
        self::OK => 'success',
        self::WARNING => 'warning',
        self::ERROR => 'danger'
    ];

    protected $icons = [
        self::NOTICE => 'lightbulb-o',
        self::INFO => 'info',
        self::OK => 'check',
        self::WARNING => 'exclamation',
        self::ERROR => 'times'
    ];

    public function __construct($message, $title = '', $severity = self::OK, $storeInSession = false)
    {
        $this->setMessage($message);
        $this->setTitle($title);
        $this->setSeverity($severity);
        $this->setStoreInSession($storeInSession);
    }

    public function isSessionMessage()
    {
        return $this->storeInSession;
    }

    public function setStoreInSession($storeInSession)
    {
        $this->storeInSession = (bool)$storeInSession;
    }

    public function getClass()
    {
        return 'alert-' . $this->classes[$this->severity];
    }

    public function getIconName()
    {
        return $this->icons[$this->severity];
    }

    public function render()
    {
        GeneralUtility::logDeprecatedFunction();
        $title = '';
        if (!empty($this->title)) {
            $title = '<h4 class="alert-title">' . $this->title . '</h4>';
        }
        $message = '
            <div class="alert ' . $this->getClass() . '">
                <div class="media">
                    <div class="media-left">
                        <span class="fa-stack fa-lg">
                            <i class="fa fa-circle fa-stack-2x"></i>
                            <i class="fa fa-' . $this->getIconName() . ' fa-stack-1x"></i>
                        </span>
                    </div>
                    <div class="media-body">
                        ' . $title . '
                        <div class="alert-message">' . $this->message . '</div>
                    </div>
                </div>
            </div>';
        return $message;
    }
}