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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
<?php
declare(strict_types=1);
class Message
{
private static $list = array();
private static $alreadyDisplayed = array();
private static $flushed = false;
/**
* Add error message to page. If messages have not been flushed
* yet, it will be added to the queue, otherwise it will be added
* in place during rendering.
*/
public static function addError(string $id, ...$params): void
{
self::add('danger', $id, $params);
}
public static function addWarning(string $id, ...$params): void
{
self::add('warning', $id, $params);
}
public static function addInfo(string $id, ...$params): void
{
self::add('info', $id, $params);
}
public static function addSuccess(string $id, ...$params): void
{
self::add('success', $id, $params);
}
/**
* Internal function that adds a message. Used by
* addError/Success/Info/... above.
*/
private static function add(string $type, string $id, array $params): void
{
if (strstr($id, '.') === false) {
$id = Page::getModule()->getIdentifier() . '.' . $id;
}
if (!empty($params) && $params[0] === true) {
$params = array_slice($params, 1);
$linkModule = true;
} else {
$linkModule = false;
}
switch ($type) {
case 'danger':
$icon = 'exclamation-sign';
break;
case 'warning':
$icon = 'warning';
break;
case 'info':
$icon = 'info-sign';
break;
case 'success':
$icon = 'ok';
break;
default:
$icon = '';
}
ArrayUtil::forceType($params, 'string');
self::$list[] = array(
'type' => $type,
'icon' => $icon,
'id' => $id,
'params' => $params,
'link' => $linkModule
);
if (self::$flushed) {
self::renderList();
}
}
/**
* Render all currently queued messages, flushing the queue.
* After calling this, any further calls to add* will be rendered in
* place in the current page output.
*/
public static function renderList(): void
{
self::$flushed = true;
if (empty(self::$list))
return;
// Ajax
$mangled = array();
foreach (self::$list as $item) {
if (!preg_match('/^(\w+)\.(.+)$/', $item['id'], $out)) {
$message = 'Invalid Message ID format: ' . $item['id'];
} else {
$message = Dictionary::getMessage($out[1], $out[2]);
}
foreach ($item['params'] as $index => $text) {
$message = str_replace('{{' . $index . '}}', '<b>' . htmlspecialchars($text) . '</b>', $message);
}
if ($item['link'] && isset($out[1])) {
$item['link'] = $out[1];
}
$mangled[] = array(
'type' => $item['type'],
'icon' => $item['icon'],
'message' => $message,
'link' => $item['link']
);
}
if (AJAX) {
foreach ($mangled as $entry) {
echo Render::parse('messagebox', $entry, 'main');
}
} else {
// Non-Ajax
foreach ($mangled as $entry) {
Render::addTemplate('messagebox', $entry, 'main');
}
self::$alreadyDisplayed = array_merge(self::$alreadyDisplayed, self::$list);
}
self::$list = array();
}
/**
* Get all queued messages, flushing the queue.
* Useful in api/ajax mode.
*/
public static function asString(): string
{
$return = '';
foreach (self::$list as $item) {
if (!preg_match('/^(\w+)\.(.+)$/', $item['id'], $out)) {
$message = 'Invalid Message ID format: ' . $item['id'];
} else {
$message = Dictionary::getMessage($out[1], $out[2]);
}
foreach ($item['params'] as $index => $text) {
$message = str_replace('{{' . $index . '}}', $text, $message);
}
$return .= '[' . $item['type'] . ']: ' . $message . "\n";
self::$alreadyDisplayed[] = $item;
}
self::$list = array();
return $return;
}
/**
* Deserialize any messages from the current HTTP request and
* place them in the message queue.
*/
public static function fromRequest(): void
{
$messages = is_array($_REQUEST['message']) ? $_REQUEST['message'] : array($_REQUEST['message']);
foreach ($messages as $message) {
$data = explode('|', $message);
if (count($data) < 2)
continue;
if (substr($data[0], -1) === '@') {
$data[0] = substr($data[0], 0, -1);
array_splice($data, 2, 0, true);
}
if (!preg_match('/^(danger|warning|info|success)$/', $data[0]))
continue;
self::add($data[0], $data[1], array_slice($data, 2));
}
}
/**
* Turn the current message queue into a serialized version,
* suitable for appending to a GET or POST request
*/
public static function toRequest(): string
{
$parts = array();
foreach (array_merge(self::$list, self::$alreadyDisplayed) as $item) {
if (isset($item['link']) && $item['link']) {
$item['type'] .= '@';
}
$str = 'message[]=' . urlencode($item['type'] . '|' .$item['id']);
if (!empty($item['params'])) {
$str .= '|' . urlencode(implode('|', $item['params']));
}
$parts[] = $str;
}
return implode('&', $parts);
}
}
|
