jon48 / webtrees-lib

app/Module/GeoDispersion/Http/RequestHandlers/GeoAnalysisViewAddAction.php

Indentation +69 added lines, -69 removed lines

@@ -36,81 +36,81 @@
  */
 class GeoAnalysisViewAddAction implements RequestHandlerInterface
 {
-    private ?GeoDispersionModule $module;
-    private GeoAnalysisViewDataService $geoview_data_service;
+	private ?GeoDispersionModule $module;
+	private GeoAnalysisViewDataService $geoview_data_service;
 
-    /**
-     * Constructor for GeoAnalysisViewAddAction Request Handler
-     *
-     * @param ModuleService $module_service
-     * @param GeoAnalysisViewDataService $geoview_data_service
-     */
-    public function __construct(ModuleService $module_service, GeoAnalysisViewDataService $geoview_data_service)
-    {
-        $this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
-        $this->geoview_data_service = $geoview_data_service;
-    }
+	/**
+	 * Constructor for GeoAnalysisViewAddAction Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 * @param GeoAnalysisViewDataService $geoview_data_service
+	 */
+	public function __construct(ModuleService $module_service, GeoAnalysisViewDataService $geoview_data_service)
+	{
+		$this->module = $module_service->findByInterface(GeoDispersionModule::class)->first();
+		$this->geoview_data_service = $geoview_data_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $tree = Validator::attributes($request)->tree();
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$tree = Validator::attributes($request)->tree();
 
-        if ($this->module === null) {
-            FlashMessages::addMessage(
-                I18N::translate('The attached module could not be found.'),
-                'danger'
-            );
-            return Registry::responseFactory()->redirect(HomePage::class, ['tree' => $tree->name()]);
-        }
+		if ($this->module === null) {
+			FlashMessages::addMessage(
+				I18N::translate('The attached module could not be found.'),
+				'danger'
+			);
+			return Registry::responseFactory()->redirect(HomePage::class, ['tree' => $tree->name()]);
+		}
 
-        $type           = Validator::parsedBody($request)->isInArray(['table', 'map'])->string('view_type', '');
-        $description    = Validator::parsedBody($request)->string('view_description', '');
-        $place_depth    = Validator::parsedBody($request)->integer('view_depth', 1);
+		$type           = Validator::parsedBody($request)->isInArray(['table', 'map'])->string('view_type', '');
+		$description    = Validator::parsedBody($request)->string('view_description', '');
+		$place_depth    = Validator::parsedBody($request)->integer('view_depth', 1);
 
-        $analysis = null;
-        try {
-            $analysis = app(Validator::parsedBody($request)->string('view_analysis', ''));
-        } catch (BindingResolutionException $ex) {
-        }
+		$analysis = null;
+		try {
+			$analysis = app(Validator::parsedBody($request)->string('view_analysis', ''));
+		} catch (BindingResolutionException $ex) {
+		}
 
-        if ($type === '' || $place_depth <= 0 || $analysis === null || !($analysis instanceof GeoAnalysisInterface)) {
-            FlashMessages::addMessage(
-                I18N::translate('The parameters for the new view are not valid.'),
-                'danger'
-            );
-            return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]);
-        }
+		if ($type === '' || $place_depth <= 0 || $analysis === null || !($analysis instanceof GeoAnalysisInterface)) {
+			FlashMessages::addMessage(
+				I18N::translate('The parameters for the new view are not valid.'),
+				'danger'
+			);
+			return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]);
+		}
 
-        if ($type === 'map') {
-            $new_view = new GeoAnalysisMap(0, $tree, true, $description, $analysis, $place_depth);
-        } else {
-            $new_view = new GeoAnalysisTable(0, $tree, true, $description, $analysis, $place_depth);
-        }
+		if ($type === 'map') {
+			$new_view = new GeoAnalysisMap(0, $tree, true, $description, $analysis, $place_depth);
+		} else {
+			$new_view = new GeoAnalysisTable(0, $tree, true, $description, $analysis, $place_depth);
+		}
 
-        $new_view_id = $this->geoview_data_service->insertGetId($new_view);
-        if ($new_view_id > 0) {
-            FlashMessages::addMessage(
-                I18N::translate('The geographical dispersion analysis view has been successfully added.'),
-                'success'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : View “' . $new_view_id . '” has been added.');
-            return Registry::responseFactory()->redirect(
-                GeoAnalysisViewEditPage::class,
-                ['tree' => $tree->name(), 'view_id' => $new_view_id ]
-            );
-        } else {
-            FlashMessages::addMessage(
-                I18N::translate('An error occured while adding the geographical dispersion analysis view.'),
-                'danger'
-            );
-            //phpcs:ignore Generic.Files.LineLength.TooLong
-            Log::addConfigurationLog('Module ' . $this->module->title() . ' : A new View could not be added. See error log.');
-            return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]);
-        }
-    }
+		$new_view_id = $this->geoview_data_service->insertGetId($new_view);
+		if ($new_view_id > 0) {
+			FlashMessages::addMessage(
+				I18N::translate('The geographical dispersion analysis view has been successfully added.'),
+				'success'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : View “' . $new_view_id . '” has been added.');
+			return Registry::responseFactory()->redirect(
+				GeoAnalysisViewEditPage::class,
+				['tree' => $tree->name(), 'view_id' => $new_view_id ]
+			);
+		} else {
+			FlashMessages::addMessage(
+				I18N::translate('An error occured while adding the geographical dispersion analysis view.'),
+				'danger'
+			);
+			//phpcs:ignore Generic.Files.LineLength.TooLong
+			Log::addConfigurationLog('Module ' . $this->module->title() . ' : A new View could not be added. See error log.');
+			return Registry::responseFactory()->redirect(AdminConfigPage::class, ['tree' => $tree->name()]);
+		}
+	}
 }

