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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
<?php declare(strict_types = 0);
/*
** Zabbix
** Copyright (C) 2001-2022 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
/**
* Helper to store success / error messages.
*/
class CMessageHelper {
public const MESSAGE_TYPE_ERROR = 'error';
public const MESSAGE_TYPE_SUCCESS = 'success';
public const MESSAGE_TYPE_WARNING = 'warning';
/**
* @var string
*/
private static $type;
/**
* @var string
*/
private static $title;
/**
* Messages array.
*
* @var array
*/
private static $messages = [];
/**
* Schedule messages from form data.
*
* @var array
*/
private static $schedule_messages = [];
/**
* Get messages.
*
* @return array
*/
public static function getMessages(): array {
return self::$messages;
}
/**
* Add message.
*
* @param array $message
*/
public static function addMessage(array $message): void {
if ($message['type'] === self::MESSAGE_TYPE_SUCCESS) {
self::addSuccess($message['message']);
}
elseif ($message['type'] === self::MESSAGE_TYPE_WARNING) {
self::addWarning($message['message']);
}
else {
self::addError($message['message'], $message['is_technical_error']);
}
}
/**
* Add message with type error.
*
* @param string $message
* @param bool $is_technical_error
*/
public static function addError(string $message, bool $is_technical_error = false): void {
if (self::$type === null) {
self::$type = self::MESSAGE_TYPE_ERROR;
}
self::$messages[] = [
'type' => self::MESSAGE_TYPE_ERROR,
'message' => $message,
'is_technical_error' => $is_technical_error
];
}
/**
* Add message with type info.
*
* @param string $message
*/
public static function addSuccess(string $message): void {
self::$messages[] = [
'type' => self::MESSAGE_TYPE_SUCCESS,
'message' => $message
];
}
/**
* Add message with type warning.
*
* @param string $message
*/
public static function addWarning(string $message): void {
self::$messages[] = [
'type' => self::MESSAGE_TYPE_WARNING,
'message' => $message
];
}
/**
* Get messages title.
*
* @return string|null
*/
public static function getTitle(): ?string {
return self::$title;
}
/**
* Set title for error messages.
*
* @param string $title
*/
public static function setErrorTitle(string $title): void {
self::$type = self::MESSAGE_TYPE_ERROR;
self::$title = $title;
}
/**
* Set title for info messages.
*
* @param $title
*/
public static function setSuccessTitle(string $title): void {
self::$type = self::MESSAGE_TYPE_SUCCESS;
self::$title = $title;
}
/**
* Get messages type.
*
* @return string
*/
public static function getType(): ?string {
return self::$type;
}
/**
* Clear messages.
*/
public static function clear(): void {
self::$type = null;
self::$title = null;
self::$messages = [];
}
/**
* Set messages from FormData.
*
* @param array $messages
*/
public static function setScheduleMessages(array $messages): void {
self::$schedule_messages = $messages;
}
/**
* Restore schedule messages.
*/
public static function restoreScheduleMessages(array $current_messages = []): void {
if (self::$schedule_messages) {
if (array_key_exists('success', self::$schedule_messages) && self::$schedule_messages['success']) {
self::setSuccessTitle(self::$schedule_messages['success']);
}
if (array_key_exists('error', self::$schedule_messages) && self::$schedule_messages['error']) {
self::setErrorTitle(self::$schedule_messages['error']);
}
if (array_key_exists('messages', self::$schedule_messages)) {
foreach (self::$schedule_messages['messages'] as $message) {
if (!self::checkDuplicates($message, $current_messages)) {
continue;
}
self::addMessage($message);
}
}
self::$schedule_messages = [];
}
}
/**
* Check duplicate from current message for schedule message.
*
* @param array $message
* @param array $current_messages
*
* @return boolean
*/
protected static function checkDuplicates(array $message, array $current_messages): bool {
foreach ($current_messages as $known_messages) {
foreach ($known_messages['messages'] as $known_message) {
if (count(array_diff_assoc($known_message, $message)) === 0) {
return false;
}
}
}
return true;
}
}
|
