xref: /webtrees/app/FlashMessages.php (revision df27497a949ee94233b78915e33f253447a14e62)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees;
21
22use stdClass;
23
24/**
25 * Generate messages in one request and display them in the next.
26 */
27class FlashMessages
28{
29    // Session storage key
30    private const FLASH_KEY = 'flash_messages';
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($text, $status = 'info'): void
41    {
42        $message         = new stdClass();
43        $message->text   = $text;
44        $message->status = $status;
45
46        $messages   = Session::get(self::FLASH_KEY, []);
47        $messages[] = $message;
48        Session::put(self::FLASH_KEY, $messages);
49    }
50
51    /**
52     * Get the current messages, and remove them from session storage.
53     *
54     * @return stdClass[]
55     */
56    public static function getMessages(): array
57    {
58        $messages = Session::get(self::FLASH_KEY, []);
59        Session::forget(self::FLASH_KEY);
60
61        return $messages;
62    }
63}
64