jon48 / webtrees-lib

app/Module/Sosa/Services/SosaRecordsService.php

Indentation +275 added lines, -275 removed lines

@@ -30,294 +30,294 @@
  */
 class SosaRecordsService
 {
-    private ?int $max_system_generations = null;
+	private ?int $max_system_generations = null;
 
-    /**
-     * Maximum number of generation the system is able to hold.
-     * This is based on the size of the bigint SQL type (2^63) and the maximum PHP integer type
-     *
-     * @return int
-     */
-    public function maxSystemGenerations(): int
-    {
-        if ($this->max_system_generations === null) {
-            $this->max_system_generations = min(63, $this->generation(PHP_INT_MAX));
-        }
-        return $this->max_system_generations;
-    }
+	/**
+	 * Maximum number of generation the system is able to hold.
+	 * This is based on the size of the bigint SQL type (2^63) and the maximum PHP integer type
+	 *
+	 * @return int
+	 */
+	public function maxSystemGenerations(): int
+	{
+		if ($this->max_system_generations === null) {
+			$this->max_system_generations = min(63, $this->generation(PHP_INT_MAX));
+		}
+		return $this->max_system_generations;
+	}
 
-    /**
-     * Calculate the generation of a sosa
-     * Sosa 1 is of generation 1.
-     *
-     * @param int $sosa
-     * @return int
-     */
-    public function generation(int $sosa): int
-    {
-        return BigInteger::of($sosa)->getBitLength();
-    }
+	/**
+	 * Calculate the generation of a sosa
+	 * Sosa 1 is of generation 1.
+	 *
+	 * @param int $sosa
+	 * @return int
+	 */
+	public function generation(int $sosa): int
+	{
+		return BigInteger::of($sosa)->getBitLength();
+	}
 
-    /**
-     * Calculate the descendant sosa of the given sosa, at the given generation.
-     * For instance, the descendant of the Sosa 14 at generation 2 is Sosa 3 (mother).
-     *
-     * @param int $sosa
-     * @param int $gen
-     * @return int
-     */
-    public function sosaDescendantOf(int $sosa, int $gen): int
-    {
-        $gen_sosa = $this->generation($sosa);
-        return $gen_sosa <= $gen ? $sosa : BigInteger::of($sosa)
-            ->dividedBy(BigInteger::of(2)->power($this->generation($sosa) - $gen), RoundingMode::DOWN)
-            ->toInt();
-    }
+	/**
+	 * Calculate the descendant sosa of the given sosa, at the given generation.
+	 * For instance, the descendant of the Sosa 14 at generation 2 is Sosa 3 (mother).
+	 *
+	 * @param int $sosa
+	 * @param int $gen
+	 * @return int
+	 */
+	public function sosaDescendantOf(int $sosa, int $gen): int
+	{
+		$gen_sosa = $this->generation($sosa);
+		return $gen_sosa <= $gen ? $sosa : BigInteger::of($sosa)
+			->dividedBy(BigInteger::of(2)->power($this->generation($sosa) - $gen), RoundingMode::DOWN)
+			->toInt();
+	}
 
-    /**
-     * Check whether an individual is a Sosa ancestor.
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     * @param Individual $indi
-     * @return bool
-     */
-    public function isSosa(Tree $tree, UserInterface $user, Individual $indi): bool
-    {
-        return $this->sosaNumbers($tree, $user, $indi)->count() > 0;
-    }
+	/**
+	 * Check whether an individual is a Sosa ancestor.
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 * @param Individual $indi
+	 * @return bool
+	 */
+	public function isSosa(Tree $tree, UserInterface $user, Individual $indi): bool
+	{
+		return $this->sosaNumbers($tree, $user, $indi)->count() > 0;
+	}
 
-    /**
-     * Returns all Sosa numbers associated to an Individual
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     * @param Individual $indi
-     * @return Collection<int, int>
-     */
-    public function sosaNumbers(Tree $tree, UserInterface $user, Individual $indi): Collection
-    {
-        return Registry::cache()->array()->remember(
-            'sosanumbers-' . $indi->xref() . '@' . $tree->id() . '-' . $user->id(),
-            function () use ($tree, $user, $indi): Collection {
-                return DB::table('maj_sosa')
-                    ->select(['majs_sosa', 'majs_gen'])
-                    ->where('majs_gedcom_id', '=', $tree->id())
-                    ->where('majs_user_id', '=', $user->id())
-                    ->where('majs_i_id', '=', $indi->xref())
-                    ->orderBy('majs_sosa')
-                    ->get()->pluck('majs_gen', 'majs_sosa');
-            }
-        );
-    }
+	/**
+	 * Returns all Sosa numbers associated to an Individual
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 * @param Individual $indi
+	 * @return Collection<int, int>
+	 */
+	public function sosaNumbers(Tree $tree, UserInterface $user, Individual $indi): Collection
+	{
+		return Registry::cache()->array()->remember(
+			'sosanumbers-' . $indi->xref() . '@' . $tree->id() . '-' . $user->id(),
+			function () use ($tree, $user, $indi): Collection {
+				return DB::table('maj_sosa')
+					->select(['majs_sosa', 'majs_gen'])
+					->where('majs_gedcom_id', '=', $tree->id())
+					->where('majs_user_id', '=', $user->id())
+					->where('majs_i_id', '=', $indi->xref())
+					->orderBy('majs_sosa')
+					->get()->pluck('majs_gen', 'majs_sosa');
+			}
+		);
+	}
 
-    /**
-     * Return a list of the Sosa ancestors across all generation
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     * @return Collection<\stdClass>
-     */
-    public function listAncestors(Tree $tree, UserInterface $user): Collection
-    {
-        return DB::table('maj_sosa')
-            ->select(['majs_sosa', 'majs_i_id'])
-            ->where('majs_gedcom_id', '=', $tree->id())
-            ->where('majs_user_id', '=', $user->id())
-            ->orderBy('majs_sosa')
-            ->get();
-    }
+	/**
+	 * Return a list of the Sosa ancestors across all generation
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 * @return Collection<\stdClass>
+	 */
+	public function listAncestors(Tree $tree, UserInterface $user): Collection
+	{
+		return DB::table('maj_sosa')
+			->select(['majs_sosa', 'majs_i_id'])
+			->where('majs_gedcom_id', '=', $tree->id())
+			->where('majs_user_id', '=', $user->id())
+			->orderBy('majs_sosa')
+			->get();
+	}
 
-    /**
-     * Return a list of the Sosa ancestors at a given generation
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     * @param int $gen
-     * @return Collection<\stdClass>
-     */
-    public function listAncestorsAtGeneration(Tree $tree, UserInterface $user, int $gen): Collection
-    {
-        return DB::table('maj_sosa')
-            ->select(['majs_sosa', 'majs_i_id'])
-            ->where('majs_gedcom_id', '=', $tree->id())
-            ->where('majs_user_id', '=', $user->id())
-            ->where('majs_gen', '=', $gen)
-            ->orderBy('majs_sosa')
-            ->get();
-    }
+	/**
+	 * Return a list of the Sosa ancestors at a given generation
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 * @param int $gen
+	 * @return Collection<\stdClass>
+	 */
+	public function listAncestorsAtGeneration(Tree $tree, UserInterface $user, int $gen): Collection
+	{
+		return DB::table('maj_sosa')
+			->select(['majs_sosa', 'majs_i_id'])
+			->where('majs_gedcom_id', '=', $tree->id())
+			->where('majs_user_id', '=', $user->id())
+			->where('majs_gen', '=', $gen)
+			->orderBy('majs_sosa')
+			->get();
+	}
 
-    /**
-     * Return a list of the Sosa families at a given generation
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     * @param int $gen
-     * @return Collection<\stdClass>
-     */
-    public function listAncestorFamiliesAtGeneration(Tree $tree, UserInterface $user, int $gen): Collection
-    {
-        $table_prefix = DB::connection()->getTablePrefix();
-        return DB::table('families')
-            ->join('maj_sosa AS sosa_husb', function (JoinClause $join) use ($tree, $user): void {
-                // Link to family husband
-                $join->on('families.f_file', '=', 'sosa_husb.majs_gedcom_id')
-                    ->on('families.f_husb', '=', 'sosa_husb.majs_i_id')
-                    ->where('sosa_husb.majs_gedcom_id', '=', $tree->id())
-                    ->where('sosa_husb.majs_user_id', '=', $user->id());
-            })
-            ->join('maj_sosa AS sosa_wife', function (JoinClause $join) use ($tree, $user): void {
-                // Link to family husband
-                $join->on('families.f_file', '=', 'sosa_wife.majs_gedcom_id')
-                ->on('families.f_wife', '=', 'sosa_wife.majs_i_id')
-                ->where('sosa_wife.majs_gedcom_id', '=', $tree->id())
-                ->where('sosa_wife.majs_user_id', '=', $user->id());
-            })
-            ->select(['sosa_husb.majs_sosa', 'families.f_id'])
-            ->where('sosa_husb.majs_gen', '=', $gen)
-            ->whereRaw($table_prefix . 'sosa_husb.majs_sosa + 1 = ' . $table_prefix . 'sosa_wife.majs_sosa')
-            ->orderBy('sosa_husb.majs_sosa')
-            ->get();
-    }
+	/**
+	 * Return a list of the Sosa families at a given generation
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 * @param int $gen
+	 * @return Collection<\stdClass>
+	 */
+	public function listAncestorFamiliesAtGeneration(Tree $tree, UserInterface $user, int $gen): Collection
+	{
+		$table_prefix = DB::connection()->getTablePrefix();
+		return DB::table('families')
+			->join('maj_sosa AS sosa_husb', function (JoinClause $join) use ($tree, $user): void {
+				// Link to family husband
+				$join->on('families.f_file', '=', 'sosa_husb.majs_gedcom_id')
+					->on('families.f_husb', '=', 'sosa_husb.majs_i_id')
+					->where('sosa_husb.majs_gedcom_id', '=', $tree->id())
+					->where('sosa_husb.majs_user_id', '=', $user->id());
+			})
+			->join('maj_sosa AS sosa_wife', function (JoinClause $join) use ($tree, $user): void {
+				// Link to family husband
+				$join->on('families.f_file', '=', 'sosa_wife.majs_gedcom_id')
+				->on('families.f_wife', '=', 'sosa_wife.majs_i_id')
+				->where('sosa_wife.majs_gedcom_id', '=', $tree->id())
+				->where('sosa_wife.majs_user_id', '=', $user->id());
+			})
+			->select(['sosa_husb.majs_sosa', 'families.f_id'])
+			->where('sosa_husb.majs_gen', '=', $gen)
+			->whereRaw($table_prefix . 'sosa_husb.majs_sosa + 1 = ' . $table_prefix . 'sosa_wife.majs_sosa')
+			->orderBy('sosa_husb.majs_sosa')
+			->get();
+	}
 
-    /**
-     * Return a list of Sosa ancestors missing at a given generation.
-     * It includes the reference of either parent if it is known.
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     * @param int $gen
-     * @return Collection<\stdClass>
-     */
-    public function listMissingAncestorsAtGeneration(Tree $tree, UserInterface $user, int $gen): Collection
-    {
-        if ($gen == 1) {
-            return collect();
-        }
+	/**
+	 * Return a list of Sosa ancestors missing at a given generation.
+	 * It includes the reference of either parent if it is known.
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 * @param int $gen
+	 * @return Collection<\stdClass>
+	 */
+	public function listMissingAncestorsAtGeneration(Tree $tree, UserInterface $user, int $gen): Collection
+	{
+		if ($gen == 1) {
+			return collect();
+		}
 
-        $table_prefix = DB::connection()->getTablePrefix();
-        return DB::table('maj_sosa AS sosa')
-            ->select(['sosa.majs_i_id', 'sosa_fat.majs_i_id AS majs_fat_id', 'sosa_mot.majs_i_id AS majs_mot_id'])
-            ->selectRaw('MIN(' . $table_prefix . 'sosa.majs_sosa) AS majs_sosa')
-            ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($tree, $user, $table_prefix): void {
-                // Link to sosa's father
-                $join->whereRaw($table_prefix . 'sosa_fat.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa')
-                    ->where('sosa_fat.majs_gedcom_id', '=', $tree->id())
-                    ->where('sosa_fat.majs_user_id', '=', $user->id());
-            })
-            ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($tree, $user, $table_prefix): void {
-                // Link to sosa's mother
-                $join->whereRaw($table_prefix . 'sosa_mot.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa + 1')
-                    ->where('sosa_mot.majs_gedcom_id', '=', $tree->id())
-                    ->where('sosa_mot.majs_user_id', '=', $user->id());
-            })
-            ->where('sosa.majs_gedcom_id', '=', $tree->id())
-            ->where('sosa.majs_user_id', '=', $user->id())
-            ->where('sosa.majs_gen', '=', $gen - 1)
-            ->where(function (Builder $query): void {
-                $query->whereNull('sosa_fat.majs_i_id')
-                    ->orWhereNull('sosa_mot.majs_i_id');
-            })
-            ->groupBy('sosa.majs_i_id', 'sosa_fat.majs_i_id', 'sosa_mot.majs_i_id')
-            ->orderByRaw('MIN(' . $table_prefix . 'sosa.majs_sosa)')
-            ->get();
-    }
+		$table_prefix = DB::connection()->getTablePrefix();
+		return DB::table('maj_sosa AS sosa')
+			->select(['sosa.majs_i_id', 'sosa_fat.majs_i_id AS majs_fat_id', 'sosa_mot.majs_i_id AS majs_mot_id'])
+			->selectRaw('MIN(' . $table_prefix . 'sosa.majs_sosa) AS majs_sosa')
+			->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($tree, $user, $table_prefix): void {
+				// Link to sosa's father
+				$join->whereRaw($table_prefix . 'sosa_fat.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa')
+					->where('sosa_fat.majs_gedcom_id', '=', $tree->id())
+					->where('sosa_fat.majs_user_id', '=', $user->id());
+			})
+			->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($tree, $user, $table_prefix): void {
+				// Link to sosa's mother
+				$join->whereRaw($table_prefix . 'sosa_mot.majs_sosa = 2 * ' . $table_prefix . 'sosa.majs_sosa + 1')
+					->where('sosa_mot.majs_gedcom_id', '=', $tree->id())
+					->where('sosa_mot.majs_user_id', '=', $user->id());
+			})
+			->where('sosa.majs_gedcom_id', '=', $tree->id())
+			->where('sosa.majs_user_id', '=', $user->id())
+			->where('sosa.majs_gen', '=', $gen - 1)
+			->where(function (Builder $query): void {
+				$query->whereNull('sosa_fat.majs_i_id')
+					->orWhereNull('sosa_mot.majs_i_id');
+			})
+			->groupBy('sosa.majs_i_id', 'sosa_fat.majs_i_id', 'sosa_mot.majs_i_id')
+			->orderByRaw('MIN(' . $table_prefix . 'sosa.majs_sosa)')
+			->get();
+	}
 
