|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* webtrees: online genealogy |
|
5
|
|
|
* Copyright (C) 2021 webtrees development team |
|
6
|
|
|
* This program is free software: you can redistribute it and/or modify |
|
7
|
|
|
* it under the terms of the GNU General Public License as published by |
|
8
|
|
|
* the Free Software Foundation, either version 3 of the License, or |
|
9
|
|
|
* (at your option) any later version. |
|
10
|
|
|
* This program is distributed in the hope that it will be useful, |
|
11
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
12
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
13
|
|
|
* GNU General Public License for more details. |
|
14
|
|
|
* You should have received a copy of the GNU General Public License |
|
15
|
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>. |
|
16
|
|
|
*/ |
|
17
|
|
|
|
|
18
|
|
|
declare(strict_types=1); |
|
19
|
|
|
|
|
20
|
|
|
namespace Fisharebest\Webtrees\Module; |
|
21
|
|
|
|
|
22
|
|
|
use Aura\Router\RouterContainer; |
|
23
|
|
|
use Fisharebest\Webtrees\Auth; |
|
24
|
|
|
use Fisharebest\Webtrees\Contracts\UserInterface; |
|
25
|
|
|
use Fisharebest\Webtrees\GedcomRecord; |
|
26
|
|
|
use Fisharebest\Webtrees\I18N; |
|
27
|
|
|
use Fisharebest\Webtrees\Location; |
|
28
|
|
|
use Fisharebest\Webtrees\Registry; |
|
29
|
|
|
use Fisharebest\Webtrees\Tree; |
|
30
|
|
|
use Illuminate\Database\Capsule\Manager as DB; |
|
31
|
|
|
use Psr\Http\Message\ResponseInterface; |
|
32
|
|
|
use Psr\Http\Message\ServerRequestInterface; |
|
33
|
|
|
use Psr\Http\Server\RequestHandlerInterface; |
|
34
|
|
|
|
|
35
|
|
|
use function app; |
|
36
|
|
|
use function assert; |
|
37
|
|
|
use function redirect; |
|
38
|
|
|
|
|
39
|
|
|
/** |
|
40
|
|
|
* Class LocationListModule |
|
41
|
|
|
*/ |
|
42
|
|
|
class LocationListModule extends AbstractModule implements ModuleListInterface, RequestHandlerInterface |
|
43
|
|
|
{ |
|
44
|
|
|
use ModuleListTrait; |
|
45
|
|
|
|
|
46
|
|
|
protected const ROUTE_URL = '/tree/{tree}/location-list'; |
|
47
|
|
|
|
|
48
|
|
|
/** @var int The default access level for this module. It can be changed in the control panel. */ |
|
49
|
|
|
protected $access_level = Auth::PRIV_USER; |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* Initialization. |
|
53
|
|
|
* |
|
54
|
|
|
* @return void |
|
55
|
|
|
*/ |
|
56
|
|
|
public function boot(): void |
|
57
|
|
|
{ |
|
58
|
|
|
$router_container = app(RouterContainer::class); |
|
59
|
|
|
assert($router_container instanceof RouterContainer); |
|
60
|
|
|
|
|
61
|
|
|
$router_container->getMap() |
|
62
|
|
|
->get(static::class, static::ROUTE_URL, $this); |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* How should this module be identified in the control panel, etc.? |
|
67
|
|
|
* |
|
68
|
|
|
* @return string |
|
69
|
|
|
*/ |
|
70
|
|
|
public function title(): string |
|
71
|
|
|
{ |
|
72
|
|
|
/* I18N: Name of a module/list */ |
|
73
|
|
|
return I18N::translate('Locations'); |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* A sentence describing what this module does. |
|
78
|
|
|
* |
|
79
|
|
|
* @return string |
|
80
|
|
|
*/ |
|
81
|
|
|
public function description(): string |
|
82
|
|
|
{ |
|
83
|
|
|
/* I18N: Description of the “Repositories” module */ |
|
84
|
|
|
return I18N::translate('A list of locations.'); |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
|
|
/** |
|
88
|
|
|
* CSS class for the URL. |
|
89
|
|
|
* |
|
90
|
|
|
* @return string |
|
91
|
|
|
*/ |
|
92
|
|
|
public function listMenuClass(): string |
|
93
|
|
|
{ |
|
94
|
|
|
return 'menu-list-loc'; |
|
95
|
|
|
} |
|
96
|
|
|
|
|
97
|
|
|
/** |
|
98
|
|
|
* @return array<string> |
|
99
|
|
|
*/ |
|
100
|
|
|
public function listUrlAttributes(): array |
|
101
|
|
|
{ |
|
102
|
|
|
return []; |
|
103
|
|
|
} |
|
104
|
|
|
|
|
105
|
|
|
/** |
|
106
|
|
|
* @param Tree $tree |
|
107
|
|
|
* |
|
108
|
|
|
* @return bool |
|
109
|
|
|
*/ |
|
110
|
|
|
public function listIsEmpty(Tree $tree): bool |
|
111
|
|
|
{ |
|
112
|
|
|
return !DB::table('other') |
|
113
|
|
|
->where('o_file', '=', $tree->id()) |
|
114
|
|
|
->where('o_type', '=', Location::RECORD_TYPE) |
|
115
|
|
|
->exists(); |
|
116
|
|
|
} |
|
117
|
|
|
|
|
118
|
|
|
/** |
|
119
|
|
|
* Handle URLs generated by older versions of webtrees |
|
120
|
|
|
* |
|
121
|
|
|
* @param ServerRequestInterface $request |
|
122
|
|
|
* |
|
123
|
|
|
* @return ResponseInterface |
|
124
|
|
|
*/ |
|
125
|
|
|
public function getListAction(ServerRequestInterface $request): ResponseInterface |
|
126
|
|
|
{ |
|
127
|
|
|
return redirect($this->listUrl($request->getAttribute('tree'), $request->getQueryParams())); |
|
128
|
|
|
} |
|
129
|
|
|
|
|
130
|
|
|
/** |
|
131
|
|
|
* @param Tree $tree |
|
132
|
|
|
* @param mixed[] $parameters |
|
133
|
|
|
* |
|
134
|
|
|
* @return string |
|
135
|
|
|
*/ |
|
136
|
|
|
public function listUrl(Tree $tree, array $parameters = []): string |
|
137
|
|
|
{ |
|
138
|
|
|
$parameters['tree'] = $tree->name(); |
|
139
|
|
|
|
|
140
|
|
|
return route(static::class, $parameters); |
|
141
|
|
|
} |
|
142
|
|
|
|
|
143
|
|
|
/** |
|
144
|
|
|
* @param ServerRequestInterface $request |
|
145
|
|
|
* |
|
146
|
|
|
* @return ResponseInterface |
|
147
|
|
|
*/ |
|
148
|
|
|
public function handle(ServerRequestInterface $request): ResponseInterface |
|
149
|
|
|
{ |
|
150
|
|
|
$tree = $request->getAttribute('tree'); |
|
151
|
|
|
assert($tree instanceof Tree); |
|
152
|
|
|
|
|
153
|
|
|
$user = $request->getAttribute('user'); |
|
154
|
|
|
assert($user instanceof UserInterface); |
|
155
|
|
|
|
|
156
|
|
|
Auth::checkComponentAccess($this, ModuleListInterface::class, $tree, $user); |
|
157
|
|
|
|
|
158
|
|
|
$locations = DB::table('other') |
|
159
|
|
|
->where('o_file', '=', $tree->id()) |
|
160
|
|
|
->where('o_type', '=', Location::RECORD_TYPE) |
|
161
|
|
|
->get() |
|
162
|
|
|
->map(Registry::locationFactory()->mapper($tree)) |
|
163
|
|
|
->filter(GedcomRecord::accessFilter()); |
|
164
|
|
|
|
|
165
|
|
|
return $this->viewResponse('modules/location-list/page', [ |
|
166
|
|
|
'locations' => $locations, |
|
167
|
|
|
'title' => I18N::translate('Locations'), |
|
168
|
|
|
'tree' => $tree, |
|
169
|
|
|
]); |
|
170
|
|
|
} |
|
171
|
|
|
} |
|
172
|
|
|
|
fisharebest /
webtrees
