-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFlashMessageQueue.php
More file actions
139 lines (120 loc) · 3.36 KB
/
Copy pathFlashMessageQueue.php
File metadata and controls
139 lines (120 loc) · 3.36 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<?php
namespace Fab\Formule\Service;
/*
* This file is part of the Fab/Formule project under GPLv2 or later.
*
* For the full copyright and license information, please read the
* LICENSE.md file that was distributed with this source code.
*/
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication;
/**
* FlashMessageQueue
*/
class FlashMessageQueue implements SingletonInterface
{
const SUCCESS = 'success';
const WARNING = 'warning';
const ERROR = 'danger';
/**
* @var array
*/
protected $messages = [];
/**
* In-memory fallback when no frontend user session is available (e.g. CLI or before TSFE init).
*
* @var array<string, array<int, array{severity: string, text: string}>>
*/
private static $memoryFallback = [];
/**
* @param string $message
*/
public function success(string $message): void
{
$this->setMessage(self::SUCCESS, $message);
}
/**
* @param string $message
*/
public function warning(string $message): void
{
$this->setMessage(self::WARNING, $message);
}
/**
* @param string $message
*/
public function error(string $message): void
{
$this->setMessage(self::ERROR, $message);
}
/**
* @param string $severity
* @param string $message
*/
protected function setMessage(string $severity, string $message)
{
$messages = $this->getMessages();
if (!is_array($messages)) {
$messages = [];
}
$messages[] = [
'severity' => $severity,
'text' => $message
];
$feUser = $this->getFrontendUser();
if ($feUser !== null) {
$feUser->setAndSaveSessionData($this->getKey(), $messages);
} else {
self::$memoryFallback[$this->getKey()] = $messages;
}
}
/**
* @return array
*/
public function getMessages(): array
{
$feUser = $this->getFrontendUser();
if ($feUser !== null) {
return $feUser->getKey('ses', $this->getKey()) ?? [];
}
return self::$memoryFallback[$this->getKey()] ?? [];
}
/**
* @return array
*/
public function getMessagesAndFlush(): array
{
$messages = $this->getMessages();
$feUser = $this->getFrontendUser();
if ($feUser !== null) {
$feUser->setAndSaveSessionData($this->getKey(), []);
} else {
$key = $this->getKey();
if (isset(self::$memoryFallback[$key])) {
unset(self::$memoryFallback[$key]);
}
}
return $messages;
}
/**
* @return string
*/
protected function getKey(): string
{
return 'formule-flush-messages-' . $this->getTemplateService()->getTemplateIdentifier();
}
protected function getFrontendUser(): ?FrontendUserAuthentication
{
$tsfe = $GLOBALS['TSFE'] ?? null;
if (!is_object($tsfe) || !isset($tsfe->fe_user)) {
return null;
}
$feUser = $tsfe->fe_user;
return $feUser instanceof FrontendUserAuthentication ? $feUser : null;
}
protected function getTemplateService(): TemplateService
{
return GeneralUtility::makeInstance(TemplateService::class);
}
}