jon48 / webtrees-lib

app/Module/Hooks/Http/RequestHandlers/ModulesHooksAction.php

Indentation +46 added lines, -46 removed lines

@@ -30,58 +30,58 @@
  */
 class ModulesHooksAction extends AbstractModuleComponentAction
 {
-    protected HookService $hook_service;
+	protected HookService $hook_service;
 
-    /**
-     * Constructor for ModulesHooksAction Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param TreeService $tree_service
-     * @param HookService $hook_service
-     */
-    public function __construct(ModuleService $module_service, TreeService $tree_service, HookService $hook_service)
-    {
-        parent::__construct($module_service, $tree_service);
-        $this->hook_service = $hook_service;
-    }
+	/**
+	 * Constructor for ModulesHooksAction Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TreeService $tree_service
+	 * @param HookService $hook_service
+	 */
+	public function __construct(ModuleService $module_service, TreeService $tree_service, HookService $hook_service)
+	{
+		parent::__construct($module_service, $tree_service);
+		$this->hook_service = $hook_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $hook_name = Validator::attributes($request)->string('hook_name', '');
-        $hook_collector = $this->hook_service->find($hook_name, true);
-        if ($hook_collector === null) {
-            FlashMessages::addMessage(I18N::translate('The hook with name “%s” does not exist.', $hook_name), 'danger');
-            return redirect(AdminConfigPage::class);
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$hook_name = Validator::attributes($request)->string('hook_name', '');
+		$hook_collector = $this->hook_service->find($hook_name, true);
+		if ($hook_collector === null) {
+			FlashMessages::addMessage(I18N::translate('The hook with name “%s” does not exist.', $hook_name), 'danger');
+			return redirect(AdminConfigPage::class);
+		}
 
-        foreach ($hook_collector->hooks() as $hook) {
-            $this->updateStatus(get_class($hook->module()), $request);
-        }
+		foreach ($hook_collector->hooks() as $hook) {
+			$this->updateStatus(get_class($hook->module()), $request);
+		}
 
-        $this->updateHookOrder($hook_collector, $request);
+		$this->updateHookOrder($hook_collector, $request);
 
-        FlashMessages::addMessage(I18N::translate('The hook preferences have been updated.'), 'success');
+		FlashMessages::addMessage(I18N::translate('The hook preferences have been updated.'), 'success');
 
-        return redirect(route(ModulesHooksPage::class, ['hook_name' => $hook_name]));
-    }
+		return redirect(route(ModulesHooksPage::class, ['hook_name' => $hook_name]));
+	}
 
-    /**
-     * Update the order of modules for a hook interface.
-     *
-     * @param HookCollectorInterface $hook_collector
-     * @param ServerRequestInterface $request
-     */
-    protected function updateHookOrder(HookCollectorInterface $hook_collector, ServerRequestInterface $request): void
-    {
-        $order = Validator::parsedBody($request)->array('order');
-        $order = array_flip($order);
+	/**
+	 * Update the order of modules for a hook interface.
+	 *
+	 * @param HookCollectorInterface $hook_collector
+	 * @param ServerRequestInterface $request
+	 */
+	protected function updateHookOrder(HookCollectorInterface $hook_collector, ServerRequestInterface $request): void
+	{
+		$order = Validator::parsedBody($request)->array('order');
+		$order = array_flip($order);
 
-        foreach ($hook_collector->hooks() as $hook) {
-            $this->hook_service->updateOrder($hook_collector, $hook->module(), $order[$hook->module()->name()] ?? 0);
-        }
-    }
+		foreach ($hook_collector->hooks() as $hook) {
+			$this->hook_service->updateOrder($hook_collector, $hook->module(), $order[$hook->module()->name()] ?? 0);
+		}
+	}
 }

app/Module/Hooks/Http/RequestHandlers/ModulesHooksPage.php

Indentation +34 added lines, -34 removed lines

@@ -29,44 +29,44 @@
  */
 class ModulesHooksPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    protected HookService $hook_service;
+	protected HookService $hook_service;
 
-    /**
-     * Constructor for ModulesHooksPage request handler
-     *
-     * @param HookService $hook_service
-     */
-    public function __construct(HookService $hook_service)
-    {
-        $this->hook_service = $hook_service;
-    }
+	/**
+	 * Constructor for ModulesHooksPage request handler
+	 *
+	 * @param HookService $hook_service
+	 */
+	public function __construct(HookService $hook_service)
+	{
+		$this->hook_service = $hook_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->layout = 'layouts/administration';
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$this->layout = 'layouts/administration';
 
-        $hook_name = Validator::attributes($request)->string('hook_name', '');
-        $hook = $this->hook_service->find($hook_name, true);
-        if ($hook === null) {
-            throw new HttpNotFoundException(I18N::translate('The hook with name “%s” does not exist.', $hook_name));
-        }
+		$hook_name = Validator::attributes($request)->string('hook_name', '');
+		$hook = $this->hook_service->find($hook_name, true);
+		if ($hook === null) {
+			throw new HttpNotFoundException(I18N::translate('The hook with name “%s” does not exist.', $hook_name));
+		}
 
-        $modules = $hook->hooks()
-            ->sortKeys()
-            ->mapWithKeys(fn(HookInterface $hook) => [$hook->module()->name() => $hook->module()]);
+		$modules = $hook->hooks()
+			->sortKeys()
+			->mapWithKeys(fn(HookInterface $hook) => [$hook->module()->name() => $hook->module()]);
 
-        return $this->viewResponse('admin/components', [
-            'description'    => $hook->description(),
-            'modules'        => $modules,
-            'title'          => $hook->title(),
-            'uses_access'    => false,
-            'uses_sorting'   => true
-        ]);
-    }
+		return $this->viewResponse('admin/components', [
+			'description'    => $hook->description(),
+			'modules'        => $modules,
+			'title'          => $hook->title(),
+			'uses_access'    => false,
+			'uses_sorting'   => true
+		]);
+	}
 }

