jon48 / webtrees-lib

src/Webtrees/Module/IsSourced/Data/NullFactSourceStatus.php

Indentation +16 added lines, -16 removed lines

@@ -19,21 +19,21 @@
  */
 class NullFactSourceStatus extends FactSourceStatus
 {
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::isSet()
-     */
-    public function isSet(): bool
-    {
-        return false;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::isSet()
+	 */
+	public function isSet(): bool
+	{
+		return false;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\FactSourceStatus::combineWith()
-     */
-    public function combineWith(SourceStatus $other): SourceStatus
-    {
-        return $other;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\FactSourceStatus::combineWith()
+	 */
+	public function combineWith(SourceStatus $other): SourceStatus
+	{
+		return $other;
+	}
 }

src/Webtrees/Module/WelcomeBlock/Http/RequestHandlers/MatomoStats.php

Indentation +52 added lines, -52 removed lines

@@ -31,64 +31,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 = filter_var($request->getAttribute('block_id'), FILTER_VALIDATE_INT);
-        $nb_visits_year = $nb_visits_today = null;
+		$block_id = filter_var($request->getAttribute('block_id'), FILTER_VALIDATE_INT);
+		$nb_visits_year = $nb_visits_today = null;
 
-        try {
-            if ($block_id !== false && $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 !== false && $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
+		]);
+	}
 }

src/Webtrees/Module/WelcomeBlock/WelcomeBlockModule.php

Indentation +155 added lines, -155 removed lines

@@ -33,159 +33,159 @@
  */
 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.2';
-    }
-
-    /**
-     * {@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),
-            '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'      => $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']);
-
-        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->get(MatomoStats::class, '/matomostats', MatomoStats::class);
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.11-v.2';
+	}
+
+	/**
+	 * {@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),
+			'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'      => $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']);
+
+		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')
+		];
+	}
 }

src/Webtrees/Module/WelcomeBlock/Services/MatomoStatsService.php

Indentation +82 added lines, -82 removed lines

@@ -29,93 +29,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 (RequestException $ex) {
-            }
-        }
+				if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
+					$result = json_decode((string) $response->getBody(), true)['value'] ?? null;
+					if ($result !== null) {
+						return (int)$result;
+					}
+				}
+			} catch (RequestException $ex) {
+			}
+		}
 
-        return null;
-    }
+		return null;
+	}
 }

src/Webtrees/Module/Certificates/CertificatesModule.php

Indentation +149 added lines, -149 removed lines

@@ -43,154 +43,154 @@
  * Certificates Module.
  */
 class CertificatesModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleConfigInterface,
