jon48 / webtrees-lib

app/Module/GeoDispersion/Services/MapAdapterDataService.php

Indentation +157 added lines, -157 removed lines

@@ -31,171 +31,171 @@
  */
 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
-     * @param bool $show_invalid
-     * @return Collection<GeoAnalysisMapAdapter|null>
-     */
-    public function allForView(GeoAnalysisMap $map_view, bool $show_invalid = false): Collection
-    {
-        $map_adapters = DB::table('maj_geodisp_mapviews')
-            ->select('maj_geodisp_mapviews.*')
-            ->where('majgm_majgv_id', '=', $map_view->id())
-            ->get()
-            ->map($this->mapAdapterMapper());
-        return $show_invalid ? $map_adapters : $map_adapters->filter();
-    }
+	/**
+	 * Get all GeoAnalysisMapAdapters linked to a Map View.
+	 *
+	 * @param GeoAnalysisMap $map_view
+	 * @param bool $show_invalid
+	 * @return Collection<GeoAnalysisMapAdapter|null>
+	 */
+	public function allForView(GeoAnalysisMap $map_view, bool $show_invalid = false): Collection
+	{
+		$map_adapters = DB::table('maj_geodisp_mapviews')
+			->select('maj_geodisp_mapviews.*')
+			->where('majgm_majgv_id', '=', $map_view->id())
+			->get()
+			->map($this->mapAdapterMapper());
+		return $show_invalid ? $map_adapters : $map_adapters->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();
+	}
 
-    /**
-     * Delete invalid GeoAnalysisMapAdapters from the database.
-     *
-     * @param AbstractGeoAnalysisView $view
-     * @param Collection<int> $valid_map_adapters
-     * @return int
-     */
-    public function deleteInvalid(AbstractGeoAnalysisView $view, Collection $valid_map_adapters): int
-    {
-        return DB::table('maj_geodisp_mapviews')
-            ->where('majgm_majgv_id', '=', $view->id())
-            ->whereNotIn('majgm_id', $valid_map_adapters)
-            ->delete();
-    }
+	/**
+	 * Delete invalid GeoAnalysisMapAdapters from the database.
+	 *
+	 * @param AbstractGeoAnalysisView $view
+	 * @param Collection<int> $valid_map_adapters
+	 * @return int
+	 */
+	public function deleteInvalid(AbstractGeoAnalysisView $view, Collection $valid_map_adapters): int
+	{
+		return DB::table('maj_geodisp_mapviews')
+			->where('majgm_majgv_id', '=', $view->id())
+			->whereNotIn('majgm_id', $valid_map_adapters)
+			->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;
+		}
+	}
 }

app/Module/GeoDispersion/Services/GeoAnalysisService.php

Indentation +34 added lines, -34 removed lines

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

Spacing +1 added lines, -1 removed lines

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

app/Module/GeoDispersion/Services/PlaceMapperService.php

Indentation +34 added lines, -34 removed lines

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

Spacing +2 added lines, -2 removed lines

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

app/Module/GeoDispersion/Services/GeoAnalysisDataService.php

Indentation +56 added lines, -56 removed lines

