97 lines
2.9 KiB
PHP
97 lines
2.9 KiB
PHP
<?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;
|
|
|
|
/**
|
|
* A class representing flash messages.
|
|
*/
|
|
class FlashMessage extends AbstractMessage
|
|
{
|
|
/**
|
|
* Defines whether the message should be stored in the session (to survive redirects) or only for one request (default)
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $storeInSession = false;
|
|
|
|
/**
|
|
* Constructor for a flash message
|
|
*
|
|
* @param string $message The message.
|
|
* @param string $title Optional message title.
|
|
* @param ContextualFeedbackSeverity $severity
|
|
* @param bool $storeInSession Optional, defines whether the message should be stored in the session or only for one request (default)
|
|
*/
|
|
public function __construct($message, $title = '', ContextualFeedbackSeverity $severity = ContextualFeedbackSeverity::OK, $storeInSession = false)
|
|
{
|
|
$this->setMessage($message);
|
|
$this->setTitle($title);
|
|
$this->setSeverity($severity);
|
|
$this->setStoreInSession($storeInSession);
|
|
}
|
|
|
|
/**
|
|
* Factory method. Useful when creating flash messages from a jsonSerialize json_decode() call.
|
|
*
|
|
* @param array<string, string|int|bool> $data
|
|
*/
|
|
public static function createFromArray(array $data): self
|
|
{
|
|
return GeneralUtility::makeInstance(
|
|
static::class,
|
|
(string)($data['message'] ?? ''),
|
|
(string)($data['title'] ?? ''),
|
|
ContextualFeedbackSeverity::tryFrom($data['severity'] ?? ContextualFeedbackSeverity::OK->value) ?? ContextualFeedbackSeverity::OK,
|
|
(bool)($data['storeInSession'] ?? false)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets the message's storeInSession flag.
|
|
*
|
|
* @return bool TRUE if message should be stored in the session, otherwise FALSE.
|
|
*/
|
|
public function isSessionMessage()
|
|
{
|
|
return $this->storeInSession;
|
|
}
|
|
|
|
/**
|
|
* Sets the message's storeInSession flag
|
|
*
|
|
* @param bool $storeInSession The persistence flag
|
|
*/
|
|
public function setStoreInSession($storeInSession)
|
|
{
|
|
$this->storeInSession = (bool)$storeInSession;
|
|
}
|
|
|
|
/**
|
|
* @return array Data which can be serialized by json_encode()
|
|
*/
|
|
public function jsonSerialize(): array
|
|
{
|
|
$data = parent::jsonSerialize();
|
|
$data['storeInSession'] = $this->storeInSession;
|
|
return $data;
|
|
}
|
|
}
|