FlashMessage.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\Messaging;
 
use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪FlashMessage extends ‪AbstractMessage
{
    protected ‪$storeInSession = false;
 
    public function ‪__construct(‪$message, ‪$title = '', ‪$severity = ContextualFeedbackSeverity::OK, ‪$storeInSession = false)
    {
        if (is_int(‪$severity)) {
            // @deprecated int type for $severity deprecated in v12, will change to Severity only in v13.
            ‪$severity = ContextualFeedbackSeverity::transform(‪$severity) ?? ContextualFeedbackSeverity::OK;
        }
        $this->‪setMessage(‪$message);
        $this->‪setTitle(‪$title);
        $this->‪setSeverity(‪$severity);
        $this->‪setStoreInSession(‪$storeInSession);
    }
 
    public static function ‪createFromArray(array $data): self
    {
        return GeneralUtility::makeInstance(
            static::class,
            (string)$data['message'],
            (string)($data['title'] ?? ''),
            ContextualFeedbackSeverity::tryFrom($data['severity']) ?? ContextualFeedbackSeverity::OK,
            (bool)($data['storeInSession'] ?? false)
        );
    }
 
    public function ‪isSessionMessage()
    {
        return ‪$this->storeInSession;
    }
 
    public function ‪setStoreInSession(‪$storeInSession)
    {
        $this->storeInSession = (bool)‪$storeInSession;
    }
 
    public function ‪jsonSerialize(): array
    {
        $data = parent::jsonSerialize();
        $data['storeInSession'] = ‪$this->storeInSession;
        return $data;
    }
}