1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2017 webtrees development team 5 * This program is free software: you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation, either version 3 of the License, or 8 * (at your option) any later version. 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * You should have received a copy of the GNU General Public License 14 * along with this program. If not, see <http://www.gnu.org/licenses/>. 15 */ 16namespace Fisharebest\Webtrees\Module; 17 18use Fisharebest\Webtrees\Auth; 19use Fisharebest\Webtrees\Bootstrap4; 20use Fisharebest\Webtrees\Filter; 21use Fisharebest\Webtrees\FontAwesome; 22use Fisharebest\Webtrees\I18N; 23use Fisharebest\Webtrees\Stats; 24use Fisharebest\Webtrees\Theme; 25 26/** 27 * Class TopGivenNamesModule 28 */ 29class TopGivenNamesModule extends AbstractModule implements ModuleBlockInterface { 30 /** {@inheritdoc} */ 31 public function getTitle() { 32 return /* I18N: Name of a module. Top=Most common */ I18N::translate('Top given names'); 33 } 34 35 /** {@inheritdoc} */ 36 public function getDescription() { 37 return /* I18N: Description of the “Top given names” module */ I18N::translate('A list of the most popular given names.'); 38 } 39 40 /** 41 * Generate the HTML content of this block. 42 * 43 * @param int $block_id 44 * @param bool $template 45 * @param string[] $cfg 46 * 47 * @return string 48 */ 49 public function getBlock($block_id, $template = true, $cfg = []) { 50 global $ctype, $WT_TREE; 51 52 $num = $this->getBlockSetting($block_id, 'num', '10'); 53 $infoStyle = $this->getBlockSetting($block_id, 'infoStyle', 'table'); 54 55 foreach (['num', 'infoStyle'] as $name) { 56 if (array_key_exists($name, $cfg)) { 57 $$name = $cfg[$name]; 58 } 59 } 60 61 $stats = new Stats($WT_TREE); 62 63 $id = $this->getName() . $block_id; 64 $class = $this->getName() . '_block'; 65 if ($ctype === 'gedcom' && Auth::isManager($WT_TREE) || $ctype === 'user' && Auth::check()) { 66 $title = FontAwesome::linkIcon('preferences', I18N::translate('Preferences'), ['class' => 'btn btn-link', 'href' => 'block_edit.php?block_id=' . $block_id . '&ged=' . $WT_TREE->getNameHtml() . '&ctype=' . $ctype]) . ' '; 67 } else { 68 $title = ''; 69 } 70 if ($num == 1) { 71 // I18N: i.e. most popular given name. 72 $title .= I18N::translate('Top given name'); 73 } else { 74 // I18N: Title for a list of the most common given names, %s is a number. Note that a separate translation exists when %s is 1 75 $title .= I18N::plural('Top %s given name', 'Top %s given names', $num, I18N::number($num)); 76 } 77 78 $content = '<div class="normal_inner_block">'; 79 //Select List or Table 80 switch ($infoStyle) { 81 case 'list': // Output style 1: Simple list style. Better suited to left side of page. 82 if (I18N::direction() === 'ltr') { 83 $padding = 'padding-left: 15px'; 84 } else { 85 $padding = 'padding-right: 15px'; 86 } 87 $params = [1, $num, 'rcount']; 88 // List Female names 89 $totals = $stats->commonGivenFemaleTotals($params); 90 if ($totals) { 91 $content .= '<b>' . I18N::translate('Females') . '</b><div class="wrap" style="' . $padding . '">' . $totals . '</div><br>'; 92 } 93 // List Male names 94 $totals = $stats->commonGivenMaleTotals($params); 95 if ($totals) { 96 $content .= '<b>' . I18N::translate('Males') . '</b><div class="wrap" style="' . $padding . '">' . $totals . '</div><br>'; 97 } 98 break; 99 case 'table': // Style 2: Tabular format. Narrow, 2 or 3 column table, good on right side of page 100 $params = [1, $num, 'rcount']; 101 $content .= '<table style="margin:auto;"> 102 <tr> 103 <td>' . $stats->commonGivenFemaleTable($params) . '</td> 104 <td>' . $stats->commonGivenMaleTable($params) . '</td>'; 105 $content .= '</tr></table>'; 106 break; 107 } 108 $content .= '</div>'; 109 110 if ($template) { 111 return Theme::theme()->formatBlock($id, $title, $class, $content); 112 } else { 113 return $content; 114 } 115 } 116 117 /** {@inheritdoc} */ 118 public function loadAjax() { 119 return true; 120 } 121 122 /** {@inheritdoc} */ 123 public function isUserBlock() { 124 return true; 125 } 126 127 /** {@inheritdoc} */ 128 public function isGedcomBlock() { 129 return true; 130 } 131 132 /** 133 * An HTML form to edit block settings 134 * 135 * @param int $block_id 136 */ 137 public function configureBlock($block_id) { 138 if (Filter::postBool('save') && Filter::checkCsrf()) { 139 $this->setBlockSetting($block_id, 'num', Filter::postInteger('num', 1, 10000, 10)); 140 $this->setBlockSetting($block_id, 'infoStyle', Filter::post('infoStyle', 'list|table', 'table')); 141 } 142 143 $num = $this->getBlockSetting($block_id, 'num', '10'); 144 $infoStyle = $this->getBlockSetting($block_id, 'infoStyle', 'table'); 145 146 ?> 147 <div class="form-group row"> 148 <label class="col-sm-3 col-form-label" for="num"> 149 <?= /* I18N: ... to show in a list */ I18N::translate('Number of given names') ?> 150 </label> 151 <div class="col-sm-9"> 152 <input type="text" id="num" name="num" size="2" value="<?= $num ?>"> 153 </div> 154 </div> 155 156 <div class="form-group row"> 157 <label class="col-sm-3 col-form-label" for="infoStyle"> 158 <?= I18N::translate('Presentation style') ?> 159 </label> 160 <div class="col-sm-9"> 161 <?= Bootstrap4::select(['list' => I18N::translate('list'), 'table' => I18N::translate('table')], $infoStyle, ['id' => 'infoStyle', 'name' => 'infoStyle']) ?> 162 </div> 163 </div> 164 <?php 165 } 166} 167