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\Module; 21 22use Psr\Http\Message\ServerRequestInterface; 23 24/** 25 * Interface ModuleFooterInterface - Add content to the bottom of every page. 26 */ 27interface ModuleFooterInterface extends ModuleInterface 28{ 29 /** 30 * Users change change the order of footers using the control panel. 31 * 32 * @param int $footer_order 33 * 34 * @return void 35 */ 36 public function setFooterOrder(int $footer_order): void; 37 38 /** 39 * Users change change the order of footers using the control panel. 40 * 41 * @return int 42 */ 43 public function getFooterOrder(): int; 44 45 /** 46 * The default position for this footer. It can be changed in the control panel. 47 * 48 * @return int 49 */ 50 public function defaultFooterOrder(): int; 51 52 /** 53 * A footer, to be added at the bottom of every page. 54 * 55 * @param ServerRequestInterface $request 56 * 57 * @return string 58 */ 59 public function getFooter(ServerRequestInterface $request): string; 60} 61