jon48 / webtrees-lib

src/Webtrees/Common/GeoDispersion/GeoAnalysis/GeoAnalysisPlace.php

Indentation +116 added lines, -116 removed lines

@@ -27,132 +27,132 @@
  */
 class GeoAnalysisPlace
 {
-    /**
-     * The default place name for invalid places
-     * @var string INVALID_PLACE
-     */
-    private const INVALID_PLACE = '##INVALID##';
+	/**
+	 * The default place name for invalid places
+	 * @var string INVALID_PLACE
+	 */
+	private const INVALID_PLACE = '##INVALID##';
     
-    private Place $place;
-    private int $depth;
-    private bool $strict_depth;
-    private bool $is_excluded;
+	private Place $place;
+	private int $depth;
+	private bool $strict_depth;
+	private bool $is_excluded;
     
-    /**
-     * Constructor for GeoAnalysisPlace
-     * 
-     * @param Tree $tree Default tree
-     * @param Place|null $place Place resulting from the analysis
-     * @param int $depth Place hierarchy depth defined by the geographical analysis view
-     * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid
-     */
-    public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false)
-    {
-        $this->depth = $depth;
-        $this->strict_depth = $strict_depth;
-        $this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree);
-        $this->is_excluded = false;
-    }
+	/**
+	 * Constructor for GeoAnalysisPlace
+	 * 
+	 * @param Tree $tree Default tree
+	 * @param Place|null $place Place resulting from the analysis
+	 * @param int $depth Place hierarchy depth defined by the geographical analysis view
+	 * @param bool $strict_depth Checks whether places with a lower depth than defined should be flagged as invalid
+	 */
+	public function __construct(Tree $tree, ?Place $place, int $depth, bool $strict_depth = false)
+	{
+		$this->depth = $depth;
+		$this->strict_depth = $strict_depth;
+		$this->place = $this->extractPlace($place, $depth, $strict_depth) ?? new Place('', $tree);
+		$this->is_excluded = false;
+	}
     
-    /**
-     * Process the provided Place to determine its status for further usage
-     * 
-     * @param Place|null $place
-     * @param int $depth
-     * @param bool $strict_depth
-     * @return Place|NULL
-     */
-    private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place
-    {
-        if($place === null) return null;
-        if(mb_strlen($place->gedcomName()) === 0) return null;
-        $parts = $place->lastParts($depth);
-        if($strict_depth && $parts->count() !== $depth) return new Place(self::INVALID_PLACE, $place->tree());
-        return new Place($parts->implode(', '), $place->tree());
-    }
+	/**
+	 * Process the provided Place to determine its status for further usage
+	 * 
+	 * @param Place|null $place
+	 * @param int $depth
+	 * @param bool $strict_depth
+	 * @return Place|NULL
+	 */
+	private function extractPlace(?Place $place, int $depth, bool $strict_depth): ?Place
+	{
+		if($place === null) return null;
+		if(mb_strlen($place->gedcomName()) === 0) return null;
+		$parts = $place->lastParts($depth);
+		if($strict_depth && $parts->count() !== $depth) return new Place(self::INVALID_PLACE, $place->tree());
+		return new Place($parts->implode(', '), $place->tree());
+	}
     
-    /**
-     * Get the GeoAnalysis Place key
-     * 
-     * @return string
-     */
-    public function key(): string
-    {
-        return $this->place->gedcomName();
-    }
+	/**
+	 * Get the GeoAnalysis Place key
+	 * 
+	 * @return string
+	 */
+	public function key(): string
+	{
+		return $this->place->gedcomName();
+	}
     
-    /**
-     * Get the underlying Place object
-     * 
-     * @return Place
-     */
-    public function place(): Place
-    {
-        return $this->place;
-    }
+	/**
+	 * Get the underlying Place object
+	 * 
+	 * @return Place
+	 */
+	public function place(): Place
+	{
+		return $this->place;
+	}
     
-    /**
-     * Check if the GeoAnalysis Place is in the Known status
-     * 
-     * @return bool
-     */
-    public function isKnown(): bool
-    {
-        return !$this->isUnknown();
-    }
+	/**
+	 * Check if the GeoAnalysis Place is in the Known status
+	 * 
+	 * @return bool
+	 */
+	public function isKnown(): bool
+	{
+		return !$this->isUnknown();
+	}
     
-    /**
-     * Check if the GeoAnalysis Place is in the Unknown status
-     * 
-     * @return bool
-     */
-    public function isUnknown(): bool
-    {
-        return mb_strlen($this->place->gedcomName()) === 0;
-    }
+	/**
+	 * Check if the GeoAnalysis Place is in the Unknown status
+	 * 
+	 * @return bool
+	 */
+	public function isUnknown(): bool
+	{
+		return mb_strlen($this->place->gedcomName()) === 0;
+	}
     
-    /**
-     * Check if the GeoAnalysis Place is in the Invalid status
-     * 
-     * @return bool
-     */
-    public function isInvalid(): bool
-    {
-        return $this->place->gedcomName() === self::INVALID_PLACE;
-    }
+	/**
+	 * Check if the GeoAnalysis Place is in the Invalid status
+	 * 
+	 * @return bool
+	 */
+	public function isInvalid(): bool
+	{
+		return $this->place->gedcomName() === self::INVALID_PLACE;
+	}
     