-    /**
-     * Remove all Sosa entries related to the gedcom file and user
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     */
-    public function deleteAll(Tree $tree, UserInterface $user): void
-    {
-        DB::table('maj_sosa')
-            ->where('majs_gedcom_id', '=', $tree->id())
-            ->where('majs_user_id', '=', $user->id())
-            ->delete();
-    }
+	/**
+	 * Remove all Sosa entries related to the gedcom file and user
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 */
+	public function deleteAll(Tree $tree, UserInterface $user): void
+	{
+		DB::table('maj_sosa')
+			->where('majs_gedcom_id', '=', $tree->id())
+			->where('majs_user_id', '=', $user->id())
+			->delete();
+	}
 
-    /**
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     * @param int $sosa
-     */
-    public function deleteAncestorsFrom(Tree $tree, UserInterface $user, int $sosa): void
-    {
-        DB::table('maj_sosa')
-            ->where('majs_gedcom_id', '=', $tree->id())
-            ->where('majs_user_id', '=', $user->id())
-            ->where('majs_sosa', '>=', $sosa)
-            ->whereRaw(
-                'FLOOR(majs_sosa / (POW(2, (majs_gen - ?)))) = ?',
-                [$this->generation($sosa), $sosa]
-            )
-            ->delete();
-    }
+	/**
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 * @param int $sosa
+	 */
+	public function deleteAncestorsFrom(Tree $tree, UserInterface $user, int $sosa): void
+	{
+		DB::table('maj_sosa')
+			->where('majs_gedcom_id', '=', $tree->id())
+			->where('majs_user_id', '=', $user->id())
+			->where('majs_sosa', '>=', $sosa)
+			->whereRaw(
+				'FLOOR(majs_sosa / (POW(2, (majs_gen - ?)))) = ?',
+				[$this->generation($sosa), $sosa]
+			)
+			->delete();
+	}
 
-    /**
-     * Insert (or update if already existing) a list of Sosa individuals
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     * @param array<array<string,mixed>> $sosa_records
-     */
-    public function insertOrUpdate(Tree $tree, UserInterface $user, array $sosa_records): void
-    {
-        $mass_update = DB::connection()->getDriverName() === 'mysql';
+	/**
+	 * Insert (or update if already existing) a list of Sosa individuals
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 * @param array<array<string,mixed>> $sosa_records
+	 */
+	public function insertOrUpdate(Tree $tree, UserInterface $user, array $sosa_records): void
+	{
+		$mass_update = DB::connection()->getDriverName() === 'mysql';
 
-        $bindings_placeholders = $bindings_values = [];
-        $has_records = false;
-        foreach ($sosa_records as $i => $row) {
-            $gen = $this->generation($row['sosa']);
-            if ($gen <=  $this->maxSystemGenerations()) {
-                $has_records = true;
-                if ($mass_update) {
-                    $bindings_placeholders[] = '(:tree_id' . $i . ', :user_id' . $i . ', :sosa' . $i . ',' .
-                        ' :indi_id' . $i . ', :gen' . $i . ',' .
-                        ' :byear' . $i . ', :byearest' . $i . ', :dyear' . $i . ', :dyearest' . $i . ')';
-                    $bindings_values = array_merge(
-                        $bindings_values,
-                        [
-                            'tree_id' . $i => $tree->id(),
-                            'user_id' . $i => $user->id(),
-                            'sosa' . $i => $row['sosa'],
-                            'indi_id' . $i => $row['indi'],
-                            'gen' . $i => $gen,
-                            'byear' . $i => $row['birth_year'],
-                            'byearest' . $i => $row['birth_year_est'],
-                            'dyear' . $i => $row['death_year'],
-                            'dyearest' . $i => $row['death_year_est']
-                        ]
-                    );
-                } else {
-                    DB::table('maj_sosa')->updateOrInsert(
-                        [ 'majs_gedcom_id' => $tree->id(), 'majs_user_id' => $user->id(), 'majs_sosa' => $row['sosa']],
-                        [
-                            'majs_i_id' => $row['indi'],
-                            'majs_gen' => $gen,
-                            'majs_birth_year' => $row['birth_year'],
-                            'majs_birth_year_est' => $row['birth_year_est'],
-                            'majs_death_year' => $row['death_year'],
-                            'majs_death_year_est' => $row['death_year_est']
-                        ]
-                    );
-                }
-            }
-        }
+		$bindings_placeholders = $bindings_values = [];
+		$has_records = false;
+		foreach ($sosa_records as $i => $row) {
+			$gen = $this->generation($row['sosa']);
+			if ($gen <=  $this->maxSystemGenerations()) {
+				$has_records = true;
+				if ($mass_update) {
+					$bindings_placeholders[] = '(:tree_id' . $i . ', :user_id' . $i . ', :sosa' . $i . ',' .
+						' :indi_id' . $i . ', :gen' . $i . ',' .
+						' :byear' . $i . ', :byearest' . $i . ', :dyear' . $i . ', :dyearest' . $i . ')';
+					$bindings_values = array_merge(
+						$bindings_values,
+						[
+							'tree_id' . $i => $tree->id(),
+							'user_id' . $i => $user->id(),
+							'sosa' . $i => $row['sosa'],
+							'indi_id' . $i => $row['indi'],
+							'gen' . $i => $gen,
+							'byear' . $i => $row['birth_year'],
+							'byearest' . $i => $row['birth_year_est'],
+							'dyear' . $i => $row['death_year'],
+							'dyearest' . $i => $row['death_year_est']
+						]
+					);
+				} else {
+					DB::table('maj_sosa')->updateOrInsert(
+						[ 'majs_gedcom_id' => $tree->id(), 'majs_user_id' => $user->id(), 'majs_sosa' => $row['sosa']],
+						[
+							'majs_i_id' => $row['indi'],
+							'majs_gen' => $gen,
+							'majs_birth_year' => $row['birth_year'],
+							'majs_birth_year_est' => $row['birth_year_est'],
+							'majs_death_year' => $row['death_year'],
+							'majs_death_year_est' => $row['death_year_est']
+						]
+					);
+				}
+			}
+		}
 
-        if ($has_records && $mass_update) {
-            DB::connection()->statement(
-                'INSERT INTO `' . DB::connection()->getTablePrefix() . 'maj_sosa`' .
-                ' (majs_gedcom_id, majs_user_id, majs_sosa,' .
-                '   majs_i_id, majs_gen, majs_birth_year, majs_birth_year_est, majs_death_year, majs_death_year_est)' .
-                ' VALUES ' . implode(',', $bindings_placeholders) .
-                ' ON DUPLICATE KEY UPDATE majs_i_id = VALUES(majs_i_id), majs_gen = VALUES(majs_gen),' .
-                '   majs_birth_year = VALUES(majs_birth_year), majs_birth_year_est = VALUES(majs_birth_year_est),' .
-                '   majs_death_year = VALUES(majs_death_year), majs_death_year_est = VALUES(majs_death_year_est)',
-                $bindings_values
-            );
-        }
-    }
+		if ($has_records && $mass_update) {
+			DB::connection()->statement(
+				'INSERT INTO `' . DB::connection()->getTablePrefix() . 'maj_sosa`' .
+				' (majs_gedcom_id, majs_user_id, majs_sosa,' .
+				'   majs_i_id, majs_gen, majs_birth_year, majs_birth_year_est, majs_death_year, majs_death_year_est)' .
+				' VALUES ' . implode(',', $bindings_placeholders) .
+				' ON DUPLICATE KEY UPDATE majs_i_id = VALUES(majs_i_id), majs_gen = VALUES(majs_gen),' .
+				'   majs_birth_year = VALUES(majs_birth_year), majs_birth_year_est = VALUES(majs_birth_year_est),' .
+				'   majs_death_year = VALUES(majs_death_year), majs_death_year_est = VALUES(majs_death_year_est)',
+				$bindings_values
+			);
+		}
+	}
 }

