jon48 / webtrees-lib

src/Webtrees/Module/GeoDispersion/Services/MapAdapterDataService.php

Indentation +142 added lines, -142 removed lines

@@ -30,155 +30,155 @@
  */
 class MapAdapterDataService
 {
-    private MapDefinitionsService $mapdefinition_service;
+	private MapDefinitionsService $mapdefinition_service;
 
-    /**
-     * Constructor for MapAdapterDataService
-     *
-     * @param MapDefinitionsService $mapdefinition_service
-     */
-    public function __construct(MapDefinitionsService $mapdefinition_service)
-    {
-        $this->mapdefinition_service = $mapdefinition_service;
-    }
+	/**
+	 * Constructor for MapAdapterDataService
+	 *
+	 * @param MapDefinitionsService $mapdefinition_service
+	 */
+	public function __construct(MapDefinitionsService $mapdefinition_service)
+	{
+		$this->mapdefinition_service = $mapdefinition_service;
+	}
 
-    /**
-     * Find a GeoAnalysisMapAdapter by ID
-     *
-     * @param int $id
-     * @return GeoAnalysisMapAdapter|NULL
-     */
-    public function find(int $id): ?GeoAnalysisMapAdapter
-    {
-        return DB::table('maj_geodisp_mapviews')
-            ->select('maj_geodisp_mapviews.*')
-            ->where('majgm_id', '=', $id)
-            ->get()
-            ->map($this->mapAdapterMapper())
-            ->first();
-    }
+	/**
+	 * Find a GeoAnalysisMapAdapter by ID
+	 *
+	 * @param int $id
+	 * @return GeoAnalysisMapAdapter|NULL
+	 */
+	public function find(int $id): ?GeoAnalysisMapAdapter
+	{
+		return DB::table('maj_geodisp_mapviews')
+			->select('maj_geodisp_mapviews.*')
+			->where('majgm_id', '=', $id)
+			->get()
+			->map($this->mapAdapterMapper())
+			->first();
+	}
 
-    /**
-     * Get all GeoAnalysisMapAdapters linked to a Map View.
-     *
-     * @param GeoAnalysisMap $map_view
-     * @return Collection<GeoAnalysisMapAdapter>
-     */
-    public function allForView(GeoAnalysisMap $map_view): Collection
-    {
-        return DB::table('maj_geodisp_mapviews')
-            ->select('maj_geodisp_mapviews.*')
-            ->where('majgm_majgv_id', '=', $map_view->id())
-            ->get()
-            ->map($this->mapAdapterMapper())
-            ->filter();
-    }
+	/**
+	 * Get all GeoAnalysisMapAdapters linked to a Map View.
+	 *
+	 * @param GeoAnalysisMap $map_view
+	 * @return Collection<GeoAnalysisMapAdapter>
+	 */
+	public function allForView(GeoAnalysisMap $map_view): Collection
+	{
+		return DB::table('maj_geodisp_mapviews')
+			->select('maj_geodisp_mapviews.*')
+			->where('majgm_majgv_id', '=', $map_view->id())
+			->get()
+			->map($this->mapAdapterMapper())
+			->filter();
+	}
 
-    /**
-     * Insert a GeoAnalysisMapAdapter in the database.
-     *
-     * @param GeoAnalysisMapAdapter $map_adapter
-     * @return int
-     */
-    public function insertGetId(GeoAnalysisMapAdapter $map_adapter): int
-    {
-        return DB::table('maj_geodisp_mapviews')
-            ->insertGetId([
-                'majgm_majgv_id' => $map_adapter->geoAnalysisViewId(),
-                'majgm_map_id' => $map_adapter->map()->id(),
-                'majgm_mapper' => get_class($map_adapter->placeMapper()),
-                'majgm_feature_prop' => $map_adapter->viewConfig()->mapMappingProperty(),
-                'majgm_config' => json_encode($map_adapter->viewConfig()->mapperConfig())
-            ]);
-    }
+	/**
+	 * Insert a GeoAnalysisMapAdapter in the database.
+	 *
+	 * @param GeoAnalysisMapAdapter $map_adapter
+	 * @return int
+	 */
+	public function insertGetId(GeoAnalysisMapAdapter $map_adapter): int
+	{
+		return DB::table('maj_geodisp_mapviews')
+			->insertGetId([
+				'majgm_majgv_id' => $map_adapter->geoAnalysisViewId(),
+				'majgm_map_id' => $map_adapter->map()->id(),
+				'majgm_mapper' => get_class($map_adapter->placeMapper()),
+				'majgm_feature_prop' => $map_adapter->viewConfig()->mapMappingProperty(),
+				'majgm_config' => json_encode($map_adapter->viewConfig()->mapperConfig())
+			]);
+	}
 
-    /**
-     * Update a GeoAnalysisMapAdapter in the database.
-     *
-     * @param GeoAnalysisMapAdapter $map_adapter
-     * @return int
-     */
-    public function update(GeoAnalysisMapAdapter $map_adapter): int
-    {
-        return DB::table('maj_geodisp_mapviews')
-            ->where('majgm_id', '=', $map_adapter->id())
-            ->update([
-                'majgm_map_id' => $map_adapter->map()->id(),
-                'majgm_mapper' => get_class($map_adapter->placeMapper()),
-                'majgm_feature_prop' => $map_adapter->viewConfig()->mapMappingProperty(),
-                'majgm_config' => json_encode($map_adapter->placeMapper()->config())
-            ]);
-    }
+	/**
+	 * Update a GeoAnalysisMapAdapter in the database.
+	 *
+	 * @param GeoAnalysisMapAdapter $map_adapter
+	 * @return int
+	 */
+	public function update(GeoAnalysisMapAdapter $map_adapter): int
+	{
+		return DB::table('maj_geodisp_mapviews')
+			->where('majgm_id', '=', $map_adapter->id())
+			->update([
+				'majgm_map_id' => $map_adapter->map()->id(),
+				'majgm_mapper' => get_class($map_adapter->placeMapper()),
+				'majgm_feature_prop' => $map_adapter->viewConfig()->mapMappingProperty(),
+				'majgm_config' => json_encode($map_adapter->placeMapper()->config())
+			]);
+	}
 
-    /**
-     * Delete a GeoAnalysisMapAdapter from the database.
-     *
-     * @param GeoAnalysisMapAdapter $map_adapter
-     * @return int
-     */
-    public function delete(GeoAnalysisMapAdapter $map_adapter): int
-    {
-        return DB::table('maj_geodisp_mapviews')
-            ->where('majgm_id', '=', $map_adapter->id())
-            ->delete();
-    }
+	/**
+	 * Delete a GeoAnalysisMapAdapter from the database.
+	 *
+	 * @param GeoAnalysisMapAdapter $map_adapter
+	 * @return int
+	 */
+	public function delete(GeoAnalysisMapAdapter $map_adapter): int
+	{
+		return DB::table('maj_geodisp_mapviews')
+			->where('majgm_id', '=', $map_adapter->id())
+			->delete();
+	}
 
-    /**
-     * Get the closure to create a GeoAnalysisMapAdapter object from a row in the database.
-     * It returns null if the classes stored in the DB cannot be loaded through the Laravel container,
-     * or if the types do not match with the ones expected.
-     *
-     * @return Closure(\stdClass $row):?GeoAnalysisMapAdapter
-     */
-    private function mapAdapterMapper(): Closure
-    {
-        return function (stdClass $row): ?GeoAnalysisMapAdapter {
-            if (null === $map = $this->mapdefinition_service->find($row->majgm_map_id)) {
-                return null;
-            }
-            try {
-                $mapper = app($row->majgm_mapper);
-                if (!($mapper instanceof PlaceMapperInterface)) {
-                    return null;
-                }
+	/**
+	 * Get the closure to create a GeoAnalysisMapAdapter object from a row in the database.
+	 * It returns null if the classes stored in the DB cannot be loaded through the Laravel container,
+	 * or if the types do not match with the ones expected.
+	 *
+	 * @return Closure(\stdClass $row):?GeoAnalysisMapAdapter
+	 */
+	private function mapAdapterMapper(): Closure
+	{
+		return function (stdClass $row): ?GeoAnalysisMapAdapter {
+			if (null === $map = $this->mapdefinition_service->find($row->majgm_map_id)) {
+				return null;
+			}
+			try {
+				$mapper = app($row->majgm_mapper);
+				if (!($mapper instanceof PlaceMapperInterface)) {
+					return null;
+				}
 
-                return new GeoAnalysisMapAdapter(
-                    (int) $row->majgm_id,
-                    (int) $row->majgm_majgv_id,
-                    $map,
-                    app($row->majgm_mapper),
-                    new MapViewConfig($row->majgm_feature_prop, $this->mapperConfigDecoder($row->majgm_config))
-                );
-            } catch (BindingResolutionException $ex) {
-                return null;
-            }
-        };
-    }
+				return new GeoAnalysisMapAdapter(
+					(int) $row->majgm_id,
+					(int) $row->majgm_majgv_id,
+					$map,
+					app($row->majgm_mapper),
+					new MapViewConfig($row->majgm_feature_prop, $this->mapperConfigDecoder($row->majgm_config))
+				);
+			} catch (BindingResolutionException $ex) {
+				return null;
+			}
+		};
+	}
 
-    /**
-     * Create a PlaceMapperConfigInterface object from a JSON column value.
-     * Returns null if the JSON string is invalid/empty or if the extracted mapper class cannot be loaded
-     * through the Laravel container or if the type do not match with the one expected.
-     *
-     * @param string $json_config
-     * @return PlaceMapperConfigInterface|NULL
-     */
-    private function mapperConfigDecoder(?string $json_config): ?PlaceMapperConfigInterface
-    {
-        $config = $json_config === null ? [] : json_decode($json_config, true);
-        $class = $config['class'] ?? null;
-        $json_mapper_config = $config['config'] ?? null;
-        if ($class === null || $json_mapper_config === null) {
-            return null;
-        }
-        try {
-            $mapper_config = app($class);
-            if (!$mapper_config instanceof PlaceMapperConfigInterface) {
-                return null;
-            }
-            return $mapper_config->jsonDeserialize($json_mapper_config);
-        } catch (BindingResolutionException $ex) {
-            return null;
-        }
-    }
+	/**
+	 * Create a PlaceMapperConfigInterface object from a JSON column value.
+	 * Returns null if the JSON string is invalid/empty or if the extracted mapper class cannot be loaded
+	 * through the Laravel container or if the type do not match with the one expected.
+	 *
+	 * @param string $json_config
+	 * @return PlaceMapperConfigInterface|NULL
+	 */
+	private function mapperConfigDecoder(?string $json_config): ?PlaceMapperConfigInterface
+	{
+		$config = $json_config === null ? [] : json_decode($json_config, true);
+		$class = $config['class'] ?? null;
+		$json_mapper_config = $config['config'] ?? null;
+		if ($class === null || $json_mapper_config === null) {
+			return null;
+		}
+		try {
+			$mapper_config = app($class);
+			if (!$mapper_config instanceof PlaceMapperConfigInterface) {
+				return null;
+			}
+			return $mapper_config->jsonDeserialize($json_mapper_config);
+		} catch (BindingResolutionException $ex) {
+			return null;
+		}
+	}
 }

