1<?php 2/** 3 * webtrees: online genealogy 4 * Copyright (C) 2016 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\Filter; 20use Fisharebest\Webtrees\Functions\FunctionsEdit; 21use Fisharebest\Webtrees\I18N; 22use Fisharebest\Webtrees\Stats; 23use Fisharebest\Webtrees\Theme; 24 25/** 26 * Class TopGivenNamesModule 27 */ 28class TopGivenNamesModule extends AbstractModule implements ModuleBlockInterface { 29 /** {@inheritdoc} */ 30 public function getTitle() { 31 return /* I18N: Name of a module. Top=Most common */ I18N::translate('Top given names'); 32 } 33 34 /** {@inheritdoc} */ 35 public function getDescription() { 36 return /* I18N: Description of the “Top given names” module */ I18N::translate('A list of the most popular given names.'); 37 } 38 39 /** 40 * Generate the HTML content of this block. 41 * 42 * @param int $block_id 43 * @param bool $template 44 * @param string[] $cfg 45 * 46 * @return string 47 */ 48 public function getBlock($block_id, $template = true, $cfg = array()) { 49 global $ctype, $WT_TREE; 50 51 $num = $this->getBlockSetting($block_id, 'num', '10'); 52 $infoStyle = $this->getBlockSetting($block_id, 'infoStyle', 'table'); 53 54 foreach (array('num', 'infoStyle') as $name) { 55 if (array_key_exists($name, $cfg)) { 56 $$name = $cfg[$name]; 57 } 58 } 59 60 $stats = new Stats($WT_TREE); 61 62 $id = $this->getName() . $block_id; 63 $class = $this->getName() . '_block'; 64 if ($ctype === 'gedcom' && Auth::isManager($WT_TREE) || $ctype === 'user' && Auth::check()) { 65 $title = '<a class="icon-admin" title="' . I18N::translate('Preferences') . '" href="block_edit.php?block_id=' . $block_id . '&ged=' . $WT_TREE->getNameHtml() . '&ctype=' . $ctype . '"></a>'; 66 } else { 67 $title = ''; 68 } 69 if ($num == 1) { 70 // I18N: i.e. most popular given name. 71 $title .= I18N::translate('Top given name'); 72 } else { 73 // 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 74 $title .= I18N::plural('Top %s given name', 'Top %s given names', $num, I18N::number($num)); 75 } 76 77 $content = '<div class="normal_inner_block">'; 78 //Select List or Table 79 switch ($infoStyle) { 80 case "list": // Output style 1: Simple list style. Better suited to left side of page. 81 if (I18N::direction() === 'ltr') { 82 $padding = 'padding-left: 15px'; 83 } else { 84 $padding = 'padding-right: 15px'; 85 } 86 $params = array(1, $num, 'rcount'); 87 // List Female names 88 $totals = $stats->commonGivenFemaleTotals($params); 89 if ($totals) { 90 $content .= '<b>' . I18N::translate('Females') . '</b><div class="wrap" style="' . $padding . '">' . $totals . '</div><br>'; 91 } 92 // List Male names 93 $totals = $stats->commonGivenMaleTotals($params); 94 if ($totals) { 95 $content .= '<b>' . I18N::translate('Males') . '</b><div class="wrap" style="' . $padding . '">' . $totals . '</div><br>'; 96 } 97 break; 98 case "table": // Style 2: Tabular format. Narrow, 2 or 3 column table, good on right side of page 99 $params = array(1, $num, 'rcount'); 100 $content .= '<table style="margin:auto;"> 101 <tr> 102 <td>' . $stats->commonGivenFemaleTable($params) . '</td> 103 <td>' . $stats->commonGivenMaleTable($params) . '</td>'; 104 $content .= '</tr></table>'; 105 break; 106 } 107 $content .= "</div>"; 108 109 if ($template) { 110 return Theme::theme()->formatBlock($id, $title, $class, $content); 111 } else { 112 return $content; 113 } 114 } 115 116 /** {@inheritdoc} */ 117 public function loadAjax() { 118 return true; 119 } 120 121 /** {@inheritdoc} */ 122 public function isUserBlock() { 123 return true; 124 } 125 126 /** {@inheritdoc} */ 127 public function isGedcomBlock() { 128 return true; 129 } 130 131 /** 132 * An HTML form to edit block settings 133 * 134 * @param int $block_id 135 */ 136 public function configureBlock($block_id) { 137 if (Filter::postBool('save') && Filter::checkCsrf()) { 138 $this->setBlockSetting($block_id, 'num', Filter::postInteger('num', 1, 10000, 10)); 139 $this->setBlockSetting($block_id, 'infoStyle', Filter::post('infoStyle', 'list|table', 'table')); 140 } 141 142 $num = $this->getBlockSetting($block_id, 'num', '10'); 143 $infoStyle = $this->getBlockSetting($block_id, 'infoStyle', 'table'); 144 145 echo '<tr><td class="descriptionbox wrap width33">'; 146 echo /* I18N: ... to show in a list */ I18N::translate('Number of given names'); 147 echo '</td><td class="optionbox">'; 148 echo '<input type="text" name="num" size="2" value="', $num, '">'; 149 echo '</td></tr>'; 150 151 echo '<tr><td class="descriptionbox wrap width33">'; 152 echo I18N::translate('Presentation style'); 153 echo '</td><td class="optionbox">'; 154 echo FunctionsEdit::selectEditControl('infoStyle', array('list' => I18N::translate('list'), 'table' => I18N::translate('table')), null, $infoStyle, ''); 155 echo '</td></tr>'; 156 } 157} 158