app/Module/GeoDispersion/Services/PlacesReferenceTableService.php

Indentation +76 added lines, -76 removed lines

@@ -21,88 +21,88 @@
  */
 class PlacesReferenceTableService
 {
-    /**
-     * Mapping format placeholder tags => table column names
-     * @var array<string, string>
-     */
-    private const COLUMN_MAPPING = [
-        'name'  =>  'majgr_place_name',
-        'id'    =>  'majgr_place_admin_id',
-        'zip'   =>  'majgr_place_zip',
-        'gov'   =>  'majgr_place_gov_id',
-        'mls'   =>  'majgr_place_mls_id'
-    ];
+	/**
+	 * Mapping format placeholder tags => table column names
+	 * @var array<string, string>
+	 */
+	private const COLUMN_MAPPING = [
+		'name'  =>  'majgr_place_name',
+		'id'    =>  'majgr_place_admin_id',
+		'zip'   =>  'majgr_place_zip',
+		'gov'   =>  'majgr_place_gov_id',
+		'mls'   =>  'majgr_place_mls_id'
+	];
 
-    /**
-     * Get the formatted target mapping value of a place defined by a source format.
-     *
-     * @param string $source
-     * @param string $source_format
-     * @param string $target_format
-     * @return string|NULL
-     */
-    public function targetId(string $source, string $source_format, string $target_format): ?string
-    {
-        // Extract parts for the WHERE clause
-        $source_format = str_replace(['{', '}'], ['{#', '#}'], $source_format);
-        $source_parts = preg_split('/[{}]/i', $source_format);
-        if ($source_parts === false) {
-            return null;
-        }
-        $source_parts = array_map(function (string $part): string {
-            if (preg_match('/^#([^#]+)#$/i', $part, $column_id) === 1) {
-                return $this->columnName($column_id[1]);
-            }
-            return $this->sanitizeString(str_replace(['?', '*'], ['_', '%'], $part));
-        }, array_filter($source_parts));
-        $source_parts[] = "'%'";
-        $concat_statement = 'CONCAT(' . implode(', ', $source_parts) . ')';
+	/**
+	 * Get the formatted target mapping value of a place defined by a source format.
+	 *
+	 * @param string $source
+	 * @param string $source_format
+	 * @param string $target_format
+	 * @return string|NULL
+	 */
+	public function targetId(string $source, string $source_format, string $target_format): ?string
+	{
+		// Extract parts for the WHERE clause
+		$source_format = str_replace(['{', '}'], ['{#', '#}'], $source_format);
+		$source_parts = preg_split('/[{}]/i', $source_format);
+		if ($source_parts === false) {
+			return null;
+		}
+		$source_parts = array_map(function (string $part): string {
+			if (preg_match('/^#([^#]+)#$/i', $part, $column_id) === 1) {
+				return $this->columnName($column_id[1]);
+			}
+			return $this->sanitizeString(str_replace(['?', '*'], ['_', '%'], $part));
+		}, array_filter($source_parts));
+		$source_parts[] = "'%'";
+		$concat_statement = 'CONCAT(' . implode(', ', $source_parts) . ')';
 
-        // Extract columns used in target
-        $columns = [];
-        if (preg_match_all('/{(.*?)}/i', $target_format, $columns_select) === 1) {
-            $columns = array_unique(array_filter(array_map(fn($id) => $this->columnName($id), $columns_select[1])));
-        }
+		// Extract columns used in target
+		$columns = [];
+		if (preg_match_all('/{(.*?)}/i', $target_format, $columns_select) === 1) {
+			$columns = array_unique(array_filter(array_map(fn($id) => $this->columnName($id), $columns_select[1])));
+		}
 
-        // Get the mapping
-        $rows = DB::table('maj_geodata_ref')  //DB::table('maj_geodata_ref')
-            ->select($columns)
-            ->whereRaw($this->sanitizeString($source) . " LIKE " . $concat_statement)
-            ->get();
+		// Get the mapping
+		$rows = DB::table('maj_geodata_ref')  //DB::table('maj_geodata_ref')
+			->select($columns)
+			->whereRaw($this->sanitizeString($source) . " LIKE " . $concat_statement)
+			->get();
 
-        // Format the output ID
-        if ($rows->count() === 0) {
-            return null;
-        }
+		// Format the output ID
+		if ($rows->count() === 0) {
+			return null;
+		}
 
-        $mapping = (array) $rows->first();
+		$mapping = (array) $rows->first();
 
-        return str_replace(
-            array_map(fn($tag) => '{' . $tag . '}', $columns_select[1]),
-            array_map(fn($tag) => $mapping[$this->columnName($tag)] ?? '', $columns_select[1]),
-            $target_format
-        );
-    }
+		return str_replace(
+			array_map(fn($tag) => '{' . $tag . '}', $columns_select[1]),
+			array_map(fn($tag) => $mapping[$this->columnName($tag)] ?? '', $columns_select[1]),
+			$target_format
+		);
+	}
 
-    /**
-     * Get the column name for a format placeholder tag
-     *
-     * @param string $placeholder
-     * @return string
-     */
-    private function columnName(string $placeholder): string
-    {
-        return self::COLUMN_MAPPING[$placeholder] ?? '';
-    }
+	/**
+	 * Get the column name for a format placeholder tag
+	 *
+	 * @param string $placeholder
+	 * @return string
+	 */
+	private function columnName(string $placeholder): string
+	{
+		return self::COLUMN_MAPPING[$placeholder] ?? '';
+	}
 
-    /**
-     * Sanitize string for use in a SQL query.
-     *
-     * @param string $string
-     * @return string
-     */
-    private function sanitizeString(string $string): string
-    {
-        return DB::connection()->getPdo()->quote($string);
-    }
+	/**
+	 * Sanitize string for use in a SQL query.
+	 *
+	 * @param string $string
+	 * @return string
+	 */
+	private function sanitizeString(string $string): string
+	{
+		return DB::connection()->getPdo()->quote($string);
+	}
 }