app/Module/Hooks/Services/HookService.php

Indentation +88 added lines, -88 removed lines

@@ -30,101 +30,101 @@
  */
 class HookService implements HookServiceInterface
 {
-    private ModuleService $module_service;
+	private ModuleService $module_service;
 
-    /**
-     * Constructor for HookService
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module_service = $module_service;
-    }
+	/**
+	 * Constructor for HookService
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module_service = $module_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookServiceInterface::use()
-     */
-    public function use(string $hook_interface): ?HookCollectorInterface
-    {
-        return $this->all()->get($hook_interface);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookServiceInterface::use()
+	 */
+	public function use(string $hook_interface): ?HookCollectorInterface
+	{
+		return $this->all()->get($hook_interface);
+	}
 
 
-    /**
-     * Find a hook collector by its name, with or without the disabled ones.
-     *
-     * @param string $hook_name
-     * @return HookCollectorInterface|null
-     */
-    public function find(string $hook_name, bool $include_disabled = false): ?HookCollectorInterface
-    {
-        return $this->all($include_disabled)
-            ->first(fn(HookCollectorInterface $hook_collector) => $hook_collector->name() === $hook_name);
-    }
+	/**
+	 * Find a hook collector by its name, with or without the disabled ones.
+	 *
+	 * @param string $hook_name
+	 * @return HookCollectorInterface|null
+	 */
+	public function find(string $hook_name, bool $include_disabled = false): ?HookCollectorInterface
+	{
+		return $this->all($include_disabled)
+			->first(fn(HookCollectorInterface $hook_collector) => $hook_collector->name() === $hook_name);
+	}
 
-    /**
-     * Get all hook collectors subscribed by modules, with hooks ordered, with or without the disabled ones.
-     *
-     * @param bool $include_disabled
-     * @return Collection<string, HookCollectorInterface>
-     */
-    public function all(bool $include_disabled = false): Collection
-    {
-        return Registry::cache()->array()->remember('all-hooks', function () use ($include_disabled): Collection {
-            $hooks_info = DB::table('maj_hook_order')
-                ->get()
-                ->groupBy(['majho_hook_name', 'majho_module_name']);
+	/**
+	 * Get all hook collectors subscribed by modules, with hooks ordered, with or without the disabled ones.
+	 *
+	 * @param bool $include_disabled
+	 * @return Collection<string, HookCollectorInterface>
+	 */
+	public function all(bool $include_disabled = false): Collection
+	{
+		return Registry::cache()->array()->remember('all-hooks', function () use ($include_disabled): Collection {
+			$hooks_info = DB::table('maj_hook_order')
+				->get()
+				->groupBy(['majho_hook_name', 'majho_module_name']);
 
-            $hooks = $this->module_service
-                ->findByInterface(ModuleHookSubscriberInterface::class, $include_disabled)
-                ->flatMap(fn(ModuleHookSubscriberInterface $module) => $module->listSubscribedHooks());
+			$hooks = $this->module_service
+				->findByInterface(ModuleHookSubscriberInterface::class, $include_disabled)
+				->flatMap(fn(ModuleHookSubscriberInterface $module) => $module->listSubscribedHooks());
 
-            $hook_collectors = collect();
-            $hook_instances = collect();
-            foreach ($hooks as $hook) {
-                if (!($hook instanceof HookInterface)) {
-                    continue;
-                }
-                if ($hook instanceof HookCollectorInterface) {
-                    $hook_collectors->put($hook->hookInterface(), $hook);
-                } else {
-                    $hook_instances->add($hook);
-                }
-            }
+			$hook_collectors = collect();
+			$hook_instances = collect();
+			foreach ($hooks as $hook) {
+				if (!($hook instanceof HookInterface)) {
+					continue;
+				}
+				if ($hook instanceof HookCollectorInterface) {
+					$hook_collectors->put($hook->hookInterface(), $hook);
+				} else {
+					$hook_instances->add($hook);
+				}
+			}
 
-            foreach ($hook_collectors as $hook_interface => $hook_collector) {
-                $hook_info = $hooks_info->get($hook_collector->name()) ?? collect();
-                foreach (
-                    $hook_instances->filter(
-                        fn(HookInterface $hook): bool => $hook instanceof $hook_interface
-                    ) as $hook_instance
-                ) {
-                    $hook_module_info = $hook_info->get($hook_instance->module()->name(), collect())->first();
-                    $hook_order = $hook_module_info instanceof stdClass ? (int) $hook_module_info->majho_hook_order : 0;
-                    $hook_collector->register($hook_instance, $hook_order);
-                }
-            }
-            return $hook_collectors;
-        });
-    }
+			foreach ($hook_collectors as $hook_interface => $hook_collector) {
+				$hook_info = $hooks_info->get($hook_collector->name()) ?? collect();
+				foreach (
+					$hook_instances->filter(
+						fn(HookInterface $hook): bool => $hook instanceof $hook_interface
+					) as $hook_instance
+				) {
+					$hook_module_info = $hook_info->get($hook_instance->module()->name(), collect())->first();
+					$hook_order = $hook_module_info instanceof stdClass ? (int) $hook_module_info->majho_hook_order : 0;
+					$hook_collector->register($hook_instance, $hook_order);
+				}
+			}
+			return $hook_collectors;
+		});
+	}
 
-    /**
-     * Update the order of the modules implementing a hook in the database.
-     *
-     * @param HookCollectorInterface $hook_collector
-     * @param ModuleInterface $module
-     * @param int $order
-     * @return int
-     */
-    public function updateOrder(HookCollectorInterface $hook_collector, ModuleInterface $module, int $order): int
-    {
-        return DB::table('maj_hook_order')
-            ->upsert([
-                'majho_module_name' =>  $module->name(),
-                'majho_hook_name'   =>  $hook_collector->name(),
-                'majho_hook_order'  =>  $order
-            ], ['majho_module_name', 'majho_hook_name'], ['majho_hook_order']);
-    }
+	/**
+	 * Update the order of the modules implementing a hook in the database.
+	 *
+	 * @param HookCollectorInterface $hook_collector
+	 * @param ModuleInterface $module
+	 * @param int $order
+	 * @return int
+	 */
+	public function updateOrder(HookCollectorInterface $hook_collector, ModuleInterface $module, int $order): int
+	{
+		return DB::table('maj_hook_order')
+			->upsert([
+				'majho_module_name' =>  $module->name(),
+				'majho_hook_name'   =>  $hook_collector->name(),
+				'majho_hook_order'  =>  $order
+			], ['majho_module_name', 'majho_hook_name'], ['majho_hook_order']);
+	}
 }

app/Module/WelcomeBlock/Http/RequestHandlers/MatomoStats.php

Indentation +52 added lines, -52 removed lines

@@ -32,64 +32,64 @@
  */
 class MatomoStats implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    /**
-     * @var WelcomeBlockModule|null $module
-     */
-    private $module;
+	/**
+	 * @var WelcomeBlockModule|null $module
+	 */
+	private $module;
 
-    /**
-     * @var MatomoStatsService $matomo_service
-     */
-    private $matomo_service;
+	/**
+	 * @var MatomoStatsService $matomo_service
+	 */
+	private $matomo_service;
 
-    /**
-     * Constructor for MatomoStats request handler
-     * @param ModuleService $module_service
-     * @param MatomoStatsService $matomo_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        MatomoStatsService $matomo_service
-    ) {
-        $this->module = $module_service->findByInterface(WelcomeBlockModule::class)->first();
-        $this->matomo_service = $matomo_service;
-    }
+	/**
+	 * Constructor for MatomoStats request handler
+	 * @param ModuleService $module_service
+	 * @param MatomoStatsService $matomo_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		MatomoStatsService $matomo_service
+	) {
+		$this->module = $module_service->findByInterface(WelcomeBlockModule::class)->first();
+		$this->matomo_service = $matomo_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->layout = 'layouts/ajax';
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$this->layout = 'layouts/ajax';
 
-        if ($this->module === null) {
-            return $this->viewResponse('errors/unhandled-exception', [
-                'error' => 'The attached module could not be found.'
-            ], StatusCodeInterface::STATUS_NOT_FOUND);
-        }
+		if ($this->module === null) {
+			return $this->viewResponse('errors/unhandled-exception', [
+				'error' => 'The attached module could not be found.'
+			], StatusCodeInterface::STATUS_NOT_FOUND);
+		}
 
-        $block_id = Validator::attributes($request)->integer('block_id', -1);
-        $nb_visits_year = $nb_visits_today = null;
+		$block_id = Validator::attributes($request)->integer('block_id', -1);
+		$nb_visits_year = $nb_visits_today = null;
 
-        try {
-            if ($block_id !== -1 && $this->module->isMatomoEnabled($block_id)) {
-                $nb_visits_today = $this->matomo_service->visitsToday($this->module, $block_id) ?? 0;
-                $nb_visits_year = ($this->matomo_service->visitsThisYear($this->module, $block_id) ?? 0)
-                    + $nb_visits_today;
-            }
-        } catch (Throwable $ex) {
-            return $this->viewResponse('errors/unhandled-exception', [
-                'error' => I18N::translate('Error while retrieving Matomo statistics: ') .
-                    (Auth::isAdmin() ? $ex->getMessage() : I18N::translate('Log in as admin for error details'))
-            ], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
-        }
+		try {
+			if ($block_id !== -1 && $this->module->isMatomoEnabled($block_id)) {
+				$nb_visits_today = $this->matomo_service->visitsToday($this->module, $block_id) ?? 0;
+				$nb_visits_year = ($this->matomo_service->visitsThisYear($this->module, $block_id) ?? 0)
+					+ $nb_visits_today;
+			}
+		} catch (Throwable $ex) {
+			return $this->viewResponse('errors/unhandled-exception', [
+				'error' => I18N::translate('Error while retrieving Matomo statistics: ') .
+					(Auth::isAdmin() ? $ex->getMessage() : I18N::translate('Log in as admin for error details'))
+			], StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR);
+		}
 
-        return $this->viewResponse($this->module->name() . '::matomo-stats', [
-            'visits_year'   =>  $nb_visits_year,
-            'visits_today'  =>  $nb_visits_today
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::matomo-stats', [
+			'visits_year'   =>  $nb_visits_year,
+			'visits_today'  =>  $nb_visits_today
+		]);
+	}
 }

app/Module/WelcomeBlock/WelcomeBlockModule.php

Indentation +159 added lines, -159 removed lines

@@ -34,163 +34,163 @@
  */
 class WelcomeBlockModule extends AbstractModule implements ModuleMyArtJaubInterface, ModuleBlockInterface
 {
-    use ModuleMyArtJaubTrait;
-    use ModuleBlockTrait;
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “WelcomeBlock” module */ I18N::translate('MyArtJaub Welcome Block');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “WelcomeBlock” module */ I18N::translate('The MyArtJaub Welcome block welcomes the visitor to the site, allows a quick login to the site, and displays statistics on visits.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/welcomeblock/{block_id}', static function (Map $router): void {
-                $router->tokens(['block_id' => '\d+']);
-                $router->get(MatomoStats::class, '/matomostats', MatomoStats::class);
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.1-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
-     *
-     * @param mixed[] $config
-     */
-    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
-    {
-        $fab_welcome_block_view = app(\Fisharebest\Webtrees\Module\WelcomeBlockModule::class)
-            ->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
-
-        $fab_login_block_view = app(\Fisharebest\Webtrees\Module\LoginBlockModule::class)
-            ->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
-
-        $content = view($this->name() . '::block-embed', [
-            'block_id'                  =>  $block_id,
-            'fab_welcome_block_view'    =>  $fab_welcome_block_view,
-            'fab_login_block_view'      =>  $fab_login_block_view,
-            'matomo_enabled'            =>  $this->isMatomoEnabled($block_id),
-            'js_script_url'             =>  $this->assetUrl('js/welcomeblock.min.js')
-        ]);
-
-        if ($context !== self::CONTEXT_EMBED) {
-            return view('modules/block-template', [
-                'block'      => Str::kebab($this->name()),
-                'id'         => $block_id,
-                'config_url' => $this->configUrl($tree, $context, $block_id),
-                'title'      => e($tree->title()),
-                'content'    => $content,
-            ]);
-        }
-
-        return $content;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::isTreeBlock()
-     */
-    public function isTreeBlock(): bool
-    {
-        return true;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::editBlockConfiguration()
-     */
-    public function editBlockConfiguration(Tree $tree, int $block_id): string
-    {
-        return view($this->name() . '::config', $this->matomoSettings($block_id));
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::saveBlockConfiguration()
-     */
-    public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
-    {
-        $matomo_enabled = Validator::parsedBody($request)->string('matomo_enabled', '') == 'yes';
-        $this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
-        if (!$matomo_enabled) {
-            return;
-        }
-
-        $matomo_url = trim(Validator::parsedBody($request)->string('matomo_url', ''));
-        if (filter_var($matomo_url, FILTER_VALIDATE_URL) === false) {
-            FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
-            return;
-        }
-
-        $matomo_siteid = Validator::parsedBody($request)->integer('matomo_siteid', -1);
-        if ($matomo_siteid === -1) {
-            FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
-            return;
-        }
-
-        $matomo_token = trim(Validator::parsedBody($request)->string('matomo_token', ''));
-
-        $this
-            ->setBlockSetting($block_id, 'matomo_url', $matomo_url)
-            ->setBlockSetting($block_id, 'matomo_token', $matomo_token)
-            ->setBlockSetting($block_id, 'matomo_siteid', (string) $matomo_siteid);
-
-        Registry::cache()->file()->forget($this->name() . '-matomovisits-yearly-' . $block_id);
-    }
-
-    /**
-     * Returns whether Matomo statistics is enabled for a specific MyArtJaub WelcomeBlock block
-     *
-     * @param int $block_id
-     * @return bool
-     */
-    public function isMatomoEnabled(int $block_id): bool
-    {
-        return $this->getBlockSetting($block_id, 'matomo_enabled', 'no') === 'yes';
-    }
-
-    /**
-     * Returns settings for retrieving Matomo statistics for a specific MyArtJaub WelcomeBlock block
-     *
-     * @param int $block_id
-     * @return array<string, mixed>
-     */
-    public function matomoSettings(int $block_id): array
-    {
-        return [
-            'matomo_enabled' => $this->isMatomoEnabled($block_id),
-            'matomo_url' => $this->getBlockSetting($block_id, 'matomo_url'),
-            'matomo_token' => $this->getBlockSetting($block_id, 'matomo_token'),
-            'matomo_siteid'  => (int) $this->getBlockSetting($block_id, 'matomo_siteid', '0')
-        ];
-    }
+	use ModuleMyArtJaubTrait;
+	use ModuleBlockTrait;
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return /* I18N: Name of the “WelcomeBlock” module */ I18N::translate('MyArtJaub Welcome Block');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “WelcomeBlock” module */ I18N::translate('The MyArtJaub Welcome block welcomes the visitor to the site, allows a quick login to the site, and displays statistics on visits.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/welcomeblock/{block_id}', static function (Map $router): void {
+				$router->tokens(['block_id' => '\d+']);
+				$router->get(MatomoStats::class, '/matomostats', MatomoStats::class);
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.1-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
+	 *
+	 * @param mixed[] $config
+	 */
+	public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
+	{
+		$fab_welcome_block_view = app(\Fisharebest\Webtrees\Module\WelcomeBlockModule::class)
+			->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
+
+		$fab_login_block_view = app(\Fisharebest\Webtrees\Module\LoginBlockModule::class)
+			->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
+
+		$content = view($this->name() . '::block-embed', [
+			'block_id'                  =>  $block_id,
+			'fab_welcome_block_view'    =>  $fab_welcome_block_view,
+			'fab_login_block_view'      =>  $fab_login_block_view,
+			'matomo_enabled'            =>  $this->isMatomoEnabled($block_id),
+			'js_script_url'             =>  $this->assetUrl('js/welcomeblock.min.js')
+		]);
+
+		if ($context !== self::CONTEXT_EMBED) {
+			return view('modules/block-template', [
+				'block'      => Str::kebab($this->name()),
+				'id'         => $block_id,
+				'config_url' => $this->configUrl($tree, $context, $block_id),
+				'title'      => e($tree->title()),
+				'content'    => $content,
+			]);
+		}
+
+		return $content;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::isTreeBlock()
+	 */
+	public function isTreeBlock(): bool
+	{
+		return true;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::editBlockConfiguration()
+	 */
+	public function editBlockConfiguration(Tree $tree, int $block_id): string
+	{
+		return view($this->name() . '::config', $this->matomoSettings($block_id));
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::saveBlockConfiguration()
+	 */
+	public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
+	{
+		$matomo_enabled = Validator::parsedBody($request)->string('matomo_enabled', '') == 'yes';
+		$this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
+		if (!$matomo_enabled) {
+			return;
+		}
+
+		$matomo_url = trim(Validator::parsedBody($request)->string('matomo_url', ''));
+		if (filter_var($matomo_url, FILTER_VALIDATE_URL) === false) {
+			FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
+			return;
+		}
+
+		$matomo_siteid = Validator::parsedBody($request)->integer('matomo_siteid', -1);
+		if ($matomo_siteid === -1) {
+			FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
+			return;
+		}
+
+		$matomo_token = trim(Validator::parsedBody($request)->string('matomo_token', ''));
+
+		$this
+			->setBlockSetting($block_id, 'matomo_url', $matomo_url)
+			->setBlockSetting($block_id, 'matomo_token', $matomo_token)
+			->setBlockSetting($block_id, 'matomo_siteid', (string) $matomo_siteid);
+
+		Registry::cache()->file()->forget($this->name() . '-matomovisits-yearly-' . $block_id);
+	}
+
+	/**
+	 * Returns whether Matomo statistics is enabled for a specific MyArtJaub WelcomeBlock block
+	 *
+	 * @param int $block_id
+	 * @return bool
+	 */
+	public function isMatomoEnabled(int $block_id): bool
+	{
+		return $this->getBlockSetting($block_id, 'matomo_enabled', 'no') === 'yes';
+	}
+
+	/**
+	 * Returns settings for retrieving Matomo statistics for a specific MyArtJaub WelcomeBlock block
+	 *
+	 * @param int $block_id
+	 * @return array<string, mixed>
+	 */
+	public function matomoSettings(int $block_id): array
+	{
+		return [
+			'matomo_enabled' => $this->isMatomoEnabled($block_id),
+			'matomo_url' => $this->getBlockSetting($block_id, 'matomo_url'),
+			'matomo_token' => $this->getBlockSetting($block_id, 'matomo_token'),
+			'matomo_siteid'  => (int) $this->getBlockSetting($block_id, 'matomo_siteid', '0')
+		];
+	}
 }

app/Module/WelcomeBlock/Services/MatomoStatsService.php

Indentation +82 added lines, -82 removed lines

@@ -28,93 +28,93 @@
  */
 class MatomoStatsService
 {
-    /**
-     * Returns the number of visits for the current year (up to the day before).
-     * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @return int|NULL
-     */
-    public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
-    {
-        return Registry::cache()->file()->remember(
-            $module->name() . '-matomovisits-yearly-' . $block_id,
-            function () use ($module, $block_id): ?int {
-                $visits_year = $this->visits($module, $block_id, 'year');
-                if ($visits_year === null) {
-                    return null;
-                }
-                $visits_today = (int) $this->visits($module, $block_id, 'day');
+	/**
+	 * Returns the number of visits for the current year (up to the day before).
+	 * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @return int|NULL
+	 */
+	public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
+	{
+		return Registry::cache()->file()->remember(
+			$module->name() . '-matomovisits-yearly-' . $block_id,
+			function () use ($module, $block_id): ?int {
+				$visits_year = $this->visits($module, $block_id, 'year');
+				if ($visits_year === null) {
+					return null;
+				}
+				$visits_today = (int) $this->visits($module, $block_id, 'day');
 
-                return $visits_year - $visits_today;
-            },
-            Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
-        );
-    }
+				return $visits_year - $visits_today;
+			},
+			Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
+		);
+	}
 
-    /**
-     * Returns the number of visits for the current day.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @return int|NULL
-     */
-    public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
-    {
-        return Registry::cache()->array()->remember(
-            $module->name() . '-matomovisits-daily-' . $block_id,
-            function () use ($module, $block_id): ?int {
-                return $this->visits($module, $block_id, 'day');
-            }
-        );
-    }
+	/**
+	 * Returns the number of visits for the current day.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @return int|NULL
+	 */
+	public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
+	{
+		return Registry::cache()->array()->remember(
+			$module->name() . '-matomovisits-daily-' . $block_id,
+			function () use ($module, $block_id): ?int {
+				return $this->visits($module, $block_id, 'day');
+			}
+		);
+	}
 
-    /**
-     * Invoke the Matomo API to retrieve the number of visits over a period.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @param string $period
-     * @return int|NULL
-     */
-    protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
-    {
-        $settings = $module->matomoSettings($block_id);
+	/**
+	 * Invoke the Matomo API to retrieve the number of visits over a period.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @param string $period
+	 * @return int|NULL
+	 */
+	protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
+	{
+		$settings = $module->matomoSettings($block_id);
 
-        if (
-            $settings['matomo_enabled'] === true
-            && mb_strlen($settings['matomo_url']) > 0
-            && mb_strlen($settings['matomo_token']) > 0
-            && $settings['matomo_siteid'] > 0
-        ) {
-            try {
-                $http_client = new Client([
-                    RequestOptions::TIMEOUT => 30
-                ]);
+		if (
+			$settings['matomo_enabled'] === true
+			&& mb_strlen($settings['matomo_url']) > 0
+			&& mb_strlen($settings['matomo_token']) > 0
+			&& $settings['matomo_siteid'] > 0
+		) {
+			try {
+				$http_client = new Client([
+					RequestOptions::TIMEOUT => 30
+				]);
 
-                $response = $http_client->get($settings['matomo_url'], [
-                    'query' =>  [
-                        'module'    =>  'API',
-                        'method'    =>  'VisitsSummary.getVisits',
-                        'idSite'    =>  $settings['matomo_siteid'],
-                        'period'    =>  $period,
-                        'date'      =>  'today',
-                        'token_auth' =>  $settings['matomo_token'],
-                        'format'    =>  'json'
-                    ]
-                ]);
+				$response = $http_client->get($settings['matomo_url'], [
+					'query' =>  [
+						'module'    =>  'API',
+						'method'    =>  'VisitsSummary.getVisits',
+						'idSite'    =>  $settings['matomo_siteid'],
+						'period'    =>  $period,
+						'date'      =>  'today',
+						'token_auth' =>  $settings['matomo_token'],
+						'format'    =>  'json'
+					]
+				]);
 
-                if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
-                    $result = json_decode((string) $response->getBody(), true)['value'] ?? null;
-                    if ($result !== null) {
-                        return (int)$result;
-                    }
-                }
-            } catch (GuzzleException $ex) {
-            }
-        }
+				if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
+					$result = json_decode((string) $response->getBody(), true)['value'] ?? null;
+					if ($result !== null) {
+						return (int)$result;
+					}
+				}
+			} catch (GuzzleException $ex) {
+			}
+		}
 
-        return null;
-    }
+		return null;
+	}
 }

app/Module/PatronymicLineage/Http/RequestHandlers/LineagesPage.php

Indentation +63 added lines, -63 removed lines

@@ -32,67 +32,67 @@
  */
 class LineagesPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
-
-    /**
-     * @var PatronymicLineageModule|null $module
-     */
-    private $module;
-
-    /**
-     * @var IndividualListModule|null $indilist_module
-     */
-    private $indilist_module;
-
-    /**
-     * Constructor for LineagesPage Request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
-        $this->indilist_module = $module_service->findByInterface(IndividualListModule::class)->first();
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
-
-        if ($this->indilist_module === null) {
-            throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
-        }
-
-        $tree = Validator::attributes($request)->tree();
-        $surname = Validator::attributes($request)->string('$surname', '');
-
-        $initial = mb_substr($surname, 0, 1);
-        $initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
-            ->reject(function (int $count, string $initial): bool {
-
-                return $initial === '@' || $initial === ',';
-            });
-
-        $title = I18N::translate('Patronymic Lineages') . ' — ' . $surname;
-
-        $lineages = app()->make(LineageBuilder::class, ['surname' => $surname])->buildLineages();
-
-        return $this->viewResponse($this->module->name() . '::lineages-page', [
-            'title'         =>  $title,
-            'module'        =>  $this->module,
-            'tree'          =>  $tree,
-            'initials_list' =>  $initials_list,
-            'initial'       =>  $initial,
-            'show_all'      =>  'no',
-            'surname'       =>  $surname,
-            'lineages'      =>  $lineages,
-            'nb_lineages'   =>  $lineages !== null ? $lineages->count() : 0
-        ]);
-    }
+	use ViewResponseTrait;
+
+	/**
+	 * @var PatronymicLineageModule|null $module
+	 */
+	private $module;
+
+	/**
+	 * @var IndividualListModule|null $indilist_module
+	 */
+	private $indilist_module;
+
+	/**
+	 * Constructor for LineagesPage Request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
+		$this->indilist_module = $module_service->findByInterface(IndividualListModule::class)->first();
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
+
+		if ($this->indilist_module === null) {
+			throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
+		}
+
+		$tree = Validator::attributes($request)->tree();
+		$surname = Validator::attributes($request)->string('$surname', '');
+
+		$initial = mb_substr($surname, 0, 1);
+		$initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
+			->reject(function (int $count, string $initial): bool {
+
+				return $initial === '@' || $initial === ',';
+			});
+
+		$title = I18N::translate('Patronymic Lineages') . ' — ' . $surname;
+
+		$lineages = app()->make(LineageBuilder::class, ['surname' => $surname])->buildLineages();
+
+		return $this->viewResponse($this->module->name() . '::lineages-page', [
+			'title'         =>  $title,
+			'module'        =>  $this->module,
+			'tree'          =>  $tree,
+			'initials_list' =>  $initials_list,
+			'initial'       =>  $initial,
+			'show_all'      =>  'no',
+			'surname'       =>  $surname,
+			'lineages'      =>  $lineages,
+			'nb_lineages'   =>  $lineages !== null ? $lineages->count() : 0
+		]);
+	}
 }

app/Module/PatronymicLineage/Http/RequestHandlers/SurnamesList.php

Indentation +47 added lines, -47 removed lines

@@ -31,59 +31,59 @@
  */
 class SurnamesList implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?PatronymicLineageModule $module;
+	private ?PatronymicLineageModule $module;
 
-    /**
-     * Constructor for SurnamesList Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
-    }
+	/**
+	 * Constructor for SurnamesList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $tree = Validator::attributes($request)->tree();
-        $initial = Validator::attributes($request)->string('alpha', '');
+		$tree = Validator::attributes($request)->tree();
+		$initial = Validator::attributes($request)->string('alpha', '');
 
-        $initials_list = collect($this->module->surnameAlpha($tree, false, false, I18N::locale()))
-            ->reject(function (int $count, string $initial): bool {
-                return $initial === '@' || $initial === ',';
-            });
+		$initials_list = collect($this->module->surnameAlpha($tree, false, false, I18N::locale()))
+			->reject(function (int $count, string $initial): bool {
+				return $initial === '@' || $initial === ',';
+			});
 
-        $show_all = Validator::queryParams($request)->string('show_all', 'no');
+		$show_all = Validator::queryParams($request)->string('show_all', 'no');
 
-        if ($show_all === 'yes') {
-            $title = I18N::translate('Patronymic Lineages') . ' — ' . I18N::translate('All');
-            $surnames = $this->module->surnames($tree, '', '', false, false, I18N::locale());
-        } elseif (mb_strlen($initial) == 1) {
-            $title = I18N::translate('Patronymic Lineages') . ' — ' . $initial;
-            $surnames = $this->module->surnames($tree, '', $initial, false, false, I18N::locale());
-        } else {
-            $title =  I18N::translate('Patronymic Lineages');
-            $surnames = [];
-        }
+		if ($show_all === 'yes') {
+			$title = I18N::translate('Patronymic Lineages') . ' — ' . I18N::translate('All');
+			$surnames = $this->module->surnames($tree, '', '', false, false, I18N::locale());
+		} elseif (mb_strlen($initial) == 1) {
+			$title = I18N::translate('Patronymic Lineages') . ' — ' . $initial;
+			$surnames = $this->module->surnames($tree, '', $initial, false, false, I18N::locale());
+		} else {
+			$title =  I18N::translate('Patronymic Lineages');
+			$surnames = [];
+		}
 
-        return $this->viewResponse($this->module->name() . '::surnames-page', [
-            'title'         =>  $title,
-            'module'        =>  $this->module,
-            'tree'          =>  $tree,
-            'initials_list' =>  $initials_list,
-            'initial'       =>  $initial,
-            'show_all'      =>  $show_all,
-            'surnames'      =>  $surnames
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::surnames-page', [
+			'title'         =>  $title,
+			'module'        =>  $this->module,
+			'tree'          =>  $tree,
+			'initials_list' =>  $initials_list,
+			'initial'       =>  $initial,
+			'show_all'      =>  $show_all,
+			'surnames'      =>  $surnames
+		]);
+	}
 }

app/Module/PatronymicLineage/PatronymicLineageModule.php

Indentation +134 added lines, -134 removed lines

@@ -36,139 +36,139 @@
  * Display lineages of people with the same surname.
  */
 class PatronymicLineageModule extends IndividualListModule implements
-    ModuleMyArtJaubInterface,
-    ModuleListInterface,
-    ModuleGlobalInterface
+	ModuleMyArtJaubInterface,
+	ModuleListInterface,
+	ModuleGlobalInterface
 {
-    use ModuleMyArtJaubTrait;
-    use ModuleListTrait;
-    use ModuleGlobalTrait;
-
-     /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “Patronymic lineage” module */ I18N::translate('Patronymic Lineages');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “Patronymic lineage” module */ I18N::translate('Display lineages of people holding the same surname.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/lineages', static function (Map $router): void {
-
-                $router->attach('', '/Page', static function (Map $router): void {
-
-                    $router->get(SurnamesList::class, '/{tree}/list{/alpha}', SurnamesList::class);
-                    $router->get(LineagesPage::class, '/{tree}/lineage/{surname}', LineagesPage::class);
-                });
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.11-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
-     *
-     * @param array<bool|int|string|array<mixed>|null> $parameters
-     */
-    public function listUrl(Tree $tree, array $parameters = []): string
-    {
-        $surname = $parameters['surname'] ?? '';
-
-        $xref = app(ServerRequestInterface::class)->getAttribute('xref', '');
-        if ($xref !== '' && ($individual = Registry::individualFactory()->make($xref, $tree)) !== null) {
-            $surname = $individual->getAllNames()[$individual->getPrimaryName()]['surname'];
-        }
-
-        if ($surname !== '') {
-            return route(LineagesPage::class, [
-                'tree'      =>  $tree->name(),
-                'surname'   =>  $surname
-            ] + $parameters);
-        }
-        return route(SurnamesList::class, [
-            'tree'  =>  $tree->name()
-        ] + $parameters);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
-     */
-    public function listMenuClass(): string
-    {
-        return 'menu-maj-patrolineage';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
-     */
-    public function headContent(): string
-    {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\IndividualListModule::individuals()
-     *
-     * Implemented to set the visibility to public.
-     * This should probably be in a service, but this hack allows for reuse of mainstream code.
-     */
-    public function individuals(
-        Tree $tree,
-        string $surn,
-        string $salpha,
-        string $galpha,
-        bool $marnm,
-        bool $fams,
-        LocaleInterface $locale
-    ): Collection {
-        return parent::individuals($tree, $surn, $salpha, $galpha, $marnm, $fams, $locale);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\IndividualListModule::surnames()
-     *
-     * Implemented to set the visibility to public.
-     * This should probably be in a service, but this hack allows for reuse of mainstream code.
-     */
-    public function surnames(
-        Tree $tree,
-        string $surn,
-        string $salpha,
-        bool $marnm,
-        bool $fams,
-        LocaleInterface $locale
-    ): array {
-        return parent::surnames($tree, $surn, $salpha, $marnm, $fams, $locale);
-    }
+	use ModuleMyArtJaubTrait;
+	use ModuleListTrait;
+	use ModuleGlobalTrait;
+
+	 /**
+	  * {@inheritDoc}
+	  * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	  */
+	public function title(): string
+	{
+		return /* I18N: Name of the “Patronymic lineage” module */ I18N::translate('Patronymic Lineages');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “Patronymic lineage” module */ I18N::translate('Display lineages of people holding the same surname.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/lineages', static function (Map $router): void {
+
+				$router->attach('', '/Page', static function (Map $router): void {
+
+					$router->get(SurnamesList::class, '/{tree}/list{/alpha}', SurnamesList::class);
+					$router->get(LineagesPage::class, '/{tree}/lineage/{surname}', LineagesPage::class);
+				});
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.11-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
+	 *
+	 * @param array<bool|int|string|array<mixed>|null> $parameters
+	 */
+	public function listUrl(Tree $tree, array $parameters = []): string
+	{
+		$surname = $parameters['surname'] ?? '';
+
+		$xref = app(ServerRequestInterface::class)->getAttribute('xref', '');
+		if ($xref !== '' && ($individual = Registry::individualFactory()->make($xref, $tree)) !== null) {
+			$surname = $individual->getAllNames()[$individual->getPrimaryName()]['surname'];
+		}
+
+		if ($surname !== '') {
+			return route(LineagesPage::class, [
+				'tree'      =>  $tree->name(),
+				'surname'   =>  $surname
+			] + $parameters);
+		}
+		return route(SurnamesList::class, [
+			'tree'  =>  $tree->name()
+		] + $parameters);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
+	 */
+	public function listMenuClass(): string
+	{
+		return 'menu-maj-patrolineage';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
+	 */
+	public function headContent(): string
+	{
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\IndividualListModule::individuals()
+	 *
+	 * Implemented to set the visibility to public.
+	 * This should probably be in a service, but this hack allows for reuse of mainstream code.
+	 */
+	public function individuals(
+		Tree $tree,
+		string $surn,
+		string $salpha,
+		string $galpha,
+		bool $marnm,
+		bool $fams,
+		LocaleInterface $locale
+	): Collection {
+		return parent::individuals($tree, $surn, $salpha, $galpha, $marnm, $fams, $locale);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\IndividualListModule::surnames()
+	 *
+	 * Implemented to set the visibility to public.
+	 * This should probably be in a service, but this hack allows for reuse of mainstream code.
+	 */
+	public function surnames(
+		Tree $tree,
+		string $surn,
+		string $salpha,
+		bool $marnm,
+		bool $fams,
+		LocaleInterface $locale
+	): array {
+		return parent::surnames($tree, $surn, $salpha, $marnm, $fams, $locale);
+	}
 }