@@ -26,64 +26,64 @@
  */
 class GeoAnalysisDataService
 {
-    /**
-     * Yields indviduals and family records for a specified tree.
-     *
-     * @param Tree $tree
-     * @return \Generator<\Fisharebest\Webtrees\GedcomRecord>
-     */
-    public function individualsAndFamilies(Tree $tree): Generator
-    {
-        yield from DB::table('individuals')
-            ->where('i_file', '=', $tree->id())
-            ->select(['individuals.*'])
-            ->get()
-            ->map(Registry::individualFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter())
-            ->all();
+	/**
+	 * Yields indviduals and family records for a specified tree.
+	 *
+	 * @param Tree $tree
+	 * @return \Generator<\Fisharebest\Webtrees\GedcomRecord>
+	 */
+	public function individualsAndFamilies(Tree $tree): Generator
+	{
+		yield from DB::table('individuals')
+			->where('i_file', '=', $tree->id())
+			->select(['individuals.*'])
+			->get()
+			->map(Registry::individualFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter())
+			->all();
 
-        yield from DB::table('families')
-            ->where('f_file', '=', $tree->id())
-            ->select(['families.*'])
-            ->get()
-            ->map(Registry::familyFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter())
-            ->all();
-    }
+		yield from DB::table('families')
+			->where('f_file', '=', $tree->id())
+			->select(['families.*'])
+			->get()
+			->map(Registry::familyFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter())
+			->all();
+	}
 
-    /**
-     * Returns an example of the place hierarchy, from a place within the GEDCOM file, looking for the deepest
-     * hierarchy found. The part order is reversed compared to the normal GEDCOM structure (largest first).
-     *
-     * {@internal The places are taken only from the individuals and families records.}
-     *
-     * @param Tree $tree
-     * @return array<int, string[]>
-     */
-    public function placeHierarchyExample(Tree $tree): array
-    {
-        $query_individuals = DB::table('individuals')
-            ->select(['i_gedcom AS g_gedcom'])
-            ->where('i_file', '=', $tree->id())
-            ->where('i_gedcom', 'like', '%2 PLAC %');
+	/**
+	 * Returns an example of the place hierarchy, from a place within the GEDCOM file, looking for the deepest
+	 * hierarchy found. The part order is reversed compared to the normal GEDCOM structure (largest first).
+	 *
+	 * {@internal The places are taken only from the individuals and families records.}
+	 *
+	 * @param Tree $tree
+	 * @return array<int, string[]>
+	 */
+	public function placeHierarchyExample(Tree $tree): array
+	{
+		$query_individuals = DB::table('individuals')
+			->select(['i_gedcom AS g_gedcom'])
+			->where('i_file', '=', $tree->id())
+			->where('i_gedcom', 'like', '%2 PLAC %');
 
-        $query_families = DB::table('families')
-            ->select(['f_gedcom AS g_gedcom'])
-            ->where('f_file', '=', $tree->id())
-            ->where('f_gedcom', 'like', '%2 PLAC %');
+		$query_families = DB::table('families')
+			->select(['f_gedcom AS g_gedcom'])
+			->where('f_file', '=', $tree->id())
+			->where('f_gedcom', 'like', '%2 PLAC %');
 
-        return $query_individuals->unionAll($query_families)
-            ->get()->pluck('g_gedcom')
-            ->flatMap(static function (string $gedcom): array {
-                preg_match_all('/\n2 PLAC (.+)/', $gedcom, $matches);
-                return $matches[1] ?? [];
-            })
-            ->sort(I18N::comparator())->reverse()
-            ->mapWithKeys(static function (string $place): array {
-                $place_array = array_reverse(array_filter(array_map('trim', explode(",", $place))));
-                return [ count($place_array) => $place_array ];
-            })
-            ->sortKeys()
-            ->last();
-    }
+		return $query_individuals->unionAll($query_families)
+			->get()->pluck('g_gedcom')
+			->flatMap(static function (string $gedcom): array {
+				preg_match_all('/\n2 PLAC (.+)/', $gedcom, $matches);
+				return $matches[1] ?? [];
+			})
+			->sort(I18N::comparator())->reverse()
+			->mapWithKeys(static function (string $place): array {
+				$place_array = array_reverse(array_filter(array_map('trim', explode(",", $place))));
+				return [ count($place_array) => $place_array ];
+			})
+			->sortKeys()
+			->last();
+	}
 }

app/Module/GeoDispersion/PlaceMappers/PlaceMapperTrait.php

Indentation +57 added lines, -57 removed lines

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

app/Module/GeoDispersion/PlaceMappers/TopFilteredPlaceMapperTrait.php

Indentation +57 added lines, -57 removed lines

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