app/Module/GeoDispersion/Services/GeoAnalysisViewDataService.php

Indentation +182 added lines, -182 removed lines

@@ -32,186 +32,186 @@
  */
 class GeoAnalysisViewDataService
 {
-    /**
-     * Find a Geographical dispersion analysis view by ID
-     *
-     * @param Tree $tree
-     * @param int $id
-     * @return AbstractGeoAnalysisView|NULL
-     */
-    public function find(Tree $tree, int $id, bool $include_disabled = false): ?AbstractGeoAnalysisView
-    {
-        return $this->all($tree, $include_disabled)
-            ->first(fn(AbstractGeoAnalysisView $view): bool => $view->id() === $id);
-    }
-
-    /**
-     * Get all Geographical dispersion analysis views, with or without the disabled ones.
-     *
-     * {@internal It would ignore any view for which the class could not be loaded by the container}
-     *
-     * @param Tree $tree
-     * @param bool $include_disabled
-     * @return Collection<AbstractGeoAnalysisView>
-     */
-    public function all(Tree $tree, bool $include_disabled = false): Collection
-    {
-        return Registry::cache()->array()->remember(
-            'all-geodispersion-views',
-            function () use ($tree, $include_disabled): Collection {
-                return DB::table('maj_geodisp_views')
-                    ->select('maj_geodisp_views.*')
-                    ->where('majgv_gedcom_id', '=', $tree->id())
-                    ->get()
-                    ->map($this->viewMapper($tree))
-                    ->filter()
-                    ->filter($this->enabledFilter($include_disabled));
-            }
-        );
-    }
-
-    /**
-     * Insert a geographical dispersion analysis view object in the database.
-     *
-     * @param AbstractGeoAnalysisView $view
-     * @return int
-     */
-    public function insertGetId(AbstractGeoAnalysisView $view): int
-    {
-        return DB::table('maj_geodisp_views')
-            ->insertGetId([
-                'majgv_gedcom_id' => $view->tree()->id(),
-                'majgv_view_class' => get_class($view),
-                'majgv_status' => $view->isEnabled() ? 'enabled' : 'disabled',
-                'majgv_descr' => mb_substr($view->description(), 0, 248),
-                'majgv_analysis' => get_class($view->analysis()),
-                'majgv_place_depth' => $view->placesDepth()
-            ]);
-    }
-
-    /**
-     * Update a geographical dispersion analysis view object in the database.
-     *
-     * @param AbstractGeoAnalysisView $view
-     * @return int
-     */
-    public function update(AbstractGeoAnalysisView $view): int
-    {
-        return DB::table('maj_geodisp_views')
-            ->where('majgv_id', '=', $view->id())
-            ->update([
-                'majgv_gedcom_id' => $view->tree()->id(),
-                'majgv_view_class' => get_class($view),
-                'majgv_status' => $view->isEnabled() ? 'enabled' : 'disabled',
-                'majgv_descr' => mb_substr($view->description(), 0, 248),
-                'majgv_analysis' => get_class($view->analysis()),
-                'majgv_place_depth' => $view->placesDepth(),
-                'majgv_top_places' => $view->numberTopPlaces(),
-                'majgv_colors' => $view instanceof GeoAnalysisMap ? json_encode($view->colors()) : null
-            ]);
-    }
-
-    /**
-     * Update the status of a geographical dispersion analysis view object in the database.
-     *
-     * @param AbstractGeoAnalysisView $view
-     * @param bool $status
-     * @return int
-     */
-    public function updateStatus(AbstractGeoAnalysisView $view, bool $status): int
-    {
-        return DB::table('maj_geodisp_views')
-            ->where('majgv_id', '=', $view->id())
-            ->update(['majgv_status' => $status ? 'enabled' : 'disabled']);
-    }
-
-    /**
-     * Delete a geographical dispersion analysis view object from the database.
-     *
-     * @param AbstractGeoAnalysisView $view
-     * @return int
-     */
-    public function delete(AbstractGeoAnalysisView $view): int
-    {
-        return DB::table('maj_geodisp_views')
-            ->where('majgv_id', '=', $view->id())
-            ->delete();
-    }
-
-    /**
-     * Get the closure to create a AbstractGeoAnalysisView 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.
-     *
-     * @param Tree $tree
-     * @return Closure(\stdClass $row):?AbstractGeoAnalysisView
-     */
-    private function viewMapper(Tree $tree): Closure
-    {
-        return function (stdClass $row) use ($tree): ?AbstractGeoAnalysisView {
-            try {
-                $geoanalysis = app($row->majgv_analysis);
-                if (!($geoanalysis instanceof GeoAnalysisInterface)) {
-                    return null;
-                }
-
-                $view = app()->makeWith($row->majgv_view_class, [
-                    'id'                    =>  (int) $row->majgv_id,
-                    'tree'                  =>  $tree,
-                    'enabled'               =>  $row->majgv_status === 'enabled',
-                    'description'           =>  $row->majgv_descr,
-                    'geoanalysis'           =>  $geoanalysis,
-                    'depth'                 =>  (int) $row->majgv_place_depth,
-                    'detailed_top_places'   =>  (int) $row->majgv_top_places
-                ]);
-
-                if ($row->majgv_colors !== null && $view instanceof GeoAnalysisMap) {
-                    $view = $view->withColors($this->colorsDecoder($row->majgv_colors));
-                }
-
-                return $view instanceof AbstractGeoAnalysisView ? $view : null;
-            } catch (BindingResolutionException $ex) {
-                return null;
-            }
-        };
-    }
-
-    /**
-     * Create a MapColorsConfig object from a JSON column value.
-     * Returns null if the JSON string is invalid, or if the colors are not valid.
-     *
-     * @param string $colors_config
-     * @return MapColorsConfig|NULL
-     */
-    private function colorsDecoder(string $colors_config): ?MapColorsConfig
-    {
-        $colors = json_decode($colors_config, true);
-        if (!is_array($colors) || count($colors) !== 4) {
-            return null;
-        }
-        try {
-            return new MapColorsConfig(
-                \Spatie\Color\Factory::fromString($colors['default'] ?? ''),
-                \Spatie\Color\Factory::fromString($colors['stroke'] ?? ''),
-                \Spatie\Color\Factory::fromString($colors['maxvalue'] ?? ''),
-                \Spatie\Color\Factory::fromString($colors['hover'] ?? '')
-            );
-        } catch (InvalidColorValue $ex) {
-            return null;
-        }
-    }
-
-    /**
-     * Get a closure to filter views by enabled/disabled status
-     *
-     * @param bool $include_disabled
-     *
-     * @return Closure(AbstractGeoAnalysisView $view):bool
-     */
-    private function enabledFilter(bool $include_disabled): Closure
-    {
-        return function (AbstractGeoAnalysisView $view) use ($include_disabled): bool {
-            return $include_disabled || $view->isEnabled();
-        };
-    }
+	/**
+	 * Find a Geographical dispersion analysis view by ID
+	 *
+	 * @param Tree $tree
+	 * @param int $id
+	 * @return AbstractGeoAnalysisView|NULL
+	 */
+	public function find(Tree $tree, int $id, bool $include_disabled = false): ?AbstractGeoAnalysisView
+	{
+		return $this->all($tree, $include_disabled)
+			->first(fn(AbstractGeoAnalysisView $view): bool => $view->id() === $id);
+	}
+
+	/**
+	 * Get all Geographical dispersion analysis views, with or without the disabled ones.
+	 *
+	 * {@internal It would ignore any view for which the class could not be loaded by the container}
+	 *
+	 * @param Tree $tree
+	 * @param bool $include_disabled
+	 * @return Collection<AbstractGeoAnalysisView>
+	 */
+	public function all(Tree $tree, bool $include_disabled = false): Collection
+	{
+		return Registry::cache()->array()->remember(
+			'all-geodispersion-views',
+			function () use ($tree, $include_disabled): Collection {
+				return DB::table('maj_geodisp_views')
+					->select('maj_geodisp_views.*')
+					->where('majgv_gedcom_id', '=', $tree->id())
+					->get()
+					->map($this->viewMapper($tree))
+					->filter()
+					->filter($this->enabledFilter($include_disabled));
+			}
+		);
+	}
+
+	/**
+	 * Insert a geographical dispersion analysis view object in the database.
+	 *
+	 * @param AbstractGeoAnalysisView $view
+	 * @return int
+	 */
+	public function insertGetId(AbstractGeoAnalysisView $view): int
+	{
+		return DB::table('maj_geodisp_views')
+			->insertGetId([
+				'majgv_gedcom_id' => $view->tree()->id(),
+				'majgv_view_class' => get_class($view),
+				'majgv_status' => $view->isEnabled() ? 'enabled' : 'disabled',
+				'majgv_descr' => mb_substr($view->description(), 0, 248),
+				'majgv_analysis' => get_class($view->analysis()),
+				'majgv_place_depth' => $view->placesDepth()
+			]);
+	}
+
+	/**
+	 * Update a geographical dispersion analysis view object in the database.
+	 *
+	 * @param AbstractGeoAnalysisView $view
+	 * @return int
+	 */
+	public function update(AbstractGeoAnalysisView $view): int
+	{
+		return DB::table('maj_geodisp_views')
+			->where('majgv_id', '=', $view->id())
+			->update([
+				'majgv_gedcom_id' => $view->tree()->id(),
+				'majgv_view_class' => get_class($view),
+				'majgv_status' => $view->isEnabled() ? 'enabled' : 'disabled',
+				'majgv_descr' => mb_substr($view->description(), 0, 248),
+				'majgv_analysis' => get_class($view->analysis()),
+				'majgv_place_depth' => $view->placesDepth(),
+				'majgv_top_places' => $view->numberTopPlaces(),
+				'majgv_colors' => $view instanceof GeoAnalysisMap ? json_encode($view->colors()) : null
+			]);
+	}
+
+	/**
+	 * Update the status of a geographical dispersion analysis view object in the database.
+	 *
+	 * @param AbstractGeoAnalysisView $view
+	 * @param bool $status
+	 * @return int
+	 */
+	public function updateStatus(AbstractGeoAnalysisView $view, bool $status): int
+	{
+		return DB::table('maj_geodisp_views')
+			->where('majgv_id', '=', $view->id())
+			->update(['majgv_status' => $status ? 'enabled' : 'disabled']);
+	}
+
+	/**
+	 * Delete a geographical dispersion analysis view object from the database.
+	 *
+	 * @param AbstractGeoAnalysisView $view
+	 * @return int
+	 */
+	public function delete(AbstractGeoAnalysisView $view): int
+	{
+		return DB::table('maj_geodisp_views')
+			->where('majgv_id', '=', $view->id())
+			->delete();
+	}
+
+	/**
+	 * Get the closure to create a AbstractGeoAnalysisView 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.
+	 *
+	 * @param Tree $tree
+	 * @return Closure(\stdClass $row):?AbstractGeoAnalysisView
+	 */
+	private function viewMapper(Tree $tree): Closure
+	{
+		return function (stdClass $row) use ($tree): ?AbstractGeoAnalysisView {
+			try {
+				$geoanalysis = app($row->majgv_analysis);
+				if (!($geoanalysis instanceof GeoAnalysisInterface)) {
+					return null;
+				}
+
+				$view = app()->makeWith($row->majgv_view_class, [
+					'id'                    =>  (int) $row->majgv_id,
+					'tree'                  =>  $tree,
+					'enabled'               =>  $row->majgv_status === 'enabled',
+					'description'           =>  $row->majgv_descr,
+					'geoanalysis'           =>  $geoanalysis,
+					'depth'                 =>  (int) $row->majgv_place_depth,
+					'detailed_top_places'   =>  (int) $row->majgv_top_places
+				]);
+
+				if ($row->majgv_colors !== null && $view instanceof GeoAnalysisMap) {
+					$view = $view->withColors($this->colorsDecoder($row->majgv_colors));
+				}
+
+				return $view instanceof AbstractGeoAnalysisView ? $view : null;
+			} catch (BindingResolutionException $ex) {
+				return null;
+			}
+		};
+	}
+
+	/**
+	 * Create a MapColorsConfig object from a JSON column value.
+	 * Returns null if the JSON string is invalid, or if the colors are not valid.
+	 *
+	 * @param string $colors_config
+	 * @return MapColorsConfig|NULL
+	 */
+	private function colorsDecoder(string $colors_config): ?MapColorsConfig
+	{
+		$colors = json_decode($colors_config, true);
+		if (!is_array($colors) || count($colors) !== 4) {
+			return null;
+		}
+		try {
+			return new MapColorsConfig(
+				\Spatie\Color\Factory::fromString($colors['default'] ?? ''),
+				\Spatie\Color\Factory::fromString($colors['stroke'] ?? ''),
+				\Spatie\Color\Factory::fromString($colors['maxvalue'] ?? ''),
+				\Spatie\Color\Factory::fromString($colors['hover'] ?? '')
+			);
+		} catch (InvalidColorValue $ex) {
+			return null;
+		}
+	}
+
+	/**
+	 * Get a closure to filter views by enabled/disabled status
+	 *
+	 * @param bool $include_disabled
+	 *
+	 * @return Closure(AbstractGeoAnalysisView $view):bool
+	 */
+	private function enabledFilter(bool $include_disabled): Closure
+	{
+		return function (AbstractGeoAnalysisView $view) use ($include_disabled): bool {
+			return $include_disabled || $view->isEnabled();
+		};
+	}
 }

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/GeoDispersionModule.php

