.
*/
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\Functions\FunctionsEdit;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Stats;
use Fisharebest\Webtrees\Theme;
/**
* Class TopGivenNamesModule
*/
class TopGivenNamesModule extends AbstractModule implements ModuleBlockInterface {
/** {@inheritdoc} */
public function getTitle() {
return /* I18N: Name of a module. Top=Most common */ I18N::translate('Top given names');
}
/** {@inheritdoc} */
public function getDescription() {
return /* I18N: Description of the “Top given names” module */ I18N::translate('A list of the most popular given names.');
}
/**
* Generate the HTML content of this block.
*
* @param int $block_id
* @param bool $template
* @param string[] $cfg
*
* @return string
*/
public function getBlock($block_id, $template = true, $cfg = array()) {
global $ctype, $WT_TREE;
$num = $this->getBlockSetting($block_id, 'num', '10');
$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', 'table');
foreach (array('num', 'infoStyle') as $name) {
if (array_key_exists($name, $cfg)) {
$$name = $cfg[$name];
}
}
$stats = new Stats($WT_TREE);
$id = $this->getName() . $block_id;
$class = $this->getName() . '_block';
if ($ctype === 'gedcom' && Auth::isManager($WT_TREE) || $ctype === 'user' && Auth::check()) {
$title = '';
} else {
$title = '';
}
if ($num == 1) {
// I18N: i.e. most popular given name.
$title .= I18N::translate('Top given name');
} else {
// 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
$title .= I18N::plural('Top %s given name', 'Top %s given names', $num, I18N::number($num));
}
$content = '
';
//Select List or Table
switch ($infoStyle) {
case "list": // Output style 1: Simple list style. Better suited to left side of page.
if (I18N::direction() === 'ltr') {
$padding = 'padding-left: 15px';
} else {
$padding = 'padding-right: 15px';
}
$params = array(1, $num, 'rcount');
// List Female names
$totals = $stats->commonGivenFemaleTotals($params);
if ($totals) {
$content .= '' . I18N::translate('Females') . '
' . $totals . '
';
}
// List Male names
$totals = $stats->commonGivenMaleTotals($params);
if ($totals) {
$content .= '' . I18N::translate('Males') . '
' . $totals . '
';
}
break;
case "table": // Style 2: Tabular format. Narrow, 2 or 3 column table, good on right side of page
$params = array(1, $num, 'rcount');
$content .= '
' . $stats->commonGivenFemaleTable($params) . '
' . $stats->commonGivenMaleTable($params) . '
';
$content .= '
';
break;
}
$content .= "
";
if ($template) {
return Theme::theme()->formatBlock($id, $title, $class, $content);
} else {
return $content;
}
}
/** {@inheritdoc} */
public function loadAjax() {
return true;
}
/** {@inheritdoc} */
public function isUserBlock() {
return true;
}
/** {@inheritdoc} */
public function isGedcomBlock() {
return true;
}
/**
* An HTML form to edit block settings
*
* @param int $block_id
*/
public function configureBlock($block_id) {
if (Filter::postBool('save') && Filter::checkCsrf()) {
$this->setBlockSetting($block_id, 'num', Filter::postInteger('num', 1, 10000, 10));
$this->setBlockSetting($block_id, 'infoStyle', Filter::post('infoStyle', 'list|table', 'table'));
}
$num = $this->getBlockSetting($block_id, 'num', '10');
$infoStyle = $this->getBlockSetting($block_id, 'infoStyle', 'table');
echo '
';
echo /* I18N: ... to show in a list */ I18N::translate('Number of given names');
echo '