blob: 5142030a8f4dd25324fcba4507c4a6bc24f70f8f (
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
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<?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\Auth;
use Fisharebest\Webtrees\Http\Exceptions\HttpAccessDeniedException;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\Validator;
use Illuminate\Support\Collection;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use function response;
use function view;
/**
* Trait ModuleTabTrait - default implementation of ModuleTabInterface
*/
trait ModuleTabTrait
{
// The default position for this tab. It can be changed in the control panel.
protected int $tab_order;
abstract public function title(): string;
/**
* The text that appears on the tab.
*
* @return string
*/
public function tabTitle(): string
{
return $this->title();
}
/**
* Get the current access level for a module
*
* @template T of ModuleInterface
*
* @param Tree $tree
* @param class-string<T> $interface
*
* @return int
*/
abstract public function accessLevel(Tree $tree, string $interface): int;
/**
* Users change change the order of tabs using the control panel.
*
* @param int $tab_order
*
* @return void
*/
public function setTabOrder(int $tab_order): void
{
$this->tab_order = $tab_order;
}
/**
* Users change change the order of tabs using the control panel.
*
* @return int
*/
public function getTabOrder(): int
{
return $this->tab_order ?? $this->defaultTabOrder();
}
/**
* The default position for this tab. It can be changed in the control panel.
*
* @return int
*/
public function defaultTabOrder(): int
{
return 9999;
}
/**
* This module handles the following facts - so don't show them on the "Facts and events" tab.
*
* @return Collection<int,string>
*/
public function supportedFacts(): Collection
{
return new Collection();
}
/**
* Generate the HTML content of this tab.
*
* @param Individual $individual
*
* @return string
*/
public function getTabContent(Individual $individual): string
{
return '';
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function getTabAction(ServerRequestInterface $request): ResponseInterface
{
$tree = Validator::attributes($request)->tree();
$user = Validator::attributes($request)->user();
$xref = Validator::queryParams($request)->isXref()->string('xref');
$record = Registry::individualFactory()->make($xref, $tree);
$record = Auth::checkIndividualAccess($record);
if ($this->accessLevel($tree, ModuleTabInterface::class) < Auth::accessLevel($tree, $user)) {
throw new HttpAccessDeniedException();
}
$layout = view('layouts/ajax', [
'content' => $this->getTabContent($record),
]);
return response($layout);
}
}
|
