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