jon48 / webtrees-lib

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

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

app/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->tokens(['block_id' => '\d+']);
-                $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->tokens(['block_id' => '\d+']);
+				$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')
+		];
+	}
 }

app/Module/ModuleMyArtJaubInterface.php

Indentation +14 added lines, -14 removed lines

@@ -21,19 +21,19 @@
  */
 interface ModuleMyArtJaubInterface extends ModuleCustomInterface
 {
-    /**
-     * Add module routes to webtrees route loader
-     *
-     * @param Map $router
-     */
-    public function loadRoutes(Map $router): void;
+	/**
+	 * Add module routes to webtrees route loader
+	 *
+	 * @param Map $router
+	 */
+	public function loadRoutes(Map $router): void;
 
-    /**
-     * Returns the URL of the module specific stylesheets.
-     * It will look for a CSS file matching the theme name (e.g. xenea.min.css),
-     * and fallback to default.min.css if none are found
-     *
-     * @return string
-     */
-    public function moduleCssUrl(): string;
+	/**
+	 * Returns the URL of the module specific stylesheets.
+	 * It will look for a CSS file matching the theme name (e.g. xenea.min.css),
+	 * and fallback to default.min.css if none are found
+	 *
+	 * @return string
+	 */
+	public function moduleCssUrl(): string;
 }

app/Module/IsSourced/Hooks/IsSourcedStatusHook.php

Indentation +55 added lines, -55 removed lines