src/Webtrees/Module/GeoDispersion/Services/GeoAnalysisService.php

Indentation +32 added lines, -32 removed lines

@@ -25,38 +25,38 @@
  */
 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
-     */
-    public function all(bool $include_disabled = false): Collection
-    {
-        return $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
+	 */
+	public function all(bool $include_disabled = false): Collection
+	{
+		return $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();
+	}
 }

src/Webtrees/Module/GeoDispersion/Services/PlaceMapperService.php

Indentation +33 added lines, -33 removed lines

@@ -25,39 +25,39 @@
  */
 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
-     */
-    public function all(bool $include_disabled = false): Collection
-    {
-        return $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
+	 */
+	public function all(bool $include_disabled = false): Collection
+	{
+		return $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();
+		;
+	}
 }

src/Webtrees/Module/GeoDispersion/GeoAnalyses/AllEventsByTypeGeoAnalysis.php

Indentation +45 added lines, -45 removed lines

@@ -26,55 +26,55 @@
  */
 class AllEventsByTypeGeoAnalysis implements GeoAnalysisInterface
 {
-    private GeoAnalysisDataService $geoanalysis_data_service;
+	private GeoAnalysisDataService $geoanalysis_data_service;
 
-    /**
-     * Constructor for AllEventsByTypeGeoAnalysis
-     *
-     * @param GeoAnalysisDataService $geoanalysis_data_service
-     */
-    public function __construct(GeoAnalysisDataService $geoanalysis_data_service)
-    {
-        $this->geoanalysis_data_service = $geoanalysis_data_service;
-    }
+	/**
+	 * Constructor for AllEventsByTypeGeoAnalysis
+	 *
+	 * @param GeoAnalysisDataService $geoanalysis_data_service
+	 */
+	public function __construct(GeoAnalysisDataService $geoanalysis_data_service)
+	{
+		$this->geoanalysis_data_service = $geoanalysis_data_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('All events places by event type');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('All events places by event type');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::itemsDescription()
-     */
-    public function itemsDescription(): callable
-    {
-        return fn(int $count): string => I18N::plural('event', 'events', $count);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::itemsDescription()
+	 */
+	public function itemsDescription(): callable
+	{
+		return fn(int $count): string => I18N::plural('event', 'events', $count);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::results()
-     */
-    public function results(Tree $tree, int $depth): GeoAnalysisResults
-    {
-        $results = new GeoAnalysisResults();
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::results()
+	 */
+	public function results(Tree $tree, int $depth): GeoAnalysisResults
+	{
+		$results = new GeoAnalysisResults();
 
-        foreach ($this->geoanalysis_data_service->individualsAndFamilies($tree) as $record) {
-            foreach ($record->facts([]) as $fact) {
-                $place = new GeoAnalysisPlace($tree, $fact->place(), $depth);
-                if ($place->isUnknown()) {
-                    continue;
-                }
-                $results->addPlace($place);
-                $results->addPlaceInCategory($fact->label(), 0, $place);
-            }
-        }
+		foreach ($this->geoanalysis_data_service->individualsAndFamilies($tree) as $record) {
+			foreach ($record->facts([]) as $fact) {
+				$place = new GeoAnalysisPlace($tree, $fact->place(), $depth);
+				if ($place->isUnknown()) {
+					continue;
+				}
+				$results->addPlace($place);
+				$results->addPlaceInCategory($fact->label(), 0, $place);
+			}
+		}
 
-        return $results;
-    }
+		return $results;
+	}
 }

src/Webtrees/Module/GeoDispersion/GeoAnalyses/AllEventsByCenturyGeoAnalysis.php

Indentation +56 added lines, -56 removed lines

@@ -28,66 +28,66 @@
  */
 class AllEventsByCenturyGeoAnalysis implements GeoAnalysisInterface
 {
-    private GeoAnalysisDataService $geoanalysis_data_service;
-    private CenturyService $century_service;
+	private GeoAnalysisDataService $geoanalysis_data_service;
+	private CenturyService $century_service;
 
-    /**
-     * Constructor for AllEventsByCenturyGeoAnalysis
-     *
-     * @param GeoAnalysisDataService $geoanalysis_data_service
-     * @param CenturyService $century_service
-     */
-    public function __construct(GeoAnalysisDataService $geoanalysis_data_service, CenturyService $century_service)
-    {
-        $this->geoanalysis_data_service = $geoanalysis_data_service;
-        $this->century_service = $century_service;
-    }
+	/**
+	 * Constructor for AllEventsByCenturyGeoAnalysis
+	 *
+	 * @param GeoAnalysisDataService $geoanalysis_data_service
+	 * @param CenturyService $century_service
+	 */
+	public function __construct(GeoAnalysisDataService $geoanalysis_data_service, CenturyService $century_service)
+	{
+		$this->geoanalysis_data_service = $geoanalysis_data_service;
+		$this->century_service = $century_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('All events places by century');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('All events places by century');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::itemsDescription()
-     */
-    public function itemsDescription(): callable
-    {
-        return fn(int $count): string => I18N::plural('event', 'events', $count);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::itemsDescription()
+	 */
+	public function itemsDescription(): callable
+	{
+		return fn(int $count): string => I18N::plural('event', 'events', $count);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::results()
-     */
-    public function results(Tree $tree, int $depth): GeoAnalysisResults
-    {
-        $results = new GeoAnalysisResults();
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::results()
+	 */
+	public function results(Tree $tree, int $depth): GeoAnalysisResults
+	{
+		$results = new GeoAnalysisResults();
 
-        foreach ($this->geoanalysis_data_service->individualsAndFamilies($tree) as $record) {
-            foreach ($record->facts([]) as $fact) {
-                $place = new GeoAnalysisPlace($tree, $fact->place(), $depth);
-                if ($place->isUnknown()) {
-                    continue;
-                }
-                $results->addPlace($place);
-                $date = $fact->date();
-                if ($date->isOK()) {
-                    $century = intdiv($date->gregorianYear(), 100);
-                    $results->addPlaceInCategory(
-                        I18N::translate('%s century', $this->century_service->centuryName($century)),
-                        $century,
-                        $place
-                    );
-                }
-            }
-        }
+		foreach ($this->geoanalysis_data_service->individualsAndFamilies($tree) as $record) {
+			foreach ($record->facts([]) as $fact) {
+				$place = new GeoAnalysisPlace($tree, $fact->place(), $depth);
+				if ($place->isUnknown()) {
+					continue;
+				}
+				$results->addPlace($place);
+				$date = $fact->date();
+				if ($date->isOK()) {
+					$century = intdiv($date->gregorianYear(), 100);
+					$results->addPlaceInCategory(
+						I18N::translate('%s century', $this->century_service->centuryName($century)),
+						$century,
+						$place
+					);
+				}
+			}
+		}
 
-        return $results;
-    }
+		return $results;
+	}
 }

src/Webtrees/Module/GeoDispersion/PlaceMappers/SimplePlaceMapper.php

Indentation +17 added lines, -17 removed lines

@@ -24,23 +24,23 @@
  */
 class SimplePlaceMapper implements PlaceMapperInterface
 {
-    use PlaceMapperTrait;
+	use PlaceMapperTrait;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Mapping on place name');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Mapping on place name');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::map()
-     */
-    public function map(Place $place, string $feature_property): ?string
-    {
-        return $place->firstParts(1)->first();
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::map()
+	 */
+	public function map(Place $place, string $feature_property): ?string
+	{
+		return $place->firstParts(1)->first();
+	}
 }

src/Webtrees/Module/GeoDispersion/PlaceMappers/Config/FilteredTopPlaceMapperConfig.php

Indentation +98 added lines, -98 removed lines

@@ -28,110 +28,110 @@
  */
 class FilteredTopPlaceMapperConfig extends GenericPlaceMapperConfig
 {
-    private TreeService $tree_service;
+	private TreeService $tree_service;
 
-    /**
-     * FilteredTopPlaceMapperConfig
-     *
-     * @param TreeService $tree_service
-     */
-    public function __construct(TreeService $tree_service)
-    {
-        $this->tree_service = $tree_service;
-    }
+	/**
+	 * FilteredTopPlaceMapperConfig
+	 *
+	 * @param TreeService $tree_service
+	 */
+	public function __construct(TreeService $tree_service)
+	{
+		$this->tree_service = $tree_service;
+	}
 
-    /**
-     * Get the configured Top Places to filter on
-     *
-     * @return Collection<Place>
-     */
-    public function topPlaces(): Collection
-    {
-        return collect($this->get('topPlaces', []))
-            ->filter(
-                /** @psalm-suppress MissingClosureParamType */
-                fn($item): bool => $item instanceof Place
-            );
-    }
+	/**
+	 * Get the configured Top Places to filter on
+	 *
+	 * @return Collection<Place>
+	 */
+	public function topPlaces(): Collection
+	{
+		return collect($this->get('topPlaces', []))
+			->filter(
+				/** @psalm-suppress MissingClosureParamType */
+				fn($item): bool => $item instanceof Place
+			);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Common\GeoDispersion\Config\GenericPlaceMapperConfig::jsonSerializeConfig()
-     */
-    public function jsonSerializeConfig()
-    {
-        return [
-            'topPlaces' => $this->topPlaces()
-                ->map(fn(Place $place): array => [ $place->tree()->id(), $place->gedcomName() ])
-                ->toArray()
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Common\GeoDispersion\Config\GenericPlaceMapperConfig::jsonSerializeConfig()
+	 */
+	public function jsonSerializeConfig()
+	{
+		return [
+			'topPlaces' => $this->topPlaces()
+				->map(fn(Place $place): array => [ $place->tree()->id(), $place->gedcomName() ])
+				->toArray()
+		];
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Common\GeoDispersion\Config\GenericPlaceMapperConfig::jsonDeserialize()
-     */
-    public function jsonDeserialize($config): self
-    {
-        if (is_string($config)) {
-            return $this->jsonDeserialize(json_decode($config));
-        }
-        if (is_array($config)) {
-            $this->setConfig([
-                'topPlaces' => collect($config['topPlaces'] ?? [])
-                    ->filter(
-                        /** @psalm-suppress MissingClosureParamType */
-                        fn($item): bool => is_array($item) && count($item) == 2
-                    )->map(function (array $item): ?Place {
-                        try {
-                            return new Place($item[1], $this->tree_service->find($item[0]));
-                        } catch (RuntimeException $ex) {
-                            return null;
-                        }
-                    })
-                    ->filter()
-                    ->toArray()
-                ]);
-        }
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Common\GeoDispersion\Config\GenericPlaceMapperConfig::jsonDeserialize()
+	 */
+	public function jsonDeserialize($config): self
+	{
+		if (is_string($config)) {
+			return $this->jsonDeserialize(json_decode($config));
+		}
+		if (is_array($config)) {
+			$this->setConfig([
+				'topPlaces' => collect($config['topPlaces'] ?? [])
+					->filter(
+						/** @psalm-suppress MissingClosureParamType */
+						fn($item): bool => is_array($item) && count($item) == 2
+					)->map(function (array $item): ?Place {
+						try {
+							return new Place($item[1], $this->tree_service->find($item[0]));
+						} catch (RuntimeException $ex) {
+							return null;
+						}
+					})
+					->filter()
+					->toArray()
+				]);
+		}
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Common\GeoDispersion\Config\GenericPlaceMapperConfig::configContent()
-     */
-    public function configContent(ModuleInterface $module, Tree $tree): string
-    {
-        return view($module->name() . '::mappers/filtered-top-config', [
-            'tree'          =>  $tree,
-            'top_places'    =>  $this->topPlaces()
-        ]);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Common\GeoDispersion\Config\GenericPlaceMapperConfig::configContent()
+	 */
+	public function configContent(ModuleInterface $module, Tree $tree): string
+	{
+		return view($module->name() . '::mappers/filtered-top-config', [
+			'tree'          =>  $tree,
+			'top_places'    =>  $this->topPlaces()
+		]);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Common\GeoDispersion\Config\GenericPlaceMapperConfig::withConfigUpdate()
-     */
-    public function withConfigUpdate(ServerRequestInterface $request): self
-    {
-        $tree = $request->getAttribute('tree');
-        if (!($tree instanceof Tree)) {
-            return $this;
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Common\GeoDispersion\Config\GenericPlaceMapperConfig::withConfigUpdate()
+	 */
+	public function withConfigUpdate(ServerRequestInterface $request): self
+	{
+		$tree = $request->getAttribute('tree');
+		if (!($tree instanceof Tree)) {
+			return $this;
+		}
 
-        $params = (array) $request->getParsedBody();
+		$params = (array) $request->getParsedBody();
 
-        $top_places = $params['mapper_filt_top_places'] ?? [];
-        if (is_array($top_places)) {
-            $config = ['topPlaces' => []];
-            foreach ($top_places as $top_place_id) {
-                $place = Place::find((int) $top_place_id, $tree);
-                if (mb_strlen($place->gedcomName()) > 0) {
-                    $config['topPlaces'][] = $place;
-                }
-            }
-            $this->setConfig($config);
-        }
-        return $this;
-    }
+		$top_places = $params['mapper_filt_top_places'] ?? [];
+		if (is_array($top_places)) {
+			$config = ['topPlaces' => []];
+			foreach ($top_places as $top_place_id) {
+				$place = Place::find((int) $top_place_id, $tree);
+				if (mb_strlen($place->gedcomName()) > 0) {
+					$config['topPlaces'][] = $place;
+				}
+			}
+			$this->setConfig($config);
+		}
+		return $this;
+	}
 }

src/Webtrees/Module/GeoDispersion/PlaceMappers/SimpleTopFilteredPlaceMapper.php

Indentation +43 added lines, -43 removed lines

@@ -28,51 +28,51 @@
  */
 class SimpleTopFilteredPlaceMapper extends SimplePlaceMapper implements PlaceMapperInterface
 {
-    use TopFilteredPlaceMapperTrait;
+	use TopFilteredPlaceMapperTrait;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\PlaceMappers\SimplePlaceMapper::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Mapping on place name with filter');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\PlaceMappers\SimplePlaceMapper::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Mapping on place name with filter');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::boot()
-     */
-    public function boot(): void
-    {
-        parent::boot();
-        $top_places = $this->config()->get('topPlaces');
-        if (is_array($top_places)) {
-            $this->setTopPlaces($top_places);
-        }
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::boot()
+	 */
+	public function boot(): void
+	{
+		parent::boot();
+		$top_places = $this->config()->get('topPlaces');
+		if (is_array($top_places)) {
+			$this->setTopPlaces($top_places);
+		}
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::config()
-     */
-    public function config(): PlaceMapperConfigInterface
-    {
-        if (!(parent::config() instanceof FilteredTopPlaceMapperConfig)) {
-            $this->setConfig(app(FilteredTopPlaceMapperConfig::class));
-        }
-        return parent::config();
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperInterface::config()
+	 */
+	public function config(): PlaceMapperConfigInterface
+	{
+		if (!(parent::config() instanceof FilteredTopPlaceMapperConfig)) {
+			$this->setConfig(app(FilteredTopPlaceMapperConfig::class));
+		}
+		return parent::config();
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\PlaceMappers\SimplePlaceMapper::map()
-     */
-    public function map(Place $place, string $feature_property): ?string
-    {
-        if (!$this->belongsToTopLevels($place)) {
-            return null;
-        }
-        return parent::map($place, $feature_property);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\PlaceMappers\SimplePlaceMapper::map()
+	 */
+	public function map(Place $place, string $feature_property): ?string
+	{
+		if (!$this->belongsToTopLevels($place)) {
+			return null;
+		}
+		return parent::map($place, $feature_property);
+	}
 }

src/Webtrees/Module/GeoDispersion/PlaceMappers/CoordinatesPlaceMapper.php

Indentation +179 added lines, -179 removed lines

@@ -36,183 +36,183 @@
  */
 class CoordinatesPlaceMapper implements PlaceMapperInterface
 {
-    use PlaceMapperTrait;
-
-    private ?string $cache_key = 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()) {
-            return null;
-        }
-        $features = $features_index['grid'][$grid_box[0]][$grid_box[1]];
-        foreach ($features as $feature) {
-            $geometry = $feature->getGeometry();
-            if ($place_point->SRID() === $geometry->SRID() && $geometry->contains($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 array|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.}
-     *
-     * @return array|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 (!GeometryEngineRegistry::has()) {
-                GeometryEngineRegistry::set(new PDOEngine(DB::connection()->getPdo()));
-            }
-            $point = Point::xy(1, 1);
-            return $point->equals($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;
+
+	/**
+	 * {@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()) {
+			return null;
+		}
+		$features = $features_index['grid'][$grid_box[0]][$grid_box[1]];
+		foreach ($features as $feature) {
+			$geometry = $feature->getGeometry();
+			if ($place_point->SRID() === $geometry->SRID() && $geometry->contains($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 array|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.}
+	 *
+	 * @return array|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 (!GeometryEngineRegistry::has()) {
+				GeometryEngineRegistry::set(new PDOEngine(DB::connection()->getPdo()));
+			}
+			$point = Point::xy(1, 1);
+			return $point->equals($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;
+	}
 }