Indentation +183 added lines, -183 removed lines

@@ -59,188 +59,188 @@
  * Geographical Dispersion Module.
  */
 class GeoDispersionModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleChartInterface,
-    ModuleConfigInterface,
-    ModuleGlobalInterface,
-    ModuleGeoAnalysisProviderInterface,
-    ModulePlaceMapperProviderInterface
+	ModuleMyArtJaubInterface,
+	ModuleChartInterface,
+	ModuleConfigInterface,
+	ModuleGlobalInterface,
+	ModuleGeoAnalysisProviderInterface,
+	ModulePlaceMapperProviderInterface
 {
-    use ModuleMyArtJaubTrait {
-        boot as traitBoot;
-    }
-    use ModuleChartTrait;
-    use ModuleConfigTrait;
-    use ModuleGlobalTrait;
-
-    // How to update the database schema for this module
-    private const SCHEMA_TARGET_VERSION   = 3;
-    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 analyses.');
-    }
-
-    /**
-     * {@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.18-v.2';
-    }
-
-    /**
-     * {@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->attach('', '/admin', static function (Map $router): void {
-                    $router->get(AdminConfigPage::class, '/config{/tree}', AdminConfigPage::class);
-
-                    $router->attach('', '/analysis-views/{tree}', static function (Map $router): void {
-                        $router->tokens(['view_id' => '\d+', 'enable' => '[01]']);
-                        $router->extras([
-                            'middleware' => [
-                                AuthManager::class,
-                            ],
-                        ]);
-                        $router->get(GeoAnalysisViewListData::class, '', GeoAnalysisViewListData::class);
-
-                        $router->get(GeoAnalysisViewAddPage::class, '/add', GeoAnalysisViewAddPage::class);
-                        $router->post(GeoAnalysisViewAddAction::class, '/add', GeoAnalysisViewAddAction::class);
-                        $router->get(GeoAnalysisViewEditPage::class, '/{view_id}', GeoAnalysisViewEditPage::class);
-                        $router->post(GeoAnalysisViewEditAction::class, '/{view_id}', GeoAnalysisViewEditAction::class);
-                        //phpcs:disable Generic.Files.LineLength.TooLong
-                        $router->get(GeoAnalysisViewStatusAction::class, '/{view_id}/status/{enable}', GeoAnalysisViewStatusAction::class);
-                        $router->get(GeoAnalysisViewDeleteAction::class, '/{view_id}/delete', GeoAnalysisViewDeleteAction::class);
-                        //phpcs:enable
-                    });
-
-                    $router->attach('', '/map-adapters/{tree}', static function (Map $router): void {
-                        $router->tokens(['adapter_id' => '\d+', 'view_id' => '\d+']);
-                        $router->extras([
-                            'middleware' => [
-                                AuthManager::class,
-                            ],
-                        ]);
-
-                        $router->get(MapAdapterAddPage::class, '/add/{view_id}', MapAdapterAddPage::class);
-                        $router->post(MapAdapterAddAction::class, '/add/{view_id}', MapAdapterAddAction::class);
-                        $router->get(MapAdapterEditPage::class, '/{adapter_id}', MapAdapterEditPage::class);
-                        $router->post(MapAdapterEditAction::class, '/{adapter_id}', MapAdapterEditAction::class);
-                        //phpcs:disable Generic.Files.LineLength.TooLong
-                        $router->get(MapAdapterDeleteAction::class, '/{adapter_id}/delete', MapAdapterDeleteAction::class);
-                        $router->get(MapAdapterDeleteInvalidAction::class, '/delete-invalid/{view_id}', MapAdapterDeleteInvalidAction::class);
-                        $router->get(MapAdapterMapperConfig::class, '/mapper/config{/adapter_id}', MapAdapterMapperConfig::class);
-                        //phpcs:enable
-                    });
-
-                    //phpcs:ignore Generic.Files.LineLength.TooLong
-                    $router->get(MapFeaturePropertyData::class, '/map/feature-properties{/map_id}', MapFeaturePropertyData::class);
-                });
-
-                $router->get(GeoAnalysisViewsList::class, '/list/{tree}', GeoAnalysisViewsList::class);
-
-                $router->attach('', '/analysisview/{tree}/{view_id}', static function (Map $router): void {
-                    $router->tokens(['view_id' => '\d+']);
-                    $router->get(GeoAnalysisViewPage::class, '', GeoAnalysisViewPage::class);
-                    $router->get(GeoAnalysisViewTabs::class, '/tabs', GeoAnalysisViewTabs::class);
-                });
-            });
-        });
-    }
-
-    public function getConfigLink(): string
-    {
-        return route(AdminConfigPage::class);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleChartInterface::chartUrl()
-     *
-     * @param array<bool|int|string|array<mixed>|null> $parameters
-     */
-    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 ModuleConfigTrait;
+	use ModuleGlobalTrait;
+
+	// How to update the database schema for this module
+	private const SCHEMA_TARGET_VERSION   = 3;
+	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 analyses.');
+	}
+
+	/**
+	 * {@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.18-v.2';
+	}
+
+	/**
+	 * {@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->attach('', '/admin', static function (Map $router): void {
+					$router->get(AdminConfigPage::class, '/config{/tree}', AdminConfigPage::class);
+
+					$router->attach('', '/analysis-views/{tree}', static function (Map $router): void {
+						$router->tokens(['view_id' => '\d+', 'enable' => '[01]']);
+						$router->extras([
+							'middleware' => [
+								AuthManager::class,
+							],
+						]);
+						$router->get(GeoAnalysisViewListData::class, '', GeoAnalysisViewListData::class);
+
+						$router->get(GeoAnalysisViewAddPage::class, '/add', GeoAnalysisViewAddPage::class);
+						$router->post(GeoAnalysisViewAddAction::class, '/add', GeoAnalysisViewAddAction::class);
+						$router->get(GeoAnalysisViewEditPage::class, '/{view_id}', GeoAnalysisViewEditPage::class);
+						$router->post(GeoAnalysisViewEditAction::class, '/{view_id}', GeoAnalysisViewEditAction::class);
+						//phpcs:disable Generic.Files.LineLength.TooLong
+						$router->get(GeoAnalysisViewStatusAction::class, '/{view_id}/status/{enable}', GeoAnalysisViewStatusAction::class);
+						$router->get(GeoAnalysisViewDeleteAction::class, '/{view_id}/delete', GeoAnalysisViewDeleteAction::class);
+						//phpcs:enable
+					});
+
+					$router->attach('', '/map-adapters/{tree}', static function (Map $router): void {
+						$router->tokens(['adapter_id' => '\d+', 'view_id' => '\d+']);
+						$router->extras([
+							'middleware' => [
+								AuthManager::class,
+							],
+						]);
+
+						$router->get(MapAdapterAddPage::class, '/add/{view_id}', MapAdapterAddPage::class);
+						$router->post(MapAdapterAddAction::class, '/add/{view_id}', MapAdapterAddAction::class);
+						$router->get(MapAdapterEditPage::class, '/{adapter_id}', MapAdapterEditPage::class);
+						$router->post(MapAdapterEditAction::class, '/{adapter_id}', MapAdapterEditAction::class);
+						//phpcs:disable Generic.Files.LineLength.TooLong
+						$router->get(MapAdapterDeleteAction::class, '/{adapter_id}/delete', MapAdapterDeleteAction::class);
+						$router->get(MapAdapterDeleteInvalidAction::class, '/delete-invalid/{view_id}', MapAdapterDeleteInvalidAction::class);
+						$router->get(MapAdapterMapperConfig::class, '/mapper/config{/adapter_id}', MapAdapterMapperConfig::class);
+						//phpcs:enable
+					});
+
+					//phpcs:ignore Generic.Files.LineLength.TooLong
+					$router->get(MapFeaturePropertyData::class, '/map/feature-properties{/map_id}', MapFeaturePropertyData::class);
+				});
+
+				$router->get(GeoAnalysisViewsList::class, '/list/{tree}', GeoAnalysisViewsList::class);
+
+				$router->attach('', '/analysisview/{tree}/{view_id}', static function (Map $router): void {
+					$router->tokens(['view_id' => '\d+']);
+					$router->get(GeoAnalysisViewPage::class, '', GeoAnalysisViewPage::class);
+					$router->get(GeoAnalysisViewTabs::class, '/tabs', GeoAnalysisViewTabs::class);
+				});
+			});
+		});
+	}
+
+	public function getConfigLink(): string
+	{
+		return route(AdminConfigPage::class);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleChartInterface::chartUrl()
+	 *
+	 * @param array<bool|int|string|array<mixed>|null> $parameters
+	 */
+	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
+		];
+	}
 }

