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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
<?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 Fisharebest\Webtrees\Menu;
use Fisharebest\Webtrees\Tree;
/**
* Trait ModuleListTrait - default implementation of ModuleListInterface
*/
trait ModuleListTrait
{
/**
* A unique internal name for this module (based on the installation folder).
*
* @return string
*/
abstract public function name(): string;
abstract public function title(): string;
/**
* A main menu item for this list, or null if the list is empty.
*
* @param Tree $tree
*
* @return Menu|null
*/
public function listMenu(Tree $tree): Menu|null
{
if ($this->listIsEmpty($tree)) {
return null;
}
return new Menu(
$this->listTitle(),
$this->listUrl($tree),
$this->listMenuClass(),
$this->listUrlAttributes()
);
}
/**
* CSS class for the menu.
*
* @return string
*/
public function listMenuClass(): string
{
return '';
}
/**
* The title for a specific instance of this list.
*
* @return string
*/
public function listTitle(): string
{
return $this->title();
}
/**
* The URL for a page showing list options.
*
* @param Tree $tree
* @param array<bool|int|string|array<string>|null> $parameters
*
* @return string
*/
public function listUrl(Tree $tree, array $parameters = []): string
{
return route('module', [
'module' => $this->name(),
'action' => 'List',
'tree' => $tree->name(),
] + $parameters);
}
/**
* Attributes for the URL.
*
* @return array<string>
*/
public function listUrlAttributes(): array
{
return ['rel' => 'nofollow'];
}
/**
* @param Tree $tree
*
* @return bool
*/
public function listIsEmpty(Tree $tree): bool
{
return false;
}
}
|
