.
*/
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Bootstrap4;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\Functions\FunctionsDb;
use Fisharebest\Webtrees\Functions\FunctionsPrintLists;
use Fisharebest\Webtrees\Html;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Query\QueryName;
use Fisharebest\Webtrees\Stats;
use Fisharebest\Webtrees\View;
/**
* Class FamilyTreeStatisticsModule
*/
class FamilyTreeStatisticsModule extends AbstractModule implements ModuleBlockInterface {
/** Show this number of surnames by default */
const DEFAULT_NUMBER_OF_SURNAMES = 10;
/** {@inheritdoc} */
public function getTitle() {
return /* I18N: Name of a module */ I18N::translate('Statistics');
}
/** {@inheritdoc} */
public function getDescription() {
return /* I18N: Description of “Statistics” module */ I18N::translate('The size of the family tree, earliest and latest events, common names, etc.');
}
/**
* 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 = []) {
global $WT_TREE, $ctype;
$show_last_update = $this->getBlockSetting($block_id, 'show_last_update', '1');
$show_common_surnames = $this->getBlockSetting($block_id, 'show_common_surnames', '1');
$number_of_surnames = $this->getBlockSetting($block_id, 'number_of_surnames', self::DEFAULT_NUMBER_OF_SURNAMES);
$stat_indi = $this->getBlockSetting($block_id, 'stat_indi', '1');
$stat_fam = $this->getBlockSetting($block_id, 'stat_fam', '1');
$stat_sour = $this->getBlockSetting($block_id, 'stat_sour', '1');
$stat_media = $this->getBlockSetting($block_id, 'stat_media', '1');
$stat_repo = $this->getBlockSetting($block_id, 'stat_repo', '1');
$stat_surname = $this->getBlockSetting($block_id, 'stat_surname', '1');
$stat_events = $this->getBlockSetting($block_id, 'stat_events', '1');
$stat_users = $this->getBlockSetting($block_id, 'stat_users', '1');
$stat_first_birth = $this->getBlockSetting($block_id, 'stat_first_birth', '1');
$stat_last_birth = $this->getBlockSetting($block_id, 'stat_last_birth', '1');
$stat_first_death = $this->getBlockSetting($block_id, 'stat_first_death', '1');
$stat_last_death = $this->getBlockSetting($block_id, 'stat_last_death', '1');
$stat_long_life = $this->getBlockSetting($block_id, 'stat_long_life', '1');
$stat_avg_life = $this->getBlockSetting($block_id, 'stat_avg_life', '1');
$stat_most_chil = $this->getBlockSetting($block_id, 'stat_most_chil', '1');
$stat_avg_chil = $this->getBlockSetting($block_id, 'stat_avg_chil', '1');
foreach (['show_common_surnames', 'number_common_surnames', 'stat_indi', 'stat_fam', 'stat_sour', 'stat_media', 'stat_surname', 'stat_events', 'stat_users', 'stat_first_birth', 'stat_last_birth', 'stat_first_death', 'stat_last_death', 'stat_long_life', 'stat_avg_life', 'stat_most_chil', 'stat_avg_chil'] as $name) {
if (array_key_exists($name, $cfg)) {
$$name = $cfg[$name];
}
}
$stats = new Stats($WT_TREE);
$content = '';
if ($show_last_update) {
$content .= '
' . /* I18N: %s is a date */
I18N::translate('This family tree was last updated on %s.', strip_tags($stats->gedcomUpdated())) . '
';
}
/** Responsive Design */
$content .= '';
if ($stat_indi) {
$content .= '
' . I18N::translate('Individuals') . '
';
$content .= '
' . I18N::translate('Males') . '
' . $stats->totalSexMales() . '
' . $stats->totalSexMalesPercentage() . '
';
$content .= '
' . I18N::translate('Females') . '
' . $stats->totalSexFemales() . '
' . $stats->totalSexFemalesPercentage() . '
';
}
if ($stat_surname) {
$content .= '
' . I18N::translate('Total surnames') . '
';
}
if ($stat_fam) {
$content .= '
' . I18N::translate('Families') . '
';
}
if ($stat_sour) {
$content .= '
' . I18N::translate('Sources') . '
';
}
if ($stat_media) {
$content .= '
' . I18N::translate('Media objects') . '
';
}
if ($stat_repo) {
$content .= '
' . I18N::translate('Repositories') . '
';
}
if ($stat_events) {
$content .= '
' . I18N::translate('Total events') . '
' . $stats->totalEvents() . '
';
}
if ($stat_users) {
$content .= '
' . I18N::translate('Total users') . '
';
}
$content .= '
';
if ($stat_first_birth) {
$content .= '
' . I18N::translate('Earliest birth year') . '
' . $stats->firstBirthYear() . '
';
$content .= '
' . $stats->firstBirth() . '
';
$content .= '
';
}
if ($stat_last_birth) {
$content .= '
' . I18N::translate('Latest birth year') . '
' . $stats->lastBirthYear() . '
';
$content .= '
' . $stats->lastBirth() . '
';
$content .= '
';
}
if ($stat_first_death) {
$content .= '
' . I18N::translate('Earliest death year') . '
' . $stats->firstDeathYear() . '
';
$content .= '
' . $stats->firstDeath() . '
';
$content .= '
';
}
if ($stat_last_death) {
$content .= '
' . I18N::translate('Latest death year') . '
' . $stats->lastDeathYear() . '
';
$content .= '
' . $stats->lastDeath() . '
';
$content .= '
';
}
if ($stat_long_life) {
$content .= '
' . I18N::translate('Individual who lived the longest') . '
' . $stats->longestLifeAge() . '
';
$content .= '
' . $stats->longestLife() . '
';
$content .= '
';
}
if ($stat_avg_life) {
$content .= '
' . I18N::translate('Average age at death') . '
' . $stats->averageLifespan() . '
';
$content .= '
' . I18N::translate('Males') . ': ' . $stats->averageLifespanMale();
$content .= ' ' . I18N::translate('Females') . ': ' . $stats->averageLifespanFemale() . '
';
$content .= '
';
}
if ($stat_most_chil) {
$content .= '
' . I18N::translate('Family with the most children') . '
' . $stats->largestFamilySize() . '
';
$content .= '
' . $stats->largestFamily() . '
';
$content .= '
';
}
if ($stat_avg_chil) {
$content .= '
' . I18N::translate('Average number of children per family') . '
' . $stats->averageChildren() . '
';
$content .= '
';
$content .= '
';
}
$content .= '
';
if ($show_common_surnames) {
$surnames = FunctionsDb::getTopSurnames($WT_TREE->getTreeId(), 0, (int) $number_of_surnames);
$all_surnames = [];
foreach (array_keys($surnames) as $surname) {
$all_surnames = array_merge($all_surnames, QueryName::surnames($WT_TREE, $surname, '', false, false));
}
if (!empty($surnames)) {
ksort($all_surnames);
$content .= '';
$content .= '
';
$content .= '' . I18N::translate('Most common surnames') . '';
$content .= '
';
$content .= '' . FunctionsPrintLists::surnameList($all_surnames, 2, false, 'indilist.php', $WT_TREE) . '';
$content .= '
';
$content .= '
';
}
}
if ($template) {
if ($ctype === 'gedcom' && Auth::isManager($WT_TREE) || $ctype === 'user' && Auth::check()) {
$config_url = Html::url('block_edit.php', ['block_id' => $block_id, 'ged' => $WT_TREE->getName()]);
} else {
$config_url = '';
}
return View::make('blocks/template', [
'block' => str_replace('_', '-', $this->getName()),
'id' => $block_id,
'config_url' => $config_url,
'title' => $this->getTitle(),
'content' => $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, 'show_last_update', Filter::postBool('show_last_update'));
$this->setBlockSetting($block_id, 'show_common_surnames', Filter::postBool('show_common_surnames'));
$this->setBlockSetting($block_id, 'number_of_surnames', Filter::postInteger('number_of_surnames'));
$this->setBlockSetting($block_id, 'stat_indi', Filter::postBool('stat_indi'));
$this->setBlockSetting($block_id, 'stat_fam', Filter::postBool('stat_fam'));
$this->setBlockSetting($block_id, 'stat_sour', Filter::postBool('stat_sour'));
$this->setBlockSetting($block_id, 'stat_other', Filter::postBool('stat_other'));
$this->setBlockSetting($block_id, 'stat_media', Filter::postBool('stat_media'));
$this->setBlockSetting($block_id, 'stat_repo', Filter::postBool('stat_repo'));
$this->setBlockSetting($block_id, 'stat_surname', Filter::postBool('stat_surname'));
$this->setBlockSetting($block_id, 'stat_events', Filter::postBool('stat_events'));
$this->setBlockSetting($block_id, 'stat_users', Filter::postBool('stat_users'));
$this->setBlockSetting($block_id, 'stat_first_birth', Filter::postBool('stat_first_birth'));
$this->setBlockSetting($block_id, 'stat_last_birth', Filter::postBool('stat_last_birth'));
$this->setBlockSetting($block_id, 'stat_first_death', Filter::postBool('stat_first_death'));
$this->setBlockSetting($block_id, 'stat_last_death', Filter::postBool('stat_last_death'));
$this->setBlockSetting($block_id, 'stat_long_life', Filter::postBool('stat_long_life'));
$this->setBlockSetting($block_id, 'stat_avg_life', Filter::postBool('stat_avg_life'));
$this->setBlockSetting($block_id, 'stat_most_chil', Filter::postBool('stat_most_chil'));
$this->setBlockSetting($block_id, 'stat_avg_chil', Filter::postBool('stat_avg_chil'));
}
$show_last_update = $this->getBlockSetting($block_id, 'show_last_update', '1');
$show_common_surnames = $this->getBlockSetting($block_id, 'show_common_surnames', '1');
$number_of_surnames = $this->getBlockSetting($block_id, 'number_of_surnames', self::DEFAULT_NUMBER_OF_SURNAMES);
$stat_indi = $this->getBlockSetting($block_id, 'stat_indi', '1');
$stat_fam = $this->getBlockSetting($block_id, 'stat_fam', '1');
$stat_sour = $this->getBlockSetting($block_id, 'stat_sour', '1');
$stat_media = $this->getBlockSetting($block_id, 'stat_media', '1');
$stat_repo = $this->getBlockSetting($block_id, 'stat_repo', '1');
$stat_surname = $this->getBlockSetting($block_id, 'stat_surname', '1');
$stat_events = $this->getBlockSetting($block_id, 'stat_events', '1');
$stat_users = $this->getBlockSetting($block_id, 'stat_users', '1');
$stat_first_birth = $this->getBlockSetting($block_id, 'stat_first_birth', '1');
$stat_last_birth = $this->getBlockSetting($block_id, 'stat_last_birth', '1');
$stat_first_death = $this->getBlockSetting($block_id, 'stat_first_death', '1');
$stat_last_death = $this->getBlockSetting($block_id, 'stat_last_death', '1');
$stat_long_life = $this->getBlockSetting($block_id, 'stat_long_life', '1');
$stat_avg_life = $this->getBlockSetting($block_id, 'stat_avg_life', '1');
$stat_most_chil = $this->getBlockSetting($block_id, 'stat_most_chil', '1');
$stat_avg_chil = $this->getBlockSetting($block_id, 'stat_avg_chil', '1');
?>