-    /**
-     * Check if the GeoAnalysis Place is in the Excluded status
-     * 
-     * @return bool
-     */
-    public function isExcluded(): bool
-    {
-        return $this->isUnknown() || $this->isInvalid() || $this->is_excluded;
-    }
+	/**
+	 * Check if the GeoAnalysis Place is in the Excluded status
+	 * 
+	 * @return bool
+	 */
+	public function isExcluded(): bool
+	{
+		return $this->isUnknown() || $this->isInvalid() || $this->is_excluded;
+	}
     
-    /**
-     * Set the GeoAnalysis Place status to Found, if the parameter is true
-     * 
-     * @param bool $include
-     * @return self
-     */
-    public function include(bool $include = true): self
-    {
-        $this->is_excluded = !$include;
-        return $this;
-    }
+	/**
+	 * Set the GeoAnalysis Place status to Found, if the parameter is true
+	 * 
+	 * @param bool $include
+	 * @return self
+	 */
+	public function include(bool $include = true): self
+	{
+		$this->is_excluded = !$include;
+		return $this;
+	}
     
-    /**
-     * Set the GeoAnalysis Place status to Excluded, if the parameter is true
-     * 
-     * @param bool $exclude
-     * @return self
-     */
-    public function exclude(bool $exclude = true): self
-    {
-        $this->is_excluded = $exclude;
-        return $this;
-    }
+	/**
+	 * Set the GeoAnalysis Place status to Excluded, if the parameter is true
+	 * 
+	 * @param bool $exclude
+	 * @return self
+	 */
+	public function exclude(bool $exclude = true): self
+	{
+		$this->is_excluded = $exclude;
+		return $this;
+	}
 }
 

src/Webtrees/Common/GeoDispersion/Maps/SimpleFilesystemMap.php

Indentation +51 added lines, -51 removed lines

