jon48 / webtrees-lib

app/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 int 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 int 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);
+	}
 }

app/Module/Certificates/Hooks/SourceCertificateIconHook.php

Indentation +77 added lines, -77 removed lines

@@ -30,87 +30,87 @@
  */
 class SourceCertificateIconHook implements FactSourceTextExtenderInterface
 {
-    private CertificatesModule $module;
-    private UrlObfuscatorService $url_obfuscator_service;
+	private CertificatesModule $module;
+	private UrlObfuscatorService $url_obfuscator_service;
 
-    /**
-     * Constructor for SourceCertificateIconHook
-     *
-     * @param CertificatesModule $module
-     * @param UrlObfuscatorService $url_obfuscator_service
-     */
-    public function __construct(CertificatesModule $module, UrlObfuscatorService $url_obfuscator_service)
-    {
-        $this->module = $module;
-        $this->url_obfuscator_service = $url_obfuscator_service;
-    }
+	/**
+	 * Constructor for SourceCertificateIconHook
+	 *
+	 * @param CertificatesModule $module
+	 * @param UrlObfuscatorService $url_obfuscator_service
+	 */
+	public function __construct(CertificatesModule $module, UrlObfuscatorService $url_obfuscator_service)
+	{
+		$this->module = $module;
+		$this->url_obfuscator_service = $url_obfuscator_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
-     */
-    public function module(): ModuleInterface
-    {
-        return $this->module;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
+	 */
+	public function module(): ModuleInterface
+	{
+		return $this->module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\FactSourceTextExtenderInterface::factSourcePrepend()
-     */
-    public function factSourcePrepend(Tree $tree, $fact): string
-    {
-        $permission_level = $tree->getPreference('MAJ_CERTIF_SHOW_CERT');
-        if (is_numeric($permission_level) && Auth::accessLevel($tree) <= (int) $permission_level) {
-            $path = $this->extractPath($fact);
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\FactSourceTextExtenderInterface::factSourcePrepend()
+	 */
+	public function factSourcePrepend(Tree $tree, $fact): string
+	{
+		$permission_level = $tree->getPreference('MAJ_CERTIF_SHOW_CERT');
+		if (is_numeric($permission_level) && Auth::accessLevel($tree) <= (int) $permission_level) {
+			$path = $this->extractPath($fact);
 
-            if ($path !== '') {
-                $certificate = new Certificate($tree, $path);
-                return view($this->module->name() . '::components/certificate-icon', [
-                    'module_name'               =>  $this->module->name(),
-                    'certificate'               =>  $certificate,
-                    'url_obfuscator_service'    =>  $this->url_obfuscator_service,
-                    'js_script_url'             =>  $this->module->assetUrl('js/certificates.min.js')
-                ]);
-            }
-        }
-        return '';
-    }
+			if ($path !== '') {
+				$certificate = new Certificate($tree, $path);
+				return view($this->module->name() . '::components/certificate-icon', [
+					'module_name'               =>  $this->module->name(),
+					'certificate'               =>  $certificate,
+					'url_obfuscator_service'    =>  $this->url_obfuscator_service,
+					'js_script_url'             =>  $this->module->assetUrl('js/certificates.min.js')
+				]);
+			}
+		}
+		return '';
+	}
 
-    /**
-     * Extract path from the provided fact objet.
-     *
-     * @param \Fisharebest\Webtrees\Fact|array<array<\Fisharebest\Webtrees\Contracts\ElementInterface|string>> $fact
-     * @return string
-     * @psalm-suppress RedundantConditionGivenDocblockType
-     */
-    private function extractPath($fact): string
-    {
-        if ($fact instanceof Fact && $fact->target() instanceof Source) {
-            return $fact->attribute('_ACT');
-        } elseif (
-            is_array($fact) && count($fact) === 2
-            && null !== ($source_elements = $fact[0]) && is_array($source_elements) // @phpstan-ignore-line
-            && null !== ($source_values = $fact[1]) && is_array($source_values) // @phpstan-ignore-line
-        ) {
-            foreach ($source_elements as $key => $element) {
-                if (
-                    $element instanceof SourceCertificate
-                    && isset($source_values[$key]) && is_string($source_values[$key])
-                ) {
-                    return $element->canonical($source_values[$key]);
-                }
-            }
-        }
-        return '';
-    }
+	/**
+	 * Extract path from the provided fact objet.
+	 *
+	 * @param \Fisharebest\Webtrees\Fact|array<array<\Fisharebest\Webtrees\Contracts\ElementInterface|string>> $fact
+	 * @return string
+	 * @psalm-suppress RedundantConditionGivenDocblockType
+	 */
+	private function extractPath($fact): string
+	{
+		if ($fact instanceof Fact && $fact->target() instanceof Source) {
+			return $fact->attribute('_ACT');
+		} elseif (
+			is_array($fact) && count($fact) === 2
+			&& null !== ($source_elements = $fact[0]) && is_array($source_elements) // @phpstan-ignore-line
+			&& null !== ($source_values = $fact[1]) && is_array($source_values) // @phpstan-ignore-line
+		) {
+			foreach ($source_elements as $key => $element) {
+				if (
+					$element instanceof SourceCertificate
+					&& isset($source_values[$key]) && is_string($source_values[$key])
+				) {
+					return $element->canonical($source_values[$key]);
+				}
+			}
+		}
+		return '';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\FactSourceTextExtenderInterface::factSourceAppend()
-     */
-    public function factSourceAppend(Tree $tree, $fact): string
-    {
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\FactSourceTextExtenderInterface::factSourceAppend()
+	 */
+	public function factSourceAppend(Tree $tree, $fact): string
+	{
+		return '';
+	}
 }

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

Indentation +46 added lines, -46 removed lines

@@ -31,58 +31,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 Registry::responseFactory()->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 Registry::responseFactory()->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 Registry::responseFactory()->redirect(ModulesHooksPage::class, ['hook_name' => $hook_name]);
-    }
+		return Registry::responseFactory()->redirect(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/Sosa/Http/RequestHandlers/SosaComputeAction.php

Indentation +43 added lines, -43 removed lines

@@ -31,54 +31,54 @@
  */
 class SosaComputeAction implements RequestHandlerInterface
 {
-    private UserService $user_service;
+	private UserService $user_service;
 
-    /**
-     * Constructor for SosaConfigAction Request Handler
-     *
-     * @param UserService $user_service
-     */
-    public function __construct(UserService $user_service)
-    {
-        $this->user_service = $user_service;
-    }
+	/**
+	 * Constructor for SosaConfigAction Request Handler
+	 *
+	 * @param UserService $user_service
+	 */
+	public function __construct(UserService $user_service)
+	{
+		$this->user_service = $user_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $tree = Validator::attributes($request)->tree();
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$tree = Validator::attributes($request)->tree();
 
-        $user_id = Validator::parsedBody($request)->integer('user_id', Auth::id() ?? 0);
-        $partial_from = Validator::parsedBody($request)->isXref()->string('partial_from', '');
+		$user_id = Validator::parsedBody($request)->integer('user_id', Auth::id() ?? 0);
+		$partial_from = Validator::parsedBody($request)->isXref()->string('partial_from', '');
 
-        if (($user_id === -1 && Auth::isManager($tree)) || Auth::id() === $user_id) {
-            $user = $user_id === -1 ? new DefaultUser() : $this->user_service->find($user_id);
+		if (($user_id === -1 && Auth::isManager($tree)) || Auth::id() === $user_id) {
+			$user = $user_id === -1 ? new DefaultUser() : $this->user_service->find($user_id);
 
-            /** @var SosaCalculatorService $sosa_calc_service */
-            $sosa_calc_service = app()->makeWith(SosaCalculatorService::class, [ 'tree' => $tree, 'user' => $user]);
+			/** @var SosaCalculatorService $sosa_calc_service */
+			$sosa_calc_service = app()->makeWith(SosaCalculatorService::class, [ 'tree' => $tree, 'user' => $user]);
 
-            if (
-                $partial_from !== '' &&
-                ($sosa_from = Registry::individualFactory()->make($partial_from, $tree)) !== null
-            ) {
-                $res = $sosa_calc_service->computeFromIndividual($sosa_from);
-            } else {
-                $res = $sosa_calc_service->computeAll();
-            }
+			if (
+				$partial_from !== '' &&
+				($sosa_from = Registry::individualFactory()->make($partial_from, $tree)) !== null
+			) {
+				$res = $sosa_calc_service->computeFromIndividual($sosa_from);
+			} else {
+				$res = $sosa_calc_service->computeAll();
+			}
 
-            return $res ?
-                Registry::responseFactory()->response() :
-                Registry::responseFactory()->response(
-                    I18N::translate('An error occurred while computing Sosa ancestors.'),
-                    StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR
-                );
-        }
-        return Registry::responseFactory()->response(
-            I18N::translate('You do not have permission to modify the user.'),
-            StatusCodeInterface::STATUS_FORBIDDEN
-        );
-    }
+			return $res ?
+				Registry::responseFactory()->response() :
+				Registry::responseFactory()->response(
+					I18N::translate('An error occurred while computing Sosa ancestors.'),
+					StatusCodeInterface::STATUS_INTERNAL_SERVER_ERROR
+				);
+		}
+		return Registry::responseFactory()->response(
+			I18N::translate('You do not have permission to modify the user.'),
+			StatusCodeInterface::STATUS_FORBIDDEN
+		);
+	}
 }

app/Module/Sosa/Http/RequestHandlers/SosaConfig.php

Indentation +59 added lines, -59 removed lines

@@ -33,71 +33,71 @@
  */
 class SosaConfig implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    /**
-     * @var SosaModule|null $module
-     */
-    private $module;
+	/**
+	 * @var SosaModule|null $module
+	 */
+	private $module;
 
-    /**
-     * Constructor for SosaConfig Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(SosaModule::class)->first();
-    }
+	/**
+	 * Constructor for SosaConfig Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(SosaModule::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();
+		$tree = Validator::attributes($request)->tree();
 
-        $users_root = array();
-        if (Auth::check()) {
-            /** @var \Fisharebest\Webtrees\User $user */
-            $user = Auth::user();
-            $users_root[] = [
-                'user'      => $user,
-                'root_id'   => $tree->getUserPreference($user, 'MAJ_SOSA_ROOT_ID'),
-                'max_gen'   => $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN')
-            ];
+		$users_root = array();
+		if (Auth::check()) {
+			/** @var \Fisharebest\Webtrees\User $user */
+			$user = Auth::user();
+			$users_root[] = [
+				'user'      => $user,
+				'root_id'   => $tree->getUserPreference($user, 'MAJ_SOSA_ROOT_ID'),
+				'max_gen'   => $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN')
+			];
 
-            if (Auth::isManager($tree)) {
-                $default_user = new DefaultUser();
-                $users_root[] = [
-                    'user' => $default_user,
-                    'root_id' => $tree->getUserPreference($default_user, 'MAJ_SOSA_ROOT_ID'),
-                    'max_gen'   => $tree->getUserPreference($default_user, 'MAJ_SOSA_MAX_GEN')
-                ];
-            }
-        }
+			if (Auth::isManager($tree)) {
+				$default_user = new DefaultUser();
+				$users_root[] = [
+					'user' => $default_user,
+					'root_id' => $tree->getUserPreference($default_user, 'MAJ_SOSA_ROOT_ID'),
+					'max_gen'   => $tree->getUserPreference($default_user, 'MAJ_SOSA_MAX_GEN')
+				];
+			}
+		}
 
-        // Use the system max generations if not set
-        $max_gen_system = app(SosaRecordsService::class)->maxSystemGenerations();
-        foreach ($users_root as $key => $user_root) {
-            $users_root[$key]['max_gen'] = is_numeric($user_root['max_gen']) ?
-                (int) $user_root['max_gen'] :
-                $max_gen_system;
-        };
+		// Use the system max generations if not set
+		$max_gen_system = app(SosaRecordsService::class)->maxSystemGenerations();
+		foreach ($users_root as $key => $user_root) {
+			$users_root[$key]['max_gen'] = is_numeric($user_root['max_gen']) ?
+				(int) $user_root['max_gen'] :
+				$max_gen_system;
+		};
 
-        return $this->viewResponse($this->module->name() . '::config-page', [
-            'module_name'       =>  $this->module->name(),
-            'title'             =>  I18N::translate('Sosa Configuration'),
-            'tree'              =>  $tree,
-            'user_id'           =>  Validator::attributes($request)->user(),
-            'selected_user_id'  =>  Validator::queryParams($request)->integer('user_id', 0),
-            'immediate_compute' =>  Validator::queryParams($request)->string('compute', '') === 'yes',
-            'users_root'        =>  $users_root
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::config-page', [
+			'module_name'       =>  $this->module->name(),
+			'title'             =>  I18N::translate('Sosa Configuration'),
+			'tree'              =>  $tree,
+			'user_id'           =>  Validator::attributes($request)->user(),
+			'selected_user_id'  =>  Validator::queryParams($request)->integer('user_id', 0),
+			'immediate_compute' =>  Validator::queryParams($request)->string('compute', '') === 'yes',
+			'users_root'        =>  $users_root
+		]);
+	}
 }

app/Module/Sosa/Http/RequestHandlers/SosaConfigAction.php

Indentation +42 added lines, -42 removed lines

@@ -31,51 +31,51 @@
  */
 class SosaConfigAction implements RequestHandlerInterface
 {
-    private UserService $user_service;
-    private SosaRecordsService $sosa_record_service;
+	private UserService $user_service;
+	private SosaRecordsService $sosa_record_service;
 
-    /**
-     * Constructor for SosaConfigAction Request Handler
-     *
-     * @param UserService $user_service
-     * @param SosaRecordsService $sosa_records_service
-     */
-    public function __construct(UserService $user_service, SosaRecordsService $sosa_records_service)
-    {
-        $this->user_service = $user_service;
-        $this->sosa_record_service = $sosa_records_service;
-    }
+	/**
+	 * Constructor for SosaConfigAction Request Handler
+	 *
+	 * @param UserService $user_service
+	 * @param SosaRecordsService $sosa_records_service
+	 */
+	public function __construct(UserService $user_service, SosaRecordsService $sosa_records_service)
+	{
+		$this->user_service = $user_service;
+		$this->sosa_record_service = $sosa_records_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $tree = Validator::attributes($request)->tree();
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$tree = Validator::attributes($request)->tree();
 
-        $user_id = Validator::parsedBody($request)->integer('sosa-userid', -1);
-        $root_id = Validator::parsedBody($request)->isXref()->string('sosa-rootid', '');
-        $max_gen = Validator::parsedBody($request)->integer(
-            'sosa-maxgen',
-            $this->sosa_record_service->maxSystemGenerations()
-        );
+		$user_id = Validator::parsedBody($request)->integer('sosa-userid', -1);
+		$root_id = Validator::parsedBody($request)->isXref()->string('sosa-rootid', '');
+		$max_gen = Validator::parsedBody($request)->integer(
+			'sosa-maxgen',
+			$this->sosa_record_service->maxSystemGenerations()
+		);
 
-        if (Auth::id() === $user_id || ($user_id === -1 && Auth::isManager($tree))) {
-            $user = $user_id === -1 ? new DefaultUser() : $this->user_service->find($user_id);
-            if ($user !== null && ($root_indi = Registry::individualFactory()->make($root_id, $tree)) !== null) {
-                $tree->setUserPreference($user, 'MAJ_SOSA_ROOT_ID', $root_indi->xref());
-                $tree->setUserPreference($user, 'MAJ_SOSA_MAX_GEN', (string) $max_gen);
-                FlashMessages::addMessage(I18N::translate('The root individual has been updated.'));
-                return Registry::responseFactory()->redirect(SosaConfig::class, [
-                    'tree' => $tree->name(),
-                    'compute' => 'yes',
-                    'user_id' => $user_id
-                ]);
-            }
-        }
+		if (Auth::id() === $user_id || ($user_id === -1 && Auth::isManager($tree))) {
+			$user = $user_id === -1 ? new DefaultUser() : $this->user_service->find($user_id);
+			if ($user !== null && ($root_indi = Registry::individualFactory()->make($root_id, $tree)) !== null) {
+				$tree->setUserPreference($user, 'MAJ_SOSA_ROOT_ID', $root_indi->xref());
+				$tree->setUserPreference($user, 'MAJ_SOSA_MAX_GEN', (string) $max_gen);
+				FlashMessages::addMessage(I18N::translate('The root individual has been updated.'));
+				return Registry::responseFactory()->redirect(SosaConfig::class, [
+					'tree' => $tree->name(),
+					'compute' => 'yes',
+					'user_id' => $user_id
+				]);
+			}
+		}
 
-        FlashMessages::addMessage(I18N::translate('The root individual could not be updated.'), 'danger');
-        return Registry::responseFactory()->redirect(SosaConfig::class, ['tree' => $tree->name()]);
-    }
+		FlashMessages::addMessage(I18N::translate('The root individual could not be updated.'), 'danger');
+		return Registry::responseFactory()->redirect(SosaConfig::class, ['tree' => $tree->name()]);
+	}
 }