app/Module/GeoDispersion/PlaceMappers/CoordinatesPlaceMapper.php

Indentation +180 added lines, -180 removed lines

@@ -36,184 +36,184 @@
  */
 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 ($geometry !== null && $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 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 (!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 ($geometry !== null && $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 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 (!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;
+	}
 }

app/Module/GeoDispersion/Views/AbstractGeoAnalysisView.php

Indentation +220 added lines, -220 removed lines

@@ -26,224 +26,224 @@
  */
 abstract class AbstractGeoAnalysisView
 {
-    private int $id;
-    private Tree $tree;
-    private bool $enabled;
-    private string $description;
-    private GeoAnalysisInterface $geoanalysis;
-    private int $depth;
-    private int $detailed_top_places;
-    private bool $use_flags;
-
-    /**
-     * Constructor for AbstractGeoAnalysisView
-     *
-     * @param int $id
-     * @param Tree $tree
-     * @param bool $enabled
-     * @param string $description
-     * @param GeoAnalysisInterface $geoanalysis
-     * @param int $depth
-     * @param int $detailed_top_places
-     * @param bool $use_flags
-     */
-    final public function __construct(
-        int $id,
-        Tree $tree,
-        bool $enabled,
-        string $description,
-        GeoAnalysisInterface $geoanalysis,
-        int $depth,
-        int $detailed_top_places = 0,
-        bool $use_flags = false
-    ) {
-        $this->id = $id;
-        $this->tree = $tree;
-        $this->enabled = $enabled;
-        $this->description = $description;
-        $this->geoanalysis = $geoanalysis;
-        $this->depth = $depth;
-        $this->detailed_top_places = $detailed_top_places;
-        $this->use_flags = $use_flags;
-    }
-
-    /**
-     * Create a copy of the view with a new ID.
-     *
-     * @param int $id
-     * @return static
-     */
-    public function withId(int $id): self
-    {
-        $new = clone $this;
-        $new->id = $id;
-        return $new;
-    }
-
-    /**
-     * Create a copy of the view with new properties.
-     *
-     * @param bool $enabled
-     * @param string $description
-     * @param GeoAnalysisInterface $geoanalysis
-     * @param int $depth
-     * @param int $detailed_top_places
-     * @param bool $use_flags
-     * @return static
-     */
-    public function with(
-        bool $enabled,
-        string $description,
-        GeoAnalysisInterface $geoanalysis,
-        int $depth,
-        int $detailed_top_places = 0,
-        bool $use_flags = false
-    ): self {
-        $new = clone $this;
-        $new->enabled = $enabled;
-        $new->description = $description;
-        $new->geoanalysis = $geoanalysis;
-        $new->depth = $depth;
-        $new->detailed_top_places = $detailed_top_places;
-        $new->use_flags = $use_flags;
-        return $new;
-    }
-
-    /**
-     * Get the view ID
-     *
-     * @return int
-     */
-    public function id(): int
-    {
-        return $this->id;
-    }
-
-    /**
-     * Get the view type for display
-     *
-     * @return string
-     */
-    abstract public function type(): string;
-
-    /**
-     * Get the icon for the view type
-     *
-     * @param ModuleInterface $module
-     * @return string
-     */
-    abstract public function icon(ModuleInterface $module): string;
-
-    /**
-     * Return the content of the global settings section of the config page
-     *
-     * @param ModuleInterface $module
-     * @return string
-     */
-    abstract public function globalSettingsContent(ModuleInterface $module): string;
-
-    /**
-     * Return a view with global settings updated according to the view rules
-     *
-     * @param ServerRequestInterface $request
-     * @return static
-     */
-    abstract public function withGlobalSettingsUpdate(ServerRequestInterface $request): self;
-
-    /**
-     * Returns the content of the view global tab
-     *
-     * @param ModuleInterface $module
-     * @param GeoAnalysisResult $result
-     * @param array<string, mixed> $params
-     * @return string
-     */
-    abstract public function globalTabContent(
-        ModuleInterface $module,
-        GeoAnalysisResult $result,
-        array $params
-    ): string;
-
-    /**
-     * Returns the content of the view detailed tab
-     *
-     * @param ModuleInterface $module
-     * @param Collection<string, GeoAnalysisResult> $results
-     * @param array<string, mixed> $params
-     * @return string
-     */
-    public function detailedTabContent(ModuleInterface $module, Collection $results, array $params): string
-    {
-        return view($module->name() . '::geoanalysisview-tab-detailed', $params + [ 'results'   =>  $results ]);
-    }
-
-    /**
-     * Get the tree to which the view belongs
-     *
-     * @return Tree
-     */
-    public function tree(): Tree
-    {
-        return $this->tree;
-    }
-
-    /**
-     * Get the description of the view
-     *
-     * @return string
-     */
-    public function description(): string
-    {
-        return $this->description;
-    }
-
-    /**
-     * Get whether the view is enabled
-     *
-     * @return bool
-     */
-    public function isEnabled(): bool
-    {
-        return $this->enabled;
-    }
-
-    /**
-     * Get the geographical dispersion analysis for the view
-     *
-     * @return GeoAnalysisInterface
-     */
-    public function analysis(): GeoAnalysisInterface
-    {
-        return $this->geoanalysis;
-    }
-
-    /**
-     * Get the place hierarchy depth for the view
-     *
-     * @return int
-     */
-    public function placesDepth(): int
-    {
-        return $this->depth;
-    }
-
-    /**
-     * Get the number of places to display in the detailed tab
-     *
-     * @return int
-     */
-    public function numberTopPlaces(): int
-    {
-        return $this->detailed_top_places;
-    }
-
-    /**
-     * Get whether flags should be used in the detailed tab
-     *
-     * @return bool
-     */
-    public function useFlags(): bool
-    {
-        return $this->use_flags;
-    }
+	private int $id;
+	private Tree $tree;
+	private bool $enabled;
+	private string $description;
+	private GeoAnalysisInterface $geoanalysis;
+	private int $depth;
+	private int $detailed_top_places;
+	private bool $use_flags;
+
+	/**
+	 * Constructor for AbstractGeoAnalysisView
+	 *
+	 * @param int $id
+	 * @param Tree $tree
+	 * @param bool $enabled
+	 * @param string $description
+	 * @param GeoAnalysisInterface $geoanalysis
+	 * @param int $depth
+	 * @param int $detailed_top_places
+	 * @param bool $use_flags
+	 */
+	final public function __construct(
+		int $id,
+		Tree $tree,
+		bool $enabled,
+		string $description,
+		GeoAnalysisInterface $geoanalysis,
+		int $depth,
+		int $detailed_top_places = 0,
+		bool $use_flags = false
+	) {
+		$this->id = $id;
+		$this->tree = $tree;
+		$this->enabled = $enabled;
+		$this->description = $description;
+		$this->geoanalysis = $geoanalysis;
+		$this->depth = $depth;
+		$this->detailed_top_places = $detailed_top_places;
+		$this->use_flags = $use_flags;
+	}
+
+	/**
+	 * Create a copy of the view with a new ID.
+	 *
+	 * @param int $id
+	 * @return static
+	 */
+	public function withId(int $id): self
+	{
+		$new = clone $this;
+		$new->id = $id;
+		return $new;
+	}
+
+	/**
+	 * Create a copy of the view with new properties.
+	 *
+	 * @param bool $enabled
+	 * @param string $description
+	 * @param GeoAnalysisInterface $geoanalysis
+	 * @param int $depth
+	 * @param int $detailed_top_places
+	 * @param bool $use_flags
+	 * @return static
+	 */
+	public function with(
+		bool $enabled,
+		string $description,
+		GeoAnalysisInterface $geoanalysis,
+		int $depth,
+		int $detailed_top_places = 0,
+		bool $use_flags = false
+	): self {
+		$new = clone $this;
+		$new->enabled = $enabled;
+		$new->description = $description;
+		$new->geoanalysis = $geoanalysis;
+		$new->depth = $depth;
+		$new->detailed_top_places = $detailed_top_places;
+		$new->use_flags = $use_flags;
+		return $new;
+	}
+
+	/**
+	 * Get the view ID
+	 *
+	 * @return int
+	 */
+	public function id(): int
+	{
+		return $this->id;
+	}
+
+	/**
+	 * Get the view type for display
+	 *
+	 * @return string
+	 */
+	abstract public function type(): string;
+
+	/**
+	 * Get the icon for the view type
+	 *
+	 * @param ModuleInterface $module
+	 * @return string
+	 */
+	abstract public function icon(ModuleInterface $module): string;
+
+	/**
+	 * Return the content of the global settings section of the config page
+	 *
+	 * @param ModuleInterface $module
+	 * @return string
+	 */
+	abstract public function globalSettingsContent(ModuleInterface $module): string;
+
+	/**
+	 * Return a view with global settings updated according to the view rules
+	 *
+	 * @param ServerRequestInterface $request
+	 * @return static
+	 */
+	abstract public function withGlobalSettingsUpdate(ServerRequestInterface $request): self;
+
+	/**
+	 * Returns the content of the view global tab
+	 *
+	 * @param ModuleInterface $module
+	 * @param GeoAnalysisResult $result
+	 * @param array<string, mixed> $params
+	 * @return string
+	 */
+	abstract public function globalTabContent(
+		ModuleInterface $module,
+		GeoAnalysisResult $result,
+		array $params
+	): string;
+
+	/**
+	 * Returns the content of the view detailed tab
+	 *
+	 * @param ModuleInterface $module
+	 * @param Collection<string, GeoAnalysisResult> $results
+	 * @param array<string, mixed> $params
+	 * @return string
+	 */
+	public function detailedTabContent(ModuleInterface $module, Collection $results, array $params): string
+	{
+		return view($module->name() . '::geoanalysisview-tab-detailed', $params + [ 'results'   =>  $results ]);
+	}
+
+	/**
+	 * Get the tree to which the view belongs
+	 *
+	 * @return Tree
+	 */
+	public function tree(): Tree
+	{
+		return $this->tree;
+	}
+
+	/**
+	 * Get the description of the view
+	 *
+	 * @return string
+	 */
+	public function description(): string
+	{
+		return $this->description;
+	}
+
+	/**
+	 * Get whether the view is enabled
+	 *
+	 * @return bool
+	 */
+	public function isEnabled(): bool
+	{
+		return $this->enabled;
+	}
+
+	/**
+	 * Get the geographical dispersion analysis for the view
+	 *
+	 * @return GeoAnalysisInterface
+	 */
+	public function analysis(): GeoAnalysisInterface
+	{
+		return $this->geoanalysis;
+	}
+
+	/**
+	 * Get the place hierarchy depth for the view
+	 *
+	 * @return int
+	 */
+	public function placesDepth(): int
+	{
+		return $this->depth;
+	}
+
+	/**
+	 * Get the number of places to display in the detailed tab
+	 *
+	 * @return int
+	 */
+	public function numberTopPlaces(): int
+	{
+		return $this->detailed_top_places;
+	}
+
+	/**
+	 * Get whether flags should be used in the detailed tab
+	 *
+	 * @return bool
+	 */
+	public function useFlags(): bool
+	{
+		return $this->use_flags;
+	}
 }

app/Module/GeoDispersion/Model/GeoAnalysisMapAdapter.php

Indentation +185 added lines, -185 removed lines

@@ -29,189 +29,189 @@
  */
 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(
-                        fn(GeoAnalysisPlace $place) => $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($id))->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(
+						fn(GeoAnalysisPlace $place) => $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($id))->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());
+	}
 }