-
Notifications
You must be signed in to change notification settings - Fork 3
/
PlacesAndPedigreeMapModuleExtended.php
409 lines (338 loc) · 14.5 KB
/
PlacesAndPedigreeMapModuleExtended.php
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
<?php
namespace Cissee\Webtrees\Module\PPM;
use Cissee\WebtreesExt\Http\Controllers\GenericPlaceHierarchyController;
use Cissee\WebtreesExt\Http\Controllers\ModulePlaceHierarchyInterface;
use Cissee\WebtreesExt\Http\RequestHandlers\FunctionsPlaceProvidersAction;
use Cissee\WebtreesExt\Http\RequestHandlers\IndividualFactsTabExtenderProvidersAction;
use Cissee\WebtreesExt\Module\ModuleMetaInterface;
use Cissee\WebtreesExt\Module\ModuleMetaTrait;
use Cissee\WebtreesExt\Module\ModuleVestalInterface;
use Cissee\WebtreesExt\Module\ModuleVestalTrait;
use Cissee\WebtreesExt\MoreI18N;
use Cissee\WebtreesExt\Requests;
use Fig\Http\Message\RequestMethodInterface;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Menu;
use Fisharebest\Webtrees\Module\ModuleChartInterface;
use Fisharebest\Webtrees\Module\ModuleChartTrait;
use Fisharebest\Webtrees\Module\ModuleConfigInterface;
use Fisharebest\Webtrees\Module\ModuleConfigTrait;
use Fisharebest\Webtrees\Module\ModuleCustomInterface;
use Fisharebest\Webtrees\Module\ModuleCustomTrait;
use Fisharebest\Webtrees\Module\ModuleListInterface;
use Fisharebest\Webtrees\Module\ModuleListTrait;
use Fisharebest\Webtrees\Module\ModuleTabInterface;
use Fisharebest\Webtrees\Module\ModuleTabTrait;
use Fisharebest\Webtrees\Module\PlaceHierarchyListModule;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Services\ChartService;
use Fisharebest\Webtrees\Services\LeafletJsService;
use Fisharebest\Webtrees\Services\ModuleService;
use Fisharebest\Webtrees\Services\RelationshipService;
use Fisharebest\Webtrees\Services\SearchService;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\View;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Vesta\CommonI18N;
use Vesta\HelpTextsPlaceHistory;
use Vesta\Hook\HookInterfaces\FunctionsPlaceInterface;
use Vesta\Hook\HookInterfaces\FunctionsPlaceUtils;
use Vesta\Hook\HookInterfaces\IndividualFactsTabExtenderUtils;
use Vesta\VestaAdminController;
use Vesta\VestaModuleTrait;
use function response;
use function route;
use function view;
//must extend PlaceHierarchyListModule in order to handle urls of standard places via $place->url()
class PlacesAndPedigreeMapModuleExtended extends PlaceHierarchyListModule implements
ModuleCustomInterface,
ModuleMetaInterface,
ModuleConfigInterface,
ModuleTabInterface,
ModuleChartInterface,
ModuleListInterface,
ModulePlaceHierarchyInterface,
ModuleVestalInterface,
RequestHandlerInterface {
use ModuleCustomTrait,
ModuleMetaTrait,
ModuleConfigTrait,
ModuleTabTrait,
ModuleChartTrait,
VestaModuleTrait,
ModuleVestalTrait,
ModuleListTrait {
VestaModuleTrait::customTranslations insteadof ModuleCustomTrait;
VestaModuleTrait::getAssetAction insteadof ModuleCustomTrait;
VestaModuleTrait::assetUrl insteadof ModuleCustomTrait;
VestaModuleTrait::getConfigLink insteadof ModuleConfigTrait;
ModuleMetaTrait::customModuleVersion insteadof ModuleCustomTrait;
ModuleMetaTrait::customModuleLatestVersion insteadof ModuleCustomTrait;
}
use PlacesAndPedigreeMapModuleTrait;
//chart
protected const ROUTE_URL = '/tree/{tree}/vesta-pedigree-map-{generations}/{xref}';
//list
protected const ROUTE_URL_LIST = '/tree/{tree}/vesta-place-list';
// Defaults
public const DEFAULT_GENERATIONS = '4';
public const DEFAULT_PARAMETERS = [
'generations' => self::DEFAULT_GENERATIONS,
];
protected ModuleService $module_service;
protected ChartService $chart_service;
protected LeafletJsService $leaflet_js_service;
protected RelationshipService $relationship_service;
public function __construct(
LeafletJsService $leaflet_js_service,
ModuleService $module_service,
SearchService $search_service,
ChartService $chart_service,
RelationshipService $relationship_service) {
parent::__construct($leaflet_js_service, $module_service, $search_service);
$this->module_service = $module_service;
$this->chart_service = $chart_service;
$this->leaflet_js_service = $leaflet_js_service;
$this->relationship_service = $relationship_service;
}
public function customModuleAuthorName(): string {
return 'Richard Cissée';
}
public function customModuleMetaDatasJson(): string {
return file_get_contents(__DIR__ . '/metadata.json');
}
public function customModuleLatestMetaDatasJsonUrl(): string {
return 'https://raw.githubusercontent.com/vesta-webtrees-2-custom-modules/vesta_places_and_pedigree_map/master/metadata.json';
}
public function customModuleSupportUrl(): string {
return 'https://cissee.de';
}
public function resourcesFolder(): string {
return __DIR__ . '/resources/';
}
public function tabTitle(): string {
return $this->getTabTitle(MoreI18N::xlate('Places'));
}
public function defaultTabOrder(): int {
return 99;
}
public function getTabContent(Individual $individual): string {
$controller = new PlacesController($this, $this->module_service, $this->leaflet_js_service);
return $controller->getTabContent($individual);
}
public function hasTabContent(Individual $individual): bool {
$controller = new PlacesController($this, $this->module_service, $this->leaflet_js_service);
return $controller->hasTabContent($individual);
}
public function isGrayedOut(Individual $individual): bool {
//no need to evaluate here, cf isGrayedOut
return false;
}
public function canLoadAjax(): bool {
return true;
}
/**
* Bootstrap the module
*/
public function onBoot(): void {
//define our 'pretty' routes
//note: potentially problematic in case of name clashes;
//webtrees isn't interested in solving this properly, see
//https://www.webtrees.net/index.php/en/forum/2-open-discussion/33687-pretty-urls-in-2-x
/*
$router_container = app(RouterContainer::class);
assert($router_container instanceof RouterContainer);
$router = $router_container->getMap();
*/
$router = Registry::routeFactory()->routeMap();
//chart
$router
->get(static::class, static::ROUTE_URL, $this)
->allows(RequestMethodInterface::METHOD_POST)
->tokens([
'generations' => '\d+',
]);
//list
$controller = new GenericPlaceHierarchyController($this);
$router
->get(GenericPlaceHierarchyController::class, static::ROUTE_URL_LIST, $controller);
//for GenericPlaceHierarchyController
View::registerCustomView('::modules/generic-place-hierarchy/place-hierarchy', $this->name() . '::modules/generic-place-hierarchy/place-hierarchy');
View::registerCustomView('::modules/generic-place-hierarchy/events', $this->name() . '::modules/generic-place-hierarchy/events');
View::registerCustomView('::modules/generic-place-hierarchy/list', $this->name() . '::modules/generic-place-hierarchy/list');
View::registerCustomView('::modules/generic-place-hierarchy/page', $this->name() . '::modules/generic-place-hierarchy/page');
View::registerCustomView('::modules/generic-place-hierarchy/sidebar', $this->name() . '::modules/generic-place-hierarchy/sidebar');
View::registerCustomView('::lists/place-history', $this->name() . '::lists/place-history');
$this->flashWhatsNew('\Cissee\Webtrees\Module\PPM\WhatsNew', 1);
}
public function chartMenu(Individual $individual): Menu {
return new Menu(
$this->getChartTitle(MoreI18N::xlate('Pedigree map')),
$this->chartUrl($individual),
$this->chartMenuClass(),
$this->chartUrlAttributes()
);
}
public function chartMenuClass(): string {
return 'menu-chart-pedigreemap';
}
public function chartTitle(Individual $individual): string {
/* I18N: %s is an individual’s name */
return $this->getChartTitle(MoreI18N::xlate('Pedigree map of %s', $individual->fullName()));
}
public function chartUrl(Individual $individual, array $parameters = []): string {
return route(static::class, [
'tree' => $individual->tree()->name(),
'xref' => $individual->xref(),
] + $parameters + self::DEFAULT_PARAMETERS);
}
public function getBoxChartMenu(Individual $individual) {
return $this->getChartMenu($individual);
}
public function handle(ServerRequestInterface $request): ResponseInterface {
$controller = new PedigreeMapChartController(
$this,
$this->chart_service,
$this->leaflet_js_service,
$this->relationship_service);
return $controller->handle($request);
}
public function getMapDataAction(ServerRequestInterface $request): ResponseInterface {
//'tree' is handled specifically in Router.php
$tree = $request->getAttribute('tree');
assert($tree instanceof Tree);
$controller = new PedigreeMapChartController(
$this,
$this->chart_service,
$this->leaflet_js_service,
$this->relationship_service);
return $controller->mapData($request, $tree);
}
//////////////////////////////////////////////////////////////////////////////
public function listTitle(): string {
return $this->getListTitle(MoreI18N::xlate('Place hierarchy'));
}
public function listMenuClass(): string {
return 'menu-list-plac';
}
//obsolete, we're using a custom url now!
/*
//cf PlaceHierarchyListModule::handle
public function getListAction(ServerRequestInterface $request): ResponseInterface {
$controller = new GenericPlaceHierarchyController(
$this);
return $controller->handle($request);
}
*/
public function listUrl(Tree $tree, array $parameters = []): string
{
//obsolete, we're using a custom url now!
/*
return route('module', [
'module' => $this->name(),
'action' => 'List',
'tree' => $tree->name(),
] + $parameters);
*/
$parameters['tree'] = $tree->name();
return route(GenericPlaceHierarchyController::class, $parameters);
}
public function listUrlAttributes(): array {
return [];
}
public function getHelpAction(ServerRequestInterface $request): ResponseInterface {
$topic = Requests::getString($request, 'topic');
return response(HelpTextsPlaceHistory::helpText($topic));
}
////////////////////////////////////////////////////////////////////////////
private function title1(): string {
return CommonI18N::locationDataProviders();
}
private function description1(): string {
return CommonI18N::mapCoordinates();
}
private function title2(): string {
return CommonI18N::placeHistoryDataProviders();
}
private function description2(): string {
return CommonI18N::factDataProvidersDescription();
}
//hook management - generalize?
//adapted from ModuleController (e.g. listFooters)
public function getFunctionsPlaceProvidersAction(): ResponseInterface {
$modules = FunctionsPlaceUtils::modules($this, true);
$controller = new VestaAdminController($this);
return $controller->listHooks(
$modules,
FunctionsPlaceInterface::class,
$this->title1(),
$this->description1(),
true,
true);
}
public function getIndividualFactsTabExtenderProvidersAction(): ResponseInterface {
$modules = IndividualFactsTabExtenderUtils::modules($this, true);
$controller = new VestaAdminController($this);
return $controller->listHooks(
$modules,
IndividualFactsTabExtenderUtils::moduleSpecificComponentName($this),
$this->title2(),
$this->description2(),
true,
true,
true);
}
public function postFunctionsPlaceProvidersAction(ServerRequestInterface $request): ResponseInterface {
$controller = new FunctionsPlaceProvidersAction($this);
return $controller->handle($request);
}
public function postIndividualFactsTabExtenderProvidersAction(ServerRequestInterface $request): ResponseInterface {
$controller = new IndividualFactsTabExtenderProvidersAction($this);
return $controller->handle($request);
}
protected function editConfigBeforeFaq() {
$modules1 = FunctionsPlaceUtils::modules($this, true);
$url1 = route('module', [
'module' => $this->name(),
'action' => 'FunctionsPlaceProviders'
]);
$modules2 = IndividualFactsTabExtenderUtils::modules($this, true);
$url2 = route('module', [
'module' => $this->name(),
'action' => 'IndividualFactsTabExtenderProviders'
]);
//cf control-panel.phtml
?>
<div class="card-body">
<div class="row">
<div class="col-sm-9">
<ul class="fa-ul">
<li>
<span class="fa-li"><?= view('icons/block') ?></span>
<a href="<?= e($url1) ?>">
<?= $this->title1() ?>
</a>
<?= view('components/badge', ['count' => $modules1->count()]) ?>
<p class="small text-muted">
<?= $this->description1() ?>
</p>
</li>
<li>
<span class="fa-li"><?= view('icons/block') ?></span>
<a href="<?= e($url2) ?>">
<?= $this->title2() ?>
</a>
<?= view('components/badge', ['count' => $modules2->count()]) ?>
<p class="small text-muted">
<?= $this->description2() ?>
</p>
</li>
</ul>
</div>
</div>
</div>
<?php
}
}