jon48 / webtrees-lib

src/Webtrees/Module/GeoDispersion/Model/GeoAnalysisMapAdapter.php

Indentation +152 added lines, -152 removed lines

@@ -29,156 +29,156 @@
  */
 class GeoAnalysisMapAdapter
 {
-    private int $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,
-        MapDefinitionInterface $map,
-        PlaceMapperInterface $mapper,
-        MapViewConfigInterface $config
-    ) {
-        $this->id = $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();
-    }
-
-    /**
-     * Get the GeoAnalysisMapAdapter ID
-     *
-     * @return int
-     */
-    public function id(): int
-    {
-        return $this->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 array
-     */
-    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 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,
+		MapDefinitionInterface $map,
+		PlaceMapperInterface $mapper,
+		MapViewConfigInterface $config
+	) {
+		$this->id = $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();
+	}
+
+	/**
+	 * Get the GeoAnalysisMapAdapter ID
+	 *
+	 * @return int
+	 */
+	public function id(): int
+	{
+		return $this->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 array
+	 */
+	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());
+	}
 }

src/Webtrees/Module/GeoDispersion/Http/RequestHandlers/GeoAnalysisViewTabs.php

Indentation +53 added lines, -53 removed lines

@@ -30,66 +30,66 @@
  */
 class GeoAnalysisViewTabs implements RequestHandlerInterface
 {
-    private ?GeoDispersionModule $module;
-    private GeoAnalysisViewDataService $geoviewdata_service;
+	private ?GeoDispersionModule $module;
+	private GeoAnalysisViewDataService $geoviewdata_service;
 
-    /**
-     * Constructor for GeoAnalysisMapsList Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        GeoAnalysisViewDataService $geoviewdata_service
-    ) {
-        $this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
-        $this->geoviewdata_service = $geoviewdata_service;
-    }
+	/**
+	 * Constructor for GeoAnalysisMapsList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		GeoAnalysisViewDataService $geoviewdata_service
+	) {
+		$this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
+		$this->geoviewdata_service = $geoviewdata_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
 
-        $view_id = $request->getAttribute('view_id');
-        $view_id = is_numeric($view_id) ? (int) $view_id : 0;
+		$view_id = $request->getAttribute('view_id');
+		$view_id = is_numeric($view_id) ? (int) $view_id : 0;
 
-        $view = $this->geoviewdata_service->find($tree, $view_id);
+		$view = $this->geoviewdata_service->find($tree, $view_id);
 
-        if ($view === null) {
-            throw new HttpNotFoundException(I18N::translate('The requested dispersion analysis does not exist.'));
-        }
+		if ($view === null) {
+			throw new HttpNotFoundException(I18N::translate('The requested dispersion analysis does not exist.'));
+		}
 
-        $results = $view->analysis()->results($tree, $view->placesDepth());
+		$results = $view->analysis()->results($tree, $view->placesDepth());
 
-        $params = [
-            'module_name'   =>  $this->module->name(),
-            'tree'          =>  $tree,
-            'view'          =>  $view,
-            'items_descr'   =>  $view->analysis()->itemsDescription()
-        ];
-        $response = [
-            'global'    =>  view('layouts/ajax', [
-                'content' =>    $view->globalTabContent(
-                    $this->module,
-                    $results->global(),
-                    $this->geoviewdata_service,
-                    $params
-                )
-            ]),
-            'detailed'  => view('layouts/ajax', [
-                'content' =>    $view->detailedTabContent($this->module, $results->sortedDetailed(), $params)
-            ])
-        ];
+		$params = [
+			'module_name'   =>  $this->module->name(),
+			'tree'          =>  $tree,
+			'view'          =>  $view,
+			'items_descr'   =>  $view->analysis()->itemsDescription()
+		];
+		$response = [
+			'global'    =>  view('layouts/ajax', [
+				'content' =>    $view->globalTabContent(
+					$this->module,
+					$results->global(),
+					$this->geoviewdata_service,
+					$params
+				)
+			]),
+			'detailed'  => view('layouts/ajax', [
+				'content' =>    $view->detailedTabContent($this->module, $results->sortedDetailed(), $params)
+			])
+		];
 
-        return response($response);
-    }
+		return response($response);
+	}
 }

src/Webtrees/Module/GeoDispersion/Http/RequestHandlers/GeoAnalysisViewsList.php

Indentation +37 added lines, -37 removed lines

@@ -32,47 +32,47 @@
  */
 class GeoAnalysisViewsList implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?GeoDispersionModule $module;
-    private GeoAnalysisViewDataService $geoviewdata_service;
+	private ?GeoDispersionModule $module;
+	private GeoAnalysisViewDataService $geoviewdata_service;
 
-    /**
-     * Constructor for GeoAnalysisViewsList Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        GeoAnalysisViewDataService $geoviewdata_service
-    ) {
-        $this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
-        $this->geoviewdata_service = $geoviewdata_service;
-    }
+	/**
+	 * Constructor for GeoAnalysisViewsList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		GeoAnalysisViewDataService $geoviewdata_service
+	) {
+		$this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
+		$this->geoviewdata_service = $geoviewdata_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
 
-        $views_list = $this->geoviewdata_service
-            ->all($tree)
-            ->sortBy(fn(AbstractGeoAnalysisView $view) => $view->description());
+		$views_list = $this->geoviewdata_service
+			->all($tree)
+			->sortBy(fn(AbstractGeoAnalysisView $view) => $view->description());
 
-        return $this->viewResponse($this->module->name() . '::geoanalysisviews-list', [
-            'module'        =>  $this->module,
-            'title'         =>  I18N::translate('Geographical dispersion'),
-            'tree'          =>  $tree,
-            'views_list'    =>  $views_list,
-            'js_script_url' =>  $this->module->assetUrl('js/geodispersion.min.js')
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::geoanalysisviews-list', [
+			'module'        =>  $this->module,
+			'title'         =>  I18N::translate('Geographical dispersion'),
+			'tree'          =>  $tree,
+			'views_list'    =>  $views_list,
+			'js_script_url' =>  $this->module->assetUrl('js/geodispersion.min.js')
+		]);
+	}
 }

src/Webtrees/Module/GeoDispersion/Http/RequestHandlers/GeoAnalysisViewPage.php

Indentation +35 added lines, -35 removed lines

@@ -31,45 +31,45 @@
  */
 class GeoAnalysisViewPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    private ?GeoDispersionModule $module;
-    private GeoAnalysisViewDataService $geoviewdata_service;
+	private ?GeoDispersionModule $module;
+	private GeoAnalysisViewDataService $geoviewdata_service;
 
-    /**
-     * Constructor for GeoAnalysisViewPage Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        GeoAnalysisViewDataService $geoviewdata_service
-    ) {
-        $this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
-        $this->geoviewdata_service = $geoviewdata_service;
-    }
+	/**
+	 * Constructor for GeoAnalysisViewPage Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		GeoAnalysisViewDataService $geoviewdata_service
+	) {
+		$this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
+		$this->geoviewdata_service = $geoviewdata_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
 
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
 
-        $view_id = $request->getAttribute('view_id');
-        $view_id = is_numeric($view_id) ? (int) $view_id : 0;
+		$view_id = $request->getAttribute('view_id');
+		$view_id = is_numeric($view_id) ? (int) $view_id : 0;
 
-        return $this->viewResponse($this->module->name() . '::geoanalysisview-page', [
-            'module_name'           =>  $this->module->name(),
-            'title'                 =>  I18N::translate('Geographical dispersion'),
-            'tree'                  =>  $tree,
-            'view'                  =>  $this->geoviewdata_service->find($tree, $view_id)
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::geoanalysisview-page', [
+			'module_name'           =>  $this->module->name(),
+			'title'                 =>  I18N::translate('Geographical dispersion'),
+			'tree'                  =>  $tree,
+			'view'                  =>  $this->geoviewdata_service->find($tree, $view_id)
+		]);
+	}
 }

src/Webtrees/Module/GeoDispersion/GeoDispersionModule.php

Indentation +129 added lines, -129 removed lines

@@ -41,134 +41,134 @@
  * Geographical Dispersion Module.
  */
 class GeoDispersionModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleChartInterface,
-    ModuleGlobalInterface,
-    ModuleGeoAnalysisProviderInterface,
-    ModulePlaceMapperProviderInterface
+	ModuleMyArtJaubInterface,
+	ModuleChartInterface,
+	ModuleGlobalInterface,
+	ModuleGeoAnalysisProviderInterface,
+	ModulePlaceMapperProviderInterface
 {
-    use ModuleMyArtJaubTrait {
-        boot as traitBoot;
-    }
-    use ModuleChartTrait;
-    use ModuleGlobalTrait;
-
-    // How to update the database schema for this module
-    private const SCHEMA_TARGET_VERSION   = 2;
-    private const SCHEMA_SETTING_NAME     = 'MAJ_GEODISP_SCHEMA_VERSION';
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “GeoDispersion” module */ I18N::translate('Geographical Dispersion');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “GeoDispersion” module */ I18N::translate('Perform and display geographical dispersion analysis');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
-     */
-    public function boot(): void
-    {
-        $this->traitBoot();
-        app(MigrationService::class)->updateSchema(
-            self::SCHEMA_MIGRATION_PREFIX,
-            self::SCHEMA_SETTING_NAME,
-            self::SCHEMA_TARGET_VERSION
-        );
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.0-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/geodispersion', static function (Map $router): void {
-
-                $router->get(GeoAnalysisViewsList::class, '/list/{tree}', GeoAnalysisViewsList::class);
-
-                $router->attach('', '/analysisview/{tree}/{view_id}', static function (Map $router): void {
-                    $router->get(GeoAnalysisViewPage::class, '', GeoAnalysisViewPage::class);
-                    $router->get(GeoAnalysisViewTabs::class, '/tabs', GeoAnalysisViewTabs::class);
-                });
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleChartInterface::chartUrl()
-     */
-    public function chartUrl(Individual $individual, array $parameters = []): string
-    {
-        return route(GeoAnalysisViewsList::class, ['tree' => $individual->tree()->name()] + $parameters);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleChartInterface::chartMenuClass()
-     */
-    public function chartMenuClass(): string
-    {
-        return 'menu-maj-geodispersion';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
-     */
-    public function headContent(): string
-    {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModulePlaceMapperProviderInterface::listPlaceMappers()
-     */
-    public function listPlaceMappers(): array
-    {
-        return [
-            CoordinatesPlaceMapper::class,
-            SimplePlaceMapper::class,
-            SimpleTopFilteredPlaceMapper::class
-        ];
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModuleGeoAnalysisProviderInterface::listGeoAnalyses()
-     */
-    public function listGeoAnalyses(): array
-    {
-        return [
-            AllEventsByCenturyGeoAnalysis::class,
-            AllEventsByTypeGeoAnalysis::class
-        ];
-    }
+	use ModuleMyArtJaubTrait {
+		boot as traitBoot;
+	}
+	use ModuleChartTrait;
+	use ModuleGlobalTrait;
+
+	// How to update the database schema for this module
+	private const SCHEMA_TARGET_VERSION   = 2;
+	private const SCHEMA_SETTING_NAME     = 'MAJ_GEODISP_SCHEMA_VERSION';
+	private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return /* I18N: Name of the “GeoDispersion” module */ I18N::translate('Geographical Dispersion');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “GeoDispersion” module */ I18N::translate('Perform and display geographical dispersion analysis');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
+	 */
+	public function boot(): void
+	{
+		$this->traitBoot();
+		app(MigrationService::class)->updateSchema(
+			self::SCHEMA_MIGRATION_PREFIX,
+			self::SCHEMA_SETTING_NAME,
+			self::SCHEMA_TARGET_VERSION
+		);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.0-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/geodispersion', static function (Map $router): void {
+
+				$router->get(GeoAnalysisViewsList::class, '/list/{tree}', GeoAnalysisViewsList::class);
+
+				$router->attach('', '/analysisview/{tree}/{view_id}', static function (Map $router): void {
+					$router->get(GeoAnalysisViewPage::class, '', GeoAnalysisViewPage::class);
+					$router->get(GeoAnalysisViewTabs::class, '/tabs', GeoAnalysisViewTabs::class);
+				});
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleChartInterface::chartUrl()
+	 */
+	public function chartUrl(Individual $individual, array $parameters = []): string
+	{
+		return route(GeoAnalysisViewsList::class, ['tree' => $individual->tree()->name()] + $parameters);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleChartInterface::chartMenuClass()
+	 */
+	public function chartMenuClass(): string
+	{
+		return 'menu-maj-geodispersion';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
+	 */
+	public function headContent(): string
+	{
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModulePlaceMapperProviderInterface::listPlaceMappers()
+	 */
+	public function listPlaceMappers(): array
+	{
+		return [
+			CoordinatesPlaceMapper::class,
+			SimplePlaceMapper::class,
+			SimpleTopFilteredPlaceMapper::class
+		];
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModuleGeoAnalysisProviderInterface::listGeoAnalyses()
+	 */
+	public function listGeoAnalyses(): array
+	{
+		return [
+			AllEventsByCenturyGeoAnalysis::class,
+			AllEventsByTypeGeoAnalysis::class
+		];
+	}
 }

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

Indentation +160 added lines, -160 removed lines

@@ -35,174 +35,174 @@
  */
 class CoordinatesPlaceMapper implements PlaceMapperInterface
 {
-    use PlaceMapperTrait;
+	use PlaceMapperTrait;
 
-    private ?string $cache_key = null;
+	private ?string $cache_key = null;
 
-    /**
-     * {@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;
-        }
+	/**
+	 * {@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;
-        }
+		$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;
-    }
+		$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();
+	/**
+	 * 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;
+		$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;
-    }
+		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
-            ];
-        });
-    }
+	/**
+	 * 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;
-    }
+	/**
+	 * 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;
-    }
+	/**
+	 * 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;
+	}
 }

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

Indentation +16 added lines, -16 removed lines

@@ -25,22 +25,22 @@
  */
 class SimpleTopFilteredPlaceMapper extends SimplePlaceMapper implements PlaceMapperInterface
 {
-    use TopFilteredPlaceMapperTrait;
+	use TopFilteredPlaceMapperTrait;
 
-    public function boot(): void
-    {
-        parent::boot();
-        $top_places = $this->config()->get('topPlaces');
-        if (is_array($top_places)) {
-            $this->setTopPlaces($top_places);
-        }
-    }
+	public function boot(): void
+	{
+		parent::boot();
+		$top_places = $this->config()->get('topPlaces');
+		if (is_array($top_places)) {
+			$this->setTopPlaces($top_places);
+		}
+	}
 
-    public function map(Place $place, string $feature_property): ?string
-    {
-        if (!$this->belongsToTopLevels($place)) {
-            return null;
-        }
-        return parent::map($place, $feature_property);
-    }
+	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/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 array $top_places
-     */
-    public function setTopPlaces(array $top_places): void
-    {
-        $this->top_places = collect($top_places)
-            ->filter(
-                /** @psalm-suppress MissingClosureParamType */
-                fn($top_places) => $top_places instanceof Place
-            )->toArray();
-    }
+	/**
+	 * Set the list of defined top level places.
+	 *
+	 * @param array $top_places
+	 */
+	public function setTopPlaces(array $top_places): void
+	{
+		$this->top_places = collect($top_places)
+			->filter(
+				/** @psalm-suppress MissingClosureParamType */
+				fn($top_places) => $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;
+	}
 }

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

Indentation +9 added lines, -9 removed lines

@@ -23,14 +23,14 @@
  */
 class SimplePlaceMapper implements PlaceMapperInterface
 {
-    use PlaceMapperTrait;
+	use PlaceMapperTrait;
 
-    /**
-     * {@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();
+	}
 }