app/Module/WelcomeBlock/WelcomeBlockModule.php

Indentation +157 added lines, -157 removed lines

@@ -33,161 +33,161 @@
  */
 class WelcomeBlockModule extends AbstractModule implements ModuleMyArtJaubInterface, ModuleBlockInterface
 {
-    use ModuleMyArtJaubTrait;
-    use ModuleBlockTrait;
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “WelcomeBlock” module */ I18N::translate('MyArtJaub Welcome Block');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “WelcomeBlock” module */ I18N::translate('The MyArtJaub Welcome block welcomes the visitor to the site, allows a quick login to the site, and displays statistics on visits.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/welcomeblock/{block_id}', static function (Map $router): void {
-                $router->tokens(['block_id' => '\d+']);
-                $router->get(MatomoStats::class, '/matomostats', MatomoStats::class);
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.11-v.2';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
-     *
-     * @param mixed[] $config
-     */
-    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
-    {
-        $fab_welcome_block_view = app(\Fisharebest\Webtrees\Module\WelcomeBlockModule::class)
-            ->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
-
-        $fab_login_block_view = app(\Fisharebest\Webtrees\Module\LoginBlockModule::class)
-            ->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
-
-        $content = view($this->name() . '::block-embed', [
-            'block_id'                  =>  $block_id,
-            'fab_welcome_block_view'    =>  $fab_welcome_block_view,
-            'fab_login_block_view'      =>  $fab_login_block_view,
-            'matomo_enabled'            =>  $this->isMatomoEnabled($block_id),
-            'js_script_url'             =>  $this->assetUrl('js/welcomeblock.min.js')
-        ]);
-
-        if ($context !== self::CONTEXT_EMBED) {
-            return view('modules/block-template', [
-                'block'      => Str::kebab($this->name()),
-                'id'         => $block_id,
-                'config_url' => $this->configUrl($tree, $context, $block_id),
-                'title'      => $tree->title(),
-                'content'    => $content,
-            ]);
-        }
-
-        return $content;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::isTreeBlock()
-     */
-    public function isTreeBlock(): bool
-    {
-        return true;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::editBlockConfiguration()
-     */
-    public function editBlockConfiguration(Tree $tree, int $block_id): string
-    {
-        return view($this->name() . '::config', $this->matomoSettings($block_id));
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::saveBlockConfiguration()
-     */
-    public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
-    {
-        $params = (array) $request->getParsedBody();
-
-        $matomo_enabled = $params['matomo_enabled'] == 'yes';
-        $this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
-        if (!$matomo_enabled) {
-            return;
-        }
-
-        if (filter_var($params['matomo_url'], FILTER_VALIDATE_URL) === false) {
-            FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
-            return;
-        }
-
-        if (filter_var($params['matomo_siteid'], FILTER_VALIDATE_INT) === false) {
-            FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
-            return;
-        }
-
-        $this
-            ->setBlockSetting($block_id, 'matomo_url', trim($params['matomo_url']))
-            ->setBlockSetting($block_id, 'matomo_token', trim($params['matomo_token']))
-            ->setBlockSetting($block_id, 'matomo_siteid', $params['matomo_siteid']);
-
-        Registry::cache()->file()->forget($this->name() . '-matomovisits-yearly-' . $block_id);
-    }
-
-    /**
-     * Returns whether Matomo statistics is enabled for a specific MyArtJaub WelcomeBlock block
-     *
-     * @param int $block_id
-     * @return bool
-     */
-    public function isMatomoEnabled(int $block_id): bool
-    {
-        return $this->getBlockSetting($block_id, 'matomo_enabled', 'no') === 'yes';
-    }
-
-    /**
-     * Returns settings for retrieving Matomo statistics for a specific MyArtJaub WelcomeBlock block
-     *
-     * @param int $block_id
-     * @return array<string, mixed>
-     */
-    public function matomoSettings(int $block_id): array
-    {
-        return [
-            'matomo_enabled' => $this->isMatomoEnabled($block_id),
-            'matomo_url' => $this->getBlockSetting($block_id, 'matomo_url'),
-            'matomo_token' => $this->getBlockSetting($block_id, 'matomo_token'),
-            'matomo_siteid'  => (int) $this->getBlockSetting($block_id, 'matomo_siteid', '0')
-        ];
-    }
+	use ModuleMyArtJaubTrait;
+	use ModuleBlockTrait;
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return /* I18N: Name of the “WelcomeBlock” module */ I18N::translate('MyArtJaub Welcome Block');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “WelcomeBlock” module */ I18N::translate('The MyArtJaub Welcome block welcomes the visitor to the site, allows a quick login to the site, and displays statistics on visits.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/welcomeblock/{block_id}', static function (Map $router): void {
+				$router->tokens(['block_id' => '\d+']);
+				$router->get(MatomoStats::class, '/matomostats', MatomoStats::class);
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.11-v.2';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::getBlock()
+	 *
+	 * @param mixed[] $config
+	 */
+	public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
+	{
+		$fab_welcome_block_view = app(\Fisharebest\Webtrees\Module\WelcomeBlockModule::class)
+			->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
+
+		$fab_login_block_view = app(\Fisharebest\Webtrees\Module\LoginBlockModule::class)
+			->getBlock($tree, $block_id, ModuleBlockInterface::CONTEXT_EMBED);
+
+		$content = view($this->name() . '::block-embed', [
+			'block_id'                  =>  $block_id,
+			'fab_welcome_block_view'    =>  $fab_welcome_block_view,
+			'fab_login_block_view'      =>  $fab_login_block_view,
+			'matomo_enabled'            =>  $this->isMatomoEnabled($block_id),
+			'js_script_url'             =>  $this->assetUrl('js/welcomeblock.min.js')
+		]);
+
+		if ($context !== self::CONTEXT_EMBED) {
+			return view('modules/block-template', [
+				'block'      => Str::kebab($this->name()),
+				'id'         => $block_id,
+				'config_url' => $this->configUrl($tree, $context, $block_id),
+				'title'      => $tree->title(),
+				'content'    => $content,
+			]);
+		}
+
+		return $content;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::isTreeBlock()
+	 */
+	public function isTreeBlock(): bool
+	{
+		return true;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::editBlockConfiguration()
+	 */
+	public function editBlockConfiguration(Tree $tree, int $block_id): string
+	{
+		return view($this->name() . '::config', $this->matomoSettings($block_id));
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleBlockInterface::saveBlockConfiguration()
+	 */
+	public function saveBlockConfiguration(ServerRequestInterface $request, int $block_id): void
+	{
+		$params = (array) $request->getParsedBody();
+
+		$matomo_enabled = $params['matomo_enabled'] == 'yes';
+		$this->setBlockSetting($block_id, 'matomo_enabled', $matomo_enabled ? 'yes' : 'no');
+		if (!$matomo_enabled) {
+			return;
+		}
+
+		if (filter_var($params['matomo_url'], FILTER_VALIDATE_URL) === false) {
+			FlashMessages::addMessage(I18N::translate('The Matomo URL provided is not valid.'), 'danger');
+			return;
+		}
+
+		if (filter_var($params['matomo_siteid'], FILTER_VALIDATE_INT) === false) {
+			FlashMessages::addMessage(I18N::translate('The Matomo Site ID provided is not valid.'), 'danger');
+			return;
+		}
+
+		$this
+			->setBlockSetting($block_id, 'matomo_url', trim($params['matomo_url']))
+			->setBlockSetting($block_id, 'matomo_token', trim($params['matomo_token']))
+			->setBlockSetting($block_id, 'matomo_siteid', $params['matomo_siteid']);
+
+		Registry::cache()->file()->forget($this->name() . '-matomovisits-yearly-' . $block_id);
+	}
+
+	/**
+	 * Returns whether Matomo statistics is enabled for a specific MyArtJaub WelcomeBlock block
+	 *
+	 * @param int $block_id
+	 * @return bool
+	 */
+	public function isMatomoEnabled(int $block_id): bool
+	{
+		return $this->getBlockSetting($block_id, 'matomo_enabled', 'no') === 'yes';
+	}
+
+	/**
+	 * Returns settings for retrieving Matomo statistics for a specific MyArtJaub WelcomeBlock block
+	 *
+	 * @param int $block_id
+	 * @return array<string, mixed>
+	 */
+	public function matomoSettings(int $block_id): array
+	{
+		return [
+			'matomo_enabled' => $this->isMatomoEnabled($block_id),
+			'matomo_url' => $this->getBlockSetting($block_id, 'matomo_url'),
+			'matomo_token' => $this->getBlockSetting($block_id, 'matomo_token'),
+			'matomo_siteid'  => (int) $this->getBlockSetting($block_id, 'matomo_siteid', '0')
+		];
+	}
 }

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(app(RouterContainer::class)->getMap());
-    }
-
-    /**
-     * @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(app(RouterContainer::class)->getMap());
+	}
+
+	/**
+	 * @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/Certificates/Services/CertificateFilesystemService.php

Indentation +117 added lines, -117 removed lines

@@ -32,129 +32,129 @@
  */
 class CertificateFilesystemService
 {
-    /**
-     * @var array<int,FilesystemOperator> $filesystem
-     */
-    private array $filesystem = [];
+	/**
+	 * @var array<int,FilesystemOperator> $filesystem
+	 */
+	private array $filesystem = [];
 
-    /**
-     * Get the filesystem containing certificates for a tree.
-     *
-     * @param Tree $tree
-     * @return FilesystemOperator
-     */
-    public function filesystem(Tree $tree): FilesystemOperator
-    {
-        if (!isset($this->filesystem[$tree->id()])) {
-            $cert_dir = $tree->getPreference('MAJ_CERTIF_ROOTDIR', 'certificates/');
-            $adapter   = new ChrootAdapter(Registry::filesystem()->data(), $cert_dir);
+	/**
+	 * Get the filesystem containing certificates for a tree.
+	 *
+	 * @param Tree $tree
+	 * @return FilesystemOperator
+	 */
+	public function filesystem(Tree $tree): FilesystemOperator
+	{
+		if (!isset($this->filesystem[$tree->id()])) {
+			$cert_dir = $tree->getPreference('MAJ_CERTIF_ROOTDIR', 'certificates/');
+			$adapter   = new ChrootAdapter(Registry::filesystem()->data(), $cert_dir);
 
-            $this->filesystem[$tree->id()] = new FileSystem($adapter);
-        }
-        return $this->filesystem[$tree->id()];
-    }
+			$this->filesystem[$tree->id()] = new FileSystem($adapter);
+		}
+		return $this->filesystem[$tree->id()];
+	}
 
-    /**
-     * Set the filesystem containing certificates for a tree.
-     *
-     * @param Tree $tree
-     * @param FilesystemOperator $filesystem
-     */
-    public function setFilesystem(Tree $tree, FilesystemOperator $filesystem): void
-    {
-        $this->filesystem[$tree->id()] = $filesystem;
-    }
+	/**
+	 * Set the filesystem containing certificates for a tree.
+	 *
+	 * @param Tree $tree
+	 * @param FilesystemOperator $filesystem
+	 */
+	public function setFilesystem(Tree $tree, FilesystemOperator $filesystem): void
+	{
+		$this->filesystem[$tree->id()] = $filesystem;
+	}
 
-    /**
-     * Create the Certificate object defined by a path on the filesystem.
-     *
-     * @param Tree $tree
-     * @param string $path
-     * @return Certificate|NULL
-     */
-    public function certificate(Tree $tree, string $path): ?Certificate
-    {
-        $filesystem = $this->filesystem($tree);
-        if ($filesystem->fileExists($path) && $this->isFileSupported($filesystem, $path)) {
-            return new Certificate($tree, $path);
-        }
-        return null;
-    }
+	/**
+	 * Create the Certificate object defined by a path on the filesystem.
+	 *
+	 * @param Tree $tree
+	 * @param string $path
+	 * @return Certificate|NULL
+	 */
+	public function certificate(Tree $tree, string $path): ?Certificate
+	{
+		$filesystem = $this->filesystem($tree);
+		if ($filesystem->fileExists($path) && $this->isFileSupported($filesystem, $path)) {
+			return new Certificate($tree, $path);
+		}
+		return null;
+	}
 
-    /**
-     * Get the cities (first-level folder) available in a the filesystem.
-     *
-     * @param Tree $tree
-     * @return string[]
-     */
-    public function cities(Tree $tree): array
-    {
-        $cities =  $this->filesystem($tree)
-            ->listContents('')
-            ->filter(fn (StorageAttributes $attributes): bool => $attributes->isDir())
-            ->map(fn (StorageAttributes $attributes): string => $attributes->path())
-            ->toArray();
-        usort($cities, I18N::comparator());
-        return $cities;
-    }
+	/**
+	 * Get the cities (first-level folder) available in a the filesystem.
+	 *
+	 * @param Tree $tree
+	 * @return string[]
+	 */
+	public function cities(Tree $tree): array
+	{
+		$cities =  $this->filesystem($tree)
+			->listContents('')
+			->filter(fn (StorageAttributes $attributes): bool => $attributes->isDir())
+			->map(fn (StorageAttributes $attributes): string => $attributes->path())
+			->toArray();
+		usort($cities, I18N::comparator());
+		return $cities;
+	}
 
-    /**
-     * Get the certificates available for a city (first-level folder).
-     *
-     * @param Tree $tree
-     * @param string $city
-     * @return Collection<Certificate>
-     */
-    public function certificatesForCity(Tree $tree, string $city): Collection
-    {
-        $filesystem = $this->filesystem($tree);
-        $certificates_paths = $filesystem->listContents($city)
-            ->filter(fn (StorageAttributes $attributes): bool  =>
-                $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path()))
-            ->map(fn (StorageAttributes $attributes): string => $attributes->path())
-            ->toArray();
-        usort($certificates_paths, I18N::comparator());
-        return collect($certificates_paths)->map(fn (string $path): Certificate => new Certificate($tree, $path));
-    }
+	/**
+	 * Get the certificates available for a city (first-level folder).
+	 *
+	 * @param Tree $tree
+	 * @param string $city
+	 * @return Collection<Certificate>
+	 */
+	public function certificatesForCity(Tree $tree, string $city): Collection
+	{
+		$filesystem = $this->filesystem($tree);
+		$certificates_paths = $filesystem->listContents($city)
+			->filter(fn (StorageAttributes $attributes): bool  =>
+				$attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path()))
+			->map(fn (StorageAttributes $attributes): string => $attributes->path())
+			->toArray();
+		usort($certificates_paths, I18N::comparator());
+		return collect($certificates_paths)->map(fn (string $path): Certificate => new Certificate($tree, $path));
+	}
 
-    /**
-     * Get the certificates available for a city (first-level folder), containing a specified text.
-     *
-     * @param Tree $tree
-     * @param string $city
-     * @param string $contains
-     * @return Collection<Certificate>
-     */
-    public function certificatesForCityContaining(Tree $tree, string $city, string $contains): Collection
-    {
-        $filesystem = $this->filesystem($tree);
-        $certificates_paths = $filesystem->listContents($city)
-            ->filter(fn (StorageAttributes $attributes): bool  =>
-                $attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path())
-                && mb_stripos($attributes->path(), $contains) !== false)
-            ->map(fn (StorageAttributes $attributes): string => $attributes->path())
-            ->toArray();
-        usort($certificates_paths, I18N::comparator());
-        return collect($certificates_paths)->map(fn (string $path): Certificate => new Certificate($tree, $path));
-    }
+	/**
+	 * Get the certificates available for a city (first-level folder), containing a specified text.
+	 *
+	 * @param Tree $tree
+	 * @param string $city
+	 * @param string $contains
+	 * @return Collection<Certificate>
+	 */
+	public function certificatesForCityContaining(Tree $tree, string $city, string $contains): Collection
+	{
+		$filesystem = $this->filesystem($tree);
+		$certificates_paths = $filesystem->listContents($city)
+			->filter(fn (StorageAttributes $attributes): bool  =>
+				$attributes->isFile() && $this->isFileSupported($filesystem, $attributes->path())
+				&& mb_stripos($attributes->path(), $contains) !== false)
+			->map(fn (StorageAttributes $attributes): string => $attributes->path())
+			->toArray();
+		usort($certificates_paths, I18N::comparator());
+		return collect($certificates_paths)->map(fn (string $path): Certificate => new Certificate($tree, $path));
+	}
 
-    /**
-     * Check if a file on the filesystem is supported by the certificate module.
-     *
-     * @param FilesystemOperator $filesystem
-     * @param string $path
-     * @return bool
-     */
-    protected function isFileSupported(FilesystemOperator $filesystem, string $path): bool
-    {
-        try {
-            $mime = $filesystem->mimeType($path);
-            return Registry::cache()->array()->remember(
-                'maj-certif-supportedfiles-' . $mime,
-                fn (): bool => app(CertificateImageFactory::class)->isMimeTypeSupported($mime)
-            );
-        } catch (UnableToRetrieveMetadata | FilesystemException $ex) {
-        }
-        return false;
-    }
+	/**
+	 * Check if a file on the filesystem is supported by the certificate module.
+	 *
+	 * @param FilesystemOperator $filesystem
+	 * @param string $path
+	 * @return bool
+	 */
+	protected function isFileSupported(FilesystemOperator $filesystem, string $path): bool
+	{
+		try {
+			$mime = $filesystem->mimeType($path);
+			return Registry::cache()->array()->remember(
+				'maj-certif-supportedfiles-' . $mime,
+				fn (): bool => app(CertificateImageFactory::class)->isMimeTypeSupported($mime)
+			);
+		} catch (UnableToRetrieveMetadata | FilesystemException $ex) {
+		}
+		return false;
+	}
 }

app/Module/Certificates/Services/CertificateDataService.php

Indentation +132 added lines, -132 removed lines

@@ -29,144 +29,144 @@
 class CertificateDataService
 {
 
-    /**
-     * Find individuals linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Individual>
-     */
-    public function linkedIndividuals(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('individuals')
-            ->where('i_file', '=', $tree->id())
-            ->where('i_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['individuals.*'])
-            ->get()
-            ->map(Registry::individualFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find individuals linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Individual>
+	 */
+	public function linkedIndividuals(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('individuals')
+			->where('i_file', '=', $tree->id())
+			->where('i_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['individuals.*'])
+			->get()
+			->map(Registry::individualFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Find families linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Family>
-     */
-    public function linkedFamilies(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('families')
-            ->where('f_file', '=', $tree->id())
-            ->where('f_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['families.*'])
-            ->get()
-            ->map(Registry::familyFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find families linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Family>
+	 */
+	public function linkedFamilies(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('families')
+			->where('f_file', '=', $tree->id())
+			->where('f_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['families.*'])
+			->get()
+			->map(Registry::familyFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Find media objects linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Media>
-     */
-    public function linkedMedias(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('media')
-            ->where('m_file', '=', $tree->id())
-            ->where('m_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['media.*'])
-            ->get()
-            ->map(Registry::mediaFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find media objects linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Media>
+	 */
+	public function linkedMedias(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('media')
+			->where('m_file', '=', $tree->id())
+			->where('m_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['media.*'])
+			->get()
+			->map(Registry::mediaFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Find notes linked to a certificate.
-     *
-     * {@internal Ideally, the underscore should be escaped in the WHERE clause,
-     * but does not work with Sqlite if no default escape has been defined}
-     *
-     * @param Certificate $certificate
-     * @return Collection<\Fisharebest\Webtrees\Note>
-     */
-    public function linkedNotes(Certificate $certificate): Collection
-    {
-        $tree = $certificate->tree();
-        return DB::table('other')
-            ->where('o_file', '=', $tree->id())
-            ->where('o_type', '=', 'NOTE')
-            ->where('o_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
-            ->select(['other.*'])
-            ->get()
-            ->map(Registry::noteFactory()->mapper($tree))
-            ->filter(GedcomRecord::accessFilter());
-    }
+	/**
+	 * Find notes linked to a certificate.
+	 *
+	 * {@internal Ideally, the underscore should be escaped in the WHERE clause,
+	 * but does not work with Sqlite if no default escape has been defined}
+	 *
+	 * @param Certificate $certificate
+	 * @return Collection<\Fisharebest\Webtrees\Note>
+	 */
+	public function linkedNotes(Certificate $certificate): Collection
+	{
+		$tree = $certificate->tree();
+		return DB::table('other')
+			->where('o_file', '=', $tree->id())
+			->where('o_type', '=', 'NOTE')
+			->where('o_gedcom', 'like', '% _ACT ' . $this->escapedSqlPath($certificate) . '%')
+			->select(['other.*'])
+			->get()
+			->map(Registry::noteFactory()->mapper($tree))
+			->filter(GedcomRecord::accessFilter());
+	}
 
-    /**
-     * Return an escaped string to be used in SQL LIKE comparisons.
-     * This would not work well for Sqlite, if the escape character is not defined.
-     *
-     * @param Certificate $certificate
-     * @return string
-     */
-    protected function escapedSqlPath(Certificate $certificate): string
-    {
-        return str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $certificate->gedcomPath());
-    }
+	/**
+	 * Return an escaped string to be used in SQL LIKE comparisons.
+	 * This would not work well for Sqlite, if the escape character is not defined.
+	 *
+	 * @param Certificate $certificate
+	 * @return string
+	 */
+	protected function escapedSqlPath(Certificate $certificate): string
+	{
+		return str_replace(array('\\', '%', '_'), array('\\\\', '\\%', '\\_'), $certificate->gedcomPath());
+	}
 
-    /**
-     * Find a source linked to a citation where a certificate file is referenced.
-     *
-     * @param Certificate $certificate
-     * @return Source|NULL
-     */
-    public function oneLinkedSource(Certificate $certificate): ?Source
-    {
-        $regex_query = preg_quote($certificate->gedcomPath(), '/');
-        $regex_pattern = '/[1-9] SOUR @(' . Gedcom::REGEX_XREF . ')@(?:\n[2-9]\s(?:(?!SOUR)\w+)\s.*)*\n[2-9] _ACT ' . $regex_query . '/i'; //phpcs:ignore Generic.Files.LineLength.TooLong
+	/**
+	 * Find a source linked to a citation where a certificate file is referenced.
+	 *
+	 * @param Certificate $certificate
+	 * @return Source|NULL
+	 */
+	public function oneLinkedSource(Certificate $certificate): ?Source
+	{
+		$regex_query = preg_quote($certificate->gedcomPath(), '/');
+		$regex_pattern = '/[1-9] SOUR @(' . Gedcom::REGEX_XREF . ')@(?:\n[2-9]\s(?:(?!SOUR)\w+)\s.*)*\n[2-9] _ACT ' . $regex_query . '/i'; //phpcs:ignore Generic.Files.LineLength.TooLong
 
-        foreach ($this->linkedRecordsLists($certificate) as $linked_records) {
-            foreach ($linked_records as $gedcom_record) {
-                foreach ($gedcom_record->facts() as $fact) {
-                    if (preg_match_all($regex_pattern, $fact->gedcom(), $matches, PREG_SET_ORDER) >= 1) {
-                        foreach ($matches as $match) {
-                            $source = Registry::sourceFactory()->make($match[1], $certificate->tree());
-                            if ($source !== null && $source->canShowName()) {
-                                return $source;
-                            }
-                        }
-                    }
-                }
-            }
-        }
+		foreach ($this->linkedRecordsLists($certificate) as $linked_records) {
+			foreach ($linked_records as $gedcom_record) {
+				foreach ($gedcom_record->facts() as $fact) {
+					if (preg_match_all($regex_pattern, $fact->gedcom(), $matches, PREG_SET_ORDER) >= 1) {
+						foreach ($matches as $match) {
+							$source = Registry::sourceFactory()->make($match[1], $certificate->tree());
+							if ($source !== null && $source->canShowName()) {
+								return $source;
+							}
+						}
+					}
+				}
+			}
+		}
 
-        return null;
-    }
+		return null;
+	}
 
-    /**
-     * Yield lists of gedcom records linked to a certificate.
-     *
-     * @param Certificate $certificate
-     * @return Generator<int, Collection<GedcomRecord>, mixed, void>
-     * @psalm-suppress InvalidReturnType
-     */
-    protected function linkedRecordsLists(Certificate $certificate): Generator
-    {
-        yield $this->linkedIndividuals($certificate);
-        yield $this->linkedFamilies($certificate);
-        yield $this->linkedMedias($certificate);
-        yield $this->linkedNotes($certificate);
-    }
+	/**
+	 * Yield lists of gedcom records linked to a certificate.
+	 *
+	 * @param Certificate $certificate
+	 * @return Generator<int, Collection<GedcomRecord>, mixed, void>
+	 * @psalm-suppress InvalidReturnType
+	 */
+	protected function linkedRecordsLists(Certificate $certificate): Generator
+	{
+		yield $this->linkedIndividuals($certificate);
+		yield $this->linkedFamilies($certificate);
+		yield $this->linkedMedias($certificate);
+		yield $this->linkedNotes($certificate);
+	}
 }

app/Module/Certificates/Model/Certificate.php

Indentation +189 added lines, -189 removed lines

@@ -25,193 +25,193 @@
  */
 class Certificate
 {
-    /**
-     * Pattern to extract information from a file name.
-     * Specific to the author's workflow.
-     * @var string
-     */
-    private const FILENAME_PATTERN = '/^(?<year>\d{1,4})(\.(?<month>\d{1,2}))?(\.(?<day>\d{1,2}))?( (?<type>[A-Z]{1,2}))?\s(?<descr>.*)/'; //phpcs:ignore Generic.Files.LineLength.TooLong
-
-    private Tree $tree;
-    private string $path;
-    private ?string $city = null;
-    private ?string $basename = null;
-    private ?string $filename = null;
-    private ?string $extension = null;
-    private ?string $type = null;
-    private ?string $description = null;
-    private ?Date $date = null;
-
-    /**
-     * Contructor for Certificate
-     *
-     * @param Tree $tree
-     * @param string $path
-     */
-    public function __construct(Tree $tree, string $path)
-    {
-        $this->tree = $tree;
-        $this->path = $path;
-        $this->extractDataFromPath($path);
-    }
-
-    /**
-     * Populate fields from the filename, based on a predeterminate pattern.
-     * Logic specific to the author.
-     *
-     * @param string $path
-     */
-    protected function extractDataFromPath(string $path): void
-    {
-        $path_parts = pathinfo($path);
-        $this->city = $path_parts['dirname'];
-        $this->basename = $path_parts['basename'];
-        $this->filename = $path_parts['filename'];
-        $this->extension = strtolower($path_parts['extension'] ?? '');
-
-        if (preg_match(self::FILENAME_PATTERN, $this->filename, $match) === 1) {
-            $this->type = $match['type'];
-            $this->description = $match['descr'];
-
-            $day = $match['day'] ?? '';
-            $month_date = DateTime::createFromFormat('m', $match['month'] ?? '');
-            $month = $month_date !== false ? strtoupper($month_date->format('M')) : '';
-            $year = $match['year'] ?? '';
-
-            $this->date = new Date(sprintf('%s %s %s', $day, $month, $year));
-        } else {
-            $this->description = $this->filename;
-        }
-    }
-
-    /**
-     * Get the family tree of the certificate
-     *
-     * @return Tree
-     */
-    public function tree(): Tree
-    {
-        return $this->tree;
-    }
-
-    /**
-     * Get the path of the certificate in the file system.
-     *
-     * @return string
-     */
-    public function path(): string
-    {
-        return $this->path;
-    }
-
-    /**
-     * The the path of the certificate, in a Gedcom canonical form.
-     *
-     * @return string
-     */
-    public function gedcomPath(): string
-    {
-        return str_replace('\\', '/', $this->path);
-    }
-
-    /**
-     * Get the certificate name.
-     *
-     * @return string
-     */
-    public function name(): string
-    {
-        return $this->filename ?? '';
-    }
-
-    /**
-     * Get the certificate file name.
-     *
-     * @return string
-     */
-    public function filename(): string
-    {
-        return $this->basename ?? '';
-    }
-
-    /**
-     * Get the certificate's city (the first level folder).
-     *
-     * @return string
-     */
-    public function city(): string
-    {
-        return $this->city ?? '';
-    }
-
-    /**
-     * Get the certificate's date. Extracted from the file name.
-     *
-     * @return Date
-     */
-    public function date(): Date
-    {
-        return $this->date ?? new Date('');
-    }
-
-    /**
-     * Get the certificate's type. Extracted from the file name.
-     *
-     * @return string
-     */
-    public function type(): string
-    {
-        return $this->type ?? '';
-    }
-
-    /**
-     * Get the certificate's description.  Extracted from the file name.
-     * @return string
-     */
-    public function description(): string
-    {
-        return $this->description ?? '';
-    }
-
-    /**
-     * Get the certificate's description to be used for sorting.
-     * This is based on surnames (at least 3 letters) found in the file name.
-     *
-     * @return string
-     */
-    public function sortDescription(): string
-    {
-        $sort_prefix = '';
-        if (preg_match_all('/\b([A-Z]{3,})\b/', $this->description(), $matches, PREG_SET_ORDER) >= 1) {
-            $sort_prefix = implode('_', array_map(function ($match) {
-                return $match[1];
-            }, $matches)) . '_';
-        }
-        return $sort_prefix . $this->description();
-    }
-
-    /**
-     * Get the certificate's MIME type.
-     *
-     * @return string
-     */
-    public function mimeType(): string
-    {
-        return Mime::TYPES[$this->extension] ?? Mime::DEFAULT_TYPE;
-    }
-
-    /**
-     * Get the base parameters to be used in url referencing the certificate.
-     *
-     * @param UrlObfuscatorService $url_obfuscator_service
-     * @return array{tree: string, cid: mixed}
-     */
-    public function urlParameters(UrlObfuscatorService $url_obfuscator_service = null): array
-    {
-        $url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
-        return [
-            'tree' => $this->tree->name(),
-            'cid' => $url_obfuscator_service->obfuscate($this->path)
-        ];
-    }
+	/**
+	 * Pattern to extract information from a file name.
+	 * Specific to the author's workflow.
+	 * @var string
+	 */
+	private const FILENAME_PATTERN = '/^(?<year>\d{1,4})(\.(?<month>\d{1,2}))?(\.(?<day>\d{1,2}))?( (?<type>[A-Z]{1,2}))?\s(?<descr>.*)/'; //phpcs:ignore Generic.Files.LineLength.TooLong
+
+	private Tree $tree;
+	private string $path;
+	private ?string $city = null;
+	private ?string $basename = null;
+	private ?string $filename = null;
+	private ?string $extension = null;
+	private ?string $type = null;
+	private ?string $description = null;
+	private ?Date $date = null;
+
+	/**
+	 * Contructor for Certificate
+	 *
+	 * @param Tree $tree
+	 * @param string $path
+	 */
+	public function __construct(Tree $tree, string $path)
+	{
+		$this->tree = $tree;
+		$this->path = $path;
+		$this->extractDataFromPath($path);
+	}
+
+	/**
+	 * Populate fields from the filename, based on a predeterminate pattern.
+	 * Logic specific to the author.
+	 *
+	 * @param string $path
+	 */
+	protected function extractDataFromPath(string $path): void
+	{
+		$path_parts = pathinfo($path);
+		$this->city = $path_parts['dirname'];
+		$this->basename = $path_parts['basename'];
+		$this->filename = $path_parts['filename'];
+		$this->extension = strtolower($path_parts['extension'] ?? '');
+
+		if (preg_match(self::FILENAME_PATTERN, $this->filename, $match) === 1) {
+			$this->type = $match['type'];
+			$this->description = $match['descr'];
+
+			$day = $match['day'] ?? '';
+			$month_date = DateTime::createFromFormat('m', $match['month'] ?? '');
+			$month = $month_date !== false ? strtoupper($month_date->format('M')) : '';
+			$year = $match['year'] ?? '';
+
+			$this->date = new Date(sprintf('%s %s %s', $day, $month, $year));
+		} else {
+			$this->description = $this->filename;
+		}
+	}
+
+	/**
+	 * Get the family tree of the certificate
+	 *
+	 * @return Tree
+	 */
+	public function tree(): Tree
+	{
+		return $this->tree;
+	}
+
+	/**
+	 * Get the path of the certificate in the file system.
+	 *
+	 * @return string
+	 */
+	public function path(): string
+	{
+		return $this->path;
+	}
+
+	/**
+	 * The the path of the certificate, in a Gedcom canonical form.
+	 *
+	 * @return string
+	 */
+	public function gedcomPath(): string
+	{
+		return str_replace('\\', '/', $this->path);
+	}
+
+	/**
+	 * Get the certificate name.
+	 *
+	 * @return string
+	 */
+	public function name(): string
+	{
+		return $this->filename ?? '';
+	}
+
+	/**
+	 * Get the certificate file name.
+	 *
+	 * @return string
+	 */
+	public function filename(): string
+	{
+		return $this->basename ?? '';
+	}
+
+	/**
+	 * Get the certificate's city (the first level folder).
+	 *
+	 * @return string
+	 */
+	public function city(): string
+	{
+		return $this->city ?? '';
+	}
+
+	/**
+	 * Get the certificate's date. Extracted from the file name.
+	 *
+	 * @return Date
+	 */
+	public function date(): Date
+	{
+		return $this->date ?? new Date('');
+	}
+
+	/**
+	 * Get the certificate's type. Extracted from the file name.
+	 *
+	 * @return string
+	 */
+	public function type(): string
+	{
+		return $this->type ?? '';
+	}
+
+	/**
+	 * Get the certificate's description.  Extracted from the file name.
+	 * @return string
+	 */
+	public function description(): string
+	{
+		return $this->description ?? '';
+	}
+
+	/**
+	 * Get the certificate's description to be used for sorting.
+	 * This is based on surnames (at least 3 letters) found in the file name.
+	 *
+	 * @return string
+	 */
+	public function sortDescription(): string
+	{
+		$sort_prefix = '';
+		if (preg_match_all('/\b([A-Z]{3,})\b/', $this->description(), $matches, PREG_SET_ORDER) >= 1) {
+			$sort_prefix = implode('_', array_map(function ($match) {
+				return $match[1];
+			}, $matches)) . '_';
+		}
+		return $sort_prefix . $this->description();
+	}
+
+	/**
+	 * Get the certificate's MIME type.
+	 *
+	 * @return string
+	 */
+	public function mimeType(): string
+	{
+		return Mime::TYPES[$this->extension] ?? Mime::DEFAULT_TYPE;
+	}
+
+	/**
+	 * Get the base parameters to be used in url referencing the certificate.
+	 *
+	 * @param UrlObfuscatorService $url_obfuscator_service
+	 * @return array{tree: string, cid: mixed}
+	 */
+	public function urlParameters(UrlObfuscatorService $url_obfuscator_service = null): array
+	{
+		$url_obfuscator_service = $url_obfuscator_service ?? app(UrlObfuscatorService::class);
+		return [
+			'tree' => $this->tree->name(),
+			'cid' => $url_obfuscator_service->obfuscate($this->path)
+		];
+	}
 }

app/Module/ModuleMyArtJaubInterface.php

Indentation +14 added lines, -14 removed lines

@@ -21,19 +21,19 @@
  */
 interface ModuleMyArtJaubInterface extends ModuleCustomInterface
 {
-    /**
-     * Add module routes to webtrees route loader
-     *
-     * @param Map<\Aura\Router\Route> $router
-     */
-    public function loadRoutes(Map $router): void;
+	/**
+	 * Add module routes to webtrees route loader
+	 *
+	 * @param Map<\Aura\Router\Route> $router
+	 */
+	public function loadRoutes(Map $router): void;
 
-    /**
-     * Returns the URL of the module specific stylesheets.
-     * It will look for a CSS file matching the theme name (e.g. xenea.min.css),
-     * and fallback to default.min.css if none are found
-     *
-     * @return string
-     */
-    public function moduleCssUrl(): string;
+	/**
+	 * Returns the URL of the module specific stylesheets.
+	 * It will look for a CSS file matching the theme name (e.g. xenea.min.css),
+	 * and fallback to default.min.css if none are found
+	 *
+	 * @return string
+	 */
+	public function moduleCssUrl(): string;
 }

app/Module/IsSourced/Services/SourceStatusService.php

Indentation +122 added lines, -122 removed lines

@@ -30,126 +30,126 @@
 class SourceStatusService
 {
 
-    /**
-     * Maximum timespan between the date of a source and the date of the event to consider the source precise.
-     * Arbitrally set to approximately a year around the event date.
-     *
-     * @var int DATE_PRECISION_MARGIN
-     */
-    private const DATE_PRECISION_MARGIN = 180;
-
-    /**
-     * Return the status of source citations for a fact.
-     *
-     * @param Fact $fact
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForFact(Fact $fact): FactSourceStatus
-    {
-        $source_status = new FactSourceStatus();
-
-        $date = $fact->date();
-        $source_status
-            ->setFactHasDate($date->isOK())
-            ->setFactHasPreciseDate($date->qual1 === '' && $date->minimumJulianDay() === $date->maximumJulianDay());
-
-        foreach ($fact->getCitations() as $citation) {
-            $source_status
-                ->setHasSource(true)
-                ->addHasSupportingDocument(preg_match('/\n3 _ACT (?:.*)/', $citation) === 1);
-
-            preg_match_all("/\n3 DATA(?:\n[4-9] .*)*\n4 DATE (.*)/", $citation, $date_matches, PREG_SET_ORDER);
-            foreach ($date_matches as $date_match) {
-                $source_date = new Date($date_match[1]);
-                $source_status
-                    ->addSourceHasDate($source_date->isOK())
-                    ->addSourceMatchesFactDate($date->isOK() && $source_date->isOK()
-                        && abs($source_date->julianDay() - $date->julianDay()) < self::DATE_PRECISION_MARGIN);
-            }
-
-            if ($source_status->isFullySourced()) {
-                return $source_status;
-            }
-        }
-
-        return $source_status;
-    }
-
-    /**
-     * Return the status of sources for a Gedcom record.
-     *
-     * @param GedcomRecord $record
-     * @return SourceStatus
-     */
-    public function sourceStatusForRecord(GedcomRecord $record): SourceStatus
-    {
-        $source_status = new SourceStatus();
-
-        foreach ($record->facts(['SOUR']) as $source) {
-            $source_status
-                ->setHasSource(true)
-                ->addHasSupportingDocument($source->attribute('_ACT') !== '');
-
-            if ($source_status->isFullySourced()) {
-                return $source_status;
-            }
-        }
-
-        return $source_status;
-    }
-
-    /**
-     * Return the status of source citations for a list of fact types associated with a record.
-     *
-     * @param GedcomRecord $record
-     * @param string[] $tags
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForFactsWithTags(GedcomRecord $record, array $tags): FactSourceStatus
-    {
-        $source_status = new NullFactSourceStatus();
-
-        foreach ($record->facts($tags) as $fact) {
-            $source_status = $source_status->combineWith($this->sourceStatusForFact($fact));
-            if ($source_status->isFullySourced()) {
-                return $source_status;
-            }
-        }
-
-        return $source_status;
-    }
-
-    /**
-     * Return the status of source citations for an individual's birth events.
-     *
-     * @param Individual $individual
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForBirth(Individual $individual): FactSourceStatus
-    {
-        return $this->sourceStatusForFactsWithTags($individual, Gedcom::BIRTH_EVENTS);
-    }
-
-    /**
-     * Return the status of source citations for an individual's death events.
-     *
-     * @param Individual $individual
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForDeath(Individual $individual): FactSourceStatus
-    {
-        return $this->sourceStatusForFactsWithTags($individual, Gedcom::DEATH_EVENTS);
-    }
-
-    /**
-     * Return the status of source citations for a family's marriage events.
-     *
-     * @param Family $family
-     * @return FactSourceStatus
-     */
-    public function sourceStatusForMarriage(Family $family): FactSourceStatus
-    {
-        $marr_events = array_merge(Gedcom::MARRIAGE_EVENTS, ['MARC', 'MARL', 'MARS']);
-        return $this->sourceStatusForFactsWithTags($family, $marr_events);
-    }
+	/**
+	 * Maximum timespan between the date of a source and the date of the event to consider the source precise.
+	 * Arbitrally set to approximately a year around the event date.
+	 *
+	 * @var int DATE_PRECISION_MARGIN
+	 */
+	private const DATE_PRECISION_MARGIN = 180;
+
+	/**
+	 * Return the status of source citations for a fact.
+	 *
+	 * @param Fact $fact
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForFact(Fact $fact): FactSourceStatus
+	{
+		$source_status = new FactSourceStatus();
+
+		$date = $fact->date();
+		$source_status
+			->setFactHasDate($date->isOK())
+			->setFactHasPreciseDate($date->qual1 === '' && $date->minimumJulianDay() === $date->maximumJulianDay());
+
+		foreach ($fact->getCitations() as $citation) {
+			$source_status
+				->setHasSource(true)
+				->addHasSupportingDocument(preg_match('/\n3 _ACT (?:.*)/', $citation) === 1);
+
+			preg_match_all("/\n3 DATA(?:\n[4-9] .*)*\n4 DATE (.*)/", $citation, $date_matches, PREG_SET_ORDER);
+			foreach ($date_matches as $date_match) {
+				$source_date = new Date($date_match[1]);
+				$source_status
+					->addSourceHasDate($source_date->isOK())
+					->addSourceMatchesFactDate($date->isOK() && $source_date->isOK()
+						&& abs($source_date->julianDay() - $date->julianDay()) < self::DATE_PRECISION_MARGIN);
+			}
+
+			if ($source_status->isFullySourced()) {
+				return $source_status;
+			}
+		}
+
+		return $source_status;
+	}
+
+	/**
+	 * Return the status of sources for a Gedcom record.
+	 *
+	 * @param GedcomRecord $record
+	 * @return SourceStatus
+	 */
+	public function sourceStatusForRecord(GedcomRecord $record): SourceStatus
+	{
+		$source_status = new SourceStatus();
+
+		foreach ($record->facts(['SOUR']) as $source) {
+			$source_status
+				->setHasSource(true)
+				->addHasSupportingDocument($source->attribute('_ACT') !== '');
+
+			if ($source_status->isFullySourced()) {
+				return $source_status;
+			}
+		}
+
+		return $source_status;
+	}
+
+	/**
+	 * Return the status of source citations for a list of fact types associated with a record.
+	 *
+	 * @param GedcomRecord $record
+	 * @param string[] $tags
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForFactsWithTags(GedcomRecord $record, array $tags): FactSourceStatus
+	{
+		$source_status = new NullFactSourceStatus();
+
+		foreach ($record->facts($tags) as $fact) {
+			$source_status = $source_status->combineWith($this->sourceStatusForFact($fact));
+			if ($source_status->isFullySourced()) {
+				return $source_status;
+			}
+		}
+
+		return $source_status;
+	}
+
+	/**
+	 * Return the status of source citations for an individual's birth events.
+	 *
+	 * @param Individual $individual
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForBirth(Individual $individual): FactSourceStatus
+	{
+		return $this->sourceStatusForFactsWithTags($individual, Gedcom::BIRTH_EVENTS);
+	}
+
+	/**
+	 * Return the status of source citations for an individual's death events.
+	 *
+	 * @param Individual $individual
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForDeath(Individual $individual): FactSourceStatus
+	{
+		return $this->sourceStatusForFactsWithTags($individual, Gedcom::DEATH_EVENTS);
+	}
+
+	/**
+	 * Return the status of source citations for a family's marriage events.
+	 *
+	 * @param Family $family
+	 * @return FactSourceStatus
+	 */
+	public function sourceStatusForMarriage(Family $family): FactSourceStatus
+	{
+		$marr_events = array_merge(Gedcom::MARRIAGE_EVENTS, ['MARC', 'MARL', 'MARS']);
+		return $this->sourceStatusForFactsWithTags($family, $marr_events);
+	}
 }

app/Module/GeoDispersion/Schema/Migration2.php

Indentation +209 added lines, -209 removed lines

@@ -39,213 +39,213 @@
  */
 class Migration2 implements MigrationInterface
 {
-    /**
-     * Mapping from old map definitions to new ones
-     * @var array<string,mixed> MAPS_XML_MAPPING
-     */
-    private const MAPS_XML_MAPPING = [
-        'aubracmargeridebycommunes.xml' =>  'fr-area-aubrac-lot-margeride-planeze-communes',
-        'calvadosbycommunes.xml'        =>  'fr-dpt-14-communes',
-        'cantalbycommunes.xml'          =>  'fr-dpt-15-communes',
-        'cotesdarmorbycommunes.xml'     =>  'fr-dpt-22-communes',
-        'essonnebycommunes.xml'         =>  'fr-dpt-91-communes',
-        'eurebycommunes.xml'            =>  'fr-dpt-27-communes',
-        'eureetloirbycommunes.xml'      =>  'fr-dpt-28-communes',
-        'francebydepartements.xml'      =>  'fr-metropole-departements',
-        'francebyregions1970.xml'       =>  'fr-metropole-regions-1970',
-        'francebyregions2016.xml'       =>  'fr-metropole-regions-2016',
-        'hauteloirebycommunes.xml'      =>  'fr-dpt-43-communes',
-        'illeetvilainebycommunes.xml'   =>  'fr-dpt-35-communes',
-        'loiretbycommunes.xml'          =>  'fr-dpt-45-communes',
-        'lozerebycodepostaux.xml'       =>  'fr-dpt-48-codespostaux',
-        'lozerebycommunes.xml'          =>  'fr-dpt-48-communes',
-        'mayennebycommunes.xml'         =>  'fr-dpt-53-communes',
-        'oisebycommunes.xml'            =>  'fr-dpt-60-communes',
-        'ornebycommunes.xml'            =>  'fr-dpt-61-communes',
-        'puydedomebycommunes.xml'       =>  'fr-dpt-63-communes',
-        'sarthebycommunes.xml'          =>  'fr-dpt-72-communes',
-        'seinemaritimebycommunes.xml'   =>  'fr-dpt-76-communes',
-        'seinesommeoisebycommunes.xml'  =>  ['fr-dpt-60-communes', 'fr-dpt-76-communes', 'fr-dpt-80-communes'],
-        'valdoisebycommunes.xml'        =>  'fr-dpt-95-communes',
-        'yvelinesbycommunes.xml'        =>  'fr-dpt-78-communes'
-    ];
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        if (!DB::schema()->hasTable('maj_geodispersion')) {
-            return;
-        }
-
-        /** @var TreeService $tree_service */
-        $tree_service = app(TreeService::class);
-        /** @var GeoAnalysisViewDataService $geoview_data_service */
-        $geoview_data_service = app(GeoAnalysisViewDataService::class);
-
-        $existing_views = DB::table('maj_geodispersion')
-            ->select()
-            ->get();
-
-        foreach ($existing_views as $old_view) {
-            try {
-                $tree = $tree_service->find((int) $old_view->majgd_file);
-            } catch (RuntimeException $ex) {
-                continue;
-            }
-
-            if ($old_view->majgd_map === null) {
-                $this->migrateGeoAnalysisTable($old_view, $tree, $geoview_data_service);
-            } else {
-                DB::connection()->beginTransaction();
-                if ($this->migrateGeoAnalysisMap($old_view, $tree, $geoview_data_service)) {
-                    DB::connection()->commit();
-                } else {
-                    DB::connection()->rollBack();
-                }
-            }
-        }
-
-        DB::schema()->drop('maj_geodispersion');
-
-        FlashMessages::addMessage(I18N::translate(
-            'The geographical dispersion analyses have been migrated for webtrees 2. Please review their settings.'
-        ));
-    }
-
-    /**
-     * Create a Table geographical analysis view from a migrated item.
-     *
-     * @param stdClass $old_view
-     * @param Tree $tree
-     * @param GeoAnalysisViewDataService $geoview_data_service
-     * @return bool
-     */
-    private function migrateGeoAnalysisTable(
-        stdClass $old_view,
-        Tree $tree,
-        GeoAnalysisViewDataService $geoview_data_service
-    ): bool {
-        $new_view = new GeoAnalysisTable(
-            0,
-            $tree,
-            $old_view->majgd_status === 'enabled',
-            $old_view->majgd_descr,
-            app(SosaByGenerationGeoAnalysis::class),
-            (int) $old_view->majgd_sublevel,
-            (int) $old_view->majgd_detailsgen
-        );
-
-        return $geoview_data_service->insertGetId($new_view) > 0;
-    }
-
-    /**
-     * Create a Map geographical analysis view from a migrated item.
-     *
-     * @param stdClass $old_view
-     * @param Tree $tree
-     * @param GeoAnalysisViewDataService $geoview_data_service
-     * @return bool
-     */
-    private function migrateGeoAnalysisMap(
-        stdClass $old_view,
-        Tree $tree,
-        GeoAnalysisViewDataService $geoview_data_service
-    ): bool {
-        /** @var MapDefinitionsService $map_definition_service */
-        $map_definition_service = app(MapDefinitionsService::class);
-        /** @var MapAdapterDataService $mapadapter_data_service */
-        $mapadapter_data_service = app(MapAdapterDataService::class);
-
-        $new_view = new GeoAnalysisMap(
-            0,
-            $tree,
-            $old_view->majgd_status === 'enabled',
-            $old_view->majgd_descr,
-            app(SosaByGenerationGeoAnalysis::class),
-            (int) $old_view->majgd_sublevel,
-            (int) $old_view->majgd_detailsgen
-        );
-
-        $view_id = $geoview_data_service->insertGetId($new_view);
-        if ($view_id === 0) {
-            return false;
-        }
-        $new_view = $new_view->withId($view_id);
-
-        $colors = $new_view->colors();
-        foreach ($this->mapIdsFromOld($old_view->majgd_map) as $new_map_id) {
-            $map = $map_definition_service->find($new_map_id);
-            if ($map === null) {
-                return false;
-            }
-            $colors = $this->colorsFromMap($new_map_id);
-
-            /** @var SimplePlaceMapper $mapper */
-            $mapper = app(SimplePlaceMapper::class);
-            $mapview_config = new MapViewConfig($this->mappingPropertyForMap($new_map_id), $mapper->config());
-            $map_adapter = new GeoAnalysisMapAdapter(0, $view_id, $map, $mapper, $mapview_config);
-
-            $mapadapter_data_service->insertGetId($map_adapter);
-        }
-
-        return $geoview_data_service->update($new_view->withColors($colors)) > 0;
-    }
-
-    /**
-     * Get all new map definitions IDs representing an old map definition
-     *
-     * @param string $map_xml
-     * @return string[]
-     */
-    private function mapIdsFromOld(string $map_xml): array
-    {
-        $mapping = self::MAPS_XML_MAPPING[$map_xml] ?? [];
-        return is_array($mapping) ? $mapping : [ $mapping ];
-    }
-
-    /**
-     * Get the mapping property to be used for the migrated map adapter
-     *
-     * @param string $map_id
-     * @return string
-     */
-    private function mappingPropertyForMap(string $map_id): string
-    {
-        switch ($map_id) {
-            case 'fr-metropole-regions-1970':
-            case 'fr-metropole-regions-2016':
-                return 'region_insee_libelle';
-            case 'fr-metropole-departements':
-                return 'dpt_insee_libelle';
-            case 'fr-dpt-48-codespostaux':
-                return 'code_postal';
-            default:
-                return 'commune_insee_libelle';
-        }
-    }
-
-    /**
-     * Get the color configuration to be used for the migrated map view
-     *
-     * @param string $map_id
-     * @return MapColorsConfig
-     */
-    private function colorsFromMap(string $map_id): MapColorsConfig
-    {
-        $default = Hex::fromString('#f5f5f5');
-        $stroke = Hex::fromString('#d5d5d5');
-        $hover = Hex::fromString('#ff6600');
-
-        switch ($map_id) {
-            case 'fr-metropole-departements':
-                return new MapColorsConfig($default, $stroke, Hex::fromString('#0493ab'), $hover);
-            case 'fr-dpt-48-codespostaux':
-                return new MapColorsConfig($default, $stroke, Hex::fromString('#44aa00'), $hover);
-            default:
-                return new MapColorsConfig($default, $stroke, Hex::fromString('#e2a61d'), $hover);
-        }
-    }
+	/**
+	 * Mapping from old map definitions to new ones
+	 * @var array<string,mixed> MAPS_XML_MAPPING
+	 */
+	private const MAPS_XML_MAPPING = [
+		'aubracmargeridebycommunes.xml' =>  'fr-area-aubrac-lot-margeride-planeze-communes',
+		'calvadosbycommunes.xml'        =>  'fr-dpt-14-communes',
+		'cantalbycommunes.xml'          =>  'fr-dpt-15-communes',
+		'cotesdarmorbycommunes.xml'     =>  'fr-dpt-22-communes',
+		'essonnebycommunes.xml'         =>  'fr-dpt-91-communes',
+		'eurebycommunes.xml'            =>  'fr-dpt-27-communes',
+		'eureetloirbycommunes.xml'      =>  'fr-dpt-28-communes',
+		'francebydepartements.xml'      =>  'fr-metropole-departements',
+		'francebyregions1970.xml'       =>  'fr-metropole-regions-1970',
+		'francebyregions2016.xml'       =>  'fr-metropole-regions-2016',
+		'hauteloirebycommunes.xml'      =>  'fr-dpt-43-communes',
+		'illeetvilainebycommunes.xml'   =>  'fr-dpt-35-communes',
+		'loiretbycommunes.xml'          =>  'fr-dpt-45-communes',
+		'lozerebycodepostaux.xml'       =>  'fr-dpt-48-codespostaux',
+		'lozerebycommunes.xml'          =>  'fr-dpt-48-communes',
+		'mayennebycommunes.xml'         =>  'fr-dpt-53-communes',
+		'oisebycommunes.xml'            =>  'fr-dpt-60-communes',
+		'ornebycommunes.xml'            =>  'fr-dpt-61-communes',
+		'puydedomebycommunes.xml'       =>  'fr-dpt-63-communes',
+		'sarthebycommunes.xml'          =>  'fr-dpt-72-communes',
+		'seinemaritimebycommunes.xml'   =>  'fr-dpt-76-communes',
+		'seinesommeoisebycommunes.xml'  =>  ['fr-dpt-60-communes', 'fr-dpt-76-communes', 'fr-dpt-80-communes'],
+		'valdoisebycommunes.xml'        =>  'fr-dpt-95-communes',
+		'yvelinesbycommunes.xml'        =>  'fr-dpt-78-communes'
+	];
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		if (!DB::schema()->hasTable('maj_geodispersion')) {
+			return;
+		}
+
+		/** @var TreeService $tree_service */
+		$tree_service = app(TreeService::class);
+		/** @var GeoAnalysisViewDataService $geoview_data_service */
+		$geoview_data_service = app(GeoAnalysisViewDataService::class);
+
+		$existing_views = DB::table('maj_geodispersion')
+			->select()
+			->get();
+
+		foreach ($existing_views as $old_view) {
+			try {
+				$tree = $tree_service->find((int) $old_view->majgd_file);
+			} catch (RuntimeException $ex) {
+				continue;
+			}
+
+			if ($old_view->majgd_map === null) {
+				$this->migrateGeoAnalysisTable($old_view, $tree, $geoview_data_service);
+			} else {
+				DB::connection()->beginTransaction();
+				if ($this->migrateGeoAnalysisMap($old_view, $tree, $geoview_data_service)) {
+					DB::connection()->commit();
+				} else {
+					DB::connection()->rollBack();
+				}
+			}
+		}
+
+		DB::schema()->drop('maj_geodispersion');
+
+		FlashMessages::addMessage(I18N::translate(
+			'The geographical dispersion analyses have been migrated for webtrees 2. Please review their settings.'
+		));
+	}
+
+	/**
+	 * Create a Table geographical analysis view from a migrated item.
+	 *
+	 * @param stdClass $old_view
+	 * @param Tree $tree
+	 * @param GeoAnalysisViewDataService $geoview_data_service
+	 * @return bool
+	 */
+	private function migrateGeoAnalysisTable(
+		stdClass $old_view,
+		Tree $tree,
+		GeoAnalysisViewDataService $geoview_data_service
+	): bool {
+		$new_view = new GeoAnalysisTable(
+			0,
+			$tree,
+			$old_view->majgd_status === 'enabled',
+			$old_view->majgd_descr,
+			app(SosaByGenerationGeoAnalysis::class),
+			(int) $old_view->majgd_sublevel,
+			(int) $old_view->majgd_detailsgen
+		);
+
+		return $geoview_data_service->insertGetId($new_view) > 0;
+	}
+
+	/**
+	 * Create a Map geographical analysis view from a migrated item.
+	 *
+	 * @param stdClass $old_view
+	 * @param Tree $tree
+	 * @param GeoAnalysisViewDataService $geoview_data_service
+	 * @return bool
+	 */
+	private function migrateGeoAnalysisMap(
+		stdClass $old_view,
+		Tree $tree,
+		GeoAnalysisViewDataService $geoview_data_service
+	): bool {
+		/** @var MapDefinitionsService $map_definition_service */
+		$map_definition_service = app(MapDefinitionsService::class);
+		/** @var MapAdapterDataService $mapadapter_data_service */
+		$mapadapter_data_service = app(MapAdapterDataService::class);
+
+		$new_view = new GeoAnalysisMap(
+			0,
+			$tree,
+			$old_view->majgd_status === 'enabled',
+			$old_view->majgd_descr,
+			app(SosaByGenerationGeoAnalysis::class),
+			(int) $old_view->majgd_sublevel,
+			(int) $old_view->majgd_detailsgen
+		);
+
+		$view_id = $geoview_data_service->insertGetId($new_view);
+		if ($view_id === 0) {
+			return false;
+		}
+		$new_view = $new_view->withId($view_id);
+
+		$colors = $new_view->colors();
+		foreach ($this->mapIdsFromOld($old_view->majgd_map) as $new_map_id) {
+			$map = $map_definition_service->find($new_map_id);
+			if ($map === null) {
+				return false;
+			}
+			$colors = $this->colorsFromMap($new_map_id);
+
+			/** @var SimplePlaceMapper $mapper */
+			$mapper = app(SimplePlaceMapper::class);
+			$mapview_config = new MapViewConfig($this->mappingPropertyForMap($new_map_id), $mapper->config());
+			$map_adapter = new GeoAnalysisMapAdapter(0, $view_id, $map, $mapper, $mapview_config);
+
+			$mapadapter_data_service->insertGetId($map_adapter);
+		}
+
+		return $geoview_data_service->update($new_view->withColors($colors)) > 0;
+	}
+
+	/**
+	 * Get all new map definitions IDs representing an old map definition
+	 *
+	 * @param string $map_xml
+	 * @return string[]
+	 */
+	private function mapIdsFromOld(string $map_xml): array
+	{
+		$mapping = self::MAPS_XML_MAPPING[$map_xml] ?? [];
+		return is_array($mapping) ? $mapping : [ $mapping ];
+	}
+
+	/**
+	 * Get the mapping property to be used for the migrated map adapter
+	 *
+	 * @param string $map_id
+	 * @return string
+	 */
+	private function mappingPropertyForMap(string $map_id): string
+	{
+		switch ($map_id) {
+			case 'fr-metropole-regions-1970':
+			case 'fr-metropole-regions-2016':
+				return 'region_insee_libelle';
+			case 'fr-metropole-departements':
+				return 'dpt_insee_libelle';
+			case 'fr-dpt-48-codespostaux':
+				return 'code_postal';
+			default:
+				return 'commune_insee_libelle';
+		}
+	}
+
+	/**
+	 * Get the color configuration to be used for the migrated map view
+	 *
+	 * @param string $map_id
+	 * @return MapColorsConfig
+	 */
+	private function colorsFromMap(string $map_id): MapColorsConfig
+	{
+		$default = Hex::fromString('#f5f5f5');
+		$stroke = Hex::fromString('#d5d5d5');
+		$hover = Hex::fromString('#ff6600');
+
+		switch ($map_id) {
+			case 'fr-metropole-departements':
+				return new MapColorsConfig($default, $stroke, Hex::fromString('#0493ab'), $hover);
+			case 'fr-dpt-48-codespostaux':
+				return new MapColorsConfig($default, $stroke, Hex::fromString('#44aa00'), $hover);
+			default:
+				return new MapColorsConfig($default, $stroke, Hex::fromString('#e2a61d'), $hover);
+		}
+	}
 }