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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2021 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 Aura\Router\RouterContainer;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Contracts\UserInterface;
use Fisharebest\Webtrees\GedcomRecord;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Location;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Tree;
use Illuminate\Database\Capsule\Manager as DB;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use function app;
use function assert;
use function redirect;
/**
* Class LocationListModule
*/
class LocationListModule extends AbstractModule implements ModuleListInterface, RequestHandlerInterface
{
use ModuleListTrait;
protected const ROUTE_URL = '/tree/{tree}/location-list';
/** @var int The default access level for this module. It can be changed in the control panel. */
protected int $access_level = Auth::PRIV_USER;
/**
* Initialization.
*
* @return void
*/
public function boot(): void
{
$router_container = app(RouterContainer::class);
assert($router_container instanceof RouterContainer);
$router_container->getMap()
->get(static::class, static::ROUTE_URL, $this);
}
/**
* How should this module be identified in the control panel, etc.?
*
* @return string
*/
public function title(): string
{
/* I18N: Name of a module/list */
return I18N::translate('Locations');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function description(): string
{
/* I18N: Description of the “Locations” module */
return I18N::translate('A list of locations.');
}
/**
* CSS class for the URL.
*
* @return string
*/
public function listMenuClass(): string
{
return 'menu-list-loc';
}
/**
* @return array<string>
*/
public function listUrlAttributes(): array
{
return [];
}
/**
* @param Tree $tree
*
* @return bool
*/
public function listIsEmpty(Tree $tree): bool
{
return !DB::table('other')
->where('o_file', '=', $tree->id())
->where('o_type', '=', Location::RECORD_TYPE)
->exists();
}
/**
* Handle URLs generated by older versions of webtrees
*
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function getListAction(ServerRequestInterface $request): ResponseInterface
{
return redirect($this->listUrl($request->getAttribute('tree'), $request->getQueryParams()));
}
/**
* @param Tree $tree
* @param array<bool|int|string|array|null> $parameters
*
* @return string
*/
public function listUrl(Tree $tree, array $parameters = []): string
{
$parameters['tree'] = $tree->name();
return route(static::class, $parameters);
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function handle(ServerRequestInterface $request): ResponseInterface
{
$tree = $request->getAttribute('tree');
assert($tree instanceof Tree);
$user = $request->getAttribute('user');
assert($user instanceof UserInterface);
Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user);
$locations = DB::table('other')
->where('o_file', '=', $tree->id())
->where('o_type', '=', Location::RECORD_TYPE)
->get()
->map(Registry::locationFactory()->mapper($tree))
->filter(GedcomRecord::accessFilter());
return $this->viewResponse('modules/location-list/page', [
'locations' => $locations,
'title' => I18N::translate('Locations'),
'tree' => $tree,
]);
}
}
|