-    ModuleGlobalInterface,
-    ModuleListInterface
+	ModuleMyArtJaubInterface,
+	ModuleConfigInterface,
+	ModuleGlobalInterface,
+	ModuleListInterface
 {
-    use ModuleMyArtJaubTrait {
-        boot as traitBoot;
-    }
-    use ModuleConfigTrait;
-    use ModuleGlobalTrait;
-    use ModuleListTrait;
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “Certificates” module */ I18N::translate('Certificates');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “Certificates” module */ I18N::translate('Display and edition of certificates linked to sources.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
-     */
-    public function boot(): void
-    {
-        $this->traitBoot();
-        Registry::elementFactory()->register([
-            'FAM:SOUR:_ACT'     =>  new SourceCertificate(I18N::translate('Certificate')),
-            'FAM:*:SOUR:_ACT'   =>  new SourceCertificate(I18N::translate('Certificate')),
-            'INDI:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate')),
-            'INDI:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate')),
-            'OBJE:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate')),
-            'OBJE:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate')),
-            'NOTE:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate')),
-            'NOTE:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate'))
-        ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes($router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/certificates', static function (Map $router): void {
-
-                $router->attach('', '/admin', static function (Map $router): void {
-
-                    $router->get(AdminTreesPage::class, '/trees', AdminTreesPage::class)
-                        ->extras(['middleware' => [ AuthAdministrator::class ]]);
-
-                    $router->attach('', '/config/{tree}', static function (Map $router): void {
-
-                        $router->extras([
-                            'middleware' => [
-                                AuthManager::class,
-                            ],
-                        ]);
-                        $router->get(AdminConfigPage::class, '', AdminConfigPage::class);
-                        $router->post(AdminConfigAction::class, '', AdminConfigAction::class);
-                    });
-                });
-
-                $router->get(CertificatesList::class, '/list/{tree}{/cityobf}', CertificatesList::class)
-                    ->extras([
-                        'middleware'            =>  [AuthTreePreference::class],
-                        'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
-                    ]);
-
-                $router->attach('', '/certificate/{tree}/{cid}', static function (Map $router): void {
-
-                    $router->extras([
-                        'middleware'            =>  [AuthTreePreference::class],
-                        'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
-                    ]);
-
-                    $router->get(CertificatePage::class, '', CertificatePage::class);
-                    $router->get(CertificateImage::class, '/image', CertificateImage::class);
-                });
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.0-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
-     */
-    public function getConfigLink(): string
-    {
-        return route(AdminTreesPage::class);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
-     */
-    public function headContent(): string
-    {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
-     */
-    public function listUrl(Tree $tree, array $parameters = []): string
-    {
-        return route(CertificatesList::class, ['tree' => $tree->name() ] + $parameters);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
-     */
-    public function listMenuClass(): string
-    {
-        return 'menu-maj-certificates';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listIsEmpty()
-     */
-    public function listIsEmpty(Tree $tree): bool
-    {
-        return Auth::accessLevel($tree) > (int) $tree->getPreference('MAJ_CERTIF_SHOW_CERT', (string) Auth::PRIV_HIDE);
-    }
+	use ModuleMyArtJaubTrait {
+		boot as traitBoot;
+	}
+	use ModuleConfigTrait;
+	use ModuleGlobalTrait;
+	use ModuleListTrait;
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return /* I18N: Name of the “Certificates” module */ I18N::translate('Certificates');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “Certificates” module */ I18N::translate('Display and edition of certificates linked to sources.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
+	 */
+	public function boot(): void
+	{
+		$this->traitBoot();
+		Registry::elementFactory()->register([
+			'FAM:SOUR:_ACT'     =>  new SourceCertificate(I18N::translate('Certificate')),
+			'FAM:*:SOUR:_ACT'   =>  new SourceCertificate(I18N::translate('Certificate')),
+			'INDI:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate')),
+			'INDI:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate')),
+			'OBJE:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate')),
+			'OBJE:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate')),
+			'NOTE:SOUR:_ACT'    =>  new SourceCertificate(I18N::translate('Certificate')),
+			'NOTE:*:SOUR:_ACT'  =>  new SourceCertificate(I18N::translate('Certificate'))
+		]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes($router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/certificates', static function (Map $router): void {
+
+				$router->attach('', '/admin', static function (Map $router): void {
+
+					$router->get(AdminTreesPage::class, '/trees', AdminTreesPage::class)
+						->extras(['middleware' => [ AuthAdministrator::class ]]);
+
+					$router->attach('', '/config/{tree}', static function (Map $router): void {
+
+						$router->extras([
+							'middleware' => [
+								AuthManager::class,
+							],
+						]);
+						$router->get(AdminConfigPage::class, '', AdminConfigPage::class);
+						$router->post(AdminConfigAction::class, '', AdminConfigAction::class);
+					});
+				});
+
+				$router->get(CertificatesList::class, '/list/{tree}{/cityobf}', CertificatesList::class)
+					->extras([
+						'middleware'            =>  [AuthTreePreference::class],
+						'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
+					]);
+
+				$router->attach('', '/certificate/{tree}/{cid}', static function (Map $router): void {
+
+					$router->extras([
+						'middleware'            =>  [AuthTreePreference::class],
+						'permission_preference' =>  'MAJ_CERTIF_SHOW_CERT'
+					]);
+
+					$router->get(CertificatePage::class, '', CertificatePage::class);
+					$router->get(CertificateImage::class, '/image', CertificateImage::class);
+				});
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.0-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
+	 */
+	public function getConfigLink(): string
+	{
+		return route(AdminTreesPage::class);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
+	 */
+	public function headContent(): string
+	{
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
+	 */
+	public function listUrl(Tree $tree, array $parameters = []): string
+	{
+		return route(CertificatesList::class, ['tree' => $tree->name() ] + $parameters);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
+	 */
+	public function listMenuClass(): string
+	{
+		return 'menu-maj-certificates';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listIsEmpty()
+	 */
+	public function listIsEmpty(Tree $tree): bool
+	{
+		return Auth::accessLevel($tree) > (int) $tree->getPreference('MAJ_CERTIF_SHOW_CERT', (string) Auth::PRIV_HIDE);
+	}
 }

src/Webtrees/Module/Certificates/Model/Certificate.php

Indentation +208 added lines, -208 removed lines

@@ -25,212 +25,212 @@
  */
 class Certificate
 {
-    /**
-     * Pattern to extract information from a file name.
-     * Specific to the author's workflow.
-     * @var string
-     */
-    private const FILENAME_PATTERN = '/^(?<year>\d{1,4})(\.(?<month>\d{1,2}))?(\.(?<day>\d{1,2}))?( (?<type>[A-Z]{1,2}))?\s(?<descr>.*)/'; //phpcs:ignore Generic.Files.LineLength.TooLong
-
-    /**
-     * @var Tree $tree
-     */
-    private $tree;
-
-    /**
-     * @var string $path
-     * */
-    private $path;
-
-    /**
-     * @var string|null $city
-     * $city */
-    private $city;
-
-    /**
-     * @var string|null $filename
-     */
-    private $filename;
-
-    /**
-     * @var string|null $extension
-     */
-    private $extension;
-
-    /**
-     * @var string|null $type
-     */
-    private $type;
-
-    /**
-     * @var string|null $description
-     */
-    private $description;
-
-    /**
-     * @var Date|null $date
-     */
-    private $date;
-
-    /**
-     * Contructor for Certificate
-     *
-     * @param Tree $tree
-     * @param string $path
-     */
-    public function __construct(Tree $tree, string $path)
-    {
-        $this->tree = $tree;
-        $this->path = $path;
-        $this->extractDataFromPath($path);
-    }
-
-    /**
-     * Populate fields from the filename, based on a predeterminate pattern.
-     * Logic specific to the author.
-     *
-     * @param string $path
-     */
-    protected function extractDataFromPath(string $path): void
-    {
-        $path_parts = pathinfo($path);
-        $this->city = $path_parts['dirname'];
-        $this->filename = $path_parts['filename'];
-        $this->extension = $path_parts['extension'] ?? '';
-
-        if (preg_match(self::FILENAME_PATTERN, $this->filename, $match) === 1) {
-            $this->type = $match['type'];
-            $this->description = $match['descr'];
-
-            $day = $match['day'] ?? '';
-            $month_date = DateTime::createFromFormat('m', $match['month'] ?? '');
-            $month = $month_date !== false ? strtoupper($month_date->format('M')) : '';
-            $year = $match['year'] ?? '';
-
-            $this->date = new Date(sprintf('%s %s %s', $day, $month, $year));
-        } else {
-            $this->description = $this->filename;
-        }
-    }
-
-    /**
-     * Get the family tree of the certificate
-     *
-     * @return Tree
-     */
-    public function tree(): Tree
-    {
-        return $this->tree;
-    }
-
-    /**
-     * Get the path of the certificate in the file system.
-     *
-     * @return string
-     */
-    public function path(): string
-    {
-        return $this->path;
-    }
-
-    /**
-     * The the path of the certificate, in a Gedcom canonical form.
-     *
-     * @return string
-     */
-    public function gedcomPath(): string
-    {
-        return str_replace('\\', '/', $this->path);
-    }
-
-    /**
-     * Get the certificate name.
-     *
-     * @return string
-     */
-    public function name(): string
-    {
-        return $this->filename ?? '';
-    }
-
-    /**
-     * Get the certificate's city (the first level folder).
-     *
-     * @return string
-     */
-    public function city(): string
-    {
-        return $this->city ?? '';
-    }
-
-    /**
-     * Get the certificate's date. Extracted from the file name.
-     *
-     * @return Date
-     */
-    public function date(): Date
-    {
-        return $this->date ?? new Date('');
-    }
-
-    /**
-     * Get the certificate's type. Extracted from the file name.
-     *
-     * @return string
-     */
-    public function type(): string
-    {
-        return $this->type ?? '';
-    }
-
-    /**
-     * Get the certificate's description.  Extracted from the file name.
-     * @return string
-     */
-    public function description(): string
-    {
-        return $this->description ?? '';
-    }
-
-    /**
-     * Get the certificate's description to be used for sorting.
-     * This is based on surnames (at least 3 letters) found in the file name.
-     *
-     * @return string
-     */
-    public function sortDescription(): string
-    {
-        $sort_prefix = '';
-        if (preg_match_all('/\b([A-Z]{3,})\b/', $this->description(), $matches, PREG_SET_ORDER) >= 1) {
-            $sort_prefix = implode('_', array_map(function ($match) {
-                return $match[1];
-            }, $matches)) . '_';
-        }
-        return $sort_prefix . $this->description();
-    }
-
-    /**
-     * Get the certificate's MIME type.
-     *
-     * @return string
-     */
-    public function mimeType(): string
-    {
-        return Mime::TYPES[$this->extension] ?? Mime::DEFAULT_TYPE;
-    }
-
-    /**
-     * Get the base parameters to be used in url referencing the certificate.
-     *
-     * @param UrlObfuscatorService $url_obfuscator_service
-     * @return array
-     */
-    public function urlParameters(UrlObfuscatorService $url_obfuscator_service = null): array
-    {
-        $url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
-        return [
-            'tree' => $this->tree->name(),
-            'cid' => $url_obfuscator_service->obfuscate($this->path)
-        ];
-    }
+	/**
+	 * Pattern to extract information from a file name.
+	 * Specific to the author's workflow.
+	 * @var string
+	 */
+	private const FILENAME_PATTERN = '/^(?<year>\d{1,4})(\.(?<month>\d{1,2}))?(\.(?<day>\d{1,2}))?( (?<type>[A-Z]{1,2}))?\s(?<descr>.*)/'; //phpcs:ignore Generic.Files.LineLength.TooLong
+
+	/**
+	 * @var Tree $tree
+	 */
+	private $tree;
+
+	/**
+	 * @var string $path
+	 * */
+	private $path;
+
+	/**
+	 * @var string|null $city
+	 * $city */
+	private $city;
+
+	/**
+	 * @var string|null $filename
+	 */
+	private $filename;
+
+	/**
+	 * @var string|null $extension
+	 */
+	private $extension;
+
+	/**
+	 * @var string|null $type
+	 */
+	private $type;
+
+	/**
+	 * @var string|null $description
+	 */
+	private $description;
+
+	/**
+	 * @var Date|null $date
+	 */
+	private $date;
+
+	/**
+	 * Contructor for Certificate
+	 *
+	 * @param Tree $tree
+	 * @param string $path
+	 */
+	public function __construct(Tree $tree, string $path)
+	{
+		$this->tree = $tree;
+		$this->path = $path;
+		$this->extractDataFromPath($path);
+	}
+
+	/**
+	 * Populate fields from the filename, based on a predeterminate pattern.
+	 * Logic specific to the author.
+	 *
+	 * @param string $path
+	 */
+	protected function extractDataFromPath(string $path): void
+	{
+		$path_parts = pathinfo($path);
+		$this->city = $path_parts['dirname'];
+		$this->filename = $path_parts['filename'];
+		$this->extension = $path_parts['extension'] ?? '';
+
+		if (preg_match(self::FILENAME_PATTERN, $this->filename, $match) === 1) {
+			$this->type = $match['type'];
+			$this->description = $match['descr'];
+
+			$day = $match['day'] ?? '';
+			$month_date = DateTime::createFromFormat('m', $match['month'] ?? '');
+			$month = $month_date !== false ? strtoupper($month_date->format('M')) : '';
+			$year = $match['year'] ?? '';
+
+			$this->date = new Date(sprintf('%s %s %s', $day, $month, $year));
+		} else {
+			$this->description = $this->filename;
+		}
+	}
+
+	/**
+	 * Get the family tree of the certificate
+	 *
+	 * @return Tree
+	 */
+	public function tree(): Tree
+	{
+		return $this->tree;
+	}
+
+	/**
+	 * Get the path of the certificate in the file system.
+	 *
+	 * @return string
+	 */
+	public function path(): string
+	{
+		return $this->path;
+	}
+
+	/**
+	 * The the path of the certificate, in a Gedcom canonical form.
+	 *
+	 * @return string
+	 */
+	public function gedcomPath(): string
+	{
+		return str_replace('\\', '/', $this->path);
+	}
+
+	/**
+	 * Get the certificate name.
+	 *
+	 * @return string
+	 */
+	public function name(): string
+	{
+		return $this->filename ?? '';
+	}
+
+	/**
+	 * Get the certificate's city (the first level folder).
+	 *
+	 * @return string
+	 */
+	public function city(): string
+	{
+		return $this->city ?? '';
+	}
+
+	/**
+	 * Get the certificate's date. Extracted from the file name.
+	 *
+	 * @return Date
+	 */
+	public function date(): Date
+	{
+		return $this->date ?? new Date('');
+	}
+
+	/**
+	 * Get the certificate's type. Extracted from the file name.
+	 *
+	 * @return string
+	 */
+	public function type(): string
+	{
+		return $this->type ?? '';
+	}
+
+	/**
+	 * Get the certificate's description.  Extracted from the file name.
+	 * @return string
+	 */
+	public function description(): string
+	{
+		return $this->description ?? '';
+	}
+
+	/**
+	 * Get the certificate's description to be used for sorting.
+	 * This is based on surnames (at least 3 letters) found in the file name.
+	 *
+	 * @return string
+	 */
+	public function sortDescription(): string
+	{
+		$sort_prefix = '';
+		if (preg_match_all('/\b([A-Z]{3,})\b/', $this->description(), $matches, PREG_SET_ORDER) >= 1) {
+			$sort_prefix = implode('_', array_map(function ($match) {
+				return $match[1];
+			}, $matches)) . '_';
+		}
+		return $sort_prefix . $this->description();
+	}
+
+	/**
+	 * Get the certificate's MIME type.
+	 *
+	 * @return string
+	 */
+	public function mimeType(): string
+	{
+		return Mime::TYPES[$this->extension] ?? Mime::DEFAULT_TYPE;
+	}
+
+	/**
+	 * Get the base parameters to be used in url referencing the certificate.
+	 *
+	 * @param UrlObfuscatorService $url_obfuscator_service
+	 * @return array
+	 */
+	public function urlParameters(UrlObfuscatorService $url_obfuscator_service = null): array
+	{
+		$url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
+		return [
+			'tree' => $this->tree->name(),
+			'cid' => $url_obfuscator_service->obfuscate($this->path)
+		];
+	}
 }

src/Webtrees/Module/Certificates/Model/Watermark.php

Indentation +108 added lines, -108 removed lines

@@ -19,112 +19,112 @@
  */
 class Watermark
 {
-    /**
-     * Default font color for watermarks
-     * @var string DEFAULT_COLOR
-     * */
-    public const DEFAULT_COLOR = '#4D6DF3';
-
-    /**
-     * Default maximum font size for watermarks
-     * @var string DEFAULT_SIZE
-     * */
-    public const DEFAULT_SIZE = 18;
-
-    /**
-     * @var string $text
-     */
-    private $text;
-
-    /**
-     * @var string $color;
-     */
-    private $color;
-
-
-    /**
-     * @var int $size
-     */
-    private $size;
-
-    /**
-     * Constructor for Watermark data class
-     *
-     * @param string $text
-     * @param string $color
-     * @param int $size
-     */
-    public function __construct(string $text, string $color, int $size)
-    {
-        $this->text = $text;
-        $this->color = $color;
-        $this->size = $size;
-    }
-
-    /**
-     * Get the watermark text.
-     *
-     * @return string
-     */
-    public function text(): string
-    {
-        return $this->text;
-    }
-
-    /**
-     * Get the watermark font color.
-     *
-     * @return string
-     */
-    public function color(): string
-    {
-        return $this->color;
-    }
-
-    /**
-     * Get the watermark maximum font size.
-     * @return int
-     */
-    public function size(): int
-    {
-        return $this->size;
-    }
-
-    /**
-     * Return an estimate of the size in pixels of the watermark text length.
-     *
-     * @return int
-     */
-    public function textLengthEstimate(): int
-    {
-        return $this->stringLengthEstimate(mb_strlen($this->text), $this->size);
-    }
-
-    /**
-     * Decrease the font size if necessary, based on the image width.
-     *
-     * @param int $width
-     */
-    public function adjustSize(int $width): void
-    {
-        $len = mb_strlen($this->text);
-        while ($this->stringLengthEstimate($len, $this->size) > 0.9 * $width) {
-            $this->size--;
-            if ($this->size == 2) {
-                return;
-            }
-        }
-    }
-
-    /**
-     * Return an estimate of the size in pixels of a text in a specified font size.
-     *
-     * @param int $text_length
-     * @param int $font_size
-     * @return int
-     */
-    private function stringLengthEstimate(int $text_length, int $font_size): int
-    {
-        return $text_length * (int) ceil(($font_size + 2) * 0.5);
-    }
+	/**
+	 * Default font color for watermarks
+	 * @var string DEFAULT_COLOR
+	 * */
+	public const DEFAULT_COLOR = '#4D6DF3';
+
+	/**
+	 * Default maximum font size for watermarks
+	 * @var string DEFAULT_SIZE
+	 * */
+	public const DEFAULT_SIZE = 18;
+
+	/**
+	 * @var string $text
+	 */
+	private $text;
+
+	/**
+	 * @var string $color;
+	 */
+	private $color;
+
+
+	/**
+	 * @var int $size
+	 */
+	private $size;
+
+	/**
+	 * Constructor for Watermark data class
+	 *
+	 * @param string $text
+	 * @param string $color
+	 * @param int $size
+	 */
+	public function __construct(string $text, string $color, int $size)
+	{
+		$this->text = $text;
+		$this->color = $color;
+		$this->size = $size;
+	}
+
+	/**
+	 * Get the watermark text.
+	 *
+	 * @return string
+	 */
+	public function text(): string
+	{
+		return $this->text;
+	}
+
+	/**
+	 * Get the watermark font color.
+	 *
+	 * @return string
+	 */
+	public function color(): string
+	{
+		return $this->color;
+	}
+
+	/**
+	 * Get the watermark maximum font size.
+	 * @return int
+	 */
+	public function size(): int
+	{
+		return $this->size;
+	}
+
+	/**
+	 * Return an estimate of the size in pixels of the watermark text length.
+	 *
+	 * @return int
+	 */
+	public function textLengthEstimate(): int
+	{
+		return $this->stringLengthEstimate(mb_strlen($this->text), $this->size);
+	}
+
+	/**
+	 * Decrease the font size if necessary, based on the image width.
+	 *
+	 * @param int $width
+	 */
+	public function adjustSize(int $width): void
+	{
+		$len = mb_strlen($this->text);
+		while ($this->stringLengthEstimate($len, $this->size) > 0.9 * $width) {
+			$this->size--;
+			if ($this->size == 2) {
+				return;
+			}
+		}
+	}
+
+	/**
+	 * Return an estimate of the size in pixels of a text in a specified font size.
+	 *
+	 * @param int $text_length
+	 * @param int $font_size
+	 * @return int
+	 */
+	private function stringLengthEstimate(int $text_length, int $font_size): int
+	{
+		return $text_length * (int) ceil(($font_size + 2) * 0.5);
+	}
 }

src/Webtrees/Module/Certificates/Http/RequestHandlers/CertificatesList.php

Indentation +69 added lines, -69 removed lines

@@ -31,73 +31,73 @@
  */
 class CertificatesList implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
-
-    /**
-     * @var CertificatesModule|null $module
-     */
-    private $module;
-
-    /**
-     * @var CertificateFilesystemService $certif_filesystem
-     */
-    private $certif_filesystem;
-
-    /**
-     * @var UrlObfuscatorService $url_obfuscator_service
-     */
-    private $url_obfuscator_service;
-
-
-    /**
-     * Constructor for CertificatesList Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        CertificateFilesystemService $certif_filesystem,
-        UrlObfuscatorService $url_obfuscator_service
-    ) {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->certif_filesystem = $certif_filesystem;
-        $this->url_obfuscator_service = $url_obfuscator_service;
-    }
-
-    /**
-     * {@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 = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
-
-        $title = I18N::translate('Certificates');
-
-        $cities = array_map(function (string $item): array {
-            return [$this->url_obfuscator_service->obfuscate($item), $item];
-        }, $this->certif_filesystem->cities($tree));
-
-        $city = $request->getQueryParams()['cityobf'] ?? $request->getAttribute('cityobf') ?? '';
-
-        if ($city !== '' && $this->url_obfuscator_service->tryDeobfuscate($city)) {
-            $title = I18N::translate('Certificates for %s', $city);
-            $certificates = $this->certif_filesystem->certificatesForCity($tree, $city);
-        }
-
-        return $this->viewResponse($this->module->name() . '::certificates-list', [
-            'title'                     =>  $title,
-            'tree'                      =>  $tree,
-            'module_name'               =>  $this->module->name(),
-            'cities'                    =>  $cities,
-            'selected_city'             =>  $city,
-            'certificates_list'         =>  $certificates ?? collect(),
-            'url_obfuscator_service'    =>  $this->url_obfuscator_service
-        ]);
-    }
+	use ViewResponseTrait;
+
+	/**
+	 * @var CertificatesModule|null $module
+	 */
+	private $module;
+
+	/**
+	 * @var CertificateFilesystemService $certif_filesystem
+	 */
+	private $certif_filesystem;
+
+	/**
+	 * @var UrlObfuscatorService $url_obfuscator_service
+	 */
+	private $url_obfuscator_service;
+
+
+	/**
+	 * Constructor for CertificatesList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		CertificateFilesystemService $certif_filesystem,
+		UrlObfuscatorService $url_obfuscator_service
+	) {
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->certif_filesystem = $certif_filesystem;
+		$this->url_obfuscator_service = $url_obfuscator_service;
+	}
+
+	/**
+	 * {@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 = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
+
+		$title = I18N::translate('Certificates');
+
+		$cities = array_map(function (string $item): array {
+			return [$this->url_obfuscator_service->obfuscate($item), $item];
+		}, $this->certif_filesystem->cities($tree));
+
+		$city = $request->getQueryParams()['cityobf'] ?? $request->getAttribute('cityobf') ?? '';
+
+		if ($city !== '' && $this->url_obfuscator_service->tryDeobfuscate($city)) {
+			$title = I18N::translate('Certificates for %s', $city);
+			$certificates = $this->certif_filesystem->certificatesForCity($tree, $city);
+		}
+
+		return $this->viewResponse($this->module->name() . '::certificates-list', [
+			'title'                     =>  $title,
+			'tree'                      =>  $tree,
+			'module_name'               =>  $this->module->name(),
+			'cities'                    =>  $cities,
+			'selected_city'             =>  $city,
+			'certificates_list'         =>  $certificates ?? collect(),
+			'url_obfuscator_service'    =>  $this->url_obfuscator_service
+		]);
+	}
 }

src/Webtrees/Module/Certificates/Http/RequestHandlers/AdminTreesPage.php

Indentation +40 added lines, -40 removed lines

@@ -30,51 +30,51 @@
  */
 class AdminTreesPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    /**
-     * @var CertificatesModule|null $module
-     */
-    private $module;
+	/**
+	 * @var CertificatesModule|null $module
+	 */
+	private $module;
 
-    /**
-     *
-     * @var TreeService $tree_service
-     */
-    private $tree_service;
+	/**
+	 *
+	 * @var TreeService $tree_service
+	 */
+	private $tree_service;
 
-    /**
-     * Constructor for Admin Trees request handler
-     *
-     * @param ModuleService $module_service
-     * @param TreeService $tree_service
-     */
-    public function __construct(ModuleService $module_service, TreeService $tree_service)
-    {
-        $this->module = $module_service->findByInterface(CertificatesModule::class)->first();
-        $this->tree_service = $tree_service;
-    }
+	/**
+	 * Constructor for Admin Trees request handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param TreeService $tree_service
+	 */
+	public function __construct(ModuleService $module_service, TreeService $tree_service)
+	{
+		$this->module = $module_service->findByInterface(CertificatesModule::class)->first();
+		$this->tree_service = $tree_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';
 
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $trees = $this->tree_service->all();
-        if ($trees->count() == 1) {
-            return redirect(route(AdminConfigPage::class, ['tree' => $trees->first()]));
-        }
+		$trees = $this->tree_service->all();
+		if ($trees->count() == 1) {
+			return redirect(route(AdminConfigPage::class, ['tree' => $trees->first()]));
+		}
 
-        return $this->viewResponse($this->module->name() . '::admin/trees', [
-            'title'             =>  $this->module->title(),
-            'trees'             =>  $this->tree_service->all()
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::admin/trees', [
+			'title'             =>  $this->module->title(),
+			'trees'             =>  $this->tree_service->all()
+		]);
+	}
 }