. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Individual; use Fisharebest\Webtrees\Services\ModuleService; use Fisharebest\Webtrees\Tree; use Symfony\Component\HttpFoundation\Request; /** * Class UserWelcomeModule */ class UserWelcomeModule extends AbstractModule implements ModuleBlockInterface { use ModuleBlockTrait; /** * @var ModuleService */ private $module_service; /** * UserWelcomeModule constructor. * * @param ModuleService $module_service */ public function __construct(ModuleService $module_service) { $this->module_service = $module_service; } /** * How should this module be labelled on tabs, menus, etc.? * * @return string */ public function title(): string { /* I18N: Name of a module */ return I18N::translate('My page'); } /** * A sentence describing what this module does. * * @return string */ public function description(): string { /* I18N: Description of the “My page” module */ return I18N::translate('A greeting message and useful links for a user.'); } /** * 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 { $gedcomid = $tree->getUserPreference(Auth::user(), 'gedcomid'); $individual = Individual::getInstance($gedcomid, $tree); $links = []; $pedigree_chart = $this->module_service->findByComponent('chart', $tree, Auth::user()) ->filter(function (ModuleInterface $module): bool { return $module instanceof PedigreeChartModule; }); if ($individual instanceof Individual) { if ($pedigree_chart instanceof PedigreeChartModule) { $links[] = [ 'url' => route('pedigree', [ 'xref' => $individual->xref(), 'ged' => $individual->tree()->name(), ]), 'title' => I18N::translate('Default chart'), 'icon' => 'icon-pedigree', ]; } $links[] = [ 'url' => $individual->url(), 'title' => I18N::translate('My individual record'), 'icon' => 'icon-indis', ]; } $links[] = [ 'url' => route('my-account', []), 'title' => I18N::translate('My account'), 'icon' => 'icon-mypage', ]; $content = view('modules/user_welcome/welcome', ['links' => $links]); $real_name = '' . e(Auth::user()->realName()) . ''; /* I18N: A %s is the user’s name */ $title = I18N::translate('Welcome %s', $real_name); if ($ctype !== '') { return view('modules/block-template', [ 'block' => str_replace('_', '-', $this->name()), 'id' => $block_id, '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 false; } /** * Update the configuration for a block. * * @param Request $request * @param int $block_id * * @return void */ public function saveBlockConfiguration(Request $request, int $block_id) { } /** * An HTML form to edit block settings * * @param Tree $tree * @param int $block_id * * @return void */ public function editBlockConfiguration(Tree $tree, int $block_id) { } }