@@ -25,63 +25,63 @@
  */
 class IsSourcedStatusHook implements RecordNameTextExtenderInterface
 {
-    private ModuleInterface $module;
-    private SourceStatusService $source_status_service;
+	private ModuleInterface $module;
+	private SourceStatusService $source_status_service;
 
-    /**
-     * Constructor for IsSourcedStatusHook
-     *
-     * @param ModuleInterface $module
-     * @param SourceStatusService $source_status_service
-     */
-    public function __construct(ModuleInterface $module, SourceStatusService $source_status_service)
-    {
-        $this->module = $module;
-        $this->source_status_service = $source_status_service;
-    }
+	/**
+	 * Constructor for IsSourcedStatusHook
+	 *
+	 * @param ModuleInterface $module
+	 * @param SourceStatusService $source_status_service
+	 */
+	public function __construct(ModuleInterface $module, SourceStatusService $source_status_service)
+	{
+		$this->module = $module;
+		$this->source_status_service = $source_status_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\RecordNameTextExtenderInterface::recordNamePrepend()
-     */
-    public function recordNamePrepend(GedcomRecord $record, bool $use_long = false, string $size = ''): string
-    {
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\RecordNameTextExtenderInterface::recordNamePrepend()
+	 */
+	public function recordNamePrepend(GedcomRecord $record, bool $use_long = false, string $size = ''): string
+	{
+		return '';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\RecordNameTextExtenderInterface::recordNameAppend()
-     */
-    public function recordNameAppend(GedcomRecord $record, bool $use_long = false, string $size = ''): string
-    {
-        if ($use_long && $record instanceof Individual) {
-            return
-                view($this->module()->name() . '::icons/source-status', [
-                    'module_name' => $this->module()->name(),
-                    'source_status' => $this->source_status_service->sourceStatusForRecord($record),
-                    'context'  => 'INDI',
-                    'size_style' => $size ]) .
-                view($this->module()->name() . '::icons/source-status', [
-                    'module_name' => $this->module()->name(),
-                    'source_status' => $this->source_status_service->sourceStatusForBirth($record),
-                    'context'  => 'INDI:BIRT',
-                    'size_style' => $size ]) .
-                ($record->isDead() ? view($this->module()->name() . '::icons/source-status', [
-                    'module_name' => $this->module()->name(),
-                    'source_status' => $this->source_status_service->sourceStatusForDeath($record),
-                    'context'  => 'INDI:DEAT',
-                    'size_style' => $size ]) : '') ;
-        }
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\RecordNameTextExtenderInterface::recordNameAppend()
+	 */
+	public function recordNameAppend(GedcomRecord $record, bool $use_long = false, string $size = ''): string
+	{
+		if ($use_long && $record instanceof Individual) {
+			return
+				view($this->module()->name() . '::icons/source-status', [
+					'module_name' => $this->module()->name(),
+					'source_status' => $this->source_status_service->sourceStatusForRecord($record),
+					'context'  => 'INDI',
+					'size_style' => $size ]) .
+				view($this->module()->name() . '::icons/source-status', [
+					'module_name' => $this->module()->name(),
+					'source_status' => $this->source_status_service->sourceStatusForBirth($record),
+					'context'  => 'INDI:BIRT',
+					'size_style' => $size ]) .
+				($record->isDead() ? view($this->module()->name() . '::icons/source-status', [
+					'module_name' => $this->module()->name(),
+					'source_status' => $this->source_status_service->sourceStatusForDeath($record),
+					'context'  => 'INDI:DEAT',
+					'size_style' => $size ]) : '') ;
+		}
+		return '';
+	}
 }

app/Module/IsSourced/Hooks/IsSourcedStatusColumnsHook.php

Indentation +171 added lines, -171 removed lines

@@ -30,183 +30,183 @@
  * Hook for adding columns with source statuses in datatables.
  */
 class IsSourcedStatusColumnsHook implements
-    FamilyDatatablesExtenderInterface,
-    IndividualDatatablesExtenderInterface,
-    SosaFamilyDatatablesExtenderInterface,
-    SosaIndividualDatatablesExtenderInterface,
-    SosaMissingDatatablesExtenderInterface
+	FamilyDatatablesExtenderInterface,
+	IndividualDatatablesExtenderInterface,
+	SosaFamilyDatatablesExtenderInterface,
+	SosaIndividualDatatablesExtenderInterface,
+	SosaMissingDatatablesExtenderInterface
 {
-    private ModuleInterface $module;
-    private SourceStatusService $source_status_service;
+	private ModuleInterface $module;
+	private SourceStatusService $source_status_service;
 
-    /**
-     * Constructor for IsSourcedStatusColumnsHook
-     *
-     * @param ModuleInterface $module
-     * @param SourceStatusService $source_status_service
-     */
-    public function __construct(ModuleInterface $module, SourceStatusService $source_status_service)
-    {
-        $this->module = $module;
-        $this->source_status_service = $source_status_service;
-    }
+	/**
+	 * Constructor for IsSourcedStatusColumnsHook
+	 *
+	 * @param ModuleInterface $module
+	 * @param SourceStatusService $source_status_service
+	 */
+	public function __construct(ModuleInterface $module, SourceStatusService $source_status_service)
+	{
+		$this->module = $module;
+		$this->source_status_service = $source_status_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\IndividualDatatablesExtenderInterface::individualColumns()
-     */
-    public function individualColumns(iterable $records): array
-    {
-        $records = collect($records);
-        return [
-            'issourced' => [
-                'birth' => [
-                    'position' => 7,
-                    'column_def' => [ 'class' => 'text-center' ],
-                    'th' => view($this->module()->name() . '::components/column-th-issourced', [
-                        'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('INDI:BIRT')->label())
-                    ]),
-                    'records' => $records->map(function (Individual $individual): array {
-                        $source_status = $this->source_status_service->sourceStatusForBirth($individual);
-                        return [
-                            'order' => $source_status->order(),
-                            'text' => view($this->module()->name() . '::icons/source-status', [
-                                'module_name' => $this->module()->name(),
-                                'source_status' => $source_status,
-                                'context'  => 'INDI:BIRT',
-                                'size_style' => '' ])
-                        ];
-                    })->toArray()
-                ],
-                'death' => [
-                    'position' => 12,
-                    'column_def' => [ 'class' => 'text-center' ],
-                    'th' => view($this->module()->name() . '::components/column-th-issourced', [
-                        'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('INDI:DEAT')->label())
-                    ]),
-                    'records' => $records->map(function (Individual $individual): array {
-                        $source_status = $this->source_status_service->sourceStatusForDeath($individual);
-                        return $individual->isDead() ? [
-                            'order' =>  $source_status->order(),
-                            'text' => view($this->module()->name() . '::icons/source-status', [
-                                'module_name' => $this->module()->name(),
-                                'source_status' => $source_status,
-                                'context'  => 'INDI:DEAT',
-                                'size_style' => '' ])
-                        ] : ['order' => 0, 'text' => ''];
-                    })->toArray()
-                ]
-            ]
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\IndividualDatatablesExtenderInterface::individualColumns()
+	 */
+	public function individualColumns(iterable $records): array
+	{
+		$records = collect($records);
+		return [
+			'issourced' => [
+				'birth' => [
+					'position' => 7,
+					'column_def' => [ 'class' => 'text-center' ],
+					'th' => view($this->module()->name() . '::components/column-th-issourced', [
+						'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('INDI:BIRT')->label())
+					]),
+					'records' => $records->map(function (Individual $individual): array {
+						$source_status = $this->source_status_service->sourceStatusForBirth($individual);
+						return [
+							'order' => $source_status->order(),
+							'text' => view($this->module()->name() . '::icons/source-status', [
+								'module_name' => $this->module()->name(),
+								'source_status' => $source_status,
+								'context'  => 'INDI:BIRT',
+								'size_style' => '' ])
+						];
+					})->toArray()
+				],
+				'death' => [
+					'position' => 12,
+					'column_def' => [ 'class' => 'text-center' ],
+					'th' => view($this->module()->name() . '::components/column-th-issourced', [
+						'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('INDI:DEAT')->label())
+					]),
+					'records' => $records->map(function (Individual $individual): array {
+						$source_status = $this->source_status_service->sourceStatusForDeath($individual);
+						return $individual->isDead() ? [
+							'order' =>  $source_status->order(),
+							'text' => view($this->module()->name() . '::icons/source-status', [
+								'module_name' => $this->module()->name(),
+								'source_status' => $source_status,
+								'context'  => 'INDI:DEAT',
+								'size_style' => '' ])
+						] : ['order' => 0, 'text' => ''];
+					})->toArray()
+				]
+			]
+		];
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\FamilyDatatablesExtenderInterface::familyColumns()
-     */
-    public function familyColumns(iterable $records): array
-    {
-        $records = collect($records);
-        return [
-            'issourced' => [
-                'marr' => [
-                    'position' => 10,
-                    'column_def' => [ 'class' => 'text-center' ],
-                    'th' => view($this->module()->name() . '::components/column-th-issourced', [
-                        'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('FAM:MARR')->label())
-                    ]),
-                    'records' => $records->map(function (Family $family): array {
-                        $source_status = $this->source_status_service->sourceStatusForMarriage($family);
-                        return $family->getMarriage() !== null ? [
-                            'order' =>  $source_status->order(),
-                            'text' => view($this->module()->name() . '::icons/source-status', [
-                                'module_name' => $this->module()->name(),
-                                'source_status' => $source_status,
-                                'context'  => 'FAM:MARR',
-                                'size_style' => '' ])
-                        ] : ['order' => 0, 'text' => ''];
-                    })->toArray()
-                ]
-            ]
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\FamilyDatatablesExtenderInterface::familyColumns()
+	 */
+	public function familyColumns(iterable $records): array
+	{
+		$records = collect($records);
+		return [
+			'issourced' => [
+				'marr' => [
+					'position' => 10,
+					'column_def' => [ 'class' => 'text-center' ],
+					'th' => view($this->module()->name() . '::components/column-th-issourced', [
+						'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('FAM:MARR')->label())
+					]),
+					'records' => $records->map(function (Family $family): array {
+						$source_status = $this->source_status_service->sourceStatusForMarriage($family);
+						return $family->getMarriage() !== null ? [
+							'order' =>  $source_status->order(),
+							'text' => view($this->module()->name() . '::icons/source-status', [
+								'module_name' => $this->module()->name(),
+								'source_status' => $source_status,
+								'context'  => 'FAM:MARR',
+								'size_style' => '' ])
+						] : ['order' => 0, 'text' => ''];
+					})->toArray()
+				]
+			]
+		];
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\SosaIndividualDatatablesExtenderInterface::sosaIndividualColumns()
-     */
-    public function sosaIndividualColumns(iterable $records): array
-    {
-        $columns = $this->individualColumns($records);
-        $columns['issourced']['birth']['position'] = 5;
-        $columns['issourced']['death']['position'] = 8;
-        return $columns;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\SosaIndividualDatatablesExtenderInterface::sosaIndividualColumns()
+	 */
+	public function sosaIndividualColumns(iterable $records): array
+	{
+		$columns = $this->individualColumns($records);
+		$columns['issourced']['birth']['position'] = 5;
+		$columns['issourced']['death']['position'] = 8;
+		return $columns;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\SosaFamilyDatatablesExtenderInterface::sosaFamilyColumns()
-     */
-    public function sosaFamilyColumns(iterable $records): array
-    {
-        return $this->familyColumns($records);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\SosaFamilyDatatablesExtenderInterface::sosaFamilyColumns()
+	 */
+	public function sosaFamilyColumns(iterable $records): array
+	{
+		return $this->familyColumns($records);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\SosaMissingDatatablesExtenderInterface::sosaMissingColumns()
-     */
-    public function sosaMissingColumns(iterable $records): array
-    {
-        $records = collect($records);
-        return [
-            'issourced' => [
-                'indi' => [
-                    'position' => 3,
-                    'column_def' => [ 'class' => 'text-center' ],
-                    'th' => view($this->module()->name() . '::components/column-th-issourced', [
-                        'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('INDI')->label())
-                    ]),
-                    'records' => $records->map(function (Individual $individual): array {
-                        $source_status = $this->source_status_service->sourceStatusForRecord($individual);
-                        return [
-                            'order' => $source_status->order(),
-                            'text' => view($this->module()->name() . '::icons/source-status', [
-                                'module_name' => $this->module()->name(),
-                                'source_status' => $source_status,
-                                'context'  => 'INDI',
-                                'size_style' => '' ])
-                        ];
-                    })->toArray()
-                ],
-                'birth' => [
-                    'position' => 7,
-                    'column_def' => [ 'class' => 'text-center' ],
-                    'th' => view($this->module()->name() . '::components/column-th-issourced', [
-                        'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('INDI:BIRT')->label())
-                    ]),
-                    'records' => $records->map(function (Individual $individual): array {
-                        $source_status = $this->source_status_service->sourceStatusForBirth($individual);
-                        return [
-                            'order' => $source_status->order(),
-                            'text' => view($this->module()->name() . '::icons/source-status', [
-                                'module_name' => $this->module()->name(),
-                                'source_status' => $source_status,
-                                'context'  => 'INDI:BIRT',
-                                'size_style' => '' ])
-                        ];
-                    })->toArray()
-                ]
-            ]
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\SosaMissingDatatablesExtenderInterface::sosaMissingColumns()
+	 */
+	public function sosaMissingColumns(iterable $records): array
+	{
+		$records = collect($records);
+		return [
+			'issourced' => [
+				'indi' => [
+					'position' => 3,
+					'column_def' => [ 'class' => 'text-center' ],
+					'th' => view($this->module()->name() . '::components/column-th-issourced', [
+						'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('INDI')->label())
+					]),
+					'records' => $records->map(function (Individual $individual): array {
+						$source_status = $this->source_status_service->sourceStatusForRecord($individual);
+						return [
+							'order' => $source_status->order(),
+							'text' => view($this->module()->name() . '::icons/source-status', [
+								'module_name' => $this->module()->name(),
+								'source_status' => $source_status,
+								'context'  => 'INDI',
+								'size_style' => '' ])
+						];
+					})->toArray()
+				],
+				'birth' => [
+					'position' => 7,
+					'column_def' => [ 'class' => 'text-center' ],
+					'th' => view($this->module()->name() . '::components/column-th-issourced', [
+						'title' => I18N::translate('%s sourced', Registry::elementFactory()->make('INDI:BIRT')->label())
+					]),
+					'records' => $records->map(function (Individual $individual): array {
+						$source_status = $this->source_status_service->sourceStatusForBirth($individual);
+						return [
+							'order' => $source_status->order(),
+							'text' => view($this->module()->name() . '::icons/source-status', [
+								'module_name' => $this->module()->name(),
+								'source_status' => $source_status,
+								'context'  => 'INDI:BIRT',
+								'size_style' => '' ])
+						];
+					})->toArray()
+				]
+			]
+		];
+	}
 }

app/Module/IsSourced/Data/SourceStatus.php

Indentation +144 added lines, -144 removed lines

@@ -22,148 +22,148 @@
  */
 class SourceStatus
 {
-    /**
-     * @var boolean $source_exist
-     */
-    private $source_exist = false;
-
-    /**
-     * @var boolean $has_document
-     */
-    private $has_document = false;
-
-    /**
-     * Return whether the SourceStatus object contains relevant data.
-     *
-     * @return bool
-     */
-    public function isSet(): bool
-    {
-        return true;
-    }
-
-    /**
-     * Returns whether the record contains a source.
-     *
-     * @return bool
-     */
-    public function hasSource(): bool
-    {
-        return $this->source_exist;
-    }
-
-    /**
-     *  Set whether the record contains a source.
-     *
-     * @param bool $source_exist
-     * @return $this
-     */
-    public function setHasSource(bool $source_exist): self
-    {
-        $this->source_exist = $source_exist;
-        return $this;
-    }
-
-    /**
-     * Combine whether the record contains a source with the previous status.
-     *
-     * @param bool $source_exist
-     * @return $this
-     */
-    public function addHasSource(bool $source_exist): self
-    {
-        $this->source_exist = $this->source_exist || $source_exist;
-        return $this;
-    }
-
-    /**
-     * Return whether the source citation is supported by a document.
-     * Uses the _ACT tag from the MyArtJaub Certificates module.
-     *
-     * @return bool
-     */
-    public function hasSupportingDocument(): bool
-    {
-        return $this->hasSource() && $this->has_document;
-    }
-
-    /**
-     * Set whether the source citation is supported by a document.
-     *
-     * @param bool $has_document
-     * @return $this
-     */
-    public function setHasSupportingDocument(bool $has_document): self
-    {
-        $this->has_document = $has_document;
-        return $this;
-    }
-
-    /**
-     * Combine whether the source citation is supported by a document with the previous status.
-     *
-     * @param bool $has_document
-     * @return $this
-     */
-    public function addHasSupportingDocument(bool $has_document): self
-    {
-        $this->has_document = $this->has_document || $has_document;
-        return $this;
-    }
-
-    /**
-     * Check whether all possible criteria for defining a sourced element have been met.
-     *
-     * @return bool
-     */
-    public function isFullySourced(): bool
-    {
-        return $this->hasSupportingDocument();
-    }
-
-    /**
-     * Get the label to display to describe the source status.
-     *
-     * @param string $context
-     * @return string
-     */
-    public function label(string $context): string
-    {
-        $context_label = Registry::elementFactory()->make($context)->label();
-
-        if (!$this->hasSource()) {
-            return I18N::translate('%s not sourced', $context_label);
-        }
-
-        if ($this->hasSupportingDocument()) {
-            return I18N::translate('%s sourced with a certificate', $context_label);
-        }
-
-        return I18N::translate('%s sourced', $context_label);
-    }
-
-    /**
-     * Get an indicative value to order source statuses
-     *
-     * @return int
-     */
-    public function order(): int
-    {
-        return ($this->hasSource() ? 1 : 0)  * (1 + ($this->hasSupportingDocument() ? 1 : 0));
-    }
-
-    /**
-     * Return an element combining properties of the current object with another SourceStatus.
-     * Do not use the initial object anymore, it may not appropriately describe the status anymore.
-     *
-     * @template T of SourceStatus
-     * @param T $other
-     * @return $this|T
-     */
-    public function combineWith(SourceStatus $other)
-    {
-        $this->addHasSource($other->hasSource());
-        $this->addHasSupportingDocument($other->hasSource());
-        return $this;
-    }
+	/**
+	 * @var boolean $source_exist
+	 */
+	private $source_exist = false;
+
+	/**
+	 * @var boolean $has_document
+	 */
+	private $has_document = false;
+
+	/**
+	 * Return whether the SourceStatus object contains relevant data.
+	 *
+	 * @return bool
+	 */
+	public function isSet(): bool
+	{
+		return true;
+	}
+
+	/**
+	 * Returns whether the record contains a source.
+	 *
+	 * @return bool
+	 */
+	public function hasSource(): bool
+	{
+		return $this->source_exist;
+	}
+
+	/**
+	 *  Set whether the record contains a source.
+	 *
+	 * @param bool $source_exist
+	 * @return $this
+	 */
+	public function setHasSource(bool $source_exist): self
+	{
+		$this->source_exist = $source_exist;
+		return $this;
+	}
+
+	/**
+	 * Combine whether the record contains a source with the previous status.
+	 *
+	 * @param bool $source_exist
+	 * @return $this
+	 */
+	public function addHasSource(bool $source_exist): self
+	{
+		$this->source_exist = $this->source_exist || $source_exist;
+		return $this;
+	}
+
+	/**
+	 * Return whether the source citation is supported by a document.
+	 * Uses the _ACT tag from the MyArtJaub Certificates module.
+	 *
+	 * @return bool
+	 */
+	public function hasSupportingDocument(): bool
+	{
+		return $this->hasSource() && $this->has_document;
+	}
+
+	/**
+	 * Set whether the source citation is supported by a document.
+	 *
+	 * @param bool $has_document
+	 * @return $this
+	 */
+	public function setHasSupportingDocument(bool $has_document): self
+	{
+		$this->has_document = $has_document;
+		return $this;
+	}
+
+	/**
+	 * Combine whether the source citation is supported by a document with the previous status.
+	 *
+	 * @param bool $has_document
+	 * @return $this
+	 */
+	public function addHasSupportingDocument(bool $has_document): self
+	{
+		$this->has_document = $this->has_document || $has_document;
+		return $this;
+	}
+
+	/**
+	 * Check whether all possible criteria for defining a sourced element have been met.
+	 *
+	 * @return bool
+	 */
+	public function isFullySourced(): bool
+	{
+		return $this->hasSupportingDocument();
+	}
+
+	/**
+	 * Get the label to display to describe the source status.
+	 *
+	 * @param string $context
+	 * @return string
+	 */
+	public function label(string $context): string
+	{
+		$context_label = Registry::elementFactory()->make($context)->label();
+
+		if (!$this->hasSource()) {
+			return I18N::translate('%s not sourced', $context_label);
+		}
+
+		if ($this->hasSupportingDocument()) {
+			return I18N::translate('%s sourced with a certificate', $context_label);
+		}
+
+		return I18N::translate('%s sourced', $context_label);
+	}
+
+	/**
+	 * Get an indicative value to order source statuses
+	 *
+	 * @return int
+	 */
+	public function order(): int
+	{
+		return ($this->hasSource() ? 1 : 0)  * (1 + ($this->hasSupportingDocument() ? 1 : 0));
+	}
+
+	/**
+	 * Return an element combining properties of the current object with another SourceStatus.
+	 * Do not use the initial object anymore, it may not appropriately describe the status anymore.
+	 *
+	 * @template T of SourceStatus
+	 * @param T $other
+	 * @return $this|T
+	 */
+	public function combineWith(SourceStatus $other)
+	{
+		$this->addHasSource($other->hasSource());
+		$this->addHasSupportingDocument($other->hasSource());
+		return $this;
+	}
 }

app/Module/IsSourced/Data/FactSourceStatus.php

Indentation +227 added lines, -227 removed lines

@@ -22,231 +22,231 @@
  */
 class FactSourceStatus extends SourceStatus
 {
-    /**
-     * @var boolean $has_date
-     */
-    private $has_date = false;
-
-    /**
-     * @var boolean $has_precise_date
-     */
-    private $has_precise_date = false;
-
-    /**
-     * @var boolean $has_source_date
-     */
-    private $has_source_date = false;
-
-    /**
-     * @var boolean $source_date_match
-     */
-    private $source_date_match = false;
-
-    /**
-     * Return whether the fact is dated.
-     *
-     * @return bool
-     */
-    public function factHasDate(): bool
-    {
-        return $this->has_date;
-    }
-
-    /**
-     * Set whether the fact is dated.
-     *
-     * @param bool $has_date
-     * @return $this
-     */
-    public function setFactHasDate(bool $has_date): self
-    {
-        $this->has_date = $has_date;
-        return $this;
-    }
-
-    /**
-     * Combinate whether the fact is dated with the previous status.
-     *
-     * @param bool $has_date
-     * @return $this
-     */
-    public function addFactHasDate(bool $has_date): self
-    {
-        $this->has_date = $this->has_date || $has_date;
-        return $this;
-    }
-
-    /**
-     * Return whether the fact is dated with a precise day.
-     * Any date modifier will be considered as not precise.
-     * A month or year will be considered as not precise.
-     *
-     * @return bool
-     */
-    public function factHasPreciseDate(): bool
-    {
-        return $this->has_date && $this->has_precise_date;
-    }
-
-    /**
-     * Set whather the fact is dated with a precise day.
-     *
-     * @param bool $has_precise_date
-     * @return $this
-     */
-    public function setFactHasPreciseDate(bool $has_precise_date): self
-    {
-        $this->has_precise_date = $has_precise_date;
-        return $this;
-    }
-
-    /**
-     * Combine whether the fact is dated with a precise day.
-     *
-     * @param bool $has_precise_date
-     * @return $this
-     */
-    public function addFactHasPreciseDate(bool $has_precise_date): self
-    {
-        $this->has_precise_date = $this->has_precise_date || $has_precise_date;
-        return $this;
-    }
-
-    /**
-     * Return whether the source citation is dated.
-     *
-     * @return bool
-     */
-    public function sourceHasDate(): bool
-    {
-        return $this->has_source_date;
-    }
-
-    /**
-     * Set whether the source citation is dated.
-     *
-     * @param bool $has_source_date
-     * @return $this
-     */
-    public function setSourceHasDate(bool $has_source_date): self
-    {
-        $this->has_source_date = $has_source_date;
-        return $this;
-    }
-
-    /**
-     * Combine whether the source citation is dated with the previous status.
-     *
-     * @param bool $has_source_date
-     * @return $this
-     */
-    public function addSourceHasDate(bool $has_source_date): self
-    {
-        $this->has_source_date = $this->has_source_date || $has_source_date;
-        return $this;
-    }
-
-    /**
-     * Return whether the source citation date is close to the fact date.
-     *
-     * @return bool
-     */
-    public function sourceMatchesFactDate(): bool
-    {
-        return $this->has_precise_date && $this->has_source_date && $this->source_date_match;
-    }
-
-    /**
-     * Set whether the source citation date is close to the fact date.
-     *
-     * @param bool $source_date_match
-     * @return $this
-     */
-    public function setSourceMatchesFactDate(bool $source_date_match): self
-    {
-        $this->source_date_match = $source_date_match;
-        return $this;
-    }
-
-    /**
-     * Combine whether the source citation date is close to the fact date with the previous status.
-     *
-     * @param bool $source_date_match
-     * @return $this
-     */
-    public function addSourceMatchesFactDate(bool $source_date_match): self
-    {
-        $this->source_date_match = $this->source_date_match || $source_date_match;
-        return $this;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::isFullySourced()
-     */
-    public function isFullySourced(): bool
-    {
-        return parent::isFullySourced() && $this->sourceMatchesFactDate();
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::label()
-     */
-    public function label(string $context): string
-    {
-        $context_label = Registry::elementFactory()->make($context)->label();
-
-        if ($this->factHasPreciseDate()) {
-            if ($this->hasSource()) {
-                if ($this->hasSupportingDocument()) {
-                    if ($this->sourceMatchesFactDate()) {
-                        return I18N::translate('%s sourced with exact certificate', $context_label);
-                    } else {
-                        return I18N::translate('%s sourced with a certificate', $context_label);
-                    }
-                }
-
-                if ($this->sourceMatchesFactDate()) {
-                    return I18N::translate('%s precisely sourced', $context_label);
-                }
-                return I18N::translate('%s sourced', $context_label);
-            }
-            return I18N::translate('%s not sourced', $context_label);
-        }
-
-        if ($this->factHasDate()) {
-            return I18N::translate('%s not precise', $context_label);
-        }
-        return I18N::translate('%s not found', $context_label);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::order()
-     */
-    public function order(): int
-    {
-        return ($this->factHasDate() ? 1 : 0) * ($this->hasSource() ? 1 : -1) *
-            ( 1 + ($this->factHasPreciseDate() ? 1 : 0) * (1 +
-                0b010 * ($this->sourceMatchesFactDate() ? 1 : 0) +
-                0b100 * ($this->hasSupportingDocument() ? 1 : 0)
-            )
-        );
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::combineWith()
-     */
-    public function combineWith(SourceStatus $other)
-    {
-        if ($other instanceof FactSourceStatus) {
-            $this->addFactHasDate($other->factHasDate());
-            $this->addFactHasPreciseDate($other->factHasPreciseDate());
-            $this->addSourceHasDate($other->sourceHasDate());
-            $this->addSourceMatchesFactDate($other->sourceMatchesFactDate());
-        }
-        return parent::combineWith($other);
-    }
+	/**
+	 * @var boolean $has_date
+	 */
+	private $has_date = false;
+
+	/**
+	 * @var boolean $has_precise_date
+	 */
+	private $has_precise_date = false;
+
+	/**
+	 * @var boolean $has_source_date
+	 */
+	private $has_source_date = false;
+
+	/**
+	 * @var boolean $source_date_match
+	 */
+	private $source_date_match = false;
+
+	/**
+	 * Return whether the fact is dated.
+	 *
+	 * @return bool
+	 */
+	public function factHasDate(): bool
+	{
+		return $this->has_date;
+	}
+
+	/**
+	 * Set whether the fact is dated.
+	 *
+	 * @param bool $has_date
+	 * @return $this
+	 */
+	public function setFactHasDate(bool $has_date): self
+	{
+		$this->has_date = $has_date;
+		return $this;
+	}
+
+	/**
+	 * Combinate whether the fact is dated with the previous status.
+	 *
+	 * @param bool $has_date
+	 * @return $this
+	 */
+	public function addFactHasDate(bool $has_date): self
+	{
+		$this->has_date = $this->has_date || $has_date;
+		return $this;
+	}
+
+	/**
+	 * Return whether the fact is dated with a precise day.
+	 * Any date modifier will be considered as not precise.
+	 * A month or year will be considered as not precise.
+	 *
+	 * @return bool
+	 */
+	public function factHasPreciseDate(): bool
+	{
+		return $this->has_date && $this->has_precise_date;
+	}
+
+	/**
+	 * Set whather the fact is dated with a precise day.
+	 *
+	 * @param bool $has_precise_date
+	 * @return $this
+	 */
+	public function setFactHasPreciseDate(bool $has_precise_date): self
+	{
+		$this->has_precise_date = $has_precise_date;
+		return $this;
+	}
+
+	/**
+	 * Combine whether the fact is dated with a precise day.
+	 *
+	 * @param bool $has_precise_date
+	 * @return $this
+	 */
+	public function addFactHasPreciseDate(bool $has_precise_date): self
+	{
+		$this->has_precise_date = $this->has_precise_date || $has_precise_date;
+		return $this;
+	}
+
+	/**
+	 * Return whether the source citation is dated.
+	 *
+	 * @return bool
+	 */
+	public function sourceHasDate(): bool
+	{
+		return $this->has_source_date;
+	}
+
+	/**
+	 * Set whether the source citation is dated.
+	 *
+	 * @param bool $has_source_date
+	 * @return $this
+	 */
+	public function setSourceHasDate(bool $has_source_date): self
+	{
+		$this->has_source_date = $has_source_date;
+		return $this;
+	}
+
+	/**
+	 * Combine whether the source citation is dated with the previous status.
+	 *
+	 * @param bool $has_source_date
+	 * @return $this
+	 */
+	public function addSourceHasDate(bool $has_source_date): self
+	{
+		$this->has_source_date = $this->has_source_date || $has_source_date;
+		return $this;
+	}
+
+	/**
+	 * Return whether the source citation date is close to the fact date.
+	 *
+	 * @return bool
+	 */
+	public function sourceMatchesFactDate(): bool
+	{
+		return $this->has_precise_date && $this->has_source_date && $this->source_date_match;
+	}
+
+	/**
+	 * Set whether the source citation date is close to the fact date.
+	 *
+	 * @param bool $source_date_match
+	 * @return $this
+	 */
+	public function setSourceMatchesFactDate(bool $source_date_match): self
+	{
+		$this->source_date_match = $source_date_match;
+		return $this;
+	}
+
+	/**
+	 * Combine whether the source citation date is close to the fact date with the previous status.
+	 *
+	 * @param bool $source_date_match
+	 * @return $this
+	 */
+	public function addSourceMatchesFactDate(bool $source_date_match): self
+	{
+		$this->source_date_match = $this->source_date_match || $source_date_match;
+		return $this;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::isFullySourced()
+	 */
+	public function isFullySourced(): bool
+	{
+		return parent::isFullySourced() && $this->sourceMatchesFactDate();
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::label()
+	 */
+	public function label(string $context): string
+	{
+		$context_label = Registry::elementFactory()->make($context)->label();
+
+		if ($this->factHasPreciseDate()) {
+			if ($this->hasSource()) {
+				if ($this->hasSupportingDocument()) {
+					if ($this->sourceMatchesFactDate()) {
+						return I18N::translate('%s sourced with exact certificate', $context_label);
+					} else {
+						return I18N::translate('%s sourced with a certificate', $context_label);
+					}
+				}
+
+				if ($this->sourceMatchesFactDate()) {
+					return I18N::translate('%s precisely sourced', $context_label);
+				}
+				return I18N::translate('%s sourced', $context_label);
+			}
+			return I18N::translate('%s not sourced', $context_label);
+		}
+
+		if ($this->factHasDate()) {
+			return I18N::translate('%s not precise', $context_label);
+		}
+		return I18N::translate('%s not found', $context_label);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::order()
+	 */
+	public function order(): int
+	{
+		return ($this->factHasDate() ? 1 : 0) * ($this->hasSource() ? 1 : -1) *
+			( 1 + ($this->factHasPreciseDate() ? 1 : 0) * (1 +
+				0b010 * ($this->sourceMatchesFactDate() ? 1 : 0) +
+				0b100 * ($this->hasSupportingDocument() ? 1 : 0)
+			)
+		);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\SourceStatus::combineWith()
+	 */
+	public function combineWith(SourceStatus $other)
+	{
+		if ($other instanceof FactSourceStatus) {
+			$this->addFactHasDate($other->factHasDate());
+			$this->addFactHasPreciseDate($other->factHasPreciseDate());
+			$this->addSourceHasDate($other->sourceHasDate());
+			$this->addSourceMatchesFactDate($other->sourceMatchesFactDate());
+		}
+		return parent::combineWith($other);
+	}
 }

app/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)
-    {
-        return $other;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\IsSourced\Data\FactSourceStatus::combineWith()
+	 */
+	public function combineWith(SourceStatus $other)
+	{
+		return $other;
+	}
 }