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