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
|
<?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/>.
*/
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\Functions\FunctionsDb;
use Fisharebest\Webtrees\Functions\FunctionsPrintLists;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Query\QueryName;
use Fisharebest\Webtrees\Tree;
/**
* Class TopSurnamesModule
*/
class TopSurnamesModule extends AbstractModule implements ModuleBlockInterface
{
// Default values for new blocks.
const DEFAULT_NUMBER = 10;
const DEFAULT_STYLE = 'table';
/**
* How should this module be labelled on tabs, menus, etc.?
*
* @return string
*/
public function getTitle()
{
return /* I18N: Name of a module. Top=Most common */
I18N::translate('Top surnames');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function getDescription()
{
return /* I18N: Description of the “Top surnames” module */
I18N::translate('A list of the most popular surnames.');
}
/**
* Generate the HTML content of this block.
*
* @param Tree $tree
* @param int $block_id
* @param bool $template
* @param string[] $cfg
*
* @return string
*/
public function getBlock(Tree $tree, int $block_id, bool $template = true, array $cfg = []): string
{
global $ctype;
$num = $this->getBlockSetting($block_id, 'num', self::DEFAULT_NUMBER);
$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_STYLE);
extract($cfg, EXTR_OVERWRITE);
// This next function is a bit out of date, and doesn't cope well with surname variants
$top_surnames = FunctionsDb::getTopSurnames($tree->getTreeId(), 0, $num);
$all_surnames = [];
$i = 0;
foreach (array_keys($top_surnames) as $top_surname) {
$all_surnames = array_merge($all_surnames, QueryName::surnames($tree, $top_surname, '', false, false));
if (++$i == $num) {
break;
}
}
if ($i < $num) {
$num = $i;
}
switch ($infoStyle) {
case 'tagcloud':
uksort($all_surnames, '\Fisharebest\Webtrees\I18N::strcasecmp');
$content = FunctionsPrintLists::surnameTagCloud($all_surnames, 'individual-list', true, $tree);
break;
case 'list':
uasort($all_surnames, '\Fisharebest\Webtrees\Module\TopSurnamesModule::surnameCountSort');
$content = FunctionsPrintLists::surnameList($all_surnames, 1, true, 'individual-list', $tree);
break;
case 'array':
uasort($all_surnames, '\Fisharebest\Webtrees\Module\TopSurnamesModule::surnameCountSort');
$content = FunctionsPrintLists::surnameList($all_surnames, 2, true, 'individual-list', $tree);
break;
case 'table':
default:
uasort($all_surnames, '\Fisharebest\Webtrees\Module\TopSurnamesModule::surnameCountSort');
$content = view('lists/surnames-table', [
'surnames' => $all_surnames,
'route' => 'individual-list',
'tree' => $tree,
]);
break;
}
if ($template) {
if ($num == 1) {
// I18N: i.e. most popular surname.
$title = I18N::translate('Top surname');
} else {
// I18N: Title for a list of the most common surnames, %s is a number. Note that a separate translation exists when %s is 1
$title = I18N::plural('Top %s surname', 'Top %s surnames', $num, I18N::number($num));
}
if ($ctype === 'gedcom' && Auth::isManager($tree)) {
$config_url = route('tree-page-block-edit', [
'block_id' => $block_id,
'ged' => $tree->getName(),
]);
} elseif ($ctype === 'user' && Auth::check()) {
$config_url = route('user-page-block-edit', [
'block_id' => $block_id,
'ged' => $tree->getName(),
]);
} else {
$config_url = '';
}
return view('modules/block-template', [
'block' => str_replace('_', '-', $this->getName()),
'id' => $block_id,
'config_url' => $config_url,
'title' => $title,
'content' => $content,
]);
} else {
return $content;
}
}
/** {@inheritdoc} */
public function loadAjax(): bool
{
return false;
}
/** {@inheritdoc} */
public function isUserBlock(): bool
{
return true;
}
/** {@inheritdoc} */
public function isGedcomBlock(): bool
{
return true;
}
/**
* An HTML form to edit block settings
*
* @param Tree $tree
* @param int $block_id
*
* @return void
*/
public function configureBlock(Tree $tree, int $block_id)
{
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
$this->setBlockSetting($block_id, 'num', Filter::postInteger('num', 1, 10000, 10));
$this->setBlockSetting($block_id, 'infoStyle', Filter::post('infoStyle', 'list|array|table|tagcloud', self::DEFAULT_STYLE));
return;
}
$num = $this->getBlockSetting($block_id, 'num', self::DEFAULT_NUMBER);
$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', self::DEFAULT_STYLE);
$info_styles = [
'list' => /* I18N: An option in a list-box */
I18N::translate('bullet list'),
'array' => /* I18N: An option in a list-box */
I18N::translate('compact list'),
'table' => /* I18N: An option in a list-box */
I18N::translate('table'),
'tagcloud' => /* I18N: An option in a list-box */
I18N::translate('tag cloud'),
];
echo view('modules/top10_surnames/config', [
'num' => $num,
'infoStyle' => $infoStyle,
'info_styles' => $info_styles,
]);
}
/**
* Sort (lists of counts of similar) surname by total count.
*
* @param string[][] $a
* @param string[][] $b
*
* @return int
*/
private static function surnameCountSort($a, $b)
{
$counta = 0;
foreach ($a as $x) {
$counta += count($x);
}
$countb = 0;
foreach ($b as $x) {
$countb += count($x);
}
return $countb - $counta;
}
}
|
