blob: b145bfa98e1d9fbe3747206e0a1b72aafed7225d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Psr\Http\Message\ServerRequestInterface;
/**
* Trait ModuleFooterTrait - default implementation of ModuleFooterInterface
*/
trait ModuleFooterTrait
{
// The default position for this footer. It can be changed in the control panel.
protected int $footer_order;
/**
* Users can change the order of footers using the control panel.
*
* @param int $footer_order
*
* @return void
*/
public function setFooterOrder(int $footer_order): void
{
$this->footer_order = $footer_order;
}
/**
* Users can change the order of footers using the control panel.
*
* @return int
*/
public function getFooterOrder(): int
{
return $this->footer_order ?? $this->defaultFooterOrder();
}
/**
* The default position for this footer.
*
* @return int
*/
public function defaultFooterOrder(): int
{
return 9999;
}
/**
* A footer, to be added at the bottom of every page.
*
* @param ServerRequestInterface $request
*
* @return string
*/
public function getFooter(ServerRequestInterface $request): string
{
return '';
}
}
|
