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 22use function is_a; 23use function is_array; 24 25/** 26 * Generate messages in one request and display them in the next. 27 */ 28class FlashMessages 29{ 30 // Session storage key 31 private const FLASH_KEY = 'flash_messages'; 32 33 /** 34 * Add a message to the session storage. 35 * 36 * @param string $text 37 * @param string $status "success", "info", "warning" or "danger" 38 * 39 * @return void 40 */ 41 public static function addMessage(string $text, string $status = 'info'): void 42 { 43 $messages = Session::get(self::FLASH_KEY); 44 $messages = is_array($messages) ? $messages : []; 45 46 $messages[] = (object) [ 47 'text' => $text, 48 'status' => $status, 49 ]; 50 51 Session::put(self::FLASH_KEY, $messages); 52 } 53 54 /** 55 * Get the current messages, and remove them from session storage. 56 * 57 * @return array<object> 58 */ 59 public static function getMessages(): array 60 { 61 $messages = Session::pull(self::FLASH_KEY); 62 63 return is_array($messages) ? $messages : []; 64 } 65} 66