xref: /webtrees/app/FlashMessages.php (revision 3976b4703df669696105ed6b024b96d433c8fbdb)
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 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees;
20
21use stdClass;
22
23/**
24 * Generate messages in one request and display them in the next.
25 */
26class FlashMessages
27{
28    // Session storage key
29    private const FLASH_KEY = 'flash_messages';
30
31    /**
32     * Add a message to the session storage.
33     *
34     * @param string $text
35     * @param string $status "success", "info", "warning" or "danger"
36     *
37     * @return void
38     */
39    public static function addMessage($text, $status = 'info'): void
40    {
41        $message         = new stdClass();
42        $message->text   = $text;
43        $message->status = $status;
44
45        $messages   = Session::get(self::FLASH_KEY, []);
46        $messages[] = $message;
47        Session::put(self::FLASH_KEY, $messages);
48    }
49
50    /**
51     * Get the current messages, and remove them from session storage.
52     *
53     * @return stdClass[]
54     */
55    public static function getMessages(): array
56    {
57        $messages = Session::get(self::FLASH_KEY, []);
58        Session::forget(self::FLASH_KEY);
59
60        return $messages;
61    }
62}
63