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
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2018 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 <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Exceptions\IndividualAccessDeniedException;
use Fisharebest\Webtrees\Exceptions\IndividualNotFoundException;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Menu;
use Fisharebest\Webtrees\Module\InteractiveTree\TreeView;
use Fisharebest\Webtrees\Tree;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
/**
* Class InteractiveTreeModule
* Tip : you could change the number of generations loaded before ajax calls both in individual page and in treeview page to optimize speed and server load
*/
class InteractiveTreeModule extends AbstractModule implements ModuleTabInterface, ModuleChartInterface
{
/** {@inheritdoc} */
public function getTitle(): string
{
/* I18N: Name of a module */
return I18N::translate('Interactive tree');
}
/** {@inheritdoc} */
public function getDescription(): string
{
/* I18N: Description of the “Interactive tree” module */
return I18N::translate('An interactive tree, showing all the ancestors and descendants of an individual.');
}
/** {@inheritdoc} */
public function defaultTabOrder(): int
{
return 68;
}
/** {@inheritdoc} */
public function getTabContent(Individual $individual): string
{
$treeview = new TreeView('tvTab');
list($html, $js) = $treeview->drawViewport($individual, 3);
return view('modules/tree/tab', [
'html' => $html,
'js' => $js,
'treeview_css' => $this->css(),
'treeview_js' => $this->js(),
]);
}
/**
* @return string
*/
public function css(): string
{
return WT_MODULES_DIR . $this->getName() . '/css/treeview.css';
}
/**
* @return string
*/
public function js(): string
{
return WT_MODULES_DIR . $this->getName() . '/js/treeview.js';
}
/** {@inheritdoc} */
public function hasTabContent(Individual $individual): bool
{
return true;
}
/** {@inheritdoc} */
public function isGrayedOut(Individual $individual): bool
{
return false;
}
/** {@inheritdoc} */
public function canLoadAjax(): bool
{
return true;
}
/**
* Return a menu item for this chart.
*
* @param Individual $individual
*
* @return Menu|null
*/
public function getChartMenu(Individual $individual)
{
return new Menu(
$this->getTitle(),
route('module', [
'module' => $this->getName(),
'action' => 'Treeview',
'xref' => $individual->getXref(),
'ged' => $individual->getTree()->getName(),
]),
'menu-chart-tree',
['rel' => 'nofollow']
);
}
/**
* Return a menu item for this chart - for use in individual boxes.
*
* @param Individual $individual
*
* @return Menu|null
*/
public function getBoxChartMenu(Individual $individual)
{
return $this->getChartMenu($individual);
}
/**
* @param Request $request
* @param Tree $tree
*
* @return Response
*/
public function getTreeviewAction(Request $request, Tree $tree): Response
{
$xref = $request->get('xref', '');
$individual = Individual::getInstance($xref, $tree);
if ($individual === null) {
throw new IndividualNotFoundException();
}
if (!$individual->canShow()) {
throw new IndividualAccessDeniedException();
}
$tv = new TreeView('tv');
list($html, $js) = $tv->drawViewport($individual, 4);
$title = I18N::translate('Interactive tree of %s', $individual->getFullName());
return $this->viewResponse('interactive-tree-page', [
'title' => $title,
'individual' => $individual,
'js' => $js,
'html' => $html,
'tree' => $tree,
]);
}
/**
* @param Request $request
* @param Tree $tree
*
* @return Response
*/
public function getDetailsAction(Request $request, Tree $tree): Response
{
$pid = $request->get('pid', WT_REGEX_XREF);
$individual = Individual::getInstance($pid, $tree);
if ($individual === null) {
throw new IndividualNotFoundException();
}
if (!$individual->canShow()) {
throw new IndividualAccessDeniedException();
}
$instance = $request->get('instance', '');
$treeview = new TreeView($instance);
return new Response($treeview->getDetails($individual));
}
/**
* @param Request $request
* @param Tree $tree
*
* @return Response
*/
public function getPersonsAction(Request $request, Tree $tree): Response
{
$q = $request->get('q', '');
$instance = $request->get('instance', '');
$treeview = new TreeView($instance);
return new Response($treeview->getPersons($tree, $q));
}
}
|
