xref: /webtrees/app/FlashMessages.php (revision eaf6176917d65962efb940f4ca71c92d33ea9f35)
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	// Session storage key
25	const FLASH_KEY = 'flash_messages';
26
27	/**
28	 * Add a message to the session storage.
29	 *
30	 * @param string $text
31	 * @param string $status "success", "info", "warning" or "danger"
32	 */
33	public static function addMessage($text, $status = 'info') {
34		$message         = new stdClass;
35		$message->text   = $text;
36		$message->status = $status;
37
38		$messages   = Session::get(self::FLASH_KEY, []);
39		$messages[] = $message;
40		Session::put(self::FLASH_KEY, $messages);
41	}
42
43	/**
44	 * Get the current messages, and remove them from session storage.
45	 *
46	 * @return stdClass[]
47	 */
48	public static function getMessages() {
49		$messages = Session::get(self::FLASH_KEY, []);
50		Session::forget(self::FLASH_KEY);
51
52		return $messages;
53	}
54}
55