app/Module/ModuleMyArtJaubTrait.php

Indentation +78 added lines, -78 removed lines

@@ -26,82 +26,82 @@
  */
 trait ModuleMyArtJaubTrait
 {
-    use ModuleCustomTrait;
-
-    /**
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
-     */
-    public function boot(): void
-    {
-        View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
-
-        $this->loadRoutes(Registry::routeFactory()->routeMap());
-    }
-
-    /**
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::resourcesFolder()
-     */
-    public function resourcesFolder(): string
-    {
-        return Webtrees::MODULES_DIR . trim($this->name(), '_') . '/resources/';
-    }
-
-    /**
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleAuthorName()
-     */
-    public function customModuleAuthorName(): string
-    {
-        return 'Jonathan Jaubart';
-    }
-
-    /**
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleSupportUrl()
-     */
-    public function customModuleSupportUrl(): string
-    {
-        return 'https://github.com/jon48/webtrees-lib';
-    }
-
-    /**
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customTranslations()
-     *
-     * @return array<string, string>
-     */
-    public function customTranslations(string $language): array
-    {
-        $translation_file = $this->resourcesFolder() . 'lang/' . $language . '/messages.php';
-
-        try {
-            $translation  = new Translation($translation_file);
-            return $translation->asArray();
-        } catch (\Exception $e) {
-        }
-
-        return [];
-    }
-
-    /**
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes
-     *
-     * @param Map<\Aura\Router\Route> $router
-     */
-    public function loadRoutes(Map $router): void
-    {
-    }
-
-    /**
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::moduleCssUrl
-     */
-    public function moduleCssUrl(): string
-    {
-        /** @var ModuleThemeInterface $theme */
-        $theme = app(ModuleThemeInterface::class);
-        $css_file = $this->resourcesFolder() . 'css/' . $theme->name() . '.min.css';
-
-        if (file_exists($css_file)) {
-            return $this->assetUrl('css/' . $theme->name() . '.min.css');
-        } else {
-            return $this->assetUrl('css/default.min.css');
-        }
-    }
+	use ModuleCustomTrait;
+
+	/**
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
+	 */
+	public function boot(): void
+	{
+		View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
+
+		$this->loadRoutes(Registry::routeFactory()->routeMap());
+	}
+
+	/**
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::resourcesFolder()
+	 */
+	public function resourcesFolder(): string
+	{
+		return Webtrees::MODULES_DIR . trim($this->name(), '_') . '/resources/';
+	}
+
+	/**
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleAuthorName()
+	 */
+	public function customModuleAuthorName(): string
+	{
+		return 'Jonathan Jaubart';
+	}
+
+	/**
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleSupportUrl()
+	 */
+	public function customModuleSupportUrl(): string
+	{
+		return 'https://github.com/jon48/webtrees-lib';
+	}
+
+	/**
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customTranslations()
+	 *
+	 * @return array<string, string>
+	 */
+	public function customTranslations(string $language): array
+	{
+		$translation_file = $this->resourcesFolder() . 'lang/' . $language . '/messages.php';
+
+		try {
+			$translation  = new Translation($translation_file);
+			return $translation->asArray();
+		} catch (\Exception $e) {
+		}
+
+		return [];
+	}
+
+	/**
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes
+	 *
+	 * @param Map<\Aura\Router\Route> $router
+	 */
+	public function loadRoutes(Map $router): void
+	{
+	}
+
+	/**
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::moduleCssUrl
+	 */
+	public function moduleCssUrl(): string
+	{
+		/** @var ModuleThemeInterface $theme */
+		$theme = app(ModuleThemeInterface::class);
+		$css_file = $this->resourcesFolder() . 'css/' . $theme->name() . '.min.css';
+
+		if (file_exists($css_file)) {
+			return $this->assetUrl('css/' . $theme->name() . '.min.css');
+		} else {
+			return $this->assetUrl('css/default.min.css');
+		}
+	}
 }

