1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>. 16 */ 17declare(strict_types=1); 18 19namespace Fisharebest\Webtrees\Module; 20 21use Psr\Http\Message\ServerRequestInterface; 22 23/** 24 * Interface ModuleFooterInterface - Add content to the bottom of every page. 25 */ 26interface ModuleFooterInterface extends ModuleInterface 27{ 28 /** 29 * Users change change the order of footers using the control panel. 30 * 31 * @param int $footer_order 32 * 33 * @return void 34 */ 35 public function setFooterOrder(int $footer_order): void; 36 37 /** 38 * Users change change the order of footers using the control panel. 39 * 40 * @return int 41 */ 42 public function getFooterOrder(): int; 43 44 /** 45 * The default position for this footer. It can be changed in the control panel. 46 * 47 * @return int 48 */ 49 public function defaultFooterOrder(): int; 50 51 /** 52 * A footer, to be added at the bottom of every page. 53 * 54 * @param ServerRequestInterface $request 55 * 56 * @return string 57 */ 58 public function getFooter(ServerRequestInterface $request): string; 59} 60