jon48 / webtrees-lib

src/Webtrees/Module/Sosa/SosaModule.php

Indentation +165 added lines, -165 removed lines

@@ -47,174 +47,174 @@
  */
 class SosaModule extends AbstractModule implements ModuleMyArtJaubInterface, ModuleGlobalInterface, ModuleMenuInterface
 {
-    use ModuleMyArtJaubTrait {
-        boot as traitBoot;
-    }
-    use ModuleGlobalTrait;
-    use ModuleMenuTrait;
+	use ModuleMyArtJaubTrait {
+		boot as traitBoot;
+	}
+	use ModuleGlobalTrait;
+	use ModuleMenuTrait;
 
 // How to update the database schema for this module
 
 
-    private const SCHEMA_TARGET_VERSION   = 3;
-    private const SCHEMA_SETTING_NAME     = 'MAJ_SOSA_SCHEMA_VERSION';
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
+	private const SCHEMA_TARGET_VERSION   = 3;
+	private const SCHEMA_SETTING_NAME     = 'MAJ_SOSA_SCHEMA_VERSION';
+	private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
 /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “Sosa” module */ I18N::translate('Sosa');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “Sosa” module */ I18N::translate('Calculate and display Sosa ancestors of the root person.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
-     */
-    public function boot(): void
-    {
-        $this->traitBoot();
-        app(MigrationService::class)->updateSchema(
-            self::SCHEMA_MIGRATION_PREFIX,
-            self::SCHEMA_SETTING_NAME,
-            self::SCHEMA_TARGET_VERSION
-        );
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/sosa', static function (Map $router): void {
-
-                $router->attach('', '/list', static function (Map $router): void {
-
-                    $router->get(AncestorsList::class, '/ancestors/{tree}{/gen}', AncestorsList::class);
-                    $router->get(AncestorsListIndividual::class, '/ancestors/{tree}/{gen}/tab/individuals', AncestorsListIndividual::class);    //phpcs:ignore Generic.Files.LineLength.TooLong
-                    $router->get(AncestorsListFamily::class, '/ancestors/{tree}/{gen}/tab/families', AncestorsListFamily::class);   //phpcs:ignore Generic.Files.LineLength.TooLong
-                    $router->get(MissingAncestorsList::class, '/missing/{tree}{/gen}', MissingAncestorsList::class);
-                });
-
-                $router->attach('', '/statistics/{tree}', static function (Map $router): void {
-
-                    $router->get(SosaStatistics::class, '', SosaStatistics::class);
-                    $router->get(PedigreeCollapseData::class, '/pedigreecollapse', PedigreeCollapseData::class);
-                });
-
-                $router->attach('', '/config/{tree}', static function (Map $router): void {
-
-                    $router->get(SosaConfig::class, '', SosaConfig::class);
-                    $router->post(SosaConfigAction::class, '', SosaConfigAction::class);
-                    $router->get(SosaComputeModal::class, '/compute/{xref}', SosaComputeModal::class);
-                    $router->post(SosaComputeAction::class, '/compute', SosaComputeAction::class);
-                });
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.11-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::defaultMenuOrder()
-     */
-    public function defaultMenuOrder(): int
-    {
-        return 7;
-    }
-
-    /**
-     * {@inhericDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::getMenu()
-     */
-    public function getMenu(Tree $tree): ?Menu
-    {
-        $menu = new Menu(I18N::translate('Sosa Statistics'));
-        $menu->setClass('menu-maj-sosa');
-        $menu->setSubmenus([
-            new Menu(
-                I18N::translate('Sosa Ancestors'),
-                route(AncestorsList::class, ['tree' => $tree->name()]),
-                'menu-maj-sosa-list',
-                ['rel' => 'nofollow']
-            ),
-            new Menu(
-                I18N::translate('Missing Ancestors'),
-                route(MissingAncestorsList::class, ['tree' => $tree->name()]),
-                'menu-maj-sosa-missing',
-                ['rel' => 'nofollow']
-            ),
-            new Menu(
-                I18N::translate('Sosa Statistics'),
-                route(SosaStatistics::class, ['tree' => $tree->name()]),
-                'menu-maj-sosa-stats'
-            )
-        ]);
-
-        if (Auth::check()) {
-            $menu->addSubmenu(new Menu(
-                I18N::translate('Sosa Configuration'),
-                route(SosaConfig::class, ['tree' => $tree->name()]),
-                'menu-maj-sosa-config'
-            ));
-
-            /** @var ServerRequestInterface $request */
-            $request = app(ServerRequestInterface::class);
-            $route = $request->getAttribute('route');
-            assert($route instanceof Route);
-
-            $root_indi_id = $tree->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
-
-            if ($route->name === IndividualPage::class && mb_strlen($root_indi_id) > 0) {
-                $xref = $request->getAttribute('xref');
-                assert(is_string($xref));
-
-                $menu->addSubmenu(new Menu(
-                    I18N::translate('Complete Sosas'),
-                    '#',
-                    'menu-maj-sosa-compute',
-                    [
-                        'rel'           => 'nofollow',
-                        'data-href'     => route(SosaComputeModal::class, ['tree' => $tree->name(), 'xref' => $xref]),
-                        'data-target'   => '#wt-ajax-modal',
-                        'data-toggle'   => 'modal',
-                        'data-backdrop' => 'static'
-                    ]
-                ));
-            }
-        }
-
-        return $menu;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
-     */
-    public function headContent(): string
-    {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
-    }
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return /* I18N: Name of the “Sosa” module */ I18N::translate('Sosa');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “Sosa” module */ I18N::translate('Calculate and display Sosa ancestors of the root person.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
+	 */
+	public function boot(): void
+	{
+		$this->traitBoot();
+		app(MigrationService::class)->updateSchema(
+			self::SCHEMA_MIGRATION_PREFIX,
+			self::SCHEMA_SETTING_NAME,
+			self::SCHEMA_TARGET_VERSION
+		);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/sosa', static function (Map $router): void {
+
+				$router->attach('', '/list', static function (Map $router): void {
+
+					$router->get(AncestorsList::class, '/ancestors/{tree}{/gen}', AncestorsList::class);
+					$router->get(AncestorsListIndividual::class, '/ancestors/{tree}/{gen}/tab/individuals', AncestorsListIndividual::class);    //phpcs:ignore Generic.Files.LineLength.TooLong
+					$router->get(AncestorsListFamily::class, '/ancestors/{tree}/{gen}/tab/families', AncestorsListFamily::class);   //phpcs:ignore Generic.Files.LineLength.TooLong
+					$router->get(MissingAncestorsList::class, '/missing/{tree}{/gen}', MissingAncestorsList::class);
+				});
+
+				$router->attach('', '/statistics/{tree}', static function (Map $router): void {
+
+					$router->get(SosaStatistics::class, '', SosaStatistics::class);
+					$router->get(PedigreeCollapseData::class, '/pedigreecollapse', PedigreeCollapseData::class);
+				});
+
+				$router->attach('', '/config/{tree}', static function (Map $router): void {
+
+					$router->get(SosaConfig::class, '', SosaConfig::class);
+					$router->post(SosaConfigAction::class, '', SosaConfigAction::class);
+					$router->get(SosaComputeModal::class, '/compute/{xref}', SosaComputeModal::class);
+					$router->post(SosaComputeAction::class, '/compute', SosaComputeAction::class);
+				});
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.11-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::defaultMenuOrder()
+	 */
+	public function defaultMenuOrder(): int
+	{
+		return 7;
+	}
+
+	/**
+	 * {@inhericDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::getMenu()
+	 */
+	public function getMenu(Tree $tree): ?Menu
+	{
+		$menu = new Menu(I18N::translate('Sosa Statistics'));
+		$menu->setClass('menu-maj-sosa');
+		$menu->setSubmenus([
+			new Menu(
+				I18N::translate('Sosa Ancestors'),
+				route(AncestorsList::class, ['tree' => $tree->name()]),
+				'menu-maj-sosa-list',
+				['rel' => 'nofollow']
+			),
+			new Menu(
+				I18N::translate('Missing Ancestors'),
+				route(MissingAncestorsList::class, ['tree' => $tree->name()]),
+				'menu-maj-sosa-missing',
+				['rel' => 'nofollow']
+			),
+			new Menu(
+				I18N::translate('Sosa Statistics'),
+				route(SosaStatistics::class, ['tree' => $tree->name()]),
+				'menu-maj-sosa-stats'
+			)
+		]);
+
+		if (Auth::check()) {
+			$menu->addSubmenu(new Menu(
+				I18N::translate('Sosa Configuration'),
+				route(SosaConfig::class, ['tree' => $tree->name()]),
+				'menu-maj-sosa-config'
+			));
+
+			/** @var ServerRequestInterface $request */
+			$request = app(ServerRequestInterface::class);
+			$route = $request->getAttribute('route');
+			assert($route instanceof Route);
+
+			$root_indi_id = $tree->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
+
+			if ($route->name === IndividualPage::class && mb_strlen($root_indi_id) > 0) {
+				$xref = $request->getAttribute('xref');
+				assert(is_string($xref));
+
+				$menu->addSubmenu(new Menu(
+					I18N::translate('Complete Sosas'),
+					'#',
+					'menu-maj-sosa-compute',
+					[
+						'rel'           => 'nofollow',
+						'data-href'     => route(SosaComputeModal::class, ['tree' => $tree->name(), 'xref' => $xref]),
+						'data-target'   => '#wt-ajax-modal',
+						'data-toggle'   => 'modal',
+						'data-backdrop' => 'static'
+					]
+				));
+			}
+		}
+
+		return $menu;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
+	 */
+	public function headContent(): string
+	{
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -58,7 +58,7 @@ 
 
     private const SCHEMA_TARGET_VERSION   = 3;
     private const SCHEMA_SETTING_NAME     = 'MAJ_SOSA_SCHEMA_VERSION';
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
+    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__.'\Schema';
 /**
      * {@inheritDoc}
      * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
@@ -98,25 +98,25 @@ 
      */
     public function loadRoutes(Map $router): void
     {
-        $router->attach('', '', static function (Map $router): void {
+        $router->attach('', '', static function(Map $router): void {
 
-            $router->attach('', '/module-maj/sosa', static function (Map $router): void {
+            $router->attach('', '/module-maj/sosa', static function(Map $router): void {
 
-                $router->attach('', '/list', static function (Map $router): void {
+                $router->attach('', '/list', static function(Map $router): void {
 
                     $router->get(AncestorsList::class, '/ancestors/{tree}{/gen}', AncestorsList::class);
-                    $router->get(AncestorsListIndividual::class, '/ancestors/{tree}/{gen}/tab/individuals', AncestorsListIndividual::class);    //phpcs:ignore Generic.Files.LineLength.TooLong
-                    $router->get(AncestorsListFamily::class, '/ancestors/{tree}/{gen}/tab/families', AncestorsListFamily::class);   //phpcs:ignore Generic.Files.LineLength.TooLong
+                    $router->get(AncestorsListIndividual::class, '/ancestors/{tree}/{gen}/tab/individuals', AncestorsListIndividual::class); //phpcs:ignore Generic.Files.LineLength.TooLong
+                    $router->get(AncestorsListFamily::class, '/ancestors/{tree}/{gen}/tab/families', AncestorsListFamily::class); //phpcs:ignore Generic.Files.LineLength.TooLong
                     $router->get(MissingAncestorsList::class, '/missing/{tree}{/gen}', MissingAncestorsList::class);
                 });
 
-                $router->attach('', '/statistics/{tree}', static function (Map $router): void {
+                $router->attach('', '/statistics/{tree}', static function(Map $router): void {
 
                     $router->get(SosaStatistics::class, '', SosaStatistics::class);
                     $router->get(PedigreeCollapseData::class, '/pedigreecollapse', PedigreeCollapseData::class);
                 });
 
-                $router->attach('', '/config/{tree}', static function (Map $router): void {
+                $router->attach('', '/config/{tree}', static function(Map $router): void {
 
                     $router->get(SosaConfig::class, '', SosaConfig::class);
                     $router->post(SosaConfigAction::class, '', SosaConfigAction::class);
@@ -215,6 +215,6 @@ 
      */
     public function headContent(): string
     {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+        return '<link rel="stylesheet" href="'.e($this->moduleCssUrl()).'">';
     }
 }

src/Webtrees/Module/WelcomeBlock/WelcomeBlockModule.php

Indentation +154 added lines, -154 removed lines

@@ -32,158 +32,158 @@
  */
 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->get(MatomoStats::class, '/matomostats', MatomoStats::class);
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.11-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
-     */
-    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)
-        ]);
-
-        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'      => $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
-    {
-        $params = (array) $request->getParsedBody();
-
-        $matomo_enabled = $params['matomo_enabled'] == 'yes';
-        $this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
-        if (!$matomo_enabled) {
-            return;
-        }
-
-        if (filter_var($params['matomo_url'], FILTER_VALIDATE_URL) === false) {
-            FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
-            return;
-        }
-
-        if (filter_var($params['matomo_siteid'], FILTER_VALIDATE_INT) === false) {
-            FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
-            return;
-        }
-
-        $this
-            ->setBlockSetting($block_id, 'matomo_url', trim($params['matomo_url']))
-            ->setBlockSetting($block_id, 'matomo_token', trim($params['matomo_token']))
-            ->setBlockSetting($block_id, 'matomo_siteid', $params['matomo_siteid']);
-
-        app('cache.files')->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->get(MatomoStats::class, '/matomostats', MatomoStats::class);
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.11-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
+	 */
+	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)
+		]);
+
+		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'      => $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
+	{
+		$params = (array) $request->getParsedBody();
+
+		$matomo_enabled = $params['matomo_enabled'] == 'yes';
+		$this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
+		if (!$matomo_enabled) {
+			return;
+		}
+
+		if (filter_var($params['matomo_url'], FILTER_VALIDATE_URL) === false) {
+			FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
+			return;
+		}
+
+		if (filter_var($params['matomo_siteid'], FILTER_VALIDATE_INT) === false) {
+			FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
+			return;
+		}
+
+		$this
+			->setBlockSetting($block_id, 'matomo_url', trim($params['matomo_url']))
+			->setBlockSetting($block_id, 'matomo_token', trim($params['matomo_token']))
+			->setBlockSetting($block_id, 'matomo_siteid', $params['matomo_siteid']);
+
+		app('cache.files')->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')
+		];
+	}
 }

src/Webtrees/Module/ModuleMyArtJaubTrait.php

Indentation +57 added lines, -57 removed lines

@@ -23,73 +23,73 @@
  */
 trait ModuleMyArtJaubTrait
 {    
-    use ModuleCustomTrait;
+	use ModuleCustomTrait;
     
-    /**
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
-     */
-    public function boot() : void
-    {
-        View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
+	/**
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
+	 */
+	public function boot() : void
+	{
+		View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
         
-        $this->loadRoutes(app(RouterContainer::class)->getMap());
-    }
+		$this->loadRoutes(app(RouterContainer::class)->getMap());
+	}
     
-    /**
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::resourcesFolder()
-     */
-    public function resourcesFolder(): string
-    {
-        return Webtrees::MODULES_DIR . trim($this->name(), '_') . '/resources/';
-    }
+	/**
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::resourcesFolder()
+	 */
+	public function resourcesFolder(): string
+	{
+		return Webtrees::MODULES_DIR . trim($this->name(), '_') . '/resources/';
+	}
     
-    /**
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleAuthorName()
-     */
-    public function customModuleAuthorName() : string
-    {
-        return 'Jonathan Jaubart';
-    }
+	/**
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleAuthorName()
+	 */
+	public function customModuleAuthorName() : string
+	{
+		return 'Jonathan Jaubart';
+	}
     
-    /**
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleSupportUrl()
-     */
-    public function customModuleSupportUrl() : string
-    {
-        return 'https://github.com/jon48/webtrees-lib';
-    }
+	/**
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleSupportUrl()
+	 */
+	public function customModuleSupportUrl() : string
+	{
+		return 'https://github.com/jon48/webtrees-lib';
+	}
     
-    /**
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customTranslations()
-     */
-    public function customTranslations(string $language) : array
-    {
-        $translation_file = $this->resourcesFolder() . 'lang/' . $language . '/messages.php';
+	/**
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customTranslations()
+	 */
+	public function customTranslations(string $language) : array
+	{
+		$translation_file = $this->resourcesFolder() . 'lang/' . $language . '/messages.php';
         
-        try {
-            $translation  = new Translation($translation_file);
-            return $translation->asArray();
-        } catch (\Exception $e) { }
+		try {
+			$translation  = new Translation($translation_file);
+			return $translation->asArray();
+		} catch (\Exception $e) { }
         
-        return array();
-    }
+		return array();
+	}
     
-    /**
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::moduleCssUrl
-     */
-    public function moduleCssUrl() : string
-    {
-        /** @var ModuleThemeInterface $theme */
-        $theme = app(ModuleThemeInterface::class);
-        $css_file = $this->resourcesFolder() . 'css/' . $theme->name() . '.min.css';
+	/**
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::moduleCssUrl
+	 */
+	public function moduleCssUrl() : string
+	{
+		/** @var ModuleThemeInterface $theme */
+		$theme = app(ModuleThemeInterface::class);
+		$css_file = $this->resourcesFolder() . 'css/' . $theme->name() . '.min.css';
         
-        if(file_exists($css_file)) {
-            return $this->assetUrl('css/' . $theme->name() . '.min.css');
-        }
-        else {
-            return $this->assetUrl('css/default.min.css');
-        }
-    }
+		if(file_exists($css_file)) {
+			return $this->assetUrl('css/' . $theme->name() . '.min.css');
+		}
+		else {
+			return $this->assetUrl('css/default.min.css');
+		}
+	}
     
 }
  
\ No newline at end of file

src/Webtrees/Module/PatronymicLineage/PatronymicLineageModule.php

Indentation +95 added lines, -95 removed lines

@@ -34,100 +34,100 @@
  * Display lineages of people with the same surname.
  */
 class PatronymicLineageModule extends AbstractModule 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()
-     */
-    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()) . '">';
-    }
+	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()
+	 */
+	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()) . '">';
+	}
 }