. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\Functions\FunctionsDate; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Statistics; use Fisharebest\Webtrees\Tree; use Symfony\Component\HttpFoundation\Request; /** * Class HtmlBlockModule */ class HtmlBlockModule extends AbstractModule implements ModuleBlockInterface { use ModuleBlockTrait; /** * @var Statistics */ private $statistics; /** * TopGivenNamesModule constructor. * * @param Statistics $statistics */ public function __construct(Statistics $statistics) { $this->statistics = $statistics; } /** * How should this module be labelled on tabs, menus, etc.? * * @return string */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('HTML'); } /** * A sentence describing what this module does. * * @return string */ public function description(): string { /* I18N: Description of the “HTML” module */ return I18N::translate('Add your own text and graphics.'); } /** * 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 { $title = $this->getBlockSetting($block_id, 'title', ''); $content = $this->getBlockSetting($block_id, 'html', ''); $show_timestamp = $this->getBlockSetting($block_id, 'show_timestamp', '0'); $languages = $this->getBlockSetting($block_id, 'languages'); // Only show this block for certain languages if ($languages && !in_array(WT_LOCALE, explode(',', $languages))) { return ''; } /* * Retrieve text, process embedded variables */ $title = $this->statistics->embedTags($title); $content = $this->statistics->embedTags($content); if ($show_timestamp === '1') { $content .= '
' . FunctionsDate::formatTimestamp((int) $this->getBlockSetting($block_id, 'timestamp', (string) WT_TIMESTAMP)); } 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->name()), 'id' => $block_id, 'config_url' => $config_url, 'title' => $title, 'content' => $content, ]); } return $content; } /** {@inheritdoc} */ public function loadAjax(): bool { return false; } /** {@inheritdoc} */ public function isUserBlock(): bool { return true; } /** {@inheritdoc} */ public function isTreeBlock(): 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) { $languages = (array) $request->get('lang'); $this->setBlockSetting($block_id, 'title', $request->get('title', '')); $this->setBlockSetting($block_id, 'html', $request->get('html', '')); $this->setBlockSetting($block_id, 'show_timestamp', $request->get('show_timestamp', '')); $this->setBlockSetting($block_id, 'timestamp', $request->get('timestamp', '')); $this->setBlockSetting($block_id, 'languages', implode(',', $languages)); } /** * An HTML form to edit block settings * * @param Tree $tree * @param int $block_id * * @return void */ public function editBlockConfiguration(Tree $tree, int $block_id) { $templates = [ I18N::translate('Keyword examples') => view('modules/html/template-keywords', []), I18N::translate('Narrative description') => view('modules/html/template-narrative', []), I18N::translate('Statistics') => view('modules/html/template-statistics', []), ]; $title = $this->getBlockSetting($block_id, 'title', ''); $html = $this->getBlockSetting($block_id, 'html', ''); $show_timestamp = $this->getBlockSetting($block_id, 'show_timestamp', '0'); $languages = explode(',', $this->getBlockSetting($block_id, 'languages')); $all_trees = Tree::getNameList(); echo view('modules/html/config', [ 'all_trees' => $all_trees, 'html' => $html, 'languages' => $languages, 'show_timestamp' => $show_timestamp, 'templates' => $templates, 'title' => $title, ]); } }