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 * Trait ModuleFooterTrait - default implementation of ModuleFooterInterface 25 */ 26trait ModuleFooterTrait 27{ 28 /** @var int The default position for this footer. It can be changed in the control panel. */ 29 protected $footer_order; 30 31 /** 32 * Users change change the order of footers using the control panel. 33 * 34 * @param int $footer_order 35 * 36 * @return void 37 */ 38 public function setFooterOrder(int $footer_order): void 39 { 40 $this->footer_order = $footer_order; 41 } 42 43 /** 44 * Users change change the order of footers using the control panel. 45 * 46 * @return int 47 */ 48 public function getFooterOrder(): int 49 { 50 return $this->footer_order ?? $this->defaultFooterOrder(); 51 } 52 53 /** 54 * The default position for this footer. 55 * 56 * @return int 57 */ 58 public function defaultFooterOrder(): int 59 { 60 return 9999; 61 } 62 63 /** 64 * A footer, to be added at the bottom of every page. 65 * 66 * @param ServerRequestInterface $request 67 * 68 * @return string 69 */ 70 public function getFooter(ServerRequestInterface $request): string 71 { 72 return ''; 73 } 74} 75