. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\Database; use Fisharebest\Webtrees\GedcomRecord; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Tree; use Symfony\Component\HttpFoundation\Request; /** * Class TopPageViewsModule */ class TopPageViewsModule extends AbstractModule implements ModuleBlockInterface { /** * How should this module be labelled on tabs, menus, etc.? * * @return string */ public function getTitle(): string { /* I18N: Name of a module */ return I18N::translate('Most viewed pages'); } /** * A sentence describing what this module does. * * @return string */ public function getDescription(): string { /* I18N: Description of the “Most visited pages” module */ return I18N::translate('A list of the pages that have been viewed the most number of times.'); } /** * Generate the HTML content of this block. * * @param Tree $tree * @param int $block_id * @param string $ctype * @param string[] $cfg * * @return string */ public function getBlock(Tree $tree, int $block_id, string $ctype = '', array $cfg = []): string { $num = $this->getBlockSetting($block_id, 'num', '10'); $count_placement = $this->getBlockSetting($block_id, 'count_placement', 'before'); extract($cfg, EXTR_OVERWRITE); // load the lines from the file $top10 = Database::prepare( "SELECT page_parameter, page_count" . " FROM `##hit_counter`" . " WHERE gedcom_id = :tree_id AND page_name IN ('individual.php','family.php','source.php','repo.php','note.php','mediaviewer.php')" . " ORDER BY page_count DESC LIMIT :limit" )->execute([ 'tree_id' => $tree->id(), 'limit' => (int) $num, ])->fetchAssoc(); $content = ''; foreach ($top10 as $id => $count) { $record = GedcomRecord::getInstance($id, $tree); if ($record && $record->canShow()) { $content .= ''; if ($count_placement == 'before') { $content .= ''; } $content .= ''; if ($count_placement == 'after') { $content .= ''; } $content .= ''; } } $content .= '

[' . $count . ']

' . $record->getFullName() . '

[' . $count . ']

'; if ($ctype !== '') { if ($ctype === 'gedcom' && Auth::isManager($tree)) { $config_url = route('tree-page-block-edit', [ 'block_id' => $block_id, 'ged' => $tree->name(), ]); } elseif ($ctype === 'user' && Auth::check()) { $config_url = route('user-page-block-edit', [ 'block_id' => $block_id, 'ged' => $tree->name(), ]); } else { $config_url = ''; } return view('modules/block-template', [ 'block' => str_replace('_', '-', $this->getName()), 'id' => $block_id, 'config_url' => $config_url, 'title' => $this->getTitle(), 'content' => $content, ]); } return $content; } /** * Should this block load asynchronously using AJAX? * * Simple blocks are faster in-line, more comples ones * can be loaded later. * * @return bool */ public function loadAjax(): bool { return true; } /** * Can this block be shown on the user’s home page? * * @return bool */ public function isUserBlock(): bool { return false; } /** * Can this block be shown on the tree’s home page? * * @return bool */ public function isGedcomBlock(): bool { return true; } /** * Update the configuration for a block. * * @param Request $request * @param int $block_id * * @return void */ public function saveBlockConfiguration(Request $request, int $block_id) { $this->setBlockSetting($block_id, 'num', $request->get('num', '10')); $this->setBlockSetting($block_id, 'count_placement', $request->get('count_placement', 'before')); } /** * An HTML form to edit block settings * * @param Tree $tree * @param int $block_id * * @return void */ public function editBlockConfiguration(Tree $tree, int $block_id) { $num = $this->getBlockSetting($block_id, 'num', '10'); $count_placement = $this->getBlockSetting($block_id, 'count_placement', 'before'); $options = [ /* I18N: An option in a list-box */ 'before' => I18N::translate('before'), /* I18N: An option in a list-box */ 'after' => I18N::translate('after'), ]; echo view('modules/top10_pageviews/config', [ 'count_placement' => $count_placement, 'num' => $num, 'options' => $options, ]); } }