jon48 / webtrees-lib

src/Webtrees/Module/PatronymicLineage/Http/RequestHandlers/SurnamesList.php

Indentation +70 added lines, -70 removed lines

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

Spacing +5 added lines, -5 removed lines

@@ -72,7 +72,7 @@ 
 
         $initial = $request->getAttribute('alpha');
         $initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
-            ->reject(function (int $count, string $initial): bool {
+            ->reject(function(int $count, string $initial): bool {
 
                 return $initial === '@' || $initial === ',';
             });
@@ -80,17 +80,17 @@ 
         $show_all = $request->getQueryParams()['show_all'] ?? 'no';
 
         if ($show_all === 'yes') {
-            $title = I18N::translate('Patronymic Lineages') . ' — ' . I18N::translate('All');
+            $title = I18N::translate('Patronymic Lineages').' — '.I18N::translate('All');
             $surnames = $this->indilist_module->surnames($tree, '', '', false, false, I18N::locale());
         } elseif ($initial !== null && mb_strlen($initial) == 1) {
-            $title = I18N::translate('Patronymic Lineages') . ' — ' . $initial;
+            $title = I18N::translate('Patronymic Lineages').' — '.$initial;
             $surnames = $this->indilist_module->surnames($tree, '', $initial, false, false, I18N::locale());
         } else {
-            $title =  I18N::translate('Patronymic Lineages');
+            $title = I18N::translate('Patronymic Lineages');
             $surnames = [];
         }
 
-        return $this->viewResponse($this->module->name() . '::surnames-page', [
+        return $this->viewResponse($this->module->name().'::surnames-page', [
             'title'         =>  $title,
             'module'        =>  $this->module,
             'tree'          =>  $tree,

src/Webtrees/Module/IsSourced/Services/SourceStatusService.php

Indentation +123 added lines, -123 removed lines

@@ -30,127 +30,127 @@
 class SourceStatusService
 {
 
-    /**
-     * Maximum timespan between the date of a source and the date of the event to consider the source precise.
-     * Arbitrally set to approximately a year around the event date.
-     *
-     * @var int DATE_PRECISION_MARGIN
-     */
-    private const DATE_PRECISION_MARGIN = 180;
-
-    /**
-     * Return the status of source citations for a fact.
-     *
-     * @param Fact $fact
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForFact(Fact $fact): FactSourceStatus
-    {
-        $source_status = new FactSourceStatus();
-
-        $date = $fact->date();
-        $source_status
-            ->setFactHasDate($date->isOK())
-            ->setFactHasPreciseDate($date->qual1 === '' && $date->minimumJulianDay() === $date->maximumJulianDay());
-
-        foreach ($fact->getCitations() as $citation) {
-            $source_status
-                ->setHasSource(true)
-                ->addHasSupportingDocument(preg_match('/\n3 _ACT (?:.*)/', $citation) === 1);
-
-            preg_match_all("/\n3 DATA(?:\n[4-9] .*)*\n4 DATE (.*)/", $citation, $date_matches, PREG_SET_ORDER);
-            foreach ($date_matches as $date_match) {
-                $source_date = new Date($date_match[1]);
-                $source_status
-                    ->addSourceHasDate($source_date->isOK())
-                    ->addSourceMatchesFactDate($date->isOK() && $source_date->isOK()
-                        && abs($source_date->julianDay() - $date->julianDay()) < self::DATE_PRECISION_MARGIN);
-            }
-
-            if ($source_status->isFullySourced()) {
-                return $source_status;
-            }
-        }
-
-        return $source_status;
-    }
-
-    /**
-     * Return the status of sources for a Gedcom record.
-     *
-     * @param GedcomRecord $record
-     * @return SourceStatus
-     */
-    public function sourceStatusForRecord(GedcomRecord $record): SourceStatus
-    {
-        $source_status = new SourceStatus();
-
-        foreach ($record->facts(['SOUR']) as $source) {
-            $source_status
-                ->setHasSource(true)
-                ->addHasSupportingDocument($source->attribute('_ACT') !== '');
-
-            if ($source_status->isFullySourced()) {
-                return $source_status;
-            }
-        }
-
-        return $source_status;
-    }
-
-    /**
-     * Return the status of source citations for a list of fact types associated with a record.
-     *
-     * @param GedcomRecord $record
-     * @param array $tags
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForFactsWithTags(GedcomRecord $record, array $tags): FactSourceStatus
-    {
-        $source_status = new NullFactSourceStatus();
-
-        foreach ($record->facts($tags) as $fact) {
-            $source_status = $source_status->combineWith($this->sourceStatusForFact($fact));
-            assert($source_status instanceof FactSourceStatus);
-            if ($source_status->isFullySourced()) {
-                return $source_status;
-            }
-        }
-
-        return $source_status;
-    }
-
-    /**
-     * Return the status of source citations for an individual's birth events.
-     *
-     * @param Individual $individual
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForBirth(Individual $individual): FactSourceStatus
-    {
-        return $this->sourceStatusForFactsWithTags($individual, Gedcom::BIRTH_EVENTS);
-    }
-
-    /**
-     * Return the status of source citations for an individual's death events.
-     *
-     * @param Individual $individual
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForDeath(Individual $individual): FactSourceStatus
-    {
-        return $this->sourceStatusForFactsWithTags($individual, Gedcom::DEATH_EVENTS);
-    }
-
-    /**
-     * Return the status of source citations for a family's marriage events.
-     *
-     * @param Family $family
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForMarriage(Family $family): FactSourceStatus
-    {
-        $marr_events = array_merge(Gedcom::MARRIAGE_EVENTS, ['MARC', 'MARL', 'MARS']);
-        return $this->sourceStatusForFactsWithTags($family, $marr_events);
-    }
+	/**
+	 * Maximum timespan between the date of a source and the date of the event to consider the source precise.
+	 * Arbitrally set to approximately a year around the event date.
+	 *
+	 * @var int DATE_PRECISION_MARGIN
+	 */
+	private const DATE_PRECISION_MARGIN = 180;
+
+	/**
+	 * Return the status of source citations for a fact.
+	 *
+	 * @param Fact $fact
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForFact(Fact $fact): FactSourceStatus
+	{
+		$source_status = new FactSourceStatus();
+
+		$date = $fact->date();
+		$source_status
+			->setFactHasDate($date->isOK())
+			->setFactHasPreciseDate($date->qual1 === '' && $date->minimumJulianDay() === $date->maximumJulianDay());
+
+		foreach ($fact->getCitations() as $citation) {
+			$source_status
+				->setHasSource(true)
+				->addHasSupportingDocument(preg_match('/\n3 _ACT (?:.*)/', $citation) === 1);
+
+			preg_match_all("/\n3 DATA(?:\n[4-9] .*)*\n4 DATE (.*)/", $citation, $date_matches, PREG_SET_ORDER);
+			foreach ($date_matches as $date_match) {
+				$source_date = new Date($date_match[1]);
+				$source_status
+					->addSourceHasDate($source_date->isOK())
+					->addSourceMatchesFactDate($date->isOK() && $source_date->isOK()
+						&& abs($source_date->julianDay() - $date->julianDay()) < self::DATE_PRECISION_MARGIN);
+			}
+
+			if ($source_status->isFullySourced()) {
+				return $source_status;
+			}
+		}
+
+		return $source_status;
+	}
+
+	/**
+	 * Return the status of sources for a Gedcom record.
+	 *
+	 * @param GedcomRecord $record
+	 * @return SourceStatus
+	 */
+	public function sourceStatusForRecord(GedcomRecord $record): SourceStatus
+	{
+		$source_status = new SourceStatus();
+
+		foreach ($record->facts(['SOUR']) as $source) {
+			$source_status
+				->setHasSource(true)
+				->addHasSupportingDocument($source->attribute('_ACT') !== '');
+
+			if ($source_status->isFullySourced()) {
+				return $source_status;
+			}
+		}
+
+		return $source_status;
+	}
+
+	/**
+	 * Return the status of source citations for a list of fact types associated with a record.
+	 *
+	 * @param GedcomRecord $record
+	 * @param array $tags
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForFactsWithTags(GedcomRecord $record, array $tags): FactSourceStatus
+	{
+		$source_status = new NullFactSourceStatus();
+
+		foreach ($record->facts($tags) as $fact) {
+			$source_status = $source_status->combineWith($this->sourceStatusForFact($fact));
+			assert($source_status instanceof FactSourceStatus);
+			if ($source_status->isFullySourced()) {
+				return $source_status;
+			}
+		}
+
+		return $source_status;
+	}
+
+	/**
+	 * Return the status of source citations for an individual's birth events.
+	 *
+	 * @param Individual $individual
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForBirth(Individual $individual): FactSourceStatus
+	{
+		return $this->sourceStatusForFactsWithTags($individual, Gedcom::BIRTH_EVENTS);
+	}
+
+	/**
+	 * Return the status of source citations for an individual's death events.
+	 *
+	 * @param Individual $individual
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForDeath(Individual $individual): FactSourceStatus
+	{
+		return $this->sourceStatusForFactsWithTags($individual, Gedcom::DEATH_EVENTS);
+	}
+
+	/**
+	 * Return the status of source citations for a family's marriage events.
+	 *
+	 * @param Family $family
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForMarriage(Family $family): FactSourceStatus
+	{
+		$marr_events = array_merge(Gedcom::MARRIAGE_EVENTS, ['MARC', 'MARL', 'MARS']);
+		return $this->sourceStatusForFactsWithTags($family, $marr_events);
+	}
 }

src/Webtrees/Module/IsSourced/IsSourcedModule.php

Indentation +78 added lines, -78 removed lines

@@ -30,92 +30,92 @@
  * IsSourced Module
  */
 class IsSourcedModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleGlobalInterface,
-    ModuleSidebarInterface
+	ModuleMyArtJaubInterface,
+	ModuleGlobalInterface,
+	ModuleSidebarInterface
 {
-    use ModuleMyArtJaubTrait;
-    use ModuleGlobalTrait;
-    use ModuleSidebarTrait;
+	use ModuleMyArtJaubTrait;
+	use ModuleGlobalTrait;
+	use ModuleSidebarTrait;
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Sourced events');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Sourced events');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        return I18N::translate('Indicate if events related to an record are sourced.');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		return I18N::translate('Indicate if events related to an record are sourced.');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.0-v.1';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.0-v.1';
+	}
 
-    /**
-     * {@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::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/issourced.min.js') . '"></script>';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
+	 */
+	public function bodyContent(): string
+	{
+		return '<script src="' . $this->assetUrl('js/issourced.min.js') . '"></script>';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
-     */
-    public function hasSidebarContent(Individual $individual): bool
-    {
-        return true;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
+	 */
+	public function hasSidebarContent(Individual $individual): bool
+	{
+		return true;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
-     */
-    public function getSidebarContent(Individual $individual): string
-    {
-        /** @var SourceStatusService $source_status_service */
-        $source_status_service = app(SourceStatusService::class);
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
+	 */
+	public function getSidebarContent(Individual $individual): string
+	{
+		/** @var SourceStatusService $source_status_service */
+		$source_status_service = app(SourceStatusService::class);
 
-        $spouse_families_status = $individual->spouseFamilies()->map(
-            function (Family $sfamily) use ($source_status_service): array {
-                return [ $sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
-            }
-        )->filter(function (array $item): bool {
-            return $item[1]->isSet();
-        });
+		$spouse_families_status = $individual->spouseFamilies()->map(
+			function (Family $sfamily) use ($source_status_service): array {
+				return [ $sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
+			}
+		)->filter(function (array $item): bool {
+			return $item[1]->isSet();
+		});
 
-        return view($this->name() . '::sidebar/content', [
-            'module_name'               => $this->name(),
-            'individual'                =>  $individual,
-            'source_status_individual'  =>  $source_status_service->sourceStatusForRecord($individual),
-            'source_status_birth'       =>  $source_status_service->sourceStatusForBirth($individual),
-            'source_status_marriages'   =>  $spouse_families_status,
-            'source_status_death'       =>  $source_status_service->sourceStatusForDeath($individual)
-        ]);
-    }
+		return view($this->name() . '::sidebar/content', [
+			'module_name'               => $this->name(),
+			'individual'                =>  $individual,
+			'source_status_individual'  =>  $source_status_service->sourceStatusForRecord($individual),
+			'source_status_birth'       =>  $source_status_service->sourceStatusForBirth($individual),
+			'source_status_marriages'   =>  $spouse_families_status,
+			'source_status_death'       =>  $source_status_service->sourceStatusForDeath($individual)
+		]);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -71,7 +71,7 @@ 
      */
     public function headContent(): string
     {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+        return '<link rel="stylesheet" href="'.e($this->moduleCssUrl()).'">';
     }
 
     /**
@@ -80,7 +80,7 @@ 
      */
     public function bodyContent(): string
     {
-        return '<script src="' . $this->assetUrl('js/issourced.min.js') . '"></script>';
+        return '<script src="'.$this->assetUrl('js/issourced.min.js').'"></script>';
     }
 
     /**
@@ -102,14 +102,14 @@ 
         $source_status_service = app(SourceStatusService::class);
 
         $spouse_families_status = $individual->spouseFamilies()->map(
-            function (Family $sfamily) use ($source_status_service): array {
-                return [ $sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
+            function(Family $sfamily) use ($source_status_service): array {
+                return [$sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
             }
-        )->filter(function (array $item): bool {
+        )->filter(function(array $item): bool {
             return $item[1]->isSet();
         });
 
-        return view($this->name() . '::sidebar/content', [
+        return view($this->name().'::sidebar/content', [
             'module_name'               => $this->name(),
             'individual'                =>  $individual,
             'source_status_individual'  =>  $source_status_service->sourceStatusForRecord($individual),

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

Indentation +133 added lines, -133 removed lines

@@ -22,137 +22,137 @@
  */
 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 self
-     */
-    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 self
-     */
-    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 self
-     */
-    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 self
-     */
-    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);
-    }
-
-    /**
-     * 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.
-     *
-     * @param SourceStatus $other
-     * @return self
-     */
-    public function combineWith(SourceStatus $other): self
-    {
-        $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 self
+	 */
+	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 self
+	 */
+	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 self
+	 */
+	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 self
+	 */
+	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);
+	}
+
+	/**
+	 * 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.
+	 *
+	 * @param SourceStatus $other
+	 * @return self
+	 */
+	public function combineWith(SourceStatus $other): self
+	{
+		$this->addHasSource($other->hasSource());
+		$this->addHasSupportingDocument($other->hasSource());
+		return $this;
+	}
 }

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

Indentation +207 added lines, -207 removed lines

@@ -22,211 +22,211 @@
  */
 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 self
-     */
-    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 self
-     */
-    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 self
-     */
-    public function setFactHasPreciseDate(bool $has_precise_date): self
-    {
-        $this->has_precise_date = $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 self
-     */
-    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 self
-     */
-    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 self
-     */
-    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 self
-     */
-    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::combineWith()
-     */
-    public function combineWith(SourceStatus $other): SourceStatus
-    {
-        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 self
+	 */
+	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 self
+	 */
+	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 self
+	 */
+	public function setFactHasPreciseDate(bool $has_precise_date): self
+	{
+		$this->has_precise_date = $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 self
+	 */
+	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 self
+	 */
+	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 self
+	 */
+	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 self
+	 */
+	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::combineWith()
+	 */
+	public function combineWith(SourceStatus $other): SourceStatus
+	{
+		if ($other instanceof FactSourceStatus) {
+			$this->addFactHasDate($other->factHasDate());
+			$this->addFactHasPreciseDate($other->factHasPreciseDate());
+			$this->addSourceHasDate($other->sourceHasDate());
+			$this->addSourceMatchesFactDate($other->sourceMatchesFactDate());
+		}
+		return parent::combineWith($other);
+	}
 }

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

Indentation +16 added lines, -16 removed lines

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

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

Indentation +52 added lines, -52 removed lines

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

Spacing +2 added lines, -2 removed lines

@@ -81,12 +81,12 @@
             }
         } catch (Throwable $ex) {
             return $this->viewResponse('errors/unhandled-exception', [
-                'error' => I18N::translate('Error while retrieving Matomo statistics: ') .
+                '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', [
+        return $this->viewResponse($this->module->name().'::matomo-stats', [
             'visits_year'   =>  $nb_visits_year,
             'visits_today'  =>  $nb_visits_today
         ]);

src/Webtrees/Module/WelcomeBlock/WelcomeBlockModule.php

Indentation +155 added lines, -155 removed lines

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

Spacing +7 added lines, -7 removed lines

@@ -61,9 +61,9 @@ 
      */
     public function loadRoutes(Map $router): void
     {
-        $router->attach('', '', static function (Map $router): void {
+        $router->attach('', '', static function(Map $router): void {
 
-            $router->attach('', '/module-maj/welcomeblock/{block_id}', static function (Map $router): void {
+            $router->attach('', '/module-maj/welcomeblock/{block_id}', static function(Map $router): void {
 
                 $router->get(MatomoStats::class, '/matomostats', MatomoStats::class);
             });
@@ -91,7 +91,7 @@ 
         $fab_login_block_view = app(\Fisharebest\Webtrees\Module\LoginBlockModule::class)
             ->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
 
-        $content = view($this->name() . '::block-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,
@@ -127,7 +127,7 @@ 
      */
     public function editBlockConfiguration(Tree $tree, int $block_id): string
     {
-        return view($this->name() . '::config', $this->matomoSettings($block_id));
+        return view($this->name().'::config', $this->matomoSettings($block_id));
     }
 
     /**
@@ -136,7 +136,7 @@ 
      */
     public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
     {
-        $params = (array) $request->getParsedBody();
+        $params = (array)$request->getParsedBody();
 
         $matomo_enabled = $params['matomo_enabled'] == 'yes';
         $this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
@@ -159,7 +159,7 @@ 
             ->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);
+        Registry::cache()->file()->forget($this->name().'-matomovisits-yearly-'.$block_id);
     }
 
     /**
@@ -185,7 +185,7 @@ 
             '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')
+            'matomo_siteid'  => (int)$this->getBlockSetting($block_id, 'matomo_siteid', '0')
         ];
     }
 }

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

Indentation +82 added lines, -82 removed lines

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

Spacing +6 added lines, -6 removed lines

@@ -40,13 +40,13 @@ 
     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 {
+            $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');
+                $visits_today = (int)$this->visits($module, $block_id, 'day');
 
                 return $visits_year - $visits_today;
             },
@@ -64,8 +64,8 @@ 
     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 {
+            $module->name().'-matomovisits-daily-'.$block_id,
+            function() use ($module, $block_id) : ?int {
                 return $this->visits($module, $block_id, 'day');
             }
         );
@@ -107,7 +107,7 @@ 
                 ]);
 
                 if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
-                    $result = json_decode((string) $response->getBody(), true)['value'] ?? null;
+                    $result = json_decode((string)$response->getBody(), true)['value'] ?? null;
                     if ($result !== null) {
                         return (int)$result;
                     }