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