jon48 / webtrees-lib

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;
+	}
 }

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;
+	}
 }

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/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResults.php

Indentation +91 added lines, -91 removed lines

@@ -23,104 +23,104 @@
  */
 class GeoAnalysisResults
 {
-    private GeoAnalysisResult $global;
+	private GeoAnalysisResult $global;
 
-    /**
-     * @var Collection<string, GeoAnalysisResult> $detailed
-     */
-    private Collection $detailed;
+	/**
+	 * @var Collection<string, GeoAnalysisResult> $detailed
+	 */
+	private Collection $detailed;
 
-    /**
-     * Constructor for GeoAnalysisResults
-     */
-    public function __construct()
-    {
-        $this->global = new GeoAnalysisResult('Global', 0);
-        $this->detailed = new Collection();
-    }
+	/**
+	 * Constructor for GeoAnalysisResults
+	 */
+	public function __construct()
+	{
+		$this->global = new GeoAnalysisResult('Global', 0);
+		$this->detailed = new Collection();
+	}
 
-    /**
-     * Global result of the geographical analysis
-     *
-     * @return GeoAnalysisResult
-     */
-    public function global(): GeoAnalysisResult
-    {
-        return $this->global;
-    }
+	/**
+	 * Global result of the geographical analysis
+	 *
+	 * @return GeoAnalysisResult
+	 */
+	public function global(): GeoAnalysisResult
+	{
+		return $this->global;
+	}
 
-    /**
-     * List of results by category of the geographical analysis
-     *
-     * @return Collection<string, GeoAnalysisResult>
-     */
-    public function detailed(): Collection
-    {
-        return $this->detailed;
-    }
+	/**
+	 * List of results by category of the geographical analysis
+	 *
+	 * @return Collection<string, GeoAnalysisResult>
+	 */
+	public function detailed(): Collection
+	{
+		return $this->detailed;
+	}
 
-    /**
-     * List of results by category of the geographical analysis.
-     * The list is sorted first by the category order, then by the category description
-     *
-     * @return Collection<string, GeoAnalysisResult>
-     */
-    public function sortedDetailed(): Collection
-    {
-        return $this->detailed->sortBy([
-            fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int => $a->order() <=> $b->order(),
-            fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int =>
-                I18N::comparator()($a->description(), $b->description())
-        ]);
-    }
+	/**
+	 * List of results by category of the geographical analysis.
+	 * The list is sorted first by the category order, then by the category description
+	 *
+	 * @return Collection<string, GeoAnalysisResult>
+	 */
+	public function sortedDetailed(): Collection
+	{
+		return $this->detailed->sortBy([
+			fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int => $a->order() <=> $b->order(),
+			fn(GeoAnalysisResult $a, GeoAnalysisResult $b): int =>
+				I18N::comparator()($a->description(), $b->description())
+		]);
+	}
 
-    /**
-     * Add a GeoAnalysis Place to the global result
-     *
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlace(GeoAnalysisPlace $place): void
-    {
-        $this->global()->addPlace($place);
-    }
+	/**
+	 * Add a GeoAnalysis Place to the global result
+	 *
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlace(GeoAnalysisPlace $place): void
+	{
+		$this->global()->addPlace($place);
+	}
 
-    /**
-     * Add a new category to the list of results, if it does not exist yet
-     *
-     * @param string $description
-     * @param int $order
-     */
-    public function addCategory(string $description, int $order): void
-    {
-        if (!$this->detailed->has($description)) {
-            $this->detailed->put($description, new GeoAnalysisResult($description, $order));
-        }
-    }
+	/**
+	 * Add a new category to the list of results, if it does not exist yet
+	 *
+	 * @param string $description
+	 * @param int $order
+	 */
+	public function addCategory(string $description, int $order): void
+	{
+		if (!$this->detailed->has($description)) {
+			$this->detailed->put($description, new GeoAnalysisResult($description, $order));
+		}
+	}
 
-    /**
-     * Add a GeoAnalysis Place to a category result, if the category exist.
-     *
-     * @param string $category_name
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlaceInCreatedCategory(string $category_name, GeoAnalysisPlace $place): void
-    {
-        if ($this->detailed->has($category_name)) {
-            $this->detailed->get($category_name)->addPlace($place);
-        }
-    }
+	/**
+	 * Add a GeoAnalysis Place to a category result, if the category exist.
+	 *
+	 * @param string $category_name
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlaceInCreatedCategory(string $category_name, GeoAnalysisPlace $place): void
+	{
+		if ($this->detailed->has($category_name)) {
+			$this->detailed->get($category_name)->addPlace($place);
+		}
+	}
 
-    /**
-     * Add a GeoAnalysis Place to a category result, after creating the category if it does not exist.
-     *
-     * @param string $category_name
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlaceInCategory(string $category_name, int $category_order, GeoAnalysisPlace $place): void
-    {
-        if (!$this->detailed->has($category_name)) {
-            $this->addCategory($category_name, $category_order);
-        }
-        $this->addPlaceInCreatedCategory($category_name, $place);
-    }
+	/**
+	 * Add a GeoAnalysis Place to a category result, after creating the category if it does not exist.
+	 *
+	 * @param string $category_name
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlaceInCategory(string $category_name, int $category_order, GeoAnalysisPlace $place): void
+	{
+		if (!$this->detailed->has($category_name)) {
+			$this->addCategory($category_name, $category_order);
+		}
+		$this->addPlaceInCreatedCategory($category_name, $place);
+	}
 }

app/Module/GeoDispersion/Views/GeoAnalysisTable.php

Indentation +43 added lines, -43 removed lines

@@ -22,51 +22,51 @@
 
 class GeoAnalysisTable extends AbstractGeoAnalysisView
 {
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::type()
-     */
-    public function type(): string
-    {
-        return I18N::translateContext('GEODISPERSION', 'Table');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::type()
+	 */
+	public function type(): string
+	{
+		return I18N::translateContext('GEODISPERSION', 'Table');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::icon()
-     */
-    public function icon(ModuleInterface $module): string
-    {
-        return view($module->name() . '::icons/view-table', ['type' => $this->type()]);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::icon()
+	 */
+	public function icon(ModuleInterface $module): string
+	{
+		return view($module->name() . '::icons/view-table', ['type' => $this->type()]);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::globalSettingsContent()
-     */
-    public function globalSettingsContent(ModuleInterface $module): string
-    {
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::globalSettingsContent()
+	 */
+	public function globalSettingsContent(ModuleInterface $module): string
+	{
+		return '';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::withGlobalSettingsUpdate()
-     * @return $this
-     */
-    public function withGlobalSettingsUpdate(ServerRequestInterface $request): self
-    {
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::withGlobalSettingsUpdate()
+	 * @return $this
+	 */
+	public function withGlobalSettingsUpdate(ServerRequestInterface $request): self
+	{
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::globalTabContent()
-     */
-    public function globalTabContent(GeoDispersionModule $module, GeoAnalysisResult $result, array $params): string
-    {
-        return view($module->name() . '::geoanalysisview-tab-glb-table', $params + [
-            'result'    =>  $result
-        ]);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\GeoDispersion\Views\AbstractGeoAnalysisView::globalTabContent()
+	 */
+	public function globalTabContent(GeoDispersionModule $module, GeoAnalysisResult $result, array $params): string
+	{
+		return view($module->name() . '::geoanalysisview-tab-glb-table', $params + [
+			'result'    =>  $result
+		]);
+	}
 }

app/Module/GeoDispersion/Views/AbstractGeoAnalysisView.php

Indentation +220 added lines, -220 removed lines

@@ -27,224 +27,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 GeoDispersionModule $module
-     * @param GeoAnalysisResult $result
-     * @param array<string, mixed> $params
-     * @return string
-     */
-    abstract public function globalTabContent(
-        GeoDispersionModule $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 GeoDispersionModule $module
+	 * @param GeoAnalysisResult $result
+	 * @param array<string, mixed> $params
+	 * @return string
+	 */
+	abstract public function globalTabContent(
+		GeoDispersionModule $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/Contracts/Hooks/NameAccordionExtenderInterface.php

Indentation +15 added lines, -15 removed lines

@@ -1,14 +1,14 @@ 
 <?php
 
  /**
- * webtrees-lib: MyArtJaub library for webtrees
- *
- * @package MyArtJaub\Webtrees
- * @subpackage Hooks
- * @author Jonathan Jaubart <dev@jaubart.com>
- * @copyright Copyright (c) 2011-2022, Jonathan Jaubart
- * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
- */
+  * webtrees-lib: MyArtJaub library for webtrees
+  *
+  * @package MyArtJaub\Webtrees
+  * @subpackage Hooks
+  * @author Jonathan Jaubart <dev@jaubart.com>
+  * @copyright Copyright (c) 2011-2022, Jonathan Jaubart
+  * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
+  */
 
 declare(strict_types=1);
 
@@ -21,11 +21,11 @@ 
  */
 interface NameAccordionExtenderInterface extends HookInterface
 {
-    /**
-     * Add a new card to the names accordion.
-     *
-     * @param Individual $individual
-     * @return string
-     */
-    public function accordionCard(Individual $individual): string;
+	/**
+	 * Add a new card to the names accordion.
+	 *
+	 * @param Individual $individual
+	 * @return string
+	 */
+	public function accordionCard(Individual $individual): string;
 }

app/Contracts/Hooks/ModuleHookSubscriberInterface.php

Indentation +14 added lines, -14 removed lines

@@ -1,14 +1,14 @@ 
 <?php
 
  /**
- * webtrees-lib: MyArtJaub library for webtrees
- *
- * @package MyArtJaub\Webtrees
- * @subpackage Hooks
- * @author Jonathan Jaubart <dev@jaubart.com>
- * @copyright Copyright (c) 2011-2022, Jonathan Jaubart
- * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
- */
+  * webtrees-lib: MyArtJaub library for webtrees
+  *
+  * @package MyArtJaub\Webtrees
+  * @subpackage Hooks
+  * @author Jonathan Jaubart <dev@jaubart.com>
+  * @copyright Copyright (c) 2011-2022, Jonathan Jaubart
+  * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
+  */
 
 declare(strict_types=1);
 
@@ -19,10 +19,10 @@ 
  */
 interface ModuleHookSubscriberInterface
 {
-    /**
-     * List hooks to be subscribed by the module as an array.
-     *
-     * @return HookInterface[]
-     */
-    public function listSubscribedHooks(): array;
+	/**
+	 * List hooks to be subscribed by the module as an array.
+	 *
+	 * @return HookInterface[]
+	 */
+	public function listSubscribedHooks(): array;
 }

app/Contracts/Hooks/FamilyDatatablesExtenderInterface.php

Indentation +15 added lines, -15 removed lines

@@ -1,14 +1,14 @@ 
 <?php
 
  /**
- * webtrees-lib: MyArtJaub library for webtrees
- *
- * @package MyArtJaub\Webtrees
- * @subpackage Hooks
- * @author Jonathan Jaubart <dev@jaubart.com>
- * @copyright Copyright (c) 2011-2022, Jonathan Jaubart
- * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
- */
+  * webtrees-lib: MyArtJaub library for webtrees
+  *
+  * @package MyArtJaub\Webtrees
+  * @subpackage Hooks
+  * @author Jonathan Jaubart <dev@jaubart.com>
+  * @copyright Copyright (c) 2011-2022, Jonathan Jaubart
+  * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
+  */
 
 declare(strict_types=1);
 
@@ -19,11 +19,11 @@ 
  */
 interface FamilyDatatablesExtenderInterface extends HookInterface
 {
-    /**
-     * Get the columns to be added to families datatables
-     *
-     * @param iterable<\Fisharebest\Webtrees\Family> $records
-     * @return array<string, array<string, array<string, mixed>>>
-     */
-    public function familyColumns(iterable $records): array;
+	/**
+	 * Get the columns to be added to families datatables
+	 *
+	 * @param iterable<\Fisharebest\Webtrees\Family> $records
+	 * @return array<string, array<string, array<string, mixed>>>
+	 */
+	public function familyColumns(iterable $records): array;
 }