app/Module/Sosa/SosaModule.php

Indentation +255 added lines, -255 removed lines

@@ -57,261 +57,261 @@
  * Identify and produce statistics about Sosa ancestors
  */
 class SosaModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleGlobalInterface,
-    ModuleMenuInterface,
-    ModuleSidebarInterface,
-    ModuleGeoAnalysisProviderInterface,
-    ModuleHookSubscriberInterface
+	ModuleMyArtJaubInterface,
+	ModuleGlobalInterface,
+	ModuleMenuInterface,
+	ModuleSidebarInterface,
+	ModuleGeoAnalysisProviderInterface,
+	ModuleHookSubscriberInterface
 {
-    use ModuleMyArtJaubTrait {
-        boot as traitBoot;
-    }
-    use ModuleGlobalTrait;
-    use ModuleMenuTrait;
-    use ModuleSidebarTrait;
-
-    // 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';
+	use ModuleMyArtJaubTrait {
+		boot as traitBoot;
+	}
+	use ModuleGlobalTrait;
+	use ModuleMenuTrait;
+	use ModuleSidebarTrait;
+
+	// 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';
 /**
-     * {@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->tokens(['gen' => '\d+']);
-                    $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.1.3-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 = Validator::attributes($request)->route();
-
-            $root_indi_id = $tree->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
-
-            if ($route->name === IndividualPage::class && mb_strlen($root_indi_id) > 0) {
-                $xref = Validator::attributes($request)->isXref()->string('xref', '');
-
-                $menu->addSubmenu(new Menu(
-                    I18N::translate('Complete Sosas'),
-                    '#',
-                    'menu-maj-sosa-compute',
-                    [
-                        'rel'           => 'nofollow',
-                        'data-wt-href'  => route(SosaComputeModal::class, ['tree' => $tree->name(), 'xref' => $xref]),
-                        'data-bs-target'    => '#wt-ajax-modal',
-                        'data-bs-toggle'    => 'modal',
-                        'data-bs-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\ModuleGlobalInterface::bodyContent()
-     */
-    public function bodyContent(): string
-    {
-        return '<script src="' . $this->assetUrl('js/sosa.min.js') . '"></script>';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::sidebarTitle()
-     */
-    public function sidebarTitle(Individual $individual): string
-    {
-        $user = Auth::check() ? Auth::user() : new DefaultUser();
-
-        return view($this->name() . '::sidebar/title', [
-            'module_name'   =>  $this->name(),
-            'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
-        ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
-     */
-    public function getSidebarContent(Individual $individual): string
-    {
-        $sosa_root_xref = $individual->tree()->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
-        $sosa_root = Registry::individualFactory()->make($sosa_root_xref, $individual->tree());
-        $user = Auth::check() ? Auth::user() : new DefaultUser();
-
-        return view($this->name() . '::sidebar/content', [
-            'sosa_ancestor' =>  $individual,
-            'sosa_root'     =>  $sosa_root,
-            'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
-        ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
-     */
-    public function hasSidebarContent(Individual $individual): bool
-    {
-        $user = Auth::check() ? Auth::user() : new DefaultUser();
-
-        return app(SosaRecordsService::class)
-            ->sosaNumbers($individual->tree(), $user, $individual)->count() > 0;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::defaultSidebarOrder()
-     */
-    public function defaultSidebarOrder(): int
-    {
-        return 1;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModuleGeoAnalysisProviderInterface::listGeoAnalyses()
-     */
-    public function listGeoAnalyses(): array
-    {
-        return [
-            SosaByGenerationGeoAnalysis::class
-        ];
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
-     */
-    public function listSubscribedHooks(): array
-    {
-        return [
-            app()->makeWith(SosaIconHook::class, [ 'module' => $this ])
-        ];
-    }
+	 * {@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->tokens(['gen' => '\d+']);
+					$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.1.3-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 = Validator::attributes($request)->route();
+
+			$root_indi_id = $tree->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
+
+			if ($route->name === IndividualPage::class && mb_strlen($root_indi_id) > 0) {
+				$xref = Validator::attributes($request)->isXref()->string('xref', '');
+
+				$menu->addSubmenu(new Menu(
+					I18N::translate('Complete Sosas'),
+					'#',
+					'menu-maj-sosa-compute',
+					[
+						'rel'           => 'nofollow',
+						'data-wt-href'  => route(SosaComputeModal::class, ['tree' => $tree->name(), 'xref' => $xref]),
+						'data-bs-target'    => '#wt-ajax-modal',
+						'data-bs-toggle'    => 'modal',
+						'data-bs-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\ModuleGlobalInterface::bodyContent()
+	 */
+	public function bodyContent(): string
+	{
+		return '<script src="' . $this->assetUrl('js/sosa.min.js') . '"></script>';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::sidebarTitle()
+	 */
+	public function sidebarTitle(Individual $individual): string
+	{
+		$user = Auth::check() ? Auth::user() : new DefaultUser();
+
+		return view($this->name() . '::sidebar/title', [
+			'module_name'   =>  $this->name(),
+			'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
+		]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
+	 */
+	public function getSidebarContent(Individual $individual): string
+	{
+		$sosa_root_xref = $individual->tree()->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
+		$sosa_root = Registry::individualFactory()->make($sosa_root_xref, $individual->tree());
+		$user = Auth::check() ? Auth::user() : new DefaultUser();
+
+		return view($this->name() . '::sidebar/content', [
+			'sosa_ancestor' =>  $individual,
+			'sosa_root'     =>  $sosa_root,
+			'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
+		]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
+	 */
+	public function hasSidebarContent(Individual $individual): bool
+	{
+		$user = Auth::check() ? Auth::user() : new DefaultUser();
+
+		return app(SosaRecordsService::class)
+			->sosaNumbers($individual->tree(), $user, $individual)->count() > 0;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::defaultSidebarOrder()
+	 */
+	public function defaultSidebarOrder(): int
+	{
+		return 1;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModuleGeoAnalysisProviderInterface::listGeoAnalyses()
+	 */
+	public function listGeoAnalyses(): array
+	{
+		return [
+			SosaByGenerationGeoAnalysis::class
+		];
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
+	 */
+	public function listSubscribedHooks(): array
+	{
+		return [
+			app()->makeWith(SosaIconHook::class, [ 'module' => $this ])
+		];
+	}
 }

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.3-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.3-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/AdminTasks/AdminTasksModule.php

Indentation +122 added lines, -122 removed lines

@@ -41,127 +41,127 @@
  * Allow for tasks to be run on a (nearly-)regular schedule
  */
 class AdminTasksModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleConfigInterface,
-    ModuleGlobalInterface,
-    ModuleTasksProviderInterface
+	ModuleMyArtJaubInterface,
+	ModuleConfigInterface,
+	ModuleGlobalInterface,
+	ModuleTasksProviderInterface
 {
-    use ModuleMyArtJaubTrait {
-        boot as traitBoot;
-    }
-    use ModuleConfigTrait;
-    use ModuleGlobalTrait;
-
-    //How to update the database schema for this module
-    private const SCHEMA_TARGET_VERSION   = 2;
-    private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Administration Tasks');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        return I18N::translate('Manage and run nearly-scheduled administration tasks.');
-    }
-
-    /**
-     * {@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/admintasks', static function (Map $router): void {
-                $router->tokens(['enable' => '[01]']);
-
-                $router->attach('', '/admin', static function (Map $router): void {
-
-                    $router->extras([
-                        'middleware' => [
-                            AuthAdministrator::class,
-                        ],
-                    ]);
-                    $router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
-
-                    $router->attach('', '/tasks', static function (Map $router): void {
-
-                        $router->get(TasksList::class, '', TasksList::class);
-                        $router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
-                        $router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
-                        $router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
-                    });
-                });
-
-                $router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
-                    ->allows(RequestMethodInterface::METHOD_POST);
-
-                $router->post(TokenGenerate::class, '/token', TokenGenerate::class)
-                    ->extras(['middleware' => [AuthAdministrator::class]]);
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.3-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
-     */
-    public function getConfigLink(): string
-    {
-        return route(AdminConfigPage::class);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
-     */
-    public function bodyContent(): string
-    {
-        return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see ModuleTasksProviderInterface::listTasks()
-     */
-    public function listTasks(): array
-    {
-        return [
-            'maj-healthcheck' => HealthCheckEmailTask::class
-        ];
-    }
+	use ModuleMyArtJaubTrait {
+		boot as traitBoot;
+	}
+	use ModuleConfigTrait;
+	use ModuleGlobalTrait;
+
+	//How to update the database schema for this module
+	private const SCHEMA_TARGET_VERSION   = 2;
+	private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
+	private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Administration Tasks');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		return I18N::translate('Manage and run nearly-scheduled administration tasks.');
+	}
+
+	/**
+	 * {@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/admintasks', static function (Map $router): void {
+				$router->tokens(['enable' => '[01]']);
+
+				$router->attach('', '/admin', static function (Map $router): void {
+
+					$router->extras([
+						'middleware' => [
+							AuthAdministrator::class,
+						],
+					]);
+					$router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
+
+					$router->attach('', '/tasks', static function (Map $router): void {
+
+						$router->get(TasksList::class, '', TasksList::class);
+						$router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
+						$router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
+						$router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
+					});
+				});
+
+				$router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
+					->allows(RequestMethodInterface::METHOD_POST);
+
+				$router->post(TokenGenerate::class, '/token', TokenGenerate::class)
+					->extras(['middleware' => [AuthAdministrator::class]]);
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.3-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
+	 */
+	public function getConfigLink(): string
+	{
+		return route(AdminConfigPage::class);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
+	 */
+	public function bodyContent(): string
+	{
+		return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see ModuleTasksProviderInterface::listTasks()
+	 */
+	public function listTasks(): array
+	{
+		return [
+			'maj-healthcheck' => HealthCheckEmailTask::class
+		];
+	}
 }