1 | <?php |
||
2 | |||
3 | /** |
||
4 | * webtrees: online genealogy |
||
5 | * Copyright (C) 2025 webtrees development team |
||
6 | * This program is free software: you can redistribute it and/or modify |
||
7 | * it under the terms of the GNU General Public License as published by |
||
8 | * the Free Software Foundation, either version 3 of the License, or |
||
9 | * (at your option) any later version. |
||
10 | * This program is distributed in the hope that it will be useful, |
||
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
||
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||
13 | * GNU General Public License for more details. |
||
14 | * You should have received a copy of the GNU General Public License |
||
15 | * along with this program. If not, see <https://www.gnu.org/licenses/>. |
||
16 | */ |
||
17 | |||
18 | declare(strict_types=1); |
||
19 | |||
20 | namespace Fisharebest\Webtrees; |
||
21 | |||
22 | use function is_array; |
||
23 | |||
24 | /** |
||
25 | * Generate messages in one request and display them in the next. |
||
26 | */ |
||
27 | class FlashMessages |
||
28 | { |
||
29 | // Session storage key |
||
30 | private const string FLASH_KEY = 'flash_messages'; |
||
0 ignored issues
–
show
Bug
introduced
by
![]() |
|||
31 | |||
32 | /** |
||
33 | * Add a message to the session storage. |
||
34 | * |
||
35 | * @param string $text |
||
36 | * @param string $status "success", "info", "warning" or "danger" |
||
37 | * |
||
38 | * @return void |
||
39 | */ |
||
40 | public static function addMessage(string $text, string $status = 'info'): void |
||
41 | { |
||
42 | $messages = Session::get(self::FLASH_KEY); |
||
43 | $messages = is_array($messages) ? $messages : []; |
||
44 | |||
45 | $messages[] = (object) [ |
||
46 | 'text' => $text, |
||
47 | 'status' => $status, |
||
48 | ]; |
||
49 | |||
50 | Session::put(self::FLASH_KEY, $messages); |
||
51 | } |
||
52 | |||
53 | /** |
||
54 | * Get the current messages, and remove them from session storage. |
||
55 | * |
||
56 | * @return array<object{text:string,status:string}> |
||
57 | */ |
||
58 | public static function getMessages(): array |
||
59 | { |
||
60 | $messages = Session::pull(self::FLASH_KEY); |
||
61 | |||
62 | return is_array($messages) ? $messages : []; |
||
63 | } |
||
64 | } |
||
65 |