jon48 / webtrees-lib

app/Common/GeoDispersion/Config/GenericPlaceMapperConfig.php

Indentation +93 added lines, -93 removed lines

@@ -25,106 +25,106 @@
  */
 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()
-     */
-    #[\ReturnTypeWillChange]
-    public function jsonSerialize()
-    {
-        return [
-            'class'     =>  get_class($this),
-            'config'    =>  $this->jsonSerializeConfig()
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \JsonSerializable::jsonSerialize()
+	 */
+	#[\ReturnTypeWillChange]
+	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((array) 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((array) 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/GeoDispersion/Config/NullPlaceMapperConfig.php

Indentation +53 added lines, -53 removed lines

@@ -26,62 +26,62 @@
  */
 class NullPlaceMapperConfig implements PlaceMapperConfigInterface
 {
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
-     */
-    public function get(string $key, $default = null)
-    {
-        return $default;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
+	 */
+	public function get(string $key, $default = null)
+	{
+		return $default;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
-     */
-    public function has(string $key): bool
-    {
-        return false;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
+	 */
+	public function has(string $key): bool
+	{
+		return false;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
-     *
-     * @param mixed $config
-     * @return $this
-     */
-    public function jsonDeserialize($config): self
-    {
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
+	 *
+	 * @param mixed $config
+	 * @return $this
+	 */
+	public function jsonDeserialize($config): self
+	{
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see JsonSerializable::jsonSerialize()
-     */
-    #[\ReturnTypeWillChange]
-    public function jsonSerialize()
-    {
-        return [];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see JsonSerializable::jsonSerialize()
+	 */
+	#[\ReturnTypeWillChange]
+	public function jsonSerialize()
+	{
+		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::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/GeoDispersion/Config/MapColorsConfig.php

Indentation +82 added lines, -82 removed lines

@@ -23,93 +23,93 @@
  */
 class MapColorsConfig implements JsonSerializable
 {
-    private Color $default;
-    private Color $stroke;
-    private Color $max_value;
-    private Color $hover;
+	private Color $default;
+	private Color $stroke;
+	private Color $max_value;
+	private Color $hover;
 
-    /**
-     * Constructor for MapColorsConfig
-     *
-     * @param Color $default
-     * @param Color $stroke
-     * @param Color $max_value
-     * @param Color $hover
-     */
-    public function __construct(
-        Color $default,
-        Color $stroke,
-        Color $max_value,
-        Color $hover
-    ) {
-        $this->default = $default;
-        $this->stroke = $stroke;
-        $this->max_value = $max_value;
-        $this->hover = $hover;
-    }
+	/**
+	 * Constructor for MapColorsConfig
+	 *
+	 * @param Color $default
+	 * @param Color $stroke
+	 * @param Color $max_value
+	 * @param Color $hover
+	 */
+	public function __construct(
+		Color $default,
+		Color $stroke,
+		Color $max_value,
+		Color $hover
+	) {
+		$this->default = $default;
+		$this->stroke = $stroke;
+		$this->max_value = $max_value;
+		$this->hover = $hover;
+	}
 
-    /**
-     * Get the default color for the features
-     *
-     * @return Color
-     */
-    public function defaultColor(): Color
-    {
-        return $this->default;
-    }
+	/**
+	 * Get the default color for the features
+	 *
+	 * @return Color
+	 */
+	public function defaultColor(): Color
+	{
+		return $this->default;
+	}
 
-    /**
-     * Get the color for the features' strokes
-     *
-     * @return Color
-     */
-    public function strokeColor(): Color
-    {
-        return $this->stroke;
-    }
+	/**
+	 * Get the color for the features' strokes
+	 *
+	 * @return Color
+	 */
+	public function strokeColor(): Color
+	{
+		return $this->stroke;
+	}
 
-    /**
-     * Get the color for the features with the lowest count
-     *
-     * @return Color
-     */
-    public function minValueColor(): Color
-    {
-        return new Rgb(255, 255, 255);
-    }
+	/**
+	 * Get the color for the features with the lowest count
+	 *
+	 * @return Color
+	 */
+	public function minValueColor(): Color
+	{
+		return new Rgb(255, 255, 255);
+	}
 
-    /**
-     * Get the color for the features with the highest count
-     *
-     * @return Color
-     */
-    public function maxValueColor(): Color
-    {
-        return $this->max_value;
-    }
+	/**
+	 * Get the color for the features with the highest count
+	 *
+	 * @return Color
+	 */
+	public function maxValueColor(): Color
+	{
+		return $this->max_value;
+	}
 
-    /**
-     * Get the color for feature hovering
-     *
-     * @return Color
-     */
-    public function hoverColor(): Color
-    {
-        return $this->hover;
-    }
+	/**
+	 * Get the color for feature hovering
+	 *
+	 * @return Color
+	 */
+	public function hoverColor(): Color
+	{
+		return $this->hover;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see JsonSerializable::jsonSerialize()
-     */
-    #[\ReturnTypeWillChange]
-    public function jsonSerialize()
-    {
-        return [
-            'default'   => (string) $this->defaultColor()->toHex(),
-            'stroke'    => (string) $this->strokeColor()->toHex(),
-            'maxvalue'  => (string) $this->maxValueColor()->toHex(),
-            'hover'     => (string) $this->hoverColor()->toHex(),
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see JsonSerializable::jsonSerialize()
+	 */
+	#[\ReturnTypeWillChange]
+	public function jsonSerialize()
+	{
+		return [
+			'default'   => (string) $this->defaultColor()->toHex(),
+			'stroke'    => (string) $this->strokeColor()->toHex(),
+			'maxvalue'  => (string) $this->maxValueColor()->toHex(),
+			'hover'     => (string) $this->hoverColor()->toHex(),
+		];
+	}
 }

app/Module/IsSourced/Services/SourceStatusService.php

Indentation +143 added lines, -143 removed lines

@@ -30,147 +30,147 @@
  */
 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;
-
-    /**
-     * Extract gedcom for all source citations of a fact.
-     * Logic removed from \Fisharebest\Webtrees\Fact.
-     *
-     * @param Fact $fact
-     * @return string[]
-     */
-    private function extractCitations(Fact $fact)
-    {
-        $extract_regex = '/\n(2 SOUR @(' . Gedcom::REGEX_XREF . ')@(?:\n[3-9] .*)*)/';
-        preg_match_all($extract_regex, $fact->gedcom(), $matches, PREG_SET_ORDER);
-        $citations = [];
-        foreach ($matches as $match) {
-            $source = Registry::sourceFactory()->make($match[2], $fact->record()->tree());
-            if ($source !== null && $source->canShow()) {
-                $citations[] = $match[1];
-            }
-        }
-        return $citations;
-    }
-
-    /**
-     * 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 ($this->extractCitations($fact) 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 = [...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;
+
+	/**
+	 * Extract gedcom for all source citations of a fact.
+	 * Logic removed from \Fisharebest\Webtrees\Fact.
+	 *
+	 * @param Fact $fact
+	 * @return string[]
+	 */
+	private function extractCitations(Fact $fact)
+	{
+		$extract_regex = '/\n(2 SOUR @(' . Gedcom::REGEX_XREF . ')@(?:\n[3-9] .*)*)/';
+		preg_match_all($extract_regex, $fact->gedcom(), $matches, PREG_SET_ORDER);
+		$citations = [];
+		foreach ($matches as $match) {
+			$source = Registry::sourceFactory()->make($match[2], $fact->record()->tree());
+			if ($source !== null && $source->canShow()) {
+				$citations[] = $match[1];
+			}
+		}
+		return $citations;
+	}
+
+	/**
+	 * 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 ($this->extractCitations($fact) 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 = [...Gedcom::MARRIAGE_EVENTS, 'MARC', 'MARL', 'MARS'];
+		return $this->sourceStatusForFactsWithTags($family, $marr_events);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
      */
     private function extractCitations(Fact $fact)
     {
-        $extract_regex = '/\n(2 SOUR @(' . Gedcom::REGEX_XREF . ')@(?:\n[3-9] .*)*)/';
+        $extract_regex = '/\n(2 SOUR @('.Gedcom::REGEX_XREF.')@(?:\n[3-9] .*)*)/';
         preg_match_all($extract_regex, $fact->gedcom(), $matches, PREG_SET_ORDER);
         $citations = [];
         foreach ($matches as $match) {

app/Module/GeoDispersion/Model/GeoAnalysisMapAdapter.php

Indentation +187 added lines, -187 removed lines

@@ -29,191 +29,191 @@
  */
 class GeoAnalysisMapAdapter
 {
-    private int $id;
-    private int $view_id;
-    private MapDefinitionInterface $map;
-    private PlaceMapperInterface $place_mapper;
-    private MapViewConfigInterface $config;
-
-    /**
-     * Constructor for GeoAnalysisMapAdapter
-     *
-     * @param int $id
-     * @param MapDefinitionInterface $map
-     * @param PlaceMapperInterface $mapper
-     * @param MapViewConfigInterface $config
-     */
-    public function __construct(
-        int $id,
-        int $view_id,
-        MapDefinitionInterface $map,
-        PlaceMapperInterface $mapper,
-        MapViewConfigInterface $config
-    ) {
-        $this->id = $id;
-        $this->view_id = $view_id;
-        $this->map = $map;
-        $this->place_mapper = $mapper;
-        $this->config = $config;
-        $this->place_mapper->setConfig($this->config->mapperConfig());
-        $this->place_mapper->setData('map', $map);
-        $this->place_mapper->boot();
-    }
-
-    /**
-     * Create a copy of the GeoAnalysisMapAdapter with new properties.
-     *
-     * @param MapDefinitionInterface $map
-     * @param PlaceMapperInterface $mapper
-     * @param string $mapping_property
-     * @return static
-     */
-    public function with(
-        MapDefinitionInterface $map,
-        PlaceMapperInterface $mapper,
-        string $mapping_property
-    ): self {
-        $new = clone $this;
-        $new->map = $map;
-        $new->place_mapper = $mapper;
-        $new->config = $this->config->with($mapping_property, $mapper->config());
-        return $new;
-    }
-
-    /**
-     * Get the GeoAnalysisMapAdapter ID
-     *
-     * @return int
-     */
-    public function id(): int
-    {
-        return $this->id;
-    }
-
-    /**
-     * Get the ID of the associated GeoAnalysisView
-     *
-     * @return int
-     */
-    public function geoAnalysisViewId(): int
-    {
-        return $this->view_id;
-    }
-
-    /**
-     * Get the associated target map
-     *
-     * @return MapDefinitionInterface
-     */
-    public function map(): MapDefinitionInterface
-    {
-        return $this->map;
-    }
-
-    /**
-     * Get the Place Mapper used for the mapping
-     *
-     * @return PlaceMapperInterface
-     */
-    public function placeMapper(): PlaceMapperInterface
-    {
-        return $this->place_mapper;
-    }
-
-    /**
-     * Get the configuration of the Map View.
-     *
-     * @return MapViewConfigInterface
-     */
-    public function viewConfig(): MapViewConfigInterface
-    {
-        return $this->config;
-    }
-
-    /**
-     * Convert the geographical analysis result to a MapAdapter result for usage in the Map View
-     *
-     * @param GeoAnalysisResult $result
-     * @return MapAdapterResult
-     */
-    public function convert(GeoAnalysisResult $result): MapAdapterResult
-    {
-        $result = $result->copy();
-
-        $features = [];
-        list($features_data, $result) = $this->featureAnalysisData($result);
-
-        $places_found = $result->countFound();
-        foreach ($this->map->features() as $feature) {
-            $feature_id = $this->featureId($feature);
-            if ($feature_id !== null && $features_data->has($feature_id)) {
-                /** @var MapFeatureAnalysisData $feature_data */
-                $feature_data = $features_data->get($feature_id)->tagAsExisting();
-                $place_count = $feature_data->count();
-                $features[] = $feature
-                    ->withProperty('count', $place_count)
-                    ->withProperty('ratio', $places_found > 0 ? $place_count / $places_found : 0)
-                    ->withProperty(
-                        'places',
-                        $feature_data->places()
-                            ->map(fn(GeoAnalysisPlace $place): string => $place->place()->firstParts(1)->first())
-                            ->sort(I18N::comparator())
-                            ->toArray()
-                    );
-            } else {
-                $features[] = $feature;
-            }
-        }
-
-        $features_data
-            ->filter(fn(MapFeatureAnalysisData $data) => !$data->existsInMap())
-            ->each(
-                fn (MapFeatureAnalysisData $data) =>
-                    $data->places()->each(
-                        function (GeoAnalysisPlace $place) use ($result): void {
-                            $result->exclude($place);
-                        }
-                    )
-            );
-
-        return new MapAdapterResult($result, $features);
-    }
-
-    /**
-     * Populate the map features with the mapped Places and total count
-     *
-     * @param GeoAnalysisResult $result
-     * @return mixed[]
-     */
-    protected function featureAnalysisData(GeoAnalysisResult $result): array
-    {
-        $features_mapping = new Collection();
-
-        $byplaces = $result->knownPlaces();
-        $byplaces->each(function (GeoAnalysisResultItem $item) use ($features_mapping, $result): void {
-            $id = $this->place_mapper->map($item->place()->place(), $this->config->mapMappingProperty());
-
-            if ($id !== null && mb_strlen($id) > 0) {
-                $features_mapping->put(
-                    $id,
-                    $features_mapping->get($id, new MapFeatureAnalysisData())->add($item->place(), $item->count())
-                );
-            } else {
-                $result->exclude($item->place());
-            }
-        });
-
-        return [ $features_mapping, $result];
-    }
-
-    /**
-     * Get the value of the feature property used for the mapping
-     *
-     * @param Feature $feature
-     * @return string|NULL
-     */
-    protected function featureId(Feature $feature): ?string
-    {
-        return $feature->getProperty($this->config->mapMappingProperty());
-    }
+	private int $id;
+	private int $view_id;
+	private MapDefinitionInterface $map;
+	private PlaceMapperInterface $place_mapper;
+	private MapViewConfigInterface $config;
+
+	/**
+	 * Constructor for GeoAnalysisMapAdapter
+	 *
+	 * @param int $id
+	 * @param MapDefinitionInterface $map
+	 * @param PlaceMapperInterface $mapper
+	 * @param MapViewConfigInterface $config
+	 */
+	public function __construct(
+		int $id,
+		int $view_id,
+		MapDefinitionInterface $map,
+		PlaceMapperInterface $mapper,
+		MapViewConfigInterface $config
+	) {
+		$this->id = $id;
+		$this->view_id = $view_id;
+		$this->map = $map;
+		$this->place_mapper = $mapper;
+		$this->config = $config;
+		$this->place_mapper->setConfig($this->config->mapperConfig());
+		$this->place_mapper->setData('map', $map);
+		$this->place_mapper->boot();
+	}
+
+	/**
+	 * Create a copy of the GeoAnalysisMapAdapter with new properties.
+	 *
+	 * @param MapDefinitionInterface $map
+	 * @param PlaceMapperInterface $mapper
+	 * @param string $mapping_property
+	 * @return static
+	 */
+	public function with(
+		MapDefinitionInterface $map,
+		PlaceMapperInterface $mapper,
+		string $mapping_property
+	): self {
+		$new = clone $this;
+		$new->map = $map;
+		$new->place_mapper = $mapper;
+		$new->config = $this->config->with($mapping_property, $mapper->config());
+		return $new;
+	}
+
+	/**
+	 * Get the GeoAnalysisMapAdapter ID
+	 *
+	 * @return int
+	 */
+	public function id(): int
+	{
+		return $this->id;
+	}
+
+	/**
+	 * Get the ID of the associated GeoAnalysisView
+	 *
+	 * @return int
+	 */
+	public function geoAnalysisViewId(): int
+	{
+		return $this->view_id;
+	}
+
+	/**
+	 * Get the associated target map
+	 *
+	 * @return MapDefinitionInterface
+	 */
+	public function map(): MapDefinitionInterface
+	{
+		return $this->map;
+	}
+
+	/**
+	 * Get the Place Mapper used for the mapping
+	 *
+	 * @return PlaceMapperInterface
+	 */
+	public function placeMapper(): PlaceMapperInterface
+	{
+		return $this->place_mapper;
+	}
+
+	/**
+	 * Get the configuration of the Map View.
+	 *
+	 * @return MapViewConfigInterface
+	 */
+	public function viewConfig(): MapViewConfigInterface
+	{
+		return $this->config;
+	}
+
+	/**
+	 * Convert the geographical analysis result to a MapAdapter result for usage in the Map View
+	 *
+	 * @param GeoAnalysisResult $result
+	 * @return MapAdapterResult
+	 */
+	public function convert(GeoAnalysisResult $result): MapAdapterResult
+	{
+		$result = $result->copy();
+
+		$features = [];
+		list($features_data, $result) = $this->featureAnalysisData($result);
+
+		$places_found = $result->countFound();
+		foreach ($this->map->features() as $feature) {
+			$feature_id = $this->featureId($feature);
+			if ($feature_id !== null && $features_data->has($feature_id)) {
+				/** @var MapFeatureAnalysisData $feature_data */
+				$feature_data = $features_data->get($feature_id)->tagAsExisting();
+				$place_count = $feature_data->count();
+				$features[] = $feature
+					->withProperty('count', $place_count)
+					->withProperty('ratio', $places_found > 0 ? $place_count / $places_found : 0)
+					->withProperty(
+						'places',
+						$feature_data->places()
+							->map(fn(GeoAnalysisPlace $place): string => $place->place()->firstParts(1)->first())
+							->sort(I18N::comparator())
+							->toArray()
+					);
+			} else {
+				$features[] = $feature;
+			}
+		}
+
+		$features_data
+			->filter(fn(MapFeatureAnalysisData $data) => !$data->existsInMap())
+			->each(
+				fn (MapFeatureAnalysisData $data) =>
+					$data->places()->each(
+						function (GeoAnalysisPlace $place) use ($result): void {
+							$result->exclude($place);
+						}
+					)
+			);
+
+		return new MapAdapterResult($result, $features);
+	}
+
+	/**
+	 * Populate the map features with the mapped Places and total count
+	 *
+	 * @param GeoAnalysisResult $result
+	 * @return mixed[]
+	 */
+	protected function featureAnalysisData(GeoAnalysisResult $result): array
+	{
+		$features_mapping = new Collection();
+
+		$byplaces = $result->knownPlaces();
+		$byplaces->each(function (GeoAnalysisResultItem $item) use ($features_mapping, $result): void {
+			$id = $this->place_mapper->map($item->place()->place(), $this->config->mapMappingProperty());
+
+			if ($id !== null && mb_strlen($id) > 0) {
+				$features_mapping->put(
+					$id,
+					$features_mapping->get($id, new MapFeatureAnalysisData())->add($item->place(), $item->count())
+				);
+			} else {
+				$result->exclude($item->place());
+			}
+		});
+
+		return [ $features_mapping, $result];
+	}
+
+	/**
+	 * Get the value of the feature property used for the mapping
+	 *
+	 * @param Feature $feature
+	 * @return string|NULL
+	 */
+	protected function featureId(Feature $feature): ?string
+	{
+		return $feature->getProperty($this->config->mapMappingProperty());
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -156,7 +156,7 @@ 
                     ->withProperty(
                         'places',
                         $feature_data->places()
-                            ->map(fn(GeoAnalysisPlace $place): string => $place->place()->firstParts(1)->first())
+                            ->map(fn(GeoAnalysisPlace $place) : string => $place->place()->firstParts(1)->first())
                             ->sort(I18N::comparator())
                             ->toArray()
                     );
@@ -170,7 +170,7 @@ 
             ->each(
                 fn (MapFeatureAnalysisData $data) =>
                     $data->places()->each(
-                        function (GeoAnalysisPlace $place) use ($result): void {
+                        function(GeoAnalysisPlace $place) use ($result): void {
                             $result->exclude($place);
                         }
                     )
@@ -190,7 +190,7 @@ 
         $features_mapping = new Collection();
 
         $byplaces = $result->knownPlaces();
-        $byplaces->each(function (GeoAnalysisResultItem $item) use ($features_mapping, $result): void {
+        $byplaces->each(function(GeoAnalysisResultItem $item) use ($features_mapping, $result): void {
             $id = $this->place_mapper->map($item->place()->place(), $this->config->mapMappingProperty());
 
             if ($id !== null && mb_strlen($id) > 0) {
@@ -203,7 +203,7 @@ 
             }
         });
 
-        return [ $features_mapping, $result];
+        return [$features_mapping, $result];
     }
 
     /**

app/Module/GeoDispersion/PlaceMappers/CoordinatesPlaceMapper.php

Indentation +184 added lines, -184 removed lines

@@ -36,188 +36,188 @@
  */
 class CoordinatesPlaceMapper implements PlaceMapperInterface
 {
-    use PlaceMapperTrait;
-
-    private ?string $cache_key = null;
-    private ?GeometryEngine $geometry_engine = null;
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Mapping on place coordinates');
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * {@internal The Place is associated to a Point only.
-     * PlaceLocation can calculate a BoundingBox.
-     * Using a BoundingBox could make the mapping more complex and potentially arbitary.
-     * Furthermore, when no coordinate is found for the place or its children, then it bubbles up to the parents.
-     * This could create the unwanted side effect of a very large area to consider}
-     *
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::map()
-     */
-    public function map(Place $place, string $feature_property): ?string
-    {
-        $location = new PlaceLocation($place->gedcomName());
-        $longitude = $location->longitude();
-        $latitude = $location->latitude();
-        if ($longitude === null || $latitude === null) {
-            return null;
-        }
-
-        $features_index = $this->featuresIndex();
-        if ($features_index === null) {
-            return null;
-        }
-
-        $place_point = Point::xy($longitude, $latitude, $features_index['SRID']);
-        $grid_box = $this->getGridCell(
-            $place_point,
-            $features_index['map_NE'],
-            $features_index['map_SW'],
-            $features_index['nb_columns']
-        );
-        if ($grid_box === null || !$this->setGeometryEngine() || $this->geometry_engine == null) {
-            return null;
-        }
-        $features = $features_index['grid'][$grid_box[0]][$grid_box[1]];
-        foreach ($features as $feature) {
-            $geometry = $feature->getGeometry();
-            if (
-                $geometry !== null && $place_point->SRID() === $geometry->SRID() &&
-                $this->geometry_engine->contains($geometry, $place_point)
-            ) {
-                return $feature->getProperty($feature_property);
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Return the XY coordinates in a bounded grid of the cell containing a specific point.
-     *
-     * @param Point $point Point to find
-     * @param Point $grid_NE North-East point of the bounded grid
-     * @param Point $grid_SW South-West point fo the bounded grid
-     * @param int $grid_columns Number of columns/rows in the grid
-     * @return int[]|NULL
-     */
-    protected function getGridCell(Point $point, Point $grid_NE, Point $grid_SW, int $grid_columns): ?array
-    {
-        list($x, $y) = $point->toArray();
-        list($x_max, $y_max) = $grid_NE->toArray();
-        list($x_min, $y_min) = $grid_SW->toArray();
-
-        $x_step = ($x_max - $x_min) / $grid_columns;
-        $y_step = ($y_max - $y_min) / $grid_columns;
-
-        if ($x_min <= $x && $x <= $x_max && $y_min <= $y && $y <= $y_max) {
-            return [
-                $x === $x_max ? $grid_columns - 1 : intval(($x - $x_min) / $x_step),
-                $y === $y_max ? $grid_columns - 1 : intval(($y - $y_min) / $y_step)
-            ];
-        }
-        return null;
-    }
-
-    /**
-     * Get an indexed array of the features of the map.
-     *
-     * {@internal The map is divided in a grid, eacg cell containing the features which bounding box overlaps that cell.
-     * The grid is computed once for each map, and cached.}
-     *
-     * @phpcs:ignore Generic.Files.LineLength.TooLong
-     * @return array{grid: array<int, array<int, \Brick\Geo\IO\GeoJSON\Feature[]>>, nb_columns: int, map_NE: \Brick\Geo\Point, map_SW: \Brick\Geo\Point, SRID: int}|NULL
-     */
-    protected function featuresIndex(): ?array
-    {
-        $cacheKey = $this->cacheKey();
-        if ($cacheKey === null) {
-            return null;
-        }
-        return Registry::cache()->array()->remember($cacheKey, function (): ?array {
-            $map_def = $this->data('map');
-            if (
-                !$this->setGeometryEngine()
-                || $map_def === null
-                || !($map_def instanceof MapDefinitionInterface)
-            ) {
-                return null;
-            }
-            $bounding_boxes = [];
-            $map_bounding_box = new BoundingBox();
-            $srid = 0;
-            foreach ($map_def->features() as $feature) {
-                $geometry = $feature->getGeometry();
-                if ($geometry === null) {
-                    continue;
-                }
-                $srid = $geometry->SRID();
-                $bounding_box = $geometry->getBoundingBox();
-                $bounding_boxes[] = [$feature, $bounding_box];
-                $map_bounding_box = $map_bounding_box->extendedWithBoundingBox($bounding_box);
-            }
-            $grid_columns = count($bounding_boxes);
-            $grid = array_fill(0, $grid_columns, array_fill(0, $grid_columns, []));
-            $map_NE = $map_bounding_box->getNorthEast();
-            $map_SW = $map_bounding_box->getSouthWest();
-            foreach ($bounding_boxes as $item) {
-                $grid_box_SW = $this->getGridCell($item[1]->getSouthWest(), $map_NE, $map_SW, $grid_columns) ?? [1, 1];
-                $grid_box_NE = $this->getGridCell($item[1]->getNorthEast(), $map_NE, $map_SW, $grid_columns) ?? [0, 0];
-                for ($i = $grid_box_SW[0]; $i <= $grid_box_NE[0]; $i++) {
-                    for ($j = $grid_box_SW[1]; $j <= $grid_box_NE[1]; $j++) {
-                        $grid[$i][$j][] = $item[0];
-                    }
-                }
-            }
-            return [
-                'grid'          =>  $grid,
-                'nb_columns'    =>  $grid_columns,
-                'map_NE'        =>  $map_NE,
-                'map_SW'        =>  $map_SW,
-                'SRID'          =>  $srid
-            ];
-        });
-    }
-
-    /**
-     * Set the Brick Geo Engine to use the database for geospatial computations.
-     * The engine is set only if it has not been set beforehand.
-     *
-     * @return bool
-     */
-    protected function setGeometryEngine(): bool
-    {
-        try {
-            if ($this->geometry_engine === null) {
-                $this->geometry_engine = new PDOEngine(DB::connection()->getPdo());
-            }
-            $point = Point::xy(1, 1);
-            return $this->geometry_engine->equals($point, $point);
-        } catch (Throwable $ex) {
-        }
-        return false;
-    }
-
-    /**
-     * Get the key to cache the indexed grid of features.
-     *
-     * @return string|NULL
-     */
-    protected function cacheKey(): ?string
-    {
-        if ($this->cache_key === null) {
-            $map_def = $this->data('map');
-            if ($map_def === null || !($map_def instanceof MapDefinitionInterface)) {
-                return null;
-            }
-            return spl_object_id($this) . '-map-' . $map_def->id();
-        }
-        return $this->cache_key;
-    }
+	use PlaceMapperTrait;
+
+	private ?string $cache_key = null;
+	private ?GeometryEngine $geometry_engine = null;
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Mapping on place coordinates');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 *
+	 * {@internal The Place is associated to a Point only.
+	 * PlaceLocation can calculate a BoundingBox.
+	 * Using a BoundingBox could make the mapping more complex and potentially arbitary.
+	 * Furthermore, when no coordinate is found for the place or its children, then it bubbles up to the parents.
+	 * This could create the unwanted side effect of a very large area to consider}
+	 *
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::map()
+	 */
+	public function map(Place $place, string $feature_property): ?string
+	{
+		$location = new PlaceLocation($place->gedcomName());
+		$longitude = $location->longitude();
+		$latitude = $location->latitude();
+		if ($longitude === null || $latitude === null) {
+			return null;
+		}
+
+		$features_index = $this->featuresIndex();
+		if ($features_index === null) {
+			return null;
+		}
+
+		$place_point = Point::xy($longitude, $latitude, $features_index['SRID']);
+		$grid_box = $this->getGridCell(
+			$place_point,
+			$features_index['map_NE'],
+			$features_index['map_SW'],
+			$features_index['nb_columns']
+		);
+		if ($grid_box === null || !$this->setGeometryEngine() || $this->geometry_engine == null) {
+			return null;
+		}
+		$features = $features_index['grid'][$grid_box[0]][$grid_box[1]];
+		foreach ($features as $feature) {
+			$geometry = $feature->getGeometry();
+			if (
+				$geometry !== null && $place_point->SRID() === $geometry->SRID() &&
+				$this->geometry_engine->contains($geometry, $place_point)
+			) {
+				return $feature->getProperty($feature_property);
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Return the XY coordinates in a bounded grid of the cell containing a specific point.
+	 *
+	 * @param Point $point Point to find
+	 * @param Point $grid_NE North-East point of the bounded grid
+	 * @param Point $grid_SW South-West point fo the bounded grid
+	 * @param int $grid_columns Number of columns/rows in the grid
+	 * @return int[]|NULL
+	 */
+	protected function getGridCell(Point $point, Point $grid_NE, Point $grid_SW, int $grid_columns): ?array
+	{
+		list($x, $y) = $point->toArray();
+		list($x_max, $y_max) = $grid_NE->toArray();
+		list($x_min, $y_min) = $grid_SW->toArray();
+
+		$x_step = ($x_max - $x_min) / $grid_columns;
+		$y_step = ($y_max - $y_min) / $grid_columns;
+
+		if ($x_min <= $x && $x <= $x_max && $y_min <= $y && $y <= $y_max) {
+			return [
+				$x === $x_max ? $grid_columns - 1 : intval(($x - $x_min) / $x_step),
+				$y === $y_max ? $grid_columns - 1 : intval(($y - $y_min) / $y_step)
+			];
+		}
+		return null;
+	}
+
+	/**
+	 * Get an indexed array of the features of the map.
+	 *
+	 * {@internal The map is divided in a grid, eacg cell containing the features which bounding box overlaps that cell.
+	 * The grid is computed once for each map, and cached.}
+	 *
+	 * @phpcs:ignore Generic.Files.LineLength.TooLong
+	 * @return array{grid: array<int, array<int, \Brick\Geo\IO\GeoJSON\Feature[]>>, nb_columns: int, map_NE: \Brick\Geo\Point, map_SW: \Brick\Geo\Point, SRID: int}|NULL
+	 */
+	protected function featuresIndex(): ?array
+	{
+		$cacheKey = $this->cacheKey();
+		if ($cacheKey === null) {
+			return null;
+		}
+		return Registry::cache()->array()->remember($cacheKey, function (): ?array {
+			$map_def = $this->data('map');
+			if (
+				!$this->setGeometryEngine()
+				|| $map_def === null
+				|| !($map_def instanceof MapDefinitionInterface)
+			) {
+				return null;
+			}
+			$bounding_boxes = [];
+			$map_bounding_box = new BoundingBox();
+			$srid = 0;
+			foreach ($map_def->features() as $feature) {
+				$geometry = $feature->getGeometry();
+				if ($geometry === null) {
+					continue;
+				}
+				$srid = $geometry->SRID();
+				$bounding_box = $geometry->getBoundingBox();
+				$bounding_boxes[] = [$feature, $bounding_box];
+				$map_bounding_box = $map_bounding_box->extendedWithBoundingBox($bounding_box);
+			}
+			$grid_columns = count($bounding_boxes);
+			$grid = array_fill(0, $grid_columns, array_fill(0, $grid_columns, []));
+			$map_NE = $map_bounding_box->getNorthEast();
+			$map_SW = $map_bounding_box->getSouthWest();
+			foreach ($bounding_boxes as $item) {
+				$grid_box_SW = $this->getGridCell($item[1]->getSouthWest(), $map_NE, $map_SW, $grid_columns) ?? [1, 1];
+				$grid_box_NE = $this->getGridCell($item[1]->getNorthEast(), $map_NE, $map_SW, $grid_columns) ?? [0, 0];
+				for ($i = $grid_box_SW[0]; $i <= $grid_box_NE[0]; $i++) {
+					for ($j = $grid_box_SW[1]; $j <= $grid_box_NE[1]; $j++) {
+						$grid[$i][$j][] = $item[0];
+					}
+				}
+			}
+			return [
+				'grid'          =>  $grid,
+				'nb_columns'    =>  $grid_columns,
+				'map_NE'        =>  $map_NE,
+				'map_SW'        =>  $map_SW,
+				'SRID'          =>  $srid
+			];
+		});
+	}
+
+	/**
+	 * Set the Brick Geo Engine to use the database for geospatial computations.
+	 * The engine is set only if it has not been set beforehand.
+	 *
+	 * @return bool
+	 */
+	protected function setGeometryEngine(): bool
+	{
+		try {
+			if ($this->geometry_engine === null) {
+				$this->geometry_engine = new PDOEngine(DB::connection()->getPdo());
+			}
+			$point = Point::xy(1, 1);
+			return $this->geometry_engine->equals($point, $point);
+		} catch (Throwable $ex) {
+		}
+		return false;
+	}
+
+	/**
+	 * Get the key to cache the indexed grid of features.
+	 *
+	 * @return string|NULL
+	 */
+	protected function cacheKey(): ?string
+	{
+		if ($this->cache_key === null) {
+			$map_def = $this->data('map');
+			if ($map_def === null || !($map_def instanceof MapDefinitionInterface)) {
+				return null;
+			}
+			return spl_object_id($this) . '-map-' . $map_def->id();
+		}
+		return $this->cache_key;
+	}
 }

app/Module/Certificates/Model/Certificate.php

Indentation +189 added lines, -189 removed lines

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

app/Common/Hooks/AbstractHookCollector.php

Indentation +64 added lines, -64 removed lines

@@ -27,77 +27,77 @@
  */
 abstract class AbstractHookCollector implements HookCollectorInterface, HookInterface
 {
-    /** @var Collection<int, array<THook>> $hooks */
-    protected Collection $hooks;
+	/** @var Collection<int, array<THook>> $hooks */
+	protected Collection $hooks;
 
-    private ModuleInterface $module;
+	private ModuleInterface $module;
 
-    /**
-     * Constructor for AbstractHookCollector
-     *
-     * @param ModuleInterface $module
-     */
-    public function __construct(ModuleInterface $module)
-    {
-        $this->hooks = new Collection();
-        $this->module = $module;
-    }
+	/**
+	 * Constructor for AbstractHookCollector
+	 *
+	 * @param ModuleInterface $module
+	 */
+	public function __construct(ModuleInterface $module)
+	{
+		$this->hooks = new Collection();
+		$this->module = $module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
-     */
-    public function module(): ModuleInterface
-    {
-        return $this->module;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
+	 */
+	public function module(): ModuleInterface
+	{
+		return $this->module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::name()
-     */
-    public function name(): string
-    {
-        return $this->module->name() . '-' .
-            mb_substr(str_replace('collector', '', mb_strtolower((new ReflectionClass($this))->getShortName())), 0, 64);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::name()
+	 */
+	public function name(): string
+	{
+		return $this->module->name() . '-' .
+			mb_substr(str_replace('collector', '', mb_strtolower((new ReflectionClass($this))->getShortName())), 0, 64);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::title()
-     */
-    abstract public function title(): string;
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::title()
+	 */
+	abstract public function title(): string;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::description()
-     */
-    abstract public function description(): string;
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::description()
+	 */
+	abstract public function description(): string;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hookInterface()
-     */
-    abstract public function hookInterface(): string;
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hookInterface()
+	 */
+	abstract public function hookInterface(): string;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::register()
-     */
-    public function register(HookInterface $hook_instance, int $order): void
-    {
-        $this->hooks->put($order, array_merge($this->hooks->get($order, []), [$hook_instance]));
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::register()
+	 */
+	public function register(HookInterface $hook_instance, int $order): void
+	{
+		$this->hooks->put($order, array_merge($this->hooks->get($order, []), [$hook_instance]));
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hooks()
-     *
-     * @return Collection<THook>
-     */
-    public function hooks(): Collection
-    {
-        /** @var Collection<THook> */
-        return $this->hooks->sortKeys()->flatten();
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hooks()
+	 *
+	 * @return Collection<THook>
+	 */
+	public function hooks(): Collection
+	{
+		/** @var Collection<THook> */
+		return $this->hooks->sortKeys()->flatten();
+	}
 }