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
|
<?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\Contracts\UserInterface;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Module\InteractiveTree\TreeView;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Services\ModuleService;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\Validator;
use Illuminate\Support\Str;
use Psr\Http\Message\ServerRequestInterface;
use function extract;
use function uasort;
use function view;
use const EXTR_OVERWRITE;
class ChartsBlockModule extends AbstractModule implements ModuleBlockInterface
{
use ModuleBlockTrait;
private ModuleService $module_service;
/**
* @param ModuleService $module_service
*/
public function __construct(ModuleService $module_service)
{
$this->module_service = $module_service;
}
public function title(): string
{
/* I18N: Name of a module/block */
return I18N::translate('Charts');
}
public function description(): string
{
/* I18N: Description of the “Charts” module */
return I18N::translate('An alternative way to display charts.');
}
/**
* Generate the HTML content of this block.
*
* @param Tree $tree
* @param int $block_id
* @param string $context
* @param array<string,string> $config
*
* @return string
*/
public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
{
$PEDIGREE_ROOT_ID = $tree->getPreference('PEDIGREE_ROOT_ID');
$gedcomid = $tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_ACCOUNT_XREF);
$default_xref = $gedcomid ?: $PEDIGREE_ROOT_ID;
$type = $this->getBlockSetting($block_id, 'type', 'pedigree');
$xref = $this->getBlockSetting($block_id, 'pid', $default_xref);
extract($config, EXTR_OVERWRITE);
$individual = Registry::individualFactory()->make($xref, $tree);
$title = $this->title();
if ($individual instanceof Individual) {
switch ($type) {
default:
case 'pedigree':
$module = $this->module_service->findByInterface(PedigreeChartModule::class)->first();
if ($module instanceof PedigreeChartModule) {
$title = $module->chartTitle($individual);
$chart_url = $module->chartUrl($individual, [
'ajax' => true,
'generations' => 3,
'layout' => PedigreeChartModule::STYLE_RIGHT,
]);
$content = view('modules/charts/chart', [
'block_id' => $block_id,
'chart_url' => $chart_url,
]);
} else {
$title = I18N::translate('Pedigree');
$content = I18N::translate('The module “%s” has been disabled.', $title);
}
break;
case 'descendants':
$module = $this->module_service->findByInterface(DescendancyChartModule::class)->first();
if ($module instanceof DescendancyChartModule) {
$title = $module->chartTitle($individual);
$chart_url = $module->chartUrl($individual, [
'ajax' => true,
'generations' => 2,
'chart_style' => DescendancyChartModule::CHART_STYLE_TREE,
]);
$content = view('modules/charts/chart', [
'block_id' => $block_id,
'chart_url' => $chart_url,
]);
} else {
$title = I18N::translate('Descendants');
$content = I18N::translate('The module “%s” has been disabled.', $title);
}
break;
case 'hourglass':
$module = $this->module_service->findByInterface(HourglassChartModule::class)->first();
if ($module instanceof HourglassChartModule) {
$title = $module->chartTitle($individual);
$chart_url = $module->chartUrl($individual, [
'ajax' => true,
'generations' => 2,
]);
$content = view('modules/charts/chart', [
'block_id' => $block_id,
'chart_url' => $chart_url,
]);
} else {
$title = I18N::translate('Hourglass chart');
$content = I18N::translate('The module “%s” has been disabled.', $title);
}
break;
case 'treenav':
$module = $this->module_service->findByInterface(InteractiveTreeModule::class)->first();
if ($module instanceof InteractiveTreeModule) {
$title = I18N::translate('Interactive tree of %s', $individual->fullName());
$tv = new TreeView();
[$html, $js] = $tv->drawViewport($individual, 2);
$js = 'document.addEventListener("DOMContentLoaded", function() {' . $js . '});';
$content = $html . '<script>' . $js . '</script>';
} else {
$title = I18N::translate('Interactive tree');
$content = I18N::translate('The module “%s” has been disabled.', $title);
}
break;
}
} else {
$content = I18N::translate('You must select an individual and a chart type in the block preferences');
}
if ($context !== self::CONTEXT_EMBED) {
return view('modules/block-template', [
'block' => Str::kebab($this->name()),
'id' => $block_id,
'config_url' => $this->configUrl($tree, $context, $block_id),
'title' => $title,
'content' => $content,
]);
}
return $content;
}
/**
* Can this block be shown on the tree’s home page?
*
* @return bool
*/
public function isTreeBlock(): bool
{
return true;
}
/**
* Update the configuration for a block.
*
* @param ServerRequestInterface $request
* @param int $block_id
*
* @return void
*/
public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
{
$type = Validator::parsedBody($request)->string('type');
$xref = Validator::parsedBody($request)->isXref()->string('xref');
$this->setBlockSetting($block_id, 'type', $type);
$this->setBlockSetting($block_id, 'pid', $xref);
}
/**
* An HTML form to edit block settings
*
* @param Tree $tree
* @param int $block_id
*
* @return string
*/
public function editBlockConfiguration(Tree $tree, int $block_id): string
{
$PEDIGREE_ROOT_ID = $tree->getPreference('PEDIGREE_ROOT_ID');
$gedcomid = $tree->getUserPreference(Auth::user(), UserInterface::PREF_TREE_ACCOUNT_XREF);
$default_xref = $gedcomid ?: $PEDIGREE_ROOT_ID;
$type = $this->getBlockSetting($block_id, 'type', 'pedigree');
$xref = $this->getBlockSetting($block_id, 'pid', $default_xref);
$charts = [
'pedigree' => I18N::translate('Pedigree'),
'descendants' => I18N::translate('Descendants'),
'hourglass' => I18N::translate('Hourglass chart'),
'treenav' => I18N::translate('Interactive tree'),
];
uasort($charts, I18N::comparator());
$individual = Registry::individualFactory()->make($xref, $tree);
return view('modules/charts/config', [
'charts' => $charts,
'individual' => $individual,
'tree' => $tree,
'type' => $type,
]);
}
}
|
