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