jon48 / webtrees-lib

app/Module/IsSourced/Services/SourceStatusService.php

Indentation +122 added lines, -122 removed lines

@@ -30,126 +30,126 @@
 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 string[] $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));
-            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 string[] $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));
+			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);
+	}
 }

app/Module/GeoDispersion/Services/GeoAnalysisService.php

Indentation +34 added lines, -34 removed lines

@@ -25,41 +25,41 @@
  */
 class GeoAnalysisService
 {
-    private ModuleService $module_service;
+	private ModuleService $module_service;
 
-    /**
-     * Constructor for MapDefinitionsService
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module_service = $module_service;
-    }
+	/**
+	 * Constructor for MapDefinitionsService
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module_service = $module_service;
+	}
 
-    /**
-     * Get all available geographical dispersion analyses.
-     *
-     * {@internal The list is generated based on the modules exposing ModuleGeoAnalysisProviderInterface
-     *
-     * @param bool $include_disabled
-     * @return Collection<GeoAnalysisInterface>
-     */
-    public function all(bool $include_disabled = false): Collection
-    {
-        /** @var Collection<GeoAnalysisInterface> $geoanalyses */
-        $geoanalyses = $this->module_service
-            ->findByInterface(ModuleGeoAnalysisProviderInterface::class, $include_disabled)
-            ->flatMap(fn(ModuleGeoAnalysisProviderInterface $module) => $module->listGeoAnalyses())
-            ->map(static function (string $analysis_class): ?GeoAnalysisInterface {
-                try {
-                    $analysis = app($analysis_class);
-                    return $analysis instanceof GeoAnalysisInterface ? $analysis : null;
-                } catch (BindingResolutionException $ex) {
-                    return null;
-                }
-            })->filter();
+	/**
+	 * Get all available geographical dispersion analyses.
+	 *
+	 * {@internal The list is generated based on the modules exposing ModuleGeoAnalysisProviderInterface
+	 *
+	 * @param bool $include_disabled
+	 * @return Collection<GeoAnalysisInterface>
+	 */
+	public function all(bool $include_disabled = false): Collection
+	{
+		/** @var Collection<GeoAnalysisInterface> $geoanalyses */
+		$geoanalyses = $this->module_service
+			->findByInterface(ModuleGeoAnalysisProviderInterface::class, $include_disabled)
+			->flatMap(fn(ModuleGeoAnalysisProviderInterface $module) => $module->listGeoAnalyses())
+			->map(static function (string $analysis_class): ?GeoAnalysisInterface {
+				try {
+					$analysis = app($analysis_class);
+					return $analysis instanceof GeoAnalysisInterface ? $analysis : null;
+				} catch (BindingResolutionException $ex) {
+					return null;
+				}
+			})->filter();
 
-        return $geoanalyses;
-    }
+		return $geoanalyses;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
         $geoanalyses = $this->module_service
             ->findByInterface(ModuleGeoAnalysisProviderInterface::class, $include_disabled)
             ->flatMap(fn(ModuleGeoAnalysisProviderInterface $module) => $module->listGeoAnalyses())
-            ->map(static function (string $analysis_class): ?GeoAnalysisInterface {
+            ->map(static function(string $analysis_class): ?GeoAnalysisInterface {
                 try {
                     $analysis = app($analysis_class);
                     return $analysis instanceof GeoAnalysisInterface ? $analysis : null;

app/Module/GeoDispersion/Services/PlaceMapperService.php

Indentation +34 added lines, -34 removed lines

@@ -25,41 +25,41 @@
  */
 class PlaceMapperService
 {
-    private ModuleService $module_service;
+	private ModuleService $module_service;
 
-    /**
-     * Constructor for PlaceMapperService
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module_service = $module_service;
-    }
+	/**
+	 * Constructor for PlaceMapperService
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module_service = $module_service;
+	}
 
-    /**
-     * Get all place mappers available.
-     *
-     * {@internal The list is generated based on the modules exposing ModulePlaceMapperProviderInterface}
-     *
-     * @param bool $include_disabled
-     * @return Collection<PlaceMapperInterface>
-     */
-    public function all(bool $include_disabled = false): Collection
-    {
-        /** @var Collection<PlaceMapperInterface> $place_mappers */
-        $place_mappers =  $this->module_service
-            ->findByInterface(ModulePlaceMapperProviderInterface::class, $include_disabled)
-            ->flatMap(fn(ModulePlaceMapperProviderInterface $module) => $module->listPlaceMappers())
-            ->map(static function (string $mapper_class): ?PlaceMapperInterface {
-                try {
-                    $mapper = app($mapper_class);
-                    return $mapper instanceof PlaceMapperInterface ? $mapper : null;
-                } catch (BindingResolutionException $ex) {
-                    return null;
-                }
-            })->filter();
+	/**
+	 * Get all place mappers available.
+	 *
+	 * {@internal The list is generated based on the modules exposing ModulePlaceMapperProviderInterface}
+	 *
+	 * @param bool $include_disabled
+	 * @return Collection<PlaceMapperInterface>
+	 */
+	public function all(bool $include_disabled = false): Collection
+	{
+		/** @var Collection<PlaceMapperInterface> $place_mappers */
+		$place_mappers =  $this->module_service
+			->findByInterface(ModulePlaceMapperProviderInterface::class, $include_disabled)
+			->flatMap(fn(ModulePlaceMapperProviderInterface $module) => $module->listPlaceMappers())
+			->map(static function (string $mapper_class): ?PlaceMapperInterface {
+				try {
+					$mapper = app($mapper_class);
+					return $mapper instanceof PlaceMapperInterface ? $mapper : null;
+				} catch (BindingResolutionException $ex) {
+					return null;
+				}
+			})->filter();
 
-        return $place_mappers;
-    }
+		return $place_mappers;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -48,10 +48,10 @@
     public function all(bool $include_disabled = false): Collection
     {
         /** @var Collection<PlaceMapperInterface> $place_mappers */
-        $place_mappers =  $this->module_service
+        $place_mappers = $this->module_service
             ->findByInterface(ModulePlaceMapperProviderInterface::class, $include_disabled)
             ->flatMap(fn(ModulePlaceMapperProviderInterface $module) => $module->listPlaceMappers())
-            ->map(static function (string $mapper_class): ?PlaceMapperInterface {
+            ->map(static function(string $mapper_class): ?PlaceMapperInterface {
                 try {
                     $mapper = app($mapper_class);
                     return $mapper instanceof PlaceMapperInterface ? $mapper : null;

app/Module/GeoDispersion/PlaceMappers/PlaceMapperTrait.php

Indentation +57 added lines, -57 removed lines

@@ -24,67 +24,67 @@
  */
 trait PlaceMapperTrait
 {
-    private ?PlaceMapperConfigInterface $config = null;
+	private ?PlaceMapperConfigInterface $config = null;
 
-    /** @var array<string, mixed> $data */
-    private array $data = [];
+	/** @var array<string, mixed> $data */
+	private array $data = [];
 
-    /**
-     * Implementation of PlaceMapperInterface::boot
-     *
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::boot()
-     */
-    public function boot(): void
-    {
-    }
+	/**
+	 * Implementation of PlaceMapperInterface::boot
+	 *
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::boot()
+	 */
+	public function boot(): void
+	{
+	}
 
-    /**
-     * Implementation of PlaceMapperInterface::config
-     *
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::config()
-     *
-     * @return PlaceMapperConfigInterface
-     */
-    public function config(): PlaceMapperConfigInterface
-    {
-        return $this->config ?? new NullPlaceMapperConfig();
-    }
+	/**
+	 * Implementation of PlaceMapperInterface::config
+	 *
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::config()
+	 *
+	 * @return PlaceMapperConfigInterface
+	 */
+	public function config(): PlaceMapperConfigInterface
+	{
+		return $this->config ?? new NullPlaceMapperConfig();
+	}
 
-    /**
-     * Implementation of PlaceMapperInterface::setConfig
-     *
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::setConfig()
-     *
-     * @param PlaceMapperConfigInterface $config
-     */
-    public function setConfig(PlaceMapperConfigInterface $config): void
-    {
-        $this->config = $config;
-    }
+	/**
+	 * Implementation of PlaceMapperInterface::setConfig
+	 *
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::setConfig()
+	 *
+	 * @param PlaceMapperConfigInterface $config
+	 */
+	public function setConfig(PlaceMapperConfigInterface $config): void
+	{
+		$this->config = $config;
+	}
 
-    /**
-     * Implementation of PlaceMapperInterface::data
-     *
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::data()
-     *
-     * @param string $key
-     * @return NULL|mixed
-     */
-    public function data(string $key)
-    {
-        return $this->data[$key] ?? null;
-    }
+	/**
+	 * Implementation of PlaceMapperInterface::data
+	 *
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::data()
+	 *
+	 * @param string $key
+	 * @return NULL|mixed
+	 */
+	public function data(string $key)
+	{
+		return $this->data[$key] ?? null;
+	}
 
-    /**
-     * Implementation of PlaceMapperInterface::setData
-     *
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::setData()
-     *
-     * @param string $key
-     * @param mixed|null $data
-     */
-    public function setData(string $key, $data): void
-    {
-        $this->data[$key] = $data;
-    }
+	/**
+	 * Implementation of PlaceMapperInterface::setData
+	 *
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::setData()
+	 *
+	 * @param string $key
+	 * @param mixed|null $data
+	 */
+	public function setData(string $key, $data): void
+	{
+		$this->data[$key] = $data;
+	}
 }

app/Module/GeoDispersion/PlaceMappers/TopFilteredPlaceMapperTrait.php

Indentation +57 added lines, -57 removed lines

@@ -21,65 +21,65 @@
  */
 trait TopFilteredPlaceMapperTrait
 {
-    /**
-     * @var Place[] $top_places
-     */
-    private array $top_places = [];
+	/**
+	 * @var Place[] $top_places
+	 */
+	private array $top_places = [];
 
-    /**
-     * Get the list of top level places.
-     *
-     * @return Place[]
-     */
-    public function topPlaces(): array
-    {
-        return $this->top_places;
-    }
+	/**
+	 * Get the list of top level places.
+	 *
+	 * @return Place[]
+	 */
+	public function topPlaces(): array
+	{
+		return $this->top_places;
+	}
 
-    /**
-     * Set the list of defined top level places.
-     *
-     * @param Place[] $top_places
-     */
-    public function setTopPlaces(array $top_places): void
-    {
-        $this->top_places = collect($top_places)
-            ->filter(
-                /** @psalm-suppress MissingClosureParamType */
-                fn($top_places): bool => $top_places instanceof Place
-            )->toArray();
-    }
+	/**
+	 * Set the list of defined top level places.
+	 *
+	 * @param Place[] $top_places
+	 */
+	public function setTopPlaces(array $top_places): void
+	{
+		$this->top_places = collect($top_places)
+			->filter(
+				/** @psalm-suppress MissingClosureParamType */
+				fn($top_places): bool => $top_places instanceof Place
+			)->toArray();
+	}
 
-    /**
-     * Check whether a string ($haystack) ends with another string ($needle)
-     *
-     * {@internal This is redundant with the function str_ends_with in PHP8}
-     *
-     * @param string $haystack
-     * @param string $needle
-     * @return bool
-     */
-    private function endsWith(string $haystack, string $needle): bool
-    {
-        return substr_compare($haystack, $needle, -strlen($needle)) === 0;
-    }
+	/**
+	 * Check whether a string ($haystack) ends with another string ($needle)
+	 *
+	 * {@internal This is redundant with the function str_ends_with in PHP8}
+	 *
+	 * @param string $haystack
+	 * @param string $needle
+	 * @return bool
+	 */
+	private function endsWith(string $haystack, string $needle): bool
+	{
+		return substr_compare($haystack, $needle, -strlen($needle)) === 0;
+	}
 
-    /**
-     * Check whether a Place belongs to one of the defined top places.
-     *
-     * @param Place $place
-     * @return bool
-     */
-    protected function belongsToTopLevels(Place $place): bool
-    {
-        foreach ($this->top_places as $top_place) {
-            if (
-                $top_place->tree()->id() === $place->tree()->id() &&
-                $this->endsWith($place->gedcomName(), $top_place->gedcomName())
-            ) {
-                    return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * Check whether a Place belongs to one of the defined top places.
+	 *
+	 * @param Place $place
+	 * @return bool
+	 */
+	protected function belongsToTopLevels(Place $place): bool
+	{
+		foreach ($this->top_places as $top_place) {
+			if (
+				$top_place->tree()->id() === $place->tree()->id() &&
+				$this->endsWith($place->gedcomName(), $top_place->gedcomName())
+			) {
+					return true;
+			}
+		}
+		return false;
+	}
 }

app/Contracts/Hooks/CustomSimpleTagEditorInterface.php

Indentation +33 added lines, -33 removed lines

@@ -1,14 +1,14 @@ 
 <?php
 
  /**
- * webtrees-lib: MyArtJaub library for webtrees
- *
- * @package MyArtJaub\Webtrees
- * @subpackage Hooks
- * @author Jonathan Jaubart <dev@jaubart.com>
- * @copyright Copyright (c) 2011-2021, Jonathan Jaubart
- * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
- */
+  * webtrees-lib: MyArtJaub library for webtrees
+  *
+  * @package MyArtJaub\Webtrees
+  * @subpackage Hooks
+  * @author Jonathan Jaubart <dev@jaubart.com>
+  * @copyright Copyright (c) 2011-2021, Jonathan Jaubart
+  * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
+  */
 
 declare(strict_types=1);
 
@@ -21,31 +21,31 @@ 
  */
 interface CustomSimpleTagEditorInterface extends HookInterface
 {
-    /**
-     * Add the tag in the hierarchy of the expected tags
-     *
-     * @param array<string, mixed> $expected_tags
-     * @return array<string, mixed>
-     */
-    public function addExpectedTags(array $expected_tags): array;
+	/**
+	 * Add the tag in the hierarchy of the expected tags
+	 *
+	 * @param array<string, mixed> $expected_tags
+	 * @return array<string, mixed>
+	 */
+	public function addExpectedTags(array $expected_tags): array;
 
-    /**
-     * Try to get a label for a tag
-     *
-     * @param string $tag
-     * @return string
-     */
-    public function getLabel(string $tag): string;
+	/**
+	 * Try to get a label for a tag
+	 *
+	 * @param string $tag
+	 * @return string
+	 */
+	public function getLabel(string $tag): string;
 
-    /**
-     * Returns HTML code for editing the custom tag.
-     *
-     * @param string $tag
-     * @param string $id
-     * @param string $name
-     * @param string $value
-     * @param Tree $tree
-     * @return string
-     */
-    public function editForm(string $tag, string $id, string $name, string $value, Tree $tree): string;
+	/**
+	 * Returns HTML code for editing the custom tag.
+	 *
+	 * @param string $tag
+	 * @param string $id
+	 * @param string $name
+	 * @param string $value
+	 * @param Tree $tree
+	 * @return string
+	 */
+	public function editForm(string $tag, string $id, string $name, string $value, Tree $tree): string;
 }

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResults.php

Indentation +91 added lines, -91 removed lines

@@ -23,104 +23,104 @@
  */
 class GeoAnalysisResults
 {
-    private GeoAnalysisResult $global;
+	private GeoAnalysisResult $global;
 
-    /**
-     * @var Collection<string, GeoAnalysisResult> $detailed
-     */
-    private Collection $detailed;
+	/**
+	 * @var Collection<string, GeoAnalysisResult> $detailed
+	 */
+	private Collection $detailed;
 
-    /**
-     * Constructor for GeoAnalysisResults
-     */
-    public function __construct()
-    {
-        $this->global = new GeoAnalysisResult('Global', 0);
-        $this->detailed = new Collection();
-    }
+	/**
+	 * Constructor for GeoAnalysisResults
+	 */
+	public function __construct()
+	{
+		$this->global = new GeoAnalysisResult('Global', 0);
+		$this->detailed = new Collection();
+	}
 
-    /**
-     * Global result of the geographical analysis
-     *
-     * @return GeoAnalysisResult
-     */
-    public function global(): GeoAnalysisResult
-    {
-        return $this->global;
-    }
+	/**
+	 * Global result of the geographical analysis
+	 *
+	 * @return GeoAnalysisResult
+	 */
+	public function global(): GeoAnalysisResult
+	{
+		return $this->global;
+	}
 
-    /**
-     * List of results by category of the geographical analysis
-     *
-     * @return Collection<string, GeoAnalysisResult>
-     */
-    public function detailed(): Collection
-    {
-        return $this->detailed;
-    }
+	/**
+	 * List of results by category of the geographical analysis
+	 *
+	 * @return Collection<string, GeoAnalysisResult>
+	 */
+	public function detailed(): Collection
+	{
+		return $this->detailed;
+	}
 
-    /**
-     * List of results by category of the geographical analysis.
-     * The list is sorted first by the category order, then by the category description
-     *
-     * @return Collection<string, GeoAnalysisResult>
-     */
-    public function sortedDetailed(): Collection
-    {
-        return $this->detailed->sortBy([
-            fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int => $a->order() <=> $b->order(),
-            fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int =>
-                I18N::comparator()($a->description(), $b->description())
-        ]);
-    }
+	/**
+	 * List of results by category of the geographical analysis.
+	 * The list is sorted first by the category order, then by the category description
+	 *
+	 * @return Collection<string, GeoAnalysisResult>
+	 */
+	public function sortedDetailed(): Collection
+	{
+		return $this->detailed->sortBy([
+			fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int => $a->order() <=> $b->order(),
+			fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int =>
+				I18N::comparator()($a->description(), $b->description())
+		]);
+	}
 
-    /**
-     * Add a GeoAnalysis Place to the global result
-     *
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlace(GeoAnalysisPlace $place): void
-    {
-        $this->global()->addPlace($place);
-    }
+	/**
+	 * Add a GeoAnalysis Place to the global result
+	 *
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlace(GeoAnalysisPlace $place): void
+	{
+		$this->global()->addPlace($place);
+	}
 
-    /**
-     * Add a new category to the list of results, if it does not exist yet
-     *
-     * @param string $description
-     * @param int $order
-     */
-    public function addCategory(string $description, int $order): void
-    {
-        if (!$this->detailed->has($description)) {
-            $this->detailed->put($description, new GeoAnalysisResult($description, $order));
-        }
-    }
+	/**
+	 * Add a new category to the list of results, if it does not exist yet
+	 *
+	 * @param string $description
+	 * @param int $order
+	 */
+	public function addCategory(string $description, int $order): void
+	{
+		if (!$this->detailed->has($description)) {
+			$this->detailed->put($description, new GeoAnalysisResult($description, $order));
+		}
+	}
 
-    /**
-     * Add a GeoAnalysis Place to a category result, if the category exist.
-     *
-     * @param string $category_name
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlaceInCreatedCategory(string $category_name, GeoAnalysisPlace $place): void
-    {
-        if ($this->detailed->has($category_name)) {
-            $this->detailed->get($category_name)->addPlace($place);
-        }
-    }
+	/**
+	 * Add a GeoAnalysis Place to a category result, if the category exist.
+	 *
+	 * @param string $category_name
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlaceInCreatedCategory(string $category_name, GeoAnalysisPlace $place): void
+	{
+		if ($this->detailed->has($category_name)) {
+			$this->detailed->get($category_name)->addPlace($place);
+		}
+	}
 
-    /**
-     * Add a GeoAnalysis Place to a category result, after creating the category if it does not exist.
-     *
-     * @param string $category_name
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlaceInCategory(string $category_name, int $category_order, GeoAnalysisPlace $place): void
-    {
-        if (!$this->detailed->has($category_name)) {
-            $this->addCategory($category_name, $category_order);
-        }
-        $this->addPlaceInCreatedCategory($category_name, $place);
-    }
+	/**
+	 * Add a GeoAnalysis Place to a category result, after creating the category if it does not exist.
+	 *
+	 * @param string $category_name
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlaceInCategory(string $category_name, int $category_order, GeoAnalysisPlace $place): void
+	{
+		if (!$this->detailed->has($category_name)) {
+			$this->addCategory($category_name, $category_order);
+		}
+		$this->addPlaceInCreatedCategory($category_name, $place);
+	}
 }

app/Common/GeoDispersion/Config/GenericPlaceMapperConfig.php

Indentation +92 added lines, -92 removed lines

@@ -25,105 +25,105 @@
  */
 class GenericPlaceMapperConfig implements PlaceMapperConfigInterface
 {
-    /** @var array<string, mixed> $config */
-    private array $config = [];
+	/** @var array<string, mixed> $config */
+	private array $config = [];
 
-    /**
-     * Get the generic mapper's config
-     *
-     * @return array<string, mixed>
-     */
-    public function config(): array
-    {
-        return $this->config;
-    }
+	/**
+	 * Get the generic mapper's config
+	 *
+	 * @return array<string, mixed>
+	 */
+	public function config(): array
+	{
+		return $this->config;
+	}
 
-    /**
-     * Set the generic mapper's config
-     *
-     * @param array<string, mixed> $config
-     * @return $this
-     */
-    public function setConfig(array $config): self
-    {
-        $this->config = $config;
-        return $this;
-    }
+	/**
+	 * Set the generic mapper's config
+	 *
+	 * @param array<string, mixed> $config
+	 * @return $this
+	 */
+	public function setConfig(array $config): self
+	{
+		$this->config = $config;
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
-     */
-    public function get(string $key, $default = null)
-    {
-        return $this->config[$key] ?? $default;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
+	 */
+	public function get(string $key, $default = null)
+	{
+		return $this->config[$key] ?? $default;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
-     */
-    public function has(string $key): bool
-    {
-        return key_exists($key, $this->config);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
+	 */
+	public function has(string $key): bool
+	{
+		return key_exists($key, $this->config);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \JsonSerializable::jsonSerialize()
-     */
-    public function jsonSerialize()
-    {
-        return [
-            'class'     =>  get_class($this),
-            'config'    =>  $this->jsonSerializeConfig()
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \JsonSerializable::jsonSerialize()
+	 */
+	public function jsonSerialize()
+	{
+		return [
+			'class'     =>  get_class($this),
+			'config'    =>  $this->jsonSerializeConfig()
+		];
+	}
 
-    /**
-     * Returns a representation of the mapper config compatible with Json serialisation
-     *
-     * @return mixed
-     */
-    public function jsonSerializeConfig()
-    {
-        return $this->config;
-    }
+	/**
+	 * Returns a representation of the mapper config compatible with Json serialisation
+	 *
+	 * @return mixed
+	 */
+	public function jsonSerializeConfig()
+	{
+		return $this->config;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
-     *
-     * @param mixed $config
-     * @return $this
-     */
-    public function jsonDeserialize($config): self
-    {
-        if (is_string($config)) {
-            return $this->jsonDeserialize(json_decode($config));
-        }
-        if (is_array($config)) {
-            return $this->setConfig($config);
-        }
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
+	 *
+	 * @param mixed $config
+	 * @return $this
+	 */
+	public function jsonDeserialize($config): self
+	{
+		if (is_string($config)) {
+			return $this->jsonDeserialize(json_decode($config));
+		}
+		if (is_array($config)) {
+			return $this->setConfig($config);
+		}
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::configContent()
-     */
-    public function configContent(ModuleInterface $module, Tree $tree): string
-    {
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::configContent()
+	 */
+	public function configContent(ModuleInterface $module, Tree $tree): string
+	{
+		return '';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::withConfigUpdate()
-     * @return $this
-     */
-    public function withConfigUpdate(ServerRequestInterface $request): self
-    {
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::withConfigUpdate()
+	 * @return $this
+	 */
+	public function withConfigUpdate(ServerRequestInterface $request): self
+	{
+		return $this;
+	}
 }

app/Common/Tasks/TaskSchedule.php

Indentation +229 added lines, -229 removed lines

@@ -24,252 +24,252 @@
  */
 class TaskSchedule
 {
-    private int $id;
-    private bool $enabled;
-    private string $task_id;
-    private Carbon $last_run;
-    private bool $last_result;
-    private CarbonInterval $frequency;
-    private int $nb_occurrences;
-    private bool $is_running;
+	private int $id;
+	private bool $enabled;
+	private string $task_id;
+	private Carbon $last_run;
+	private bool $last_result;
+	private CarbonInterval $frequency;
+	private int $nb_occurrences;
+	private bool $is_running;
 
-    /**
-     * Constructor for TaskSchedule
-     *
-     * @param int $id Schedule ID
-     * @param string $task_id Task ID
-     * @param bool $enabled Is the schedule enabled
-     * @param Carbon $last_run Last successful run date/time
-     * @param bool $last_result Result of the last run
-     * @param CarbonInterval $frequency Schedule frequency
-     * @param int $nb_occurrences Number of remaining occurrences to be run
-     * @param bool $is_running Is the task currently running
-     */
-    public function __construct(
-        int $id,
-        string $task_id,
-        bool $enabled,
-        Carbon $last_run,
-        bool $last_result,
-        CarbonInterval $frequency,
-        int $nb_occurrences,
-        bool $is_running
-    ) {
-        $this->id = $id;
-        $this->task_id = $task_id;
-        $this->enabled = $enabled;
-        $this->last_run = $last_run;
-        $this->last_result = $last_result;
-        $this->frequency = $frequency;
-        $this->nb_occurrences = $nb_occurrences;
-        $this->is_running = $is_running;
-    }
+	/**
+	 * Constructor for TaskSchedule
+	 *
+	 * @param int $id Schedule ID
+	 * @param string $task_id Task ID
+	 * @param bool $enabled Is the schedule enabled
+	 * @param Carbon $last_run Last successful run date/time
+	 * @param bool $last_result Result of the last run
+	 * @param CarbonInterval $frequency Schedule frequency
+	 * @param int $nb_occurrences Number of remaining occurrences to be run
+	 * @param bool $is_running Is the task currently running
+	 */
+	public function __construct(
+		int $id,
+		string $task_id,
+		bool $enabled,
+		Carbon $last_run,
+		bool $last_result,
+		CarbonInterval $frequency,
+		int $nb_occurrences,
+		bool $is_running
+	) {
+		$this->id = $id;
+		$this->task_id = $task_id;
+		$this->enabled = $enabled;
+		$this->last_run = $last_run;
+		$this->last_result = $last_result;
+		$this->frequency = $frequency;
+		$this->nb_occurrences = $nb_occurrences;
+		$this->is_running = $is_running;
+	}
 
-    /**
-     * Get the schedule ID.
-     *
-     * @return int
-     */
-    public function id(): int
-    {
-        return $this->id;
-    }
+	/**
+	 * Get the schedule ID.
+	 *
+	 * @return int
+	 */
+	public function id(): int
+	{
+		return $this->id;
+	}
 
-    /**
-     * Get the task ID.
-     *
-     * @return string
-     */
-    public function taskId(): string
-    {
-        return $this->task_id;
-    }
+	/**
+	 * Get the task ID.
+	 *
+	 * @return string
+	 */
+	public function taskId(): string
+	{
+		return $this->task_id;
+	}
 
-    /**
-     * Returns whether the schedule is enabled
-     *
-     * @return bool
-     */
-    public function isEnabled(): bool
-    {
-        return $this->enabled;
-    }
+	/**
+	 * Returns whether the schedule is enabled
+	 *
+	 * @return bool
+	 */
+	public function isEnabled(): bool
+	{
+		return $this->enabled;
+	}
 
-    /**
-     * Enable the schedule
-     *
-     * @return $this
-     */
-    public function enable(): self
-    {
-        $this->enabled = true;
-        return $this;
-    }
+	/**
+	 * Enable the schedule
+	 *
+	 * @return $this
+	 */
+	public function enable(): self
+	{
+		$this->enabled = true;
+		return $this;
+	}
 
-    /**
-     * Disable the schedule
-     *
-     * @return $this
-     */
-    public function disable(): self
-    {
-        $this->enabled = false;
-        return $this;
-    }
+	/**
+	 * Disable the schedule
+	 *
+	 * @return $this
+	 */
+	public function disable(): self
+	{
+		$this->enabled = false;
+		return $this;
+	}
 
-    /**
-     * Get the frequency of the schedule
-     *
-     * @return CarbonInterval
-     */
-    public function frequency(): CarbonInterval
-    {
-        return $this->frequency;
-    }
+	/**
+	 * Get the frequency of the schedule
+	 *
+	 * @return CarbonInterval
+	 */
+	public function frequency(): CarbonInterval
+	{
+		return $this->frequency;
+	}
 
-    /**
-     * Set the frequency of the schedule
-     *
-     * @param CarbonInterval $frequency
-     * @return $this
-     */
-    public function setFrequency(CarbonInterval $frequency): self
-    {
-        $this->frequency = $frequency;
-        return $this;
-    }
+	/**
+	 * Set the frequency of the schedule
+	 *
+	 * @param CarbonInterval $frequency
+	 * @return $this
+	 */
+	public function setFrequency(CarbonInterval $frequency): self
+	{
+		$this->frequency = $frequency;
+		return $this;
+	}
 
-    /**
-     * Get the date/time of the last successful run.
-     *
-     * @return Carbon
-     */
-    public function lastRunTime(): Carbon
-    {
-        return $this->last_run;
-    }
+	/**
+	 * Get the date/time of the last successful run.
+	 *
+	 * @return Carbon
+	 */
+	public function lastRunTime(): Carbon
+	{
+		return $this->last_run;
+	}
 
-    /**
-     * Set the last successful run date/time
-     *
-     * @param Carbon $last_run
-     * @return $this
-     */
-    public function setLastRunTime(Carbon $last_run): self
-    {
-        $this->last_run = $last_run;
-        return $this;
-    }
+	/**
+	 * Set the last successful run date/time
+	 *
+	 * @param Carbon $last_run
+	 * @return $this
+	 */
+	public function setLastRunTime(Carbon $last_run): self
+	{
+		$this->last_run = $last_run;
+		return $this;
+	}
 
-    /**
-     * Returns whether the last run was successful
-     *
-     * @return bool
-     */
-    public function wasLastRunSuccess(): bool
-    {
-        return $this->last_result;
-    }
+	/**
+	 * Returns whether the last run was successful
+	 *
+	 * @return bool
+	 */
+	public function wasLastRunSuccess(): bool
+	{
+		return $this->last_result;
+	}
 
-    /**
-     * Set the last run result
-     *
-     * @param bool $last_result
-     * @return $this
-     */
-    public function setLastResult(bool $last_result): self
-    {
-        $this->last_result = $last_result;
-        return $this;
-    }
+	/**
+	 * Set the last run result
+	 *
+	 * @param bool $last_result
+	 * @return $this
+	 */
+	public function setLastResult(bool $last_result): self
+	{
+		$this->last_result = $last_result;
+		return $this;
+	}
 
-    /**
-     * Get the number of remaining of occurrences of task runs.
-     * Returns 0 if the tasks must be run indefinitely.
-     *
-     * @return int
-     */
-    public function remainingOccurences(): int
-    {
-        return $this->nb_occurrences;
-    }
+	/**
+	 * Get the number of remaining of occurrences of task runs.
+	 * Returns 0 if the tasks must be run indefinitely.
+	 *
+	 * @return int
+	 */
+	public function remainingOccurences(): int
+	{
+		return $this->nb_occurrences;
+	}
 
-    /**
-     * Decrements the number of remaining occurences by 1.
-     * The task will be disabled when the number reaches 0.
-     *
-     * @return $this
-     */
-    public function decrementRemainingOccurences(): self
-    {
-        if ($this->nb_occurrences > 0) {
-            $this->nb_occurrences--;
-            if ($this->nb_occurrences == 0) {
-                $this->disable();
-            }
-        }
-        return $this;
-    }
+	/**
+	 * Decrements the number of remaining occurences by 1.
+	 * The task will be disabled when the number reaches 0.
+	 *
+	 * @return $this
+	 */
+	public function decrementRemainingOccurences(): self
+	{
+		if ($this->nb_occurrences > 0) {
+			$this->nb_occurrences--;
+			if ($this->nb_occurrences == 0) {
+				$this->disable();
+			}
+		}
+		return $this;
+	}
 
-    /**
-     * Set the number of remaining occurences of task runs.
-     *
-     * @param int $nb_occurrences
-     * @return $this
-     */
-    public function setRemainingOccurences(int $nb_occurrences): self
-    {
-        $this->nb_occurrences = $nb_occurrences;
-        return $this;
-    }
+	/**
+	 * Set the number of remaining occurences of task runs.
+	 *
+	 * @param int $nb_occurrences
+	 * @return $this
+	 */
+	public function setRemainingOccurences(int $nb_occurrences): self
+	{
+		$this->nb_occurrences = $nb_occurrences;
+		return $this;
+	}
 
-    /**
-     * Returns whether the task is running
-     * @return bool
-     */
-    public function isRunning(): bool
-    {
-        return $this->is_running;
-    }
+	/**
+	 * Returns whether the task is running
+	 * @return bool
+	 */
+	public function isRunning(): bool
+	{
+		return $this->is_running;
+	}
 
-    /**
-     * Informs the schedule that the task is going to run
-     *
-     * @return $this
-     */
-    public function startRunning(): self
-    {
-        $this->is_running = true;
-        return $this;
-    }
+	/**
+	 * Informs the schedule that the task is going to run
+	 *
+	 * @return $this
+	 */
+	public function startRunning(): self
+	{
+		$this->is_running = true;
+		return $this;
+	}
 
-    /**
-     * Informs the schedule that the task has stopped running.
-     * @return $this
-     */
-    public function stopRunning(): self
-    {
-        $this->is_running = false;
-        return $this;
-    }
+	/**
+	 * Informs the schedule that the task has stopped running.
+	 * @return $this
+	 */
+	public function stopRunning(): self
+	{
+		$this->is_running = false;
+		return $this;
+	}
 
-    /**
-     * Returns the schedule details as an associate array
-     *
-     * @phpcs:ignore Generic.Files.LineLength.TooLong
-     * @return array{id: int, task_id: string, enabled: bool, last_run: Carbon, last_result: bool, frequency: CarbonInterval, nb_occurrences: int, is_running: bool}
-     */
-    public function toArray(): array
-    {
-        return [
-            'id'            =>  $this->id,
-            'task_id'       =>  $this->task_id,
-            'enabled'       =>  $this->enabled,
-            'last_run'      =>  $this->last_run,
-            'last_result'   =>  $this->last_result,
-            'frequency'     =>  $this->frequency,
-            'nb_occurrences' =>  $this->nb_occurrences,
-            'is_running'    =>  $this->is_running
-        ];
-    }
+	/**
+	 * Returns the schedule details as an associate array
+	 *
+	 * @phpcs:ignore Generic.Files.LineLength.TooLong
+	 * @return array{id: int, task_id: string, enabled: bool, last_run: Carbon, last_result: bool, frequency: CarbonInterval, nb_occurrences: int, is_running: bool}
+	 */
+	public function toArray(): array
+	{
+		return [
+			'id'            =>  $this->id,
+			'task_id'       =>  $this->task_id,
+			'enabled'       =>  $this->enabled,
+			'last_run'      =>  $this->last_run,
+			'last_result'   =>  $this->last_result,
+			'frequency'     =>  $this->frequency,
+			'nb_occurrences' =>  $this->nb_occurrences,
+			'is_running'    =>  $this->is_running
+		];
+	}
 }