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