@@ -26,61 +26,61 @@
  */
 class SimpleFilesystemMap implements MapDefinitionInterface
 {
-    private string $id;
-    private string $title;
-    private string $path;
-    private FilesystemReader $filesystem;
+	private string $id;
+	private string $title;
+	private string $path;
+	private FilesystemReader $filesystem;
     
-    /**
-     * Constructor for SimpleFilesystemMap
-     * 
-     * @param string $id
-     * @param string $title
-     * @param FilesystemReader $filesystem
-     * @param string $path
-     */
-    public function __construct(string $id, string $title, FilesystemReader $filesystem, string $path)
-    {
-        $this->id = $id;
-        $this->title = $title;
-        $this->filesystem = $filesystem;
-        $this->path = $path;
-    }
+	/**
+	 * Constructor for SimpleFilesystemMap
+	 * 
+	 * @param string $id
+	 * @param string $title
+	 * @param FilesystemReader $filesystem
+	 * @param string $path
+	 */
+	public function __construct(string $id, string $title, FilesystemReader $filesystem, string $path)
+	{
+		$this->id = $id;
+		$this->title = $title;
+		$this->filesystem = $filesystem;
+		$this->path = $path;
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::id()
-     */
-    public function id(): string
-    {
-        return $this->id;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::id()
+	 */
+	public function id(): string
+	{
+		return $this->id;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::title()
-     */
-    public function title(): string
-    {
-        return $this->title;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::title()
+	 */
+	public function title(): string
+	{
+		return $this->title;
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::features()
-     */
-    public function features(): array
-    {
-        $reader = new GeoJSONReader();
-        try {
-            $feature_collection = $reader->read($this->filesystem->read($this->path));
-            if($feature_collection instanceof FeatureCollection) {
-                return $feature_collection->getFeatures();
-            }
-        }
-        catch(Throwable $ex) { }
-        return [];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapDefinitionInterface::features()
+	 */
+	public function features(): array
+	{
+		$reader = new GeoJSONReader();
+		try {
+			$feature_collection = $reader->read($this->filesystem->read($this->path));
+			if($feature_collection instanceof FeatureCollection) {
+				return $feature_collection->getFeatures();
+			}
+		}
+		catch(Throwable $ex) { }
+		return [];
+	}
     
 
 }
\ No newline at end of file

src/Webtrees/Common/GeoDispersion/Config/MapViewConfig.php

Indentation +31 added lines, -31 removed lines

@@ -22,38 +22,38 @@
  */
 class MapViewConfig implements MapViewConfigInterface
 {
-    private string $map_mapping_property;
-    private PlaceMapperConfigInterface $mapper_config;
+	private string $map_mapping_property;
+	private PlaceMapperConfigInterface $mapper_config;
     
-    /**
-     * Constructor for MapViewConfig
-     * 
-     * @param string $map_mapping_property
-     * @param PlaceMapperConfigInterface $mapper_config
-     */
-    public function __construct(
-        string $map_mapping_property,
-        PlaceMapperConfigInterface $mapper_config = null
-    ) {
-        $this->map_mapping_property = $map_mapping_property;
-        $this->mapper_config = $mapper_config ?? new NullPlaceMapperConfig();
-    }
+	/**
+	 * Constructor for MapViewConfig
+	 * 
+	 * @param string $map_mapping_property
+	 * @param PlaceMapperConfigInterface $mapper_config
+	 */
+	public function __construct(
+		string $map_mapping_property,
+		PlaceMapperConfigInterface $mapper_config = null
+	) {
+		$this->map_mapping_property = $map_mapping_property;
+		$this->mapper_config = $mapper_config ?? new NullPlaceMapperConfig();
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::mapMappingProperty()
-     */
-    function mapMappingProperty(): string
-    {
-        return $this->map_mapping_property;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::mapMappingProperty()
+	 */
+	function mapMappingProperty(): string
+	{
+		return $this->map_mapping_property;
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::mapperConfig()
-     */
-    function mapperConfig(): PlaceMapperConfigInterface
-    {
-        return $this->mapper_config;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\MapViewConfigInterface::mapperConfig()
+	 */
+	function mapperConfig(): PlaceMapperConfigInterface
+	{
+		return $this->mapper_config;
+	}
 }
\ No newline at end of file

src/Webtrees/Common/GeoDispersion/Config/NullPlaceMapperConfig.php

Indentation +33 added lines, -33 removed lines

@@ -22,41 +22,41 @@
  */
 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::has()
-     */
-    public function has(string $key): bool
-    {
-        return false;
-    }
+	/**
+	 * {@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::jsonDeserialize()
-     */
-    public function jsonDeserialize($config): self
-    {
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
+	 */
+	public function jsonDeserialize($config): self
+	{
+		return $this;
+	}
     
-    /**
-     * {@inheritDoc}
-     * @see JsonSerializable::jsonSerialize()
-     */
-    public function jsonSerialize()
-    {
-        return [];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see JsonSerializable::jsonSerialize()
+	 */
+	public function jsonSerialize()
+	{
+		return [];
+	}
 
 
 

src/Webtrees/Common/GeoDispersion/Config/GenericPlaceMapperConfig.php

Indentation +71 added lines, -71 removed lines

@@ -21,84 +21,84 @@
  */
 class GenericPlaceMapperConfig implements PlaceMapperConfigInterface
 {
-    private array $config = [];
+	private array $config = [];
     
-    /**
-     * Get the generic mapper's config
-     * 
-     * @return array
-     */
-    public function config(): array
-    {
-        return $this->config;
-    }
+	/**
+	 * Get the generic mapper's config
+	 * 
+	 * @return array
+	 */
+	public function config(): array
+	{
+		return $this->config;
+	}
     
-    /**
-     * Set the generic mapper's config
-     * 
-     * @param array $config
-     * @return self
-     */
-    public function setConfig(array $config): self
-    {
-        $this->config = $config;
-        return $this;
-    }
+	/**
+	 * Set the generic mapper's config
+	 * 
+	 * @param array $config
+	 * @return self
+	 */
+	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()
-     */
-    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()
+	 */
+	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;
+	}
 
 
 }
\ No newline at end of file

src/Webtrees/Common/GeoDispersion/Config/MapColorsConfig.php

Indentation +41 added lines, -41 removed lines

@@ -22,53 +22,53 @@
  */
 class MapColorsConfig implements JsonSerializable
 {
-    private Color $default, $stroke, $max_value, $hover;
+	private Color $default, $stroke, $max_value, $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;
-    }
+	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;
+	}
     
-    function defaultColor(): Color
-    {
-        return $this->default;
-    }
+	function defaultColor(): Color
+	{
+		return $this->default;
+	}
     
-    function strokeColor(): Color
-    {
-        return $this->stroke;
-    }
+	function strokeColor(): Color
+	{
+		return $this->stroke;
+	}
     
-    function minValueColor(): Color
-    {
-        return new Rgb(255, 255, 255);
-    }
+	function minValueColor(): Color
+	{
+		return new Rgb(255, 255, 255);
+	}
     
-    function maxValueColor(): Color
-    {
-        return $this->max_value;
-    }
+	function maxValueColor(): Color
+	{
+		return $this->max_value;
+	}
     
-    function hoverColor(): Color
-    {
-        return $this->hover;
-    }
+	function hoverColor(): Color
+	{
+		return $this->hover;
+	}
 
-    public function jsonSerialize()
-    {
-        return [
-            'default'   => (string) $this->defaultColor()->toHex(),
-            'stroke'    => (string) $this->strokeColor()->toHex(),
-            'maxvalue'  => (string) $this->maxValueColor()->toHex(),
-            'hover'     => (string) $this->hoverColor()->toHex(),
-        ];
-    }
+	public function jsonSerialize()
+	{
+		return [
+			'default'   => (string) $this->defaultColor()->toHex(),
+			'stroke'    => (string) $this->strokeColor()->toHex(),
+			'maxvalue'  => (string) $this->maxValueColor()->toHex(),
+			'hover'     => (string) $this->hoverColor()->toHex(),
+		];
+	}
 
 }
\ No newline at end of file