app/Module/IsSourced/IsSourcedModule.php

Indentation +90 added lines, -90 removed lines

@@ -33,105 +33,105 @@
  * IsSourced Module
  */
 class IsSourcedModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleGlobalInterface,
-    ModuleSidebarInterface,
-    ModuleHookSubscriberInterface
+	ModuleMyArtJaubInterface,
+	ModuleGlobalInterface,
+	ModuleSidebarInterface,
+	ModuleHookSubscriberInterface
 {
-    use ModuleMyArtJaubTrait;
-    use ModuleGlobalTrait;
-    use ModuleSidebarTrait;
+	use ModuleMyArtJaubTrait;
+	use ModuleGlobalTrait;
+	use ModuleSidebarTrait;
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Sourced events');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Sourced events');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        return I18N::translate('Indicate if events related to an record are sourced.');
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		return I18N::translate('Indicate if events related to an record are sourced.');
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.1.8-v.1';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.1.8-v.1';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
-     */
-    public function headContent(): string
-    {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
+	 */
+	public function headContent(): string
+	{
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
-     */
-    public function bodyContent(): string
-    {
-        return '<script src="' . $this->assetUrl('js/issourced.min.js') . '"></script>';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
+	 */
+	public function bodyContent(): string
+	{
+		return '<script src="' . $this->assetUrl('js/issourced.min.js') . '"></script>';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
-     */
-    public function hasSidebarContent(Individual $individual): bool
-    {
-        return true;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
+	 */
+	public function hasSidebarContent(Individual $individual): bool
+	{
+		return true;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
-     */
-    public function getSidebarContent(Individual $individual): string
-    {
-        /** @var SourceStatusService $source_status_service */
-        $source_status_service = app(SourceStatusService::class);
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
+	 */
+	public function getSidebarContent(Individual $individual): string
+	{
+		/** @var SourceStatusService $source_status_service */
+		$source_status_service = app(SourceStatusService::class);
 
-        $spouse_families_status = $individual->spouseFamilies()->map(
-            function (Family $sfamily) use ($source_status_service): array {
-                return [ $sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
-            }
-        )->filter(function (array $item): bool {
-            return $item[1]->isSet();
-        });
+		$spouse_families_status = $individual->spouseFamilies()->map(
+			function (Family $sfamily) use ($source_status_service): array {
+				return [ $sfamily, $source_status_service->sourceStatusForMarriage($sfamily)];
+			}
+		)->filter(function (array $item): bool {
+			return $item[1]->isSet();
+		});
 
-        return view($this->name() . '::sidebar/content', [
-            'module_name'               => $this->name(),
-            'individual'                =>  $individual,
-            'source_status_individual'  =>  $source_status_service->sourceStatusForRecord($individual),
-            'source_status_birth'       =>  $source_status_service->sourceStatusForBirth($individual),
-            'source_status_marriages'   =>  $spouse_families_status,
-            'source_status_death'       =>  $source_status_service->sourceStatusForDeath($individual)
-        ]);
-    }
+		return view($this->name() . '::sidebar/content', [
+			'module_name'               => $this->name(),
+			'individual'                =>  $individual,
+			'source_status_individual'  =>  $source_status_service->sourceStatusForRecord($individual),
+			'source_status_birth'       =>  $source_status_service->sourceStatusForBirth($individual),
+			'source_status_marriages'   =>  $spouse_families_status,
+			'source_status_death'       =>  $source_status_service->sourceStatusForDeath($individual)
+		]);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
-     */
-    public function listSubscribedHooks(): array
-    {
-        return [
-            app()->makeWith(IsSourcedStatusHook::class, [ 'module' => $this ]),
-            app()->makeWith(IsSourcedStatusColumnsHook::class, [ 'module' => $this ])
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\ModuleHookSubscriberInterface::listSubscribedHooks()
+	 */
+	public function listSubscribedHooks(): array
+	{
+		return [
+			app()->makeWith(IsSourcedStatusHook::class, [ 'module' => $this ]),
+			app()->makeWith(IsSourcedStatusColumnsHook::class, [ 'module' => $this ])
+		];
+	}
 }