jon48 / webtrees-lib

src/Webtrees/Module/Sosa/GeoAnalyses/SosaByGenerationGeoAnalysis.php

Indentation +97 added lines, -97 removed lines

@@ -31,101 +31,101 @@
  */
 class SosaByGenerationGeoAnalysis implements GeoAnalysisInterface
 {
-    private SosaRecordsService $records_service;
-
-    /**
-     * Constructor for SosaByGenerationGeoAnalysis
-     *
-     * @param SosaRecordsService $records_service
-     */
-    public function __construct(SosaRecordsService $records_service)
-    {
-        $this->records_service = $records_service;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Sosa ancestors places');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::itemsDescription()
-     */
-    public function itemsDescription(): callable
-    {
-        return fn(int $count): string => I18N::plural('ancestor', 'ancestors', $count);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::results()
-     */
-    public function results(Tree $tree, int $depth): GeoAnalysisResults
-    {
-        $results = new GeoAnalysisResults();
-
-        $unique_ancestors = $this->records_service
-            ->listAncestors($tree, Auth::user())
-            ->uniqueStrict(fn(stdClass $item): string => $item->majs_i_id);
-
-        foreach ($unique_ancestors as $item) {
-            $ancestor = Registry::individualFactory()->make($item->majs_i_id, $tree);
-            if ($ancestor === null || !$ancestor->canShow()) {
-                continue;
-            }
-            $generation = $this->records_service->generation((int) $item->majs_sosa);
-            $significantplace = new GeoAnalysisPlace($tree, null, $depth);
-            foreach ($this->significantPlaces($ancestor) as $place) {
-                $significantplace = new GeoAnalysisPlace($tree, $place, $depth, true);
-                if ($significantplace->isKnown()) {
-                    break;
-                }
-            }
-            $results->addPlace($significantplace);
-            $results->addPlaceInCategory(
-                I18N::translate('Generation %s', I18N::number($generation)),
-                $generation,
-                $significantplace
-            );
-        }
-
-        return $results;
-    }
-
-    /**
-     * Returns significant places in order of priority for an individual
-     *
-     * @param Individual $individual
-     * @return Generator<\Fisharebest\Webtrees\Place>
-     */
-    protected function significantPlaces(Individual $individual): Generator
-    {
-        yield $individual->getBirthPlace();
-
-        /** @var \Fisharebest\Webtrees\Fact $fact */
-        foreach ($individual->facts(['RESI']) as $fact) {
-            yield $fact->place();
-        }
-
-        yield $individual->getDeathPlace();
-
-        /** @var \Fisharebest\Webtrees\Family $family */
-        foreach ($individual->childFamilies() as $family) {
-            foreach ($family->facts(['RESI']) as $fact) {
-                yield $fact->place();
-            }
-        }
-
-        /** @var \Fisharebest\Webtrees\Family $family */
-        foreach ($individual->spouseFamilies() as $family) {
-            foreach ($family->facts(['RESI']) as $fact) {
-                yield $fact->place();
-            }
-        }
-    }
+	private SosaRecordsService $records_service;
+
+	/**
+	 * Constructor for SosaByGenerationGeoAnalysis
+	 *
+	 * @param SosaRecordsService $records_service
+	 */
+	public function __construct(SosaRecordsService $records_service)
+	{
+		$this->records_service = $records_service;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Sosa ancestors places');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::itemsDescription()
+	 */
+	public function itemsDescription(): callable
+	{
+		return fn(int $count): string => I18N::plural('ancestor', 'ancestors', $count);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\GeoAnalysisInterface::results()
+	 */
+	public function results(Tree $tree, int $depth): GeoAnalysisResults
+	{
+		$results = new GeoAnalysisResults();
+
+		$unique_ancestors = $this->records_service
+			->listAncestors($tree, Auth::user())
+			->uniqueStrict(fn(stdClass $item): string => $item->majs_i_id);
+
+		foreach ($unique_ancestors as $item) {
+			$ancestor = Registry::individualFactory()->make($item->majs_i_id, $tree);
+			if ($ancestor === null || !$ancestor->canShow()) {
+				continue;
+			}
+			$generation = $this->records_service->generation((int) $item->majs_sosa);
+			$significantplace = new GeoAnalysisPlace($tree, null, $depth);
+			foreach ($this->significantPlaces($ancestor) as $place) {
+				$significantplace = new GeoAnalysisPlace($tree, $place, $depth, true);
+				if ($significantplace->isKnown()) {
+					break;
+				}
+			}
+			$results->addPlace($significantplace);
+			$results->addPlaceInCategory(
+				I18N::translate('Generation %s', I18N::number($generation)),
+				$generation,
+				$significantplace
+			);
+		}
+
+		return $results;
+	}
+
+	/**
+	 * Returns significant places in order of priority for an individual
+	 *
+	 * @param Individual $individual
+	 * @return Generator<\Fisharebest\Webtrees\Place>
+	 */
+	protected function significantPlaces(Individual $individual): Generator
+	{
+		yield $individual->getBirthPlace();
+
+		/** @var \Fisharebest\Webtrees\Fact $fact */
+		foreach ($individual->facts(['RESI']) as $fact) {
+			yield $fact->place();
+		}
+
+		yield $individual->getDeathPlace();
+
+		/** @var \Fisharebest\Webtrees\Family $family */
+		foreach ($individual->childFamilies() as $family) {
+			foreach ($family->facts(['RESI']) as $fact) {
+				yield $fact->place();
+			}
+		}
+
+		/** @var \Fisharebest\Webtrees\Family $family */
+		foreach ($individual->spouseFamilies() as $family) {
+			foreach ($family->facts(['RESI']) as $fact) {
+				yield $fact->place();
+			}
+		}
+	}
 }

src/Webtrees/Module/Sosa/Services/SosaRecordsService.php

Indentation +266 added lines, -266 removed lines

@@ -30,284 +30,284 @@
  */
 class SosaRecordsService
 {
-    /**
-     * @var int|null $max_system_generations
-     */
-    private $max_system_generations;
+	/**
+	 * @var int|null $max_system_generations
+	 */
+	private $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;
-    }
+	/**
+	 * 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();
+	}
 
-    /**
-     * Returns all Sosa numbers associated to an Individual
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     * @param Individual $indi
-     * @return Collection
-     */
-    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
+	 */
+	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
-     */
-    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
+	 */
+	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
-     */
-    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
+	 */
+	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
-     */
-    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
+	 */
+	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
-     */
-    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
+	 */
+	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 $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 $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
+			);
+		}
+	}
 }

src/Webtrees/Module/Sosa/Services/SosaStatisticsService.php

Indentation +500 added lines, -500 removed lines

@@ -30,511 +30,511 @@
 class SosaStatisticsService
 {
 
-    /**
-     * Reference user
-     * @var UserInterface $user
-     */
-    private $user;
-
-    /**
-     * Reference tree
-     * @var Tree $tree
-     */
-    private $tree;
-
-    /**
-     * Constructor for Sosa Statistics Service
-     *
-     * @param Tree $tree
-     * @param UserInterface $user
-     */
-    public function __construct(Tree $tree, UserInterface $user)
-    {
-        $this->tree = $tree;
-        $this->user = $user;
-    }
-
-    /**
-     * Return the root individual for the reference tree and user.
-     *
-     * @return Individual|NULL
-     */
-    public function rootIndividual(): ?Individual
-    {
-        $root_indi_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
-        return Registry::individualFactory()->make($root_indi_id, $this->tree);
-    }
-
-    /**
-     * Get the highest generation for the reference tree and user.
-     *
-     * @return int
-     */
-    public function maxGeneration(): int
-    {
-        return (int) DB::table('maj_sosa')
-            ->where('majs_gedcom_id', '=', $this->tree->id())
-            ->where('majs_user_id', '=', $this->user->id())
-            ->max('majs_gen');
-    }
-
-    /**
-     * Get the total count of individuals in the tree.
-     *
-     * @return int
-     */
-    public function totalIndividuals(): int
-    {
-        return DB::table('individuals')
-            ->where('i_file', '=', $this->tree->id())
-            ->count();
-    }
-
-    /**
-     * Get the total count of Sosa ancestors for all generations
-     *
-     * @return int
-     */
-    public function totalAncestors(): int
-    {
-        return DB::table('maj_sosa')
-            ->where('majs_gedcom_id', '=', $this->tree->id())
-            ->where('majs_user_id', '=', $this->user->id())
-            ->count();
-    }
-
-    /**
-     * Get the total count of Sosa ancestors for a generation
-     *
-     * @return int
-     */
-    public function totalAncestorsAtGeneration(int $gen): int
-    {
-        return DB::table('maj_sosa')
-            ->where('majs_gedcom_id', '=', $this->tree->id())
-            ->where('majs_user_id', '=', $this->user->id())
-            ->where('majs_gen', '=', $gen)
-            ->count();
-    }
-
-    /**
-     * Get the total count of distinct Sosa ancestors for all generations
-     *
-     * @return int
-     */
-    public function totalDistinctAncestors(): int
-    {
-        return DB::table('maj_sosa')
-            ->where('majs_gedcom_id', '=', $this->tree->id())
-            ->where('majs_user_id', '=', $this->user->id())
-            ->distinct()
-            ->count('majs_i_id');
-    }
-
-    /**
-     * Get the mean generation time, as the slope of the linear regression of birth years vs generations
-     *
-     * @return float
-     */
-    public function meanGenerationTime(): float
-    {
-        $row = DB::table('maj_sosa')
-            ->where('majs_gedcom_id', '=', $this->tree->id())
-            ->where('majs_user_id', '=', $this->user->id())
-            ->whereNotNull('majs_birth_year')
-            ->selectRaw('COUNT(majs_sosa) AS n')
-            ->selectRaw('SUM(majs_gen * majs_birth_year) AS sum_xy')
-            ->selectRaw('SUM(majs_gen) AS sum_x')
-            ->selectRaw('SUM(majs_birth_year) AS sum_y')
-            ->selectRaw('SUM(majs_gen * majs_gen) AS sum_x2')
-            ->get()->first();
-
-        return $row->n == 0 ? 0 :
-            -($row->n * $row->sum_xy - $row->sum_x * $row->sum_y) / ($row->n * $row->sum_x2 - pow($row->sum_x, 2));
-    }
-
-    /**
-     * Get the statistic array detailed by generation.
-     * Statistics for each generation are:
-     *  - The number of Sosa in generation
-     *  - The number of Sosa up to generation
-     *  - The number of distinct Sosa up to generation
-     *  - The year of the first birth in generation
-     *  - The year of the first estimated birth in generation
-     *  - The year of the last birth in generation
-     *  - The year of the last estimated birth in generation
-     *  - The average year of birth in generation
-     *
-     * @return array<int, array<string, int|null>> Statistics array
-     */
-    public function statisticsByGenerations(): array
-    {
-        $stats_by_gen = $this->statisticsByGenerationBasicData();
-        $cumul_stats_by_gen = $this->statisticsByGenerationCumulativeData();
-
-        $statistics_by_gen = [];
-        foreach ($stats_by_gen as $gen => $stats_gen) {
-            $statistics_by_gen[(int) $stats_gen->gen] = array(
-                'sosaCount'             =>  (int) $stats_gen->total_sosa,
-                'sosaTotalCount'        =>  (int) $cumul_stats_by_gen[$gen]->total_cumul,
-                'diffSosaTotalCount'    =>  (int) $cumul_stats_by_gen[$gen]->total_distinct_cumul,
-                'firstBirth'            =>  $stats_gen->first_year,
-                'firstEstimatedBirth'   =>  $stats_gen->first_est_year,
-                'lastBirth'             =>  $stats_gen->last_year,
-                'lastEstimatedBirth'    =>  $stats_gen->last_est_year
-            );
-        }
-
-        return $statistics_by_gen;
-    }
-
-    /**
-     * Returns the basic statistics data by generation.
-     *
-     * @return Collection
-     */
-    private function statisticsByGenerationBasicData(): Collection
-    {
-        return DB::table('maj_sosa')
-            ->where('majs_gedcom_id', '=', $this->tree->id())
-            ->where('majs_user_id', '=', $this->user->id())
-            ->groupBy('majs_gen')
-            ->orderBy('majs_gen', 'asc')
-            ->select('majs_gen AS gen')
-            ->selectRaw('COUNT(majs_sosa) AS total_sosa')
-            ->selectRaw('MIN(majs_birth_year) AS first_year')
-            ->selectRaw('MIN(majs_birth_year_est) AS first_est_year')
-            ->selectRaw('MAX(majs_birth_year) AS last_year')
-            ->selectRaw('MAX(majs_birth_year_est) AS last_est_year')
-            ->get()->keyBy('gen');
-    }
-
-    /**
-     * Returns the cumulative statistics data by generation
-     *
-     * @return Collection
-     */
-    private function statisticsByGenerationCumulativeData(): Collection
-    {
-        $list_gen = DB::table('maj_sosa')->select('majs_gen')->distinct()
-            ->where('majs_gedcom_id', '=', $this->tree->id())
-            ->where('majs_user_id', '=', $this->user->id());
-
-        return DB::table('maj_sosa')
-            ->joinSub($list_gen, 'list_gen', function (JoinClause $join): void {
-                $join->on('maj_sosa.majs_gen', '<=', 'list_gen.majs_gen')
-                ->where('majs_gedcom_id', '=', $this->tree->id())
-                ->where('majs_user_id', '=', $this->user->id());
-            })
-            ->groupBy('list_gen.majs_gen')
-            ->select('list_gen.majs_gen AS gen')
-            ->selectRaw('COUNT(majs_i_id) AS total_cumul')
-            ->selectRaw('COUNT(DISTINCT majs_i_id) AS total_distinct_cumul')
-            ->selectRaw('1 - COUNT(DISTINCT majs_i_id) / COUNT(majs_i_id) AS pedi_collapse_simple')
-            ->get()->keyBy('gen');
-    }
-
-    /**
-     * Returns the pedigree collapse improved calculation by generation.
-     *
-     * Format:
-     *  - key : generation
-     *  - values:
-     *      - pedi_collapse_roots : pedigree collapse of ancestor roots for the generation
-     *      - pedi_collapse_xgen : pedigree cross-generation shrinkage for the generation
-     *
-     * @return array<int, array<string, float>>
-     */
-    public function pedigreeCollapseByGenerationData(): array
-    {
-        $table_prefix = DB::connection()->getTablePrefix();
-
-        $list_gen = DB::table('maj_sosa')->select('majs_gen')->distinct()
-            ->where('majs_gedcom_id', '=', $this->tree->id())
-            ->where('majs_user_id', '=', $this->user->id());
-
-        /* Compute the contributions of nodes of previous generations to the current generation */
-        $root_ancestors_contributions = DB::table('maj_sosa AS sosa')
-            ->select(['list_gen.majs_gen AS gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id'])
-            ->addSelect(['sosa.majs_i_id', 'sosa.majs_gen'])
-            ->selectRaw(
-                '(CASE ' .
-                    ' WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL' .
-                    ' THEN POWER(2, ' . $table_prefix . 'list_gen.majs_gen - ' . $table_prefix . 'sosa.majs_gen - 1)' .
-                    ' ELSE 0 ' .
-                ' END)' .
-                ' + (CASE ' .
-                    ' WHEN ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL' .
-                    ' THEN POWER(2, ' . $table_prefix . 'list_gen.majs_gen - ' . $table_prefix . 'sosa.majs_gen - 1)' .
-                    ' ELSE 0 ' .
-                ' END) contrib'
-            )
-            ->joinSub($list_gen, 'list_gen', function (JoinClause $join): void {
-                $join->on('sosa.majs_gen', '<', 'list_gen.majs_gen')
-                    ->where('majs_gedcom_id', '=', $this->tree->id())
-                    ->where('majs_user_id', '=', $this->user->id());
-            })
-            ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($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', '=', $this->tree->id())
-                    ->where('sosa_fat.majs_user_id', '=', $this->user->id());
-            })
-            ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($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', '=', $this->tree->id())
-                    ->where('sosa_mot.majs_user_id', '=', $this->user->id());
-            })
-            ->where('sosa.majs_gedcom_id', '=', $this->tree->id())
-            ->where('sosa.majs_user_id', '=', $this->user->id())
-            ->where(function (Builder $query): void {
-                $query->whereNull('sosa_fat.majs_i_id')
-                ->orWhereNull('sosa_mot.majs_i_id');
-            });
-
-        /* Identify nodes in the generations with ancestors who are also in the same generation.
+	/**
+	 * Reference user
+	 * @var UserInterface $user
+	 */
+	private $user;
+
+	/**
+	 * Reference tree
+	 * @var Tree $tree
+	 */
+	private $tree;
+
+	/**
+	 * Constructor for Sosa Statistics Service
+	 *
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 */
+	public function __construct(Tree $tree, UserInterface $user)
+	{
+		$this->tree = $tree;
+		$this->user = $user;
+	}
+
+	/**
+	 * Return the root individual for the reference tree and user.
+	 *
+	 * @return Individual|NULL
+	 */
+	public function rootIndividual(): ?Individual
+	{
+		$root_indi_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
+		return Registry::individualFactory()->make($root_indi_id, $this->tree);
+	}
+
+	/**
+	 * Get the highest generation for the reference tree and user.
+	 *
+	 * @return int
+	 */
+	public function maxGeneration(): int
+	{
+		return (int) DB::table('maj_sosa')
+			->where('majs_gedcom_id', '=', $this->tree->id())
+			->where('majs_user_id', '=', $this->user->id())
+			->max('majs_gen');
+	}
+
+	/**
+	 * Get the total count of individuals in the tree.
+	 *
+	 * @return int
+	 */
+	public function totalIndividuals(): int
+	{
+		return DB::table('individuals')
+			->where('i_file', '=', $this->tree->id())
+			->count();
+	}
+
+	/**
+	 * Get the total count of Sosa ancestors for all generations
+	 *
+	 * @return int
+	 */
+	public function totalAncestors(): int
+	{
+		return DB::table('maj_sosa')
+			->where('majs_gedcom_id', '=', $this->tree->id())
+			->where('majs_user_id', '=', $this->user->id())
+			->count();
+	}
+
+	/**
+	 * Get the total count of Sosa ancestors for a generation
+	 *
+	 * @return int
+	 */
+	public function totalAncestorsAtGeneration(int $gen): int
+	{
+		return DB::table('maj_sosa')
+			->where('majs_gedcom_id', '=', $this->tree->id())
+			->where('majs_user_id', '=', $this->user->id())
+			->where('majs_gen', '=', $gen)
+			->count();
+	}
+
+	/**
+	 * Get the total count of distinct Sosa ancestors for all generations
+	 *
+	 * @return int
+	 */
+	public function totalDistinctAncestors(): int
+	{
+		return DB::table('maj_sosa')
+			->where('majs_gedcom_id', '=', $this->tree->id())
+			->where('majs_user_id', '=', $this->user->id())
+			->distinct()
+			->count('majs_i_id');
+	}
+
+	/**
+	 * Get the mean generation time, as the slope of the linear regression of birth years vs generations
+	 *
+	 * @return float
+	 */
+	public function meanGenerationTime(): float
+	{
+		$row = DB::table('maj_sosa')
+			->where('majs_gedcom_id', '=', $this->tree->id())
+			->where('majs_user_id', '=', $this->user->id())
+			->whereNotNull('majs_birth_year')
+			->selectRaw('COUNT(majs_sosa) AS n')
+			->selectRaw('SUM(majs_gen * majs_birth_year) AS sum_xy')
+			->selectRaw('SUM(majs_gen) AS sum_x')
+			->selectRaw('SUM(majs_birth_year) AS sum_y')
+			->selectRaw('SUM(majs_gen * majs_gen) AS sum_x2')
+			->get()->first();
+
+		return $row->n == 0 ? 0 :
+			-($row->n * $row->sum_xy - $row->sum_x * $row->sum_y) / ($row->n * $row->sum_x2 - pow($row->sum_x, 2));
+	}
+
+	/**
+	 * Get the statistic array detailed by generation.
+	 * Statistics for each generation are:
+	 *  - The number of Sosa in generation
+	 *  - The number of Sosa up to generation
+	 *  - The number of distinct Sosa up to generation
+	 *  - The year of the first birth in generation
+	 *  - The year of the first estimated birth in generation
+	 *  - The year of the last birth in generation
+	 *  - The year of the last estimated birth in generation
+	 *  - The average year of birth in generation
+	 *
+	 * @return array<int, array<string, int|null>> Statistics array
+	 */
+	public function statisticsByGenerations(): array
+	{
+		$stats_by_gen = $this->statisticsByGenerationBasicData();
+		$cumul_stats_by_gen = $this->statisticsByGenerationCumulativeData();
+
+		$statistics_by_gen = [];
+		foreach ($stats_by_gen as $gen => $stats_gen) {
+			$statistics_by_gen[(int) $stats_gen->gen] = array(
+				'sosaCount'             =>  (int) $stats_gen->total_sosa,
+				'sosaTotalCount'        =>  (int) $cumul_stats_by_gen[$gen]->total_cumul,
+				'diffSosaTotalCount'    =>  (int) $cumul_stats_by_gen[$gen]->total_distinct_cumul,
+				'firstBirth'            =>  $stats_gen->first_year,
+				'firstEstimatedBirth'   =>  $stats_gen->first_est_year,
+				'lastBirth'             =>  $stats_gen->last_year,
+				'lastEstimatedBirth'    =>  $stats_gen->last_est_year
+			);
+		}
+
+		return $statistics_by_gen;
+	}
+
+	/**
+	 * Returns the basic statistics data by generation.
+	 *
+	 * @return Collection
+	 */
+	private function statisticsByGenerationBasicData(): Collection
+	{
+		return DB::table('maj_sosa')
+			->where('majs_gedcom_id', '=', $this->tree->id())
+			->where('majs_user_id', '=', $this->user->id())
+			->groupBy('majs_gen')
+			->orderBy('majs_gen', 'asc')
+			->select('majs_gen AS gen')
+			->selectRaw('COUNT(majs_sosa) AS total_sosa')
+			->selectRaw('MIN(majs_birth_year) AS first_year')
+			->selectRaw('MIN(majs_birth_year_est) AS first_est_year')
+			->selectRaw('MAX(majs_birth_year) AS last_year')
+			->selectRaw('MAX(majs_birth_year_est) AS last_est_year')
+			->get()->keyBy('gen');
+	}
+
+	/**
+	 * Returns the cumulative statistics data by generation
+	 *
+	 * @return Collection
+	 */
+	private function statisticsByGenerationCumulativeData(): Collection
+	{
+		$list_gen = DB::table('maj_sosa')->select('majs_gen')->distinct()
+			->where('majs_gedcom_id', '=', $this->tree->id())
+			->where('majs_user_id', '=', $this->user->id());
+
+		return DB::table('maj_sosa')
+			->joinSub($list_gen, 'list_gen', function (JoinClause $join): void {
+				$join->on('maj_sosa.majs_gen', '<=', 'list_gen.majs_gen')
+				->where('majs_gedcom_id', '=', $this->tree->id())
+				->where('majs_user_id', '=', $this->user->id());
+			})
+			->groupBy('list_gen.majs_gen')
+			->select('list_gen.majs_gen AS gen')
+			->selectRaw('COUNT(majs_i_id) AS total_cumul')
+			->selectRaw('COUNT(DISTINCT majs_i_id) AS total_distinct_cumul')
+			->selectRaw('1 - COUNT(DISTINCT majs_i_id) / COUNT(majs_i_id) AS pedi_collapse_simple')
+			->get()->keyBy('gen');
+	}
+
+	/**
+	 * Returns the pedigree collapse improved calculation by generation.
+	 *
+	 * Format:
+	 *  - key : generation
+	 *  - values:
+	 *      - pedi_collapse_roots : pedigree collapse of ancestor roots for the generation
+	 *      - pedi_collapse_xgen : pedigree cross-generation shrinkage for the generation
+	 *
+	 * @return array<int, array<string, float>>
+	 */
+	public function pedigreeCollapseByGenerationData(): array
+	{
+		$table_prefix = DB::connection()->getTablePrefix();
+
+		$list_gen = DB::table('maj_sosa')->select('majs_gen')->distinct()
+			->where('majs_gedcom_id', '=', $this->tree->id())
+			->where('majs_user_id', '=', $this->user->id());
+
+		/* Compute the contributions of nodes of previous generations to the current generation */
+		$root_ancestors_contributions = DB::table('maj_sosa AS sosa')
+			->select(['list_gen.majs_gen AS gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id'])
+			->addSelect(['sosa.majs_i_id', 'sosa.majs_gen'])
+			->selectRaw(
+				'(CASE ' .
+					' WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL' .
+					' THEN POWER(2, ' . $table_prefix . 'list_gen.majs_gen - ' . $table_prefix . 'sosa.majs_gen - 1)' .
+					' ELSE 0 ' .
+				' END)' .
+				' + (CASE ' .
+					' WHEN ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL' .
+					' THEN POWER(2, ' . $table_prefix . 'list_gen.majs_gen - ' . $table_prefix . 'sosa.majs_gen - 1)' .
+					' ELSE 0 ' .
+				' END) contrib'
+			)
+			->joinSub($list_gen, 'list_gen', function (JoinClause $join): void {
+				$join->on('sosa.majs_gen', '<', 'list_gen.majs_gen')
+					->where('majs_gedcom_id', '=', $this->tree->id())
+					->where('majs_user_id', '=', $this->user->id());
+			})
+			->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($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', '=', $this->tree->id())
+					->where('sosa_fat.majs_user_id', '=', $this->user->id());
+			})
+			->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($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', '=', $this->tree->id())
+					->where('sosa_mot.majs_user_id', '=', $this->user->id());
+			})
+			->where('sosa.majs_gedcom_id', '=', $this->tree->id())
+			->where('sosa.majs_user_id', '=', $this->user->id())
+			->where(function (Builder $query): void {
+				$query->whereNull('sosa_fat.majs_i_id')
+				->orWhereNull('sosa_mot.majs_i_id');
+			});
+
+		/* Identify nodes in the generations with ancestors who are also in the same generation.
          * This is the vertical/generational collapse that will reduce the number or roots.
          */
-        $non_roots_ancestors = DB::table('maj_sosa AS sosa')
-            ->select(['sosa.majs_gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id', 'sosa.majs_sosa'])
-            ->selectRaw('MAX(' . $table_prefix . 'sosa_anc.majs_sosa) - MIN(' . $table_prefix . 'sosa_anc.majs_sosa)' .
-                ' AS full_ancestors')
-            ->join('maj_sosa AS sosa_anc', function (JoinClause $join) use ($table_prefix): void {
-                $join->on('sosa.majs_gen', '<', 'sosa_anc.majs_gen')
-                    ->whereRaw('FLOOR(' . $table_prefix . 'sosa_anc.majs_sosa / POWER(2, ' .
-                        $table_prefix . 'sosa_anc.majs_gen - ' . $table_prefix . 'sosa.majs_gen)) = ' .
-                        $table_prefix . 'sosa.majs_sosa')
-                    ->where('sosa_anc.majs_gedcom_id', '=', $this->tree->id())
-                    ->where('sosa_anc.majs_user_id', '=', $this->user->id());
-            })
-            ->where('sosa.majs_gedcom_id', '=', $this->tree->id())
-            ->where('sosa.majs_user_id', '=', $this->user->id())
-            ->whereIn('sosa_anc.majs_i_id', function (Builder $query) use ($table_prefix): void {
-                $query->from('maj_sosa AS sosa_gen')
-                ->select('sosa_gen.majs_i_id')->distinct()
-                ->where('sosa_gen.majs_gedcom_id', '=', $this->tree->id())
-                ->where('sosa_gen.majs_user_id', '=', $this->user->id())
-                ->whereRaw($table_prefix . 'sosa_gen.majs_gen = ' . $table_prefix . 'sosa.majs_gen');
-            })
-            ->groupBy(['sosa.majs_gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id',
-                'sosa.majs_sosa', 'sosa.majs_i_id']);
-
-        /* Compute the contribution of the nodes in the generation,
+		$non_roots_ancestors = DB::table('maj_sosa AS sosa')
+			->select(['sosa.majs_gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id', 'sosa.majs_sosa'])
+			->selectRaw('MAX(' . $table_prefix . 'sosa_anc.majs_sosa) - MIN(' . $table_prefix . 'sosa_anc.majs_sosa)' .
+				' AS full_ancestors')
+			->join('maj_sosa AS sosa_anc', function (JoinClause $join) use ($table_prefix): void {
+				$join->on('sosa.majs_gen', '<', 'sosa_anc.majs_gen')
+					->whereRaw('FLOOR(' . $table_prefix . 'sosa_anc.majs_sosa / POWER(2, ' .
+						$table_prefix . 'sosa_anc.majs_gen - ' . $table_prefix . 'sosa.majs_gen)) = ' .
+						$table_prefix . 'sosa.majs_sosa')
+					->where('sosa_anc.majs_gedcom_id', '=', $this->tree->id())
+					->where('sosa_anc.majs_user_id', '=', $this->user->id());
+			})
+			->where('sosa.majs_gedcom_id', '=', $this->tree->id())
+			->where('sosa.majs_user_id', '=', $this->user->id())
+			->whereIn('sosa_anc.majs_i_id', function (Builder $query) use ($table_prefix): void {
+				$query->from('maj_sosa AS sosa_gen')
+				->select('sosa_gen.majs_i_id')->distinct()
+				->where('sosa_gen.majs_gedcom_id', '=', $this->tree->id())
+				->where('sosa_gen.majs_user_id', '=', $this->user->id())
+				->whereRaw($table_prefix . 'sosa_gen.majs_gen = ' . $table_prefix . 'sosa.majs_gen');
+			})
+			->groupBy(['sosa.majs_gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id',
+				'sosa.majs_sosa', 'sosa.majs_i_id']);
+
+		/* Compute the contribution of the nodes in the generation,
          * excluding the nodes with ancestors in the same generation.
          * Nodes with a parent missing are not excluded to cater for the missing one.
          */
-        $known_ancestors_contributions = DB::table('maj_sosa AS sosa')
-            ->select(['sosa.majs_gen AS gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id'])
-            ->addSelect(['sosa.majs_i_id', 'sosa.majs_gen'])
-            ->selectRaw('1 AS contrib')
-            ->leftJoinSub($non_roots_ancestors, 'nonroot', function (JoinClause $join): void {
-                $join->on('sosa.majs_gen', '=', 'nonroot.majs_gen')
-                    ->on('sosa.majs_sosa', '=', 'nonroot.majs_sosa')
-                    ->where('nonroot.full_ancestors', '>', 0)
-                    ->where('nonroot.majs_gedcom_id', '=', $this->tree->id())
-                    ->where('nonroot.majs_user_id', '=', $this->user->id());
-            })
-            ->where('sosa.majs_gedcom_id', '=', $this->tree->id())
-            ->where('sosa.majs_user_id', '=', $this->user->id())
-            ->whereNull('nonroot.majs_sosa');
-
-        /* Aggregate both queries, and calculate the sum of contributions by generation roots.
+		$known_ancestors_contributions = DB::table('maj_sosa AS sosa')
+			->select(['sosa.majs_gen AS gen', 'sosa.majs_gedcom_id', 'sosa.majs_user_id'])
+			->addSelect(['sosa.majs_i_id', 'sosa.majs_gen'])
+			->selectRaw('1 AS contrib')
+			->leftJoinSub($non_roots_ancestors, 'nonroot', function (JoinClause $join): void {
+				$join->on('sosa.majs_gen', '=', 'nonroot.majs_gen')
+					->on('sosa.majs_sosa', '=', 'nonroot.majs_sosa')
+					->where('nonroot.full_ancestors', '>', 0)
+					->where('nonroot.majs_gedcom_id', '=', $this->tree->id())
+					->where('nonroot.majs_user_id', '=', $this->user->id());
+			})
+			->where('sosa.majs_gedcom_id', '=', $this->tree->id())
+			->where('sosa.majs_user_id', '=', $this->user->id())
+			->whereNull('nonroot.majs_sosa');
+
+		/* Aggregate both queries, and calculate the sum of contributions by generation roots.
          * Exclude as well nodes that already appear in lower generations, as their branche has already been reduced.
          */
-        $ancestors_contributions_sum = DB::connection()->query()
-            ->fromSub($root_ancestors_contributions->unionAll($known_ancestors_contributions), 'sosa_contribs')
-            ->select(['sosa_contribs.gen', 'sosa_contribs.majs_gedcom_id', 'sosa_contribs.majs_user_id'])
-            ->addSelect(['sosa_contribs.majs_i_id', 'sosa_contribs.contrib'])
-            ->selectRaw('COUNT(' . $table_prefix . 'sosa_contribs.majs_i_id) * ' .
-                $table_prefix . 'sosa_contribs.contrib AS totalContrib')
-            ->leftJoin('maj_sosa AS sosa_low', function (JoinClause $join): void {
-                $join->on('sosa_low.majs_gen', '<', 'sosa_contribs.majs_gen')
-                    ->on('sosa_low.majs_i_id', '=', 'sosa_contribs.majs_i_id')
-                    ->where('sosa_low.majs_gedcom_id', '=', $this->tree->id())
-                    ->where('sosa_low.majs_user_id', '=', $this->user->id());
-            })
-            ->whereNull('sosa_low.majs_sosa')
-            ->groupBy(['sosa_contribs.gen', 'sosa_contribs.majs_gedcom_id', 'sosa_contribs.majs_user_id',
-                'sosa_contribs.majs_i_id', 'sosa_contribs.contrib']);
-
-        // Aggregate all generation roots to compute root and generation pedigree collapse
-        $pedi_collapse_coll = DB::connection()->query()->fromSub($ancestors_contributions_sum, 'sosa_contribs_sum')
-            ->select(['gen'])->selectRaw('SUM(contrib), SUM(totalContrib)')
-            ->selectRaw('1 - SUM(contrib) / SUM(totalContrib) AS pedi_collapse_roots')  // Roots/horizontal collapse
-            ->selectRaw('1 - SUM(totalContrib) / POWER ( 2, gen - 1) AS pedi_collapse_xgen') // Crossgeneration collapse
-            ->groupBy(['gen', 'majs_gedcom_id', 'majs_user_id'])
-            ->orderBy('gen')
-            ->get();
-
-        $pedi_collapse_by_gen = [];
-        foreach ($pedi_collapse_coll as $collapse_gen) {
-            $pedi_collapse_by_gen[(int) $collapse_gen->gen] = array(
-                'pedi_collapse_roots'   =>  (float) $collapse_gen->pedi_collapse_roots,
-                'pedi_collapse_xgen'   =>  (float) $collapse_gen->pedi_collapse_xgen
-            );
-        }
-        return $pedi_collapse_by_gen;
-    }
-
-    /**
-     * Return a Collection of the mean generation depth and deviation for all Sosa ancestors at a given generation.
-     * Sosa 1 is of generation 1.
-     *
-     * Mean generation depth and deviation are calculated based on the works of Marie-Héléne Cazes and Pierre Cazes,
-     * published in Population (French Edition), Vol. 51, No. 1 (Jan. - Feb., 1996), pp. 117-140
-     * http://kintip.net/index.php?option=com_jdownloads&task=download.send&id=9&catid=4&m=0
-     *
-     * Format:
-     *  - key : sosa number of the ancestor
-     *  - values:
-     *      - root_ancestor_id : ID of the ancestor
-     *      - mean_gen_depth : Mean generation depth
-     *      - stddev_gen_depth : Standard deviation of generation depth
-     *
-     * @param int $gen Sosa generation
-     * @return Collection
-     */
-    public function generationDepthStatsAtGeneration(int $gen): Collection
-    {
-        $table_prefix = DB::connection()->getTablePrefix();
-        $missing_ancestors_by_gen = DB::table('maj_sosa AS sosa')
-            ->selectRaw($table_prefix . 'sosa.majs_gen - ? AS majs_gen_norm', [$gen])
-            ->selectRaw('FLOOR(((' . $table_prefix . 'sosa.majs_sosa / POW(2, ' . $table_prefix . 'sosa.majs_gen -1 )) - 1) * POWER(2, ? - 1)) + POWER(2, ? - 1) AS root_ancestor', [$gen, $gen])   //@phpcs:ignore Generic.Files.LineLength.TooLong
-            ->selectRaw('SUM(CASE WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL AND ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL THEN 1 ELSE 0 END) AS full_root_count')  //@phpcs:ignore Generic.Files.LineLength.TooLong
-            ->selectRaw('SUM(CASE WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL AND ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL THEN 0 ELSE 1 END) As semi_root_count')  //@phpcs:ignore Generic.Files.LineLength.TooLong
-            ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($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', '=', $this->tree->id())
-                ->where('sosa_fat.majs_user_id', '=', $this->user->id());
-            })
-            ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($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', '=', $this->tree->id())
-                ->where('sosa_mot.majs_user_id', '=', $this->user->id());
-            })
-            ->where('sosa.majs_gedcom_id', '=', $this->tree->id())
-            ->where('sosa.majs_user_id', '=', $this->user->id())
-            ->where('sosa.majs_gen', '>=', $gen)
-            ->where(function (Builder $query): void {
-                $query->whereNull('sosa_fat.majs_i_id')
-                    ->orWhereNull('sosa_mot.majs_i_id');
-            })
-            ->groupBy(['sosa.majs_gen', 'root_ancestor']);
-
-        return DB::table('maj_sosa AS sosa_list')
-            ->select(['stats_by_gen.root_ancestor AS root_ancestor_sosa', 'sosa_list.majs_i_id as root_ancestor_id'])
-            ->selectRaw('1 + SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm))) AS mean_gen_depth')  //@phpcs:ignore Generic.Files.LineLength.TooLong
-            ->selectRaw(' SQRT(' .
-                '   SUM(POWER(majs_gen_norm, 2) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm)))' .     //@phpcs:ignore Generic.Files.LineLength.TooLong
-                '   - POWER( SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm))), 2)' .       //@phpcs:ignore Generic.Files.LineLength.TooLong
-                ' ) AS stddev_gen_depth')
-            ->joinSub($missing_ancestors_by_gen, 'stats_by_gen', function (JoinClause $join): void {
-                $join->on('sosa_list.majs_sosa', '=', 'stats_by_gen.root_ancestor')
-                    ->where('sosa_list.majs_gedcom_id', '=', $this->tree->id())
-                    ->where('sosa_list.majs_user_id', '=', $this->user->id());
-            })
-            ->groupBy(['stats_by_gen.root_ancestor', 'sosa_list.majs_i_id'])
-            ->orderBy('stats_by_gen.root_ancestor')
-            ->get()->keyBy('root_ancestor_sosa');
-    }
-
-    /**
-     * Return a collection of the most duplicated root Sosa ancestors.
-     * The number of ancestors to return is limited by the parameter $limit.
-     * If several individuals are tied when reaching the limit, none of them are returned,
-     * which means that there can be less individuals returned than requested.
-     *
-     * Format:
-     *  - value:
-     *      - sosa_i_id : sosa individual
-     *      - sosa_count: number of duplications of the ancestor (e.g. 3 if it appears 3 times)
-     *
-     * @param int $limit
-     * @return Collection
-     */
-    public function topMultipleAncestorsWithNoTies(int $limit): Collection
-    {
-        $table_prefix = DB::connection()->getTablePrefix();
-        $multiple_ancestors = DB::table('maj_sosa AS sosa')
-            ->select('sosa.majs_i_id AS sosa_i_id')
-            ->selectRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) AS sosa_count')
-            ->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($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', '=', $this->tree->id())
-                    ->where('sosa_fat.majs_user_id', '=', $this->user->id());
-            })
-            ->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($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', '=', $this->tree->id())
-                ->where('sosa_mot.majs_user_id', '=', $this->user->id());
-            })
-            ->where('sosa.majs_gedcom_id', '=', $this->tree->id())
-            ->where('sosa.majs_user_id', '=', $this->user->id())
-            ->whereNull('sosa_fat.majs_sosa')   // We keep only root individuals, i.e. those with no father or mother
-            ->whereNull('sosa_mot.majs_sosa')
-            ->groupBy('sosa.majs_i_id')
-            ->havingRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) > 1')    // Limit to the duplicate sosas.
-            ->orderByRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) DESC, MIN(' . $table_prefix . 'sosa.majs_sosa) ASC')   //@phpcs:ignore Generic.Files.LineLength.TooLong
-            ->limit($limit + 1)     // We want to select one more than required, for ties
-            ->get();
-
-        if ($multiple_ancestors->count() > $limit) {
-            $last_count = $multiple_ancestors->last()->sosa_count;
-            $multiple_ancestors = $multiple_ancestors->reject(function (stdClass $element) use ($last_count): bool {
-                return $element->sosa_count ==  $last_count;
-            });
-        }
-        return $multiple_ancestors;
-    }
-
-    /**
-     * Return a computed array of statistics about the dispersion of ancestors across the ancestors
-     * at a specified generation.
-     *
-     * Format:
-     *  - key : rank of the ancestor in generation G for which exclusive ancestors have been found
-     *          For instance 3 represent the maternal grand father
-     *          0 is used for shared ancestors
-     *  - values: number of ancestors exclusively in the ancestors of the ancestor in key
-     *
-     *  For instance a result at generation 3 could be :
-     *      array (   0     =>  12      -> 12 ancestors are shared by the grand-parents
-     *                1     =>  32      -> 32 ancestors are exclusive to the paternal grand-father
-     *                2     =>  25      -> 25 ancestors are exclusive to the paternal grand-mother
-     *                3     =>  12      -> 12 ancestors are exclusive to the maternal grand-father
-     *                4     =>  30      -> 30 ancestors are exclusive to the maternal grand-mother
-     *            )
-     *
-     * @param int $gen
-     * @return Collection
-     */
-    public function ancestorsDispersionForGeneration(int $gen): Collection
-    {
-        $ancestors_branches = DB::table('maj_sosa')
-            ->select('majs_i_id AS i_id')
-            ->selectRaw('FLOOR(majs_sosa / POW(2, (majs_gen - ?))) - POW(2, ? -1) + 1 AS branch', [$gen, $gen])
-            ->where('majs_gedcom_id', '=', $this->tree->id())
-            ->where('majs_user_id', '=', $this->user->id())
-            ->where('majs_gen', '>=', $gen)
-            ->groupBy('majs_i_id', 'branch');
-
-
-        $consolidated_ancestors_branches = DB::table('maj_sosa')
-            ->fromSub($ancestors_branches, 'indi_branch')
-            ->select('i_id')
-            ->selectRaw('CASE WHEN COUNT(branch) > 1 THEN 0 ELSE MIN(branch) END AS branches')
-            ->groupBy('i_id');
-
-        return DB::table('maj_sosa')
-            ->fromSub($consolidated_ancestors_branches, 'indi_branch_consolidated')
-            ->select('branches')
-            ->selectRaw('COUNT(i_id) AS count_indi')
-            ->groupBy('branches')
-            ->get()->pluck('count_indi', 'branches');
-    }
+		$ancestors_contributions_sum = DB::connection()->query()
+			->fromSub($root_ancestors_contributions->unionAll($known_ancestors_contributions), 'sosa_contribs')
+			->select(['sosa_contribs.gen', 'sosa_contribs.majs_gedcom_id', 'sosa_contribs.majs_user_id'])
+			->addSelect(['sosa_contribs.majs_i_id', 'sosa_contribs.contrib'])
+			->selectRaw('COUNT(' . $table_prefix . 'sosa_contribs.majs_i_id) * ' .
+				$table_prefix . 'sosa_contribs.contrib AS totalContrib')
+			->leftJoin('maj_sosa AS sosa_low', function (JoinClause $join): void {
+				$join->on('sosa_low.majs_gen', '<', 'sosa_contribs.majs_gen')
+					->on('sosa_low.majs_i_id', '=', 'sosa_contribs.majs_i_id')
+					->where('sosa_low.majs_gedcom_id', '=', $this->tree->id())
+					->where('sosa_low.majs_user_id', '=', $this->user->id());
+			})
+			->whereNull('sosa_low.majs_sosa')
+			->groupBy(['sosa_contribs.gen', 'sosa_contribs.majs_gedcom_id', 'sosa_contribs.majs_user_id',
+				'sosa_contribs.majs_i_id', 'sosa_contribs.contrib']);
+
+		// Aggregate all generation roots to compute root and generation pedigree collapse
+		$pedi_collapse_coll = DB::connection()->query()->fromSub($ancestors_contributions_sum, 'sosa_contribs_sum')
+			->select(['gen'])->selectRaw('SUM(contrib), SUM(totalContrib)')
+			->selectRaw('1 - SUM(contrib) / SUM(totalContrib) AS pedi_collapse_roots')  // Roots/horizontal collapse
+			->selectRaw('1 - SUM(totalContrib) / POWER ( 2, gen - 1) AS pedi_collapse_xgen') // Crossgeneration collapse
+			->groupBy(['gen', 'majs_gedcom_id', 'majs_user_id'])
+			->orderBy('gen')
+			->get();
+
+		$pedi_collapse_by_gen = [];
+		foreach ($pedi_collapse_coll as $collapse_gen) {
+			$pedi_collapse_by_gen[(int) $collapse_gen->gen] = array(
+				'pedi_collapse_roots'   =>  (float) $collapse_gen->pedi_collapse_roots,
+				'pedi_collapse_xgen'   =>  (float) $collapse_gen->pedi_collapse_xgen
+			);
+		}
+		return $pedi_collapse_by_gen;
+	}
+
+	/**
+	 * Return a Collection of the mean generation depth and deviation for all Sosa ancestors at a given generation.
+	 * Sosa 1 is of generation 1.
+	 *
+	 * Mean generation depth and deviation are calculated based on the works of Marie-Héléne Cazes and Pierre Cazes,
+	 * published in Population (French Edition), Vol. 51, No. 1 (Jan. - Feb., 1996), pp. 117-140
+	 * http://kintip.net/index.php?option=com_jdownloads&task=download.send&id=9&catid=4&m=0
+	 *
+	 * Format:
+	 *  - key : sosa number of the ancestor
+	 *  - values:
+	 *      - root_ancestor_id : ID of the ancestor
+	 *      - mean_gen_depth : Mean generation depth
+	 *      - stddev_gen_depth : Standard deviation of generation depth
+	 *
+	 * @param int $gen Sosa generation
+	 * @return Collection
+	 */
+	public function generationDepthStatsAtGeneration(int $gen): Collection
+	{
+		$table_prefix = DB::connection()->getTablePrefix();
+		$missing_ancestors_by_gen = DB::table('maj_sosa AS sosa')
+			->selectRaw($table_prefix . 'sosa.majs_gen - ? AS majs_gen_norm', [$gen])
+			->selectRaw('FLOOR(((' . $table_prefix . 'sosa.majs_sosa / POW(2, ' . $table_prefix . 'sosa.majs_gen -1 )) - 1) * POWER(2, ? - 1)) + POWER(2, ? - 1) AS root_ancestor', [$gen, $gen])   //@phpcs:ignore Generic.Files.LineLength.TooLong
+			->selectRaw('SUM(CASE WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL AND ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL THEN 1 ELSE 0 END) AS full_root_count')  //@phpcs:ignore Generic.Files.LineLength.TooLong
+			->selectRaw('SUM(CASE WHEN ' . $table_prefix . 'sosa_fat.majs_i_id IS NULL AND ' . $table_prefix . 'sosa_mot.majs_i_id IS NULL THEN 0 ELSE 1 END) As semi_root_count')  //@phpcs:ignore Generic.Files.LineLength.TooLong
+			->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($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', '=', $this->tree->id())
+				->where('sosa_fat.majs_user_id', '=', $this->user->id());
+			})
+			->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($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', '=', $this->tree->id())
+				->where('sosa_mot.majs_user_id', '=', $this->user->id());
+			})
+			->where('sosa.majs_gedcom_id', '=', $this->tree->id())
+			->where('sosa.majs_user_id', '=', $this->user->id())
+			->where('sosa.majs_gen', '>=', $gen)
+			->where(function (Builder $query): void {
+				$query->whereNull('sosa_fat.majs_i_id')
+					->orWhereNull('sosa_mot.majs_i_id');
+			})
+			->groupBy(['sosa.majs_gen', 'root_ancestor']);
+
+		return DB::table('maj_sosa AS sosa_list')
+			->select(['stats_by_gen.root_ancestor AS root_ancestor_sosa', 'sosa_list.majs_i_id as root_ancestor_id'])
+			->selectRaw('1 + SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm))) AS mean_gen_depth')  //@phpcs:ignore Generic.Files.LineLength.TooLong
+			->selectRaw(' SQRT(' .
+				'   SUM(POWER(majs_gen_norm, 2) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm)))' .     //@phpcs:ignore Generic.Files.LineLength.TooLong
+				'   - POWER( SUM( (majs_gen_norm) * ( 2 * full_root_count + semi_root_count) /  (2 * POWER(2, majs_gen_norm))), 2)' .       //@phpcs:ignore Generic.Files.LineLength.TooLong
+				' ) AS stddev_gen_depth')
+			->joinSub($missing_ancestors_by_gen, 'stats_by_gen', function (JoinClause $join): void {
+				$join->on('sosa_list.majs_sosa', '=', 'stats_by_gen.root_ancestor')
+					->where('sosa_list.majs_gedcom_id', '=', $this->tree->id())
+					->where('sosa_list.majs_user_id', '=', $this->user->id());
+			})
+			->groupBy(['stats_by_gen.root_ancestor', 'sosa_list.majs_i_id'])
+			->orderBy('stats_by_gen.root_ancestor')
+			->get()->keyBy('root_ancestor_sosa');
+	}
+
+	/**
+	 * Return a collection of the most duplicated root Sosa ancestors.
+	 * The number of ancestors to return is limited by the parameter $limit.
+	 * If several individuals are tied when reaching the limit, none of them are returned,
+	 * which means that there can be less individuals returned than requested.
+	 *
+	 * Format:
+	 *  - value:
+	 *      - sosa_i_id : sosa individual
+	 *      - sosa_count: number of duplications of the ancestor (e.g. 3 if it appears 3 times)
+	 *
+	 * @param int $limit
+	 * @return Collection
+	 */
+	public function topMultipleAncestorsWithNoTies(int $limit): Collection
+	{
+		$table_prefix = DB::connection()->getTablePrefix();
+		$multiple_ancestors = DB::table('maj_sosa AS sosa')
+			->select('sosa.majs_i_id AS sosa_i_id')
+			->selectRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) AS sosa_count')
+			->leftJoin('maj_sosa AS sosa_fat', function (JoinClause $join) use ($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', '=', $this->tree->id())
+					->where('sosa_fat.majs_user_id', '=', $this->user->id());
+			})
+			->leftJoin('maj_sosa AS sosa_mot', function (JoinClause $join) use ($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', '=', $this->tree->id())
+				->where('sosa_mot.majs_user_id', '=', $this->user->id());
+			})
+			->where('sosa.majs_gedcom_id', '=', $this->tree->id())
+			->where('sosa.majs_user_id', '=', $this->user->id())
+			->whereNull('sosa_fat.majs_sosa')   // We keep only root individuals, i.e. those with no father or mother
+			->whereNull('sosa_mot.majs_sosa')
+			->groupBy('sosa.majs_i_id')
+			->havingRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) > 1')    // Limit to the duplicate sosas.
+			->orderByRaw('COUNT(' . $table_prefix . 'sosa.majs_sosa) DESC, MIN(' . $table_prefix . 'sosa.majs_sosa) ASC')   //@phpcs:ignore Generic.Files.LineLength.TooLong
+			->limit($limit + 1)     // We want to select one more than required, for ties
+			->get();
+
+		if ($multiple_ancestors->count() > $limit) {
+			$last_count = $multiple_ancestors->last()->sosa_count;
+			$multiple_ancestors = $multiple_ancestors->reject(function (stdClass $element) use ($last_count): bool {
+				return $element->sosa_count ==  $last_count;
+			});
+		}
+		return $multiple_ancestors;
+	}
+
+	/**
+	 * Return a computed array of statistics about the dispersion of ancestors across the ancestors
+	 * at a specified generation.
+	 *
+	 * Format:
+	 *  - key : rank of the ancestor in generation G for which exclusive ancestors have been found
+	 *          For instance 3 represent the maternal grand father
+	 *          0 is used for shared ancestors
+	 *  - values: number of ancestors exclusively in the ancestors of the ancestor in key
+	 *
+	 *  For instance a result at generation 3 could be :
+	 *      array (   0     =>  12      -> 12 ancestors are shared by the grand-parents
+	 *                1     =>  32      -> 32 ancestors are exclusive to the paternal grand-father
+	 *                2     =>  25      -> 25 ancestors are exclusive to the paternal grand-mother
+	 *                3     =>  12      -> 12 ancestors are exclusive to the maternal grand-father
+	 *                4     =>  30      -> 30 ancestors are exclusive to the maternal grand-mother
+	 *            )
+	 *
+	 * @param int $gen
+	 * @return Collection
+	 */
+	public function ancestorsDispersionForGeneration(int $gen): Collection
+	{
+		$ancestors_branches = DB::table('maj_sosa')
+			->select('majs_i_id AS i_id')
+			->selectRaw('FLOOR(majs_sosa / POW(2, (majs_gen - ?))) - POW(2, ? -1) + 1 AS branch', [$gen, $gen])
+			->where('majs_gedcom_id', '=', $this->tree->id())
+			->where('majs_user_id', '=', $this->user->id())
+			->where('majs_gen', '>=', $gen)
+			->groupBy('majs_i_id', 'branch');
+
+
+		$consolidated_ancestors_branches = DB::table('maj_sosa')
+			->fromSub($ancestors_branches, 'indi_branch')
+			->select('i_id')
+			->selectRaw('CASE WHEN COUNT(branch) > 1 THEN 0 ELSE MIN(branch) END AS branches')
+			->groupBy('i_id');
+
+		return DB::table('maj_sosa')
+			->fromSub($consolidated_ancestors_branches, 'indi_branch_consolidated')
+			->select('branches')
+			->selectRaw('COUNT(i_id) AS count_indi')
+			->groupBy('branches')
+			->get()->pluck('count_indi', 'branches');
+	}
 }

src/Webtrees/Module/Sosa/Services/SosaCalculatorService.php

Indentation +139 added lines, -139 removed lines

@@ -24,143 +24,143 @@
  */
 class SosaCalculatorService
 {
-    /**
-     * Maximium size for the temporary Sosa table
-     * @var int TMP_SOSA_TABLE_LIMIT
-     */
-    private const TMP_SOSA_TABLE_LIMIT = 1000;
-
-    /**
-     * @var SosaRecordsService $sosa_records_service
-     */
-    private $sosa_records_service;
-
-    /**
-     * Reference user
-     * @var UserInterface $user
-     */
-    private $user;
-
-    /**
-     * Reference tree
-     * @var Tree $tree
-     */
-    private $tree;
-
-    /**
-     * Temporary Sosa table, used during construction
-     * @var array<array<string,mixed>> $tmp_sosa_table
-     */
-    private $tmp_sosa_table;
-
-    /**
-     * Maximum number of generations to calculate
-     * @var int $max_generations
-     */
-    private $max_generations;
-
-    /**
-     * Constructor for the Sosa Calculator
-     *
-     * @param SosaRecordsService $sosa_records_service
-     * @param Tree $tree
-     * @param UserInterface $user
-     */
-    public function __construct(SosaRecordsService $sosa_records_service, Tree $tree, UserInterface $user)
-    {
-        $this->sosa_records_service = $sosa_records_service;
-        $this->tree = $tree;
-        $this->user = $user;
-        $this->tmp_sosa_table = array();
-        $max_gen_setting = $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN');
-        $this->max_generations = is_numeric($max_gen_setting) ?
-            (int) $max_gen_setting :
-            $this->sosa_records_service->maxSystemGenerations();
-    }
-
-    /**
-     * Compute all Sosa ancestors from the user's root individual.
-     *
-     * @return bool Result of the computation
-     */
-    public function computeAll(): bool
-    {
-        $root_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
-        if (($indi = Registry::individualFactory()->make($root_id, $this->tree)) !== null) {
-            $this->sosa_records_service->deleteAll($this->tree, $this->user);
-            $this->addNode($indi, 1);
-            $this->flushTmpSosaTable(true);
-            return true;
-        }
-        return false;
-    }
-
-    /**
-     * Compute all Sosa Ancestors from a specified Individual
-     *
-     * @param Individual $indi
-     * @return bool
-     */
-    public function computeFromIndividual(Individual $indi): bool
-    {
-        $current_sosas = $this->sosa_records_service->sosaNumbers($this->tree, $this->user, $indi);
-        foreach ($current_sosas->keys() as $sosa) {
-            $this->sosa_records_service->deleteAncestorsFrom($this->tree, $this->user, $sosa);
-            $this->addNode($indi, $sosa);
-        }
-        $this->flushTmpSosaTable(true);
-        return true;
-    }
-
-    /**
-     * Recursive method to add individual to the Sosa table, and flush it regularly
-     *
-     * @param Individual $indi Individual to add
-     * @param int $sosa Individual's sosa
-     */
-    private function addNode(Individual $indi, int $sosa): void
-    {
-        $birth_year = $indi->getBirthDate()->gregorianYear();
-        $birth_year_est = $birth_year === 0 ? $indi->getEstimatedBirthDate()->gregorianYear() : $birth_year;
-
-        $death_year = $indi->getDeathDate()->gregorianYear();
-        $death_year_est = $death_year === 0 ? $indi->getEstimatedDeathDate()->gregorianYear() : $death_year;
-
-        $this->tmp_sosa_table[] = [
-            'indi' => $indi->xref(),
-            'sosa' => $sosa,
-            'birth_year' => $birth_year === 0 ? null : $birth_year,
-            'birth_year_est' => $birth_year_est === 0 ? null : $birth_year_est,
-            'death_year' => $death_year === 0 ? null : $death_year,
-            'death_year_est' => $death_year_est === 0 ? null : $death_year_est
-        ];
-
-        $this->flushTmpSosaTable();
-
-        if (
-            ($fam = $indi->childFamilies()->first()) !== null
-            && $this->sosa_records_service->generation($sosa) < $this->max_generations
-        ) {
-            /** @var \Fisharebest\Webtrees\Family $fam */
-            if (($husb = $fam->husband()) !== null) {
-                $this->addNode($husb, 2 * $sosa);
-            }
-            if (($wife = $fam->wife()) !== null) {
-                $this->addNode($wife, 2 * $sosa + 1);
-            }
-        }
-    }
-
-    /**
-     * Write sosas in the table, if the number of items is superior to the limit, or if forced.
-     *
-     * @param bool $force Should the flush be forced
-     */
-    private function flushTmpSosaTable($force = false): void
-    {
-        if ($force || count($this->tmp_sosa_table) >= self::TMP_SOSA_TABLE_LIMIT) {
-            $this->sosa_records_service->insertOrUpdate($this->tree, $this->user, $this->tmp_sosa_table);
-            $this->tmp_sosa_table = array();
-        }
-    }
+	/**
+	 * Maximium size for the temporary Sosa table
+	 * @var int TMP_SOSA_TABLE_LIMIT
+	 */
+	private const TMP_SOSA_TABLE_LIMIT = 1000;
+
+	/**
+	 * @var SosaRecordsService $sosa_records_service
+	 */
+	private $sosa_records_service;
+
+	/**
+	 * Reference user
+	 * @var UserInterface $user
+	 */
+	private $user;
+
+	/**
+	 * Reference tree
+	 * @var Tree $tree
+	 */
+	private $tree;
+
+	/**
+	 * Temporary Sosa table, used during construction
+	 * @var array<array<string,mixed>> $tmp_sosa_table
+	 */
+	private $tmp_sosa_table;
+
+	/**
+	 * Maximum number of generations to calculate
+	 * @var int $max_generations
+	 */
+	private $max_generations;
+
+	/**
+	 * Constructor for the Sosa Calculator
+	 *
+	 * @param SosaRecordsService $sosa_records_service
+	 * @param Tree $tree
+	 * @param UserInterface $user
+	 */
+	public function __construct(SosaRecordsService $sosa_records_service, Tree $tree, UserInterface $user)
+	{
+		$this->sosa_records_service = $sosa_records_service;
+		$this->tree = $tree;
+		$this->user = $user;
+		$this->tmp_sosa_table = array();
+		$max_gen_setting = $tree->getUserPreference($user, 'MAJ_SOSA_MAX_GEN');
+		$this->max_generations = is_numeric($max_gen_setting) ?
+			(int) $max_gen_setting :
+			$this->sosa_records_service->maxSystemGenerations();
+	}
+
+	/**
+	 * Compute all Sosa ancestors from the user's root individual.
+	 *
+	 * @return bool Result of the computation
+	 */
+	public function computeAll(): bool
+	{
+		$root_id = $this->tree->getUserPreference($this->user, 'MAJ_SOSA_ROOT_ID');
+		if (($indi = Registry::individualFactory()->make($root_id, $this->tree)) !== null) {
+			$this->sosa_records_service->deleteAll($this->tree, $this->user);
+			$this->addNode($indi, 1);
+			$this->flushTmpSosaTable(true);
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * Compute all Sosa Ancestors from a specified Individual
+	 *
+	 * @param Individual $indi
+	 * @return bool
+	 */
+	public function computeFromIndividual(Individual $indi): bool
+	{
+		$current_sosas = $this->sosa_records_service->sosaNumbers($this->tree, $this->user, $indi);
+		foreach ($current_sosas->keys() as $sosa) {
+			$this->sosa_records_service->deleteAncestorsFrom($this->tree, $this->user, $sosa);
+			$this->addNode($indi, $sosa);
+		}
+		$this->flushTmpSosaTable(true);
+		return true;
+	}
+
+	/**
+	 * Recursive method to add individual to the Sosa table, and flush it regularly
+	 *
+	 * @param Individual $indi Individual to add
+	 * @param int $sosa Individual's sosa
+	 */
+	private function addNode(Individual $indi, int $sosa): void
+	{
+		$birth_year = $indi->getBirthDate()->gregorianYear();
+		$birth_year_est = $birth_year === 0 ? $indi->getEstimatedBirthDate()->gregorianYear() : $birth_year;
+
+		$death_year = $indi->getDeathDate()->gregorianYear();
+		$death_year_est = $death_year === 0 ? $indi->getEstimatedDeathDate()->gregorianYear() : $death_year;
+
+		$this->tmp_sosa_table[] = [
+			'indi' => $indi->xref(),
+			'sosa' => $sosa,
+			'birth_year' => $birth_year === 0 ? null : $birth_year,
+			'birth_year_est' => $birth_year_est === 0 ? null : $birth_year_est,
+			'death_year' => $death_year === 0 ? null : $death_year,
+			'death_year_est' => $death_year_est === 0 ? null : $death_year_est
+		];
+
+		$this->flushTmpSosaTable();
+
+		if (
+			($fam = $indi->childFamilies()->first()) !== null
+			&& $this->sosa_records_service->generation($sosa) < $this->max_generations
+		) {
+			/** @var \Fisharebest\Webtrees\Family $fam */
+			if (($husb = $fam->husband()) !== null) {
+				$this->addNode($husb, 2 * $sosa);
+			}
+			if (($wife = $fam->wife()) !== null) {
+				$this->addNode($wife, 2 * $sosa + 1);
+			}
+		}
+	}
+
+	/**
+	 * Write sosas in the table, if the number of items is superior to the limit, or if forced.
+	 *
+	 * @param bool $force Should the flush be forced
+	 */
+	private function flushTmpSosaTable($force = false): void
+	{
+		if ($force || count($this->tmp_sosa_table) >= self::TMP_SOSA_TABLE_LIMIT) {
+			$this->sosa_records_service->insertOrUpdate($this->tree, $this->user, $this->tmp_sosa_table);
+			$this->tmp_sosa_table = array();
+		}
+	}
 }

src/Webtrees/Module/Sosa/SosaModule.php

Indentation +250 added lines, -250 removed lines

@@ -54,256 +54,256 @@
  * Identify and produce statistics about Sosa ancestors
  */
 class SosaModule extends AbstractModule implements
-    ModuleMyArtJaubInterface,
-    ModuleGlobalInterface,
-    ModuleMenuInterface,
-    ModuleSidebarInterface,
-    ModuleGeoAnalysisProviderInterface
+	ModuleMyArtJaubInterface,
+	ModuleGlobalInterface,
+	ModuleMenuInterface,
+	ModuleSidebarInterface,
+	ModuleGeoAnalysisProviderInterface
 {
-    use ModuleMyArtJaubTrait {
-        boot as traitBoot;
-    }
-    use ModuleGlobalTrait;
-    use ModuleMenuTrait;
-    use ModuleSidebarTrait;
-
-    // How to update the database schema for this module
-    private const SCHEMA_TARGET_VERSION   = 3;
-    private const SCHEMA_SETTING_NAME     = 'MAJ_SOSA_SCHEMA_VERSION';
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
+	use ModuleMyArtJaubTrait {
+		boot as traitBoot;
+	}
+	use ModuleGlobalTrait;
+	use ModuleMenuTrait;
+	use ModuleSidebarTrait;
+
+	// How to update the database schema for this module
+	private const SCHEMA_TARGET_VERSION   = 3;
+	private const SCHEMA_SETTING_NAME     = 'MAJ_SOSA_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 “Sosa” module */ I18N::translate('Sosa');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “Sosa” module */ I18N::translate('Calculate and display Sosa ancestors of the root person.');
-    }
-
-    /**
-     * {@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 \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/sosa', static function (Map $router): void {
-
-                $router->attach('', '/list', static function (Map $router): void {
-
-                    $router->get(AncestorsList::class, '/ancestors/{tree}{/gen}', AncestorsList::class);
-                    $router->get(AncestorsListIndividual::class, '/ancestors/{tree}/{gen}/tab/individuals', AncestorsListIndividual::class);    //phpcs:ignore Generic.Files.LineLength.TooLong
-                    $router->get(AncestorsListFamily::class, '/ancestors/{tree}/{gen}/tab/families', AncestorsListFamily::class);   //phpcs:ignore Generic.Files.LineLength.TooLong
-                    $router->get(MissingAncestorsList::class, '/missing/{tree}{/gen}', MissingAncestorsList::class);
-                });
-
-                $router->attach('', '/statistics/{tree}', static function (Map $router): void {
-
-                    $router->get(SosaStatistics::class, '', SosaStatistics::class);
-                    $router->get(PedigreeCollapseData::class, '/pedigreecollapse', PedigreeCollapseData::class);
-                });
-
-                $router->attach('', '/config/{tree}', static function (Map $router): void {
-
-                    $router->get(SosaConfig::class, '', SosaConfig::class);
-                    $router->post(SosaConfigAction::class, '', SosaConfigAction::class);
-                    $router->get(SosaComputeModal::class, '/compute/{xref}', SosaComputeModal::class);
-                    $router->post(SosaComputeAction::class, '/compute', SosaComputeAction::class);
-                });
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.11-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::defaultMenuOrder()
-     */
-    public function defaultMenuOrder(): int
-    {
-        return 7;
-    }
-
-    /**
-     * {@inhericDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::getMenu()
-     */
-    public function getMenu(Tree $tree): ?Menu
-    {
-        $menu = new Menu(I18N::translate('Sosa Statistics'));
-        $menu->setClass('menu-maj-sosa');
-        $menu->setSubmenus([
-            new Menu(
-                I18N::translate('Sosa Ancestors'),
-                route(AncestorsList::class, ['tree' => $tree->name()]),
-                'menu-maj-sosa-list',
-                ['rel' => 'nofollow']
-            ),
-            new Menu(
-                I18N::translate('Missing Ancestors'),
-                route(MissingAncestorsList::class, ['tree' => $tree->name()]),
-                'menu-maj-sosa-missing',
-                ['rel' => 'nofollow']
-            ),
-            new Menu(
-                I18N::translate('Sosa Statistics'),
-                route(SosaStatistics::class, ['tree' => $tree->name()]),
-                'menu-maj-sosa-stats'
-            )
-        ]);
-
-        if (Auth::check()) {
-            $menu->addSubmenu(new Menu(
-                I18N::translate('Sosa Configuration'),
-                route(SosaConfig::class, ['tree' => $tree->name()]),
-                'menu-maj-sosa-config'
-            ));
-
-            /** @var ServerRequestInterface $request */
-            $request = app(ServerRequestInterface::class);
-            $route = $request->getAttribute('route');
-            assert($route instanceof Route);
-
-            $root_indi_id = $tree->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
-
-            if ($route->name === IndividualPage::class && mb_strlen($root_indi_id) > 0) {
-                $xref = $request->getAttribute('xref');
-                assert(is_string($xref));
-
-                $menu->addSubmenu(new Menu(
-                    I18N::translate('Complete Sosas'),
-                    '#',
-                    'menu-maj-sosa-compute',
-                    [
-                        'rel'           => 'nofollow',
-                        'data-href'     => route(SosaComputeModal::class, ['tree' => $tree->name(), 'xref' => $xref]),
-                        'data-target'   => '#wt-ajax-modal',
-                        'data-toggle'   => 'modal',
-                        'data-backdrop' => 'static'
-                    ]
-                ));
-            }
-        }
-
-        return $menu;
-    }
-
-    /**
-     * {@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/sosa.min.js') . '"></script>';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::sidebarTitle()
-     */
-    public function sidebarTitle(): string
-    {
-        $request = app(ServerRequestInterface::class);
-        $xref = $request->getAttribute('xref');
-        $tree = $request->getAttribute('tree');
-        $user = Auth::check() ? Auth::user() : new DefaultUser();
-
-        $individual = Registry::individualFactory()->make($xref, $tree);
-
-        return view($this->name() . '::sidebar/title', [
-            'module_name'   =>  $this->name(),
-            'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($tree, $user, $individual)
-        ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
-     */
-    public function getSidebarContent(Individual $individual): string
-    {
-        $sosa_root_xref = $individual->tree()->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
-        $sosa_root = Registry::individualFactory()->make($sosa_root_xref, $individual->tree());
-        $user = Auth::check() ? Auth::user() : new DefaultUser();
-
-        return view($this->name() . '::sidebar/content', [
-            'sosa_ancestor' =>  $individual,
-            'sosa_root'     =>  $sosa_root,
-            'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
-        ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
-     */
-    public function hasSidebarContent(Individual $individual): bool
-    {
-        $user = Auth::check() ? Auth::user() : new DefaultUser();
-
-        return app(SosaRecordsService::class)
-            ->sosaNumbers($individual->tree(), $user, $individual)->count() > 0;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::defaultSidebarOrder()
-     */
-    public function defaultSidebarOrder(): int
-    {
-        return 1;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModuleGeoAnalysisProviderInterface::listGeoAnalyses()
-     */
-    public function listGeoAnalyses(): array
-    {
-        return [
-            SosaByGenerationGeoAnalysis::class
-        ];
-    }
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return /* I18N: Name of the “Sosa” module */ I18N::translate('Sosa');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “Sosa” module */ I18N::translate('Calculate and display Sosa ancestors of the root person.');
+	}
+
+	/**
+	 * {@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 \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/sosa', static function (Map $router): void {
+
+				$router->attach('', '/list', static function (Map $router): void {
+
+					$router->get(AncestorsList::class, '/ancestors/{tree}{/gen}', AncestorsList::class);
+					$router->get(AncestorsListIndividual::class, '/ancestors/{tree}/{gen}/tab/individuals', AncestorsListIndividual::class);    //phpcs:ignore Generic.Files.LineLength.TooLong
+					$router->get(AncestorsListFamily::class, '/ancestors/{tree}/{gen}/tab/families', AncestorsListFamily::class);   //phpcs:ignore Generic.Files.LineLength.TooLong
+					$router->get(MissingAncestorsList::class, '/missing/{tree}{/gen}', MissingAncestorsList::class);
+				});
+
+				$router->attach('', '/statistics/{tree}', static function (Map $router): void {
+
+					$router->get(SosaStatistics::class, '', SosaStatistics::class);
+					$router->get(PedigreeCollapseData::class, '/pedigreecollapse', PedigreeCollapseData::class);
+				});
+
+				$router->attach('', '/config/{tree}', static function (Map $router): void {
+
+					$router->get(SosaConfig::class, '', SosaConfig::class);
+					$router->post(SosaConfigAction::class, '', SosaConfigAction::class);
+					$router->get(SosaComputeModal::class, '/compute/{xref}', SosaComputeModal::class);
+					$router->post(SosaComputeAction::class, '/compute', SosaComputeAction::class);
+				});
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.11-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::defaultMenuOrder()
+	 */
+	public function defaultMenuOrder(): int
+	{
+		return 7;
+	}
+
+	/**
+	 * {@inhericDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleMenuInterface::getMenu()
+	 */
+	public function getMenu(Tree $tree): ?Menu
+	{
+		$menu = new Menu(I18N::translate('Sosa Statistics'));
+		$menu->setClass('menu-maj-sosa');
+		$menu->setSubmenus([
+			new Menu(
+				I18N::translate('Sosa Ancestors'),
+				route(AncestorsList::class, ['tree' => $tree->name()]),
+				'menu-maj-sosa-list',
+				['rel' => 'nofollow']
+			),
+			new Menu(
+				I18N::translate('Missing Ancestors'),
+				route(MissingAncestorsList::class, ['tree' => $tree->name()]),
+				'menu-maj-sosa-missing',
+				['rel' => 'nofollow']
+			),
+			new Menu(
+				I18N::translate('Sosa Statistics'),
+				route(SosaStatistics::class, ['tree' => $tree->name()]),
+				'menu-maj-sosa-stats'
+			)
+		]);
+
+		if (Auth::check()) {
+			$menu->addSubmenu(new Menu(
+				I18N::translate('Sosa Configuration'),
+				route(SosaConfig::class, ['tree' => $tree->name()]),
+				'menu-maj-sosa-config'
+			));
+
+			/** @var ServerRequestInterface $request */
+			$request = app(ServerRequestInterface::class);
+			$route = $request->getAttribute('route');
+			assert($route instanceof Route);
+
+			$root_indi_id = $tree->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
+
+			if ($route->name === IndividualPage::class && mb_strlen($root_indi_id) > 0) {
+				$xref = $request->getAttribute('xref');
+				assert(is_string($xref));
+
+				$menu->addSubmenu(new Menu(
+					I18N::translate('Complete Sosas'),
+					'#',
+					'menu-maj-sosa-compute',
+					[
+						'rel'           => 'nofollow',
+						'data-href'     => route(SosaComputeModal::class, ['tree' => $tree->name(), 'xref' => $xref]),
+						'data-target'   => '#wt-ajax-modal',
+						'data-toggle'   => 'modal',
+						'data-backdrop' => 'static'
+					]
+				));
+			}
+		}
+
+		return $menu;
+	}
+
+	/**
+	 * {@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/sosa.min.js') . '"></script>';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::sidebarTitle()
+	 */
+	public function sidebarTitle(): string
+	{
+		$request = app(ServerRequestInterface::class);
+		$xref = $request->getAttribute('xref');
+		$tree = $request->getAttribute('tree');
+		$user = Auth::check() ? Auth::user() : new DefaultUser();
+
+		$individual = Registry::individualFactory()->make($xref, $tree);
+
+		return view($this->name() . '::sidebar/title', [
+			'module_name'   =>  $this->name(),
+			'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($tree, $user, $individual)
+		]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::getSidebarContent()
+	 */
+	public function getSidebarContent(Individual $individual): string
+	{
+		$sosa_root_xref = $individual->tree()->getUserPreference(Auth::user(), 'MAJ_SOSA_ROOT_ID');
+		$sosa_root = Registry::individualFactory()->make($sosa_root_xref, $individual->tree());
+		$user = Auth::check() ? Auth::user() : new DefaultUser();
+
+		return view($this->name() . '::sidebar/content', [
+			'sosa_ancestor' =>  $individual,
+			'sosa_root'     =>  $sosa_root,
+			'sosa_numbers'  =>  app(SosaRecordsService::class)->sosaNumbers($individual->tree(), $user, $individual)
+		]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::hasSidebarContent()
+	 */
+	public function hasSidebarContent(Individual $individual): bool
+	{
+		$user = Auth::check() ? Auth::user() : new DefaultUser();
+
+		return app(SosaRecordsService::class)
+			->sosaNumbers($individual->tree(), $user, $individual)->count() > 0;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleSidebarInterface::defaultSidebarOrder()
+	 */
+	public function defaultSidebarOrder(): int
+	{
+		return 1;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\ModuleGeoAnalysisProviderInterface::listGeoAnalyses()
+	 */
+	public function listGeoAnalyses(): array
+	{
+		return [
+			SosaByGenerationGeoAnalysis::class
+		];
+	}
 }

src/Webtrees/Module/ModuleMyArtJaubTrait.php

Indentation +63 added lines, -63 removed lines

@@ -24,80 +24,80 @@
  */
 trait ModuleMyArtJaubTrait
 {    
-    use ModuleCustomTrait;
+	use ModuleCustomTrait;
     
-    /**
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
-     */
-    public function boot() : void
-    {
-        View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
+	/**
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
+	 */
+	public function boot() : void
+	{
+		View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
         
-        $this->loadRoutes(app(RouterContainer::class)->getMap());
-    }
+		$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\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::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::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';
+	/**
+	 * @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) { }
+		try {
+			$translation  = new Translation($translation_file);
+			return $translation->asArray();
+		} catch (\Exception $e) { }
         
-        return [];
-    }
+		return [];
+	}
     
-    /**
-     * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes
-     */
-    public function loadRoutes(Map $router): void { }
+	/**
+	 * @see \MyArtJaub\Webtrees\Module\ModuleMyArtJaubInterface::loadRoutes
+	 */
+	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';
+	/**
+	 * @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');
-        }
-    }
+		if(file_exists($css_file)) {
+			return $this->assetUrl('css/' . $theme->name() . '.min.css');
+		}
+		else {
+			return $this->assetUrl('css/default.min.css');
+		}
+	}
     
 }
  
\ No newline at end of file

src/Webtrees/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 $router
-     */
-    public function loadRoutes(Map $router): void;
+	/**
+	 * Add module routes to webtrees route loader
+	 *
+	 * @param Map $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;
 }

src/Webtrees/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResult.php

Indentation +219 added lines, -219 removed lines

@@ -23,226 +23,226 @@
  */
 class GeoAnalysisResult
 {
-    private string $description;
-    private int $order;
-    private int $unknown_count;
-    /**
-     * @var Collection<GeoAnalysisResultItem>
-     */
-    private Collection $places;
-    
-    /**
-     * Constructor for GeoAnalysisResult
-     * 
-     * @param string $description
-     * @param int $order
-     * @param Collection<GeoAnalysisResultItem> $places
-     * @param int $unknown
-     */
-    final public function __construct(
-        string $description, 
-        int $order = 0, 
-        Collection $places = null, 
-        int $unknown = 0
-    ) {
-        $this->description = $description;
-        $this->order = $order;
-        $this->places = $places ?? new Collection();
-        $this->unknown_count = $unknown;
-    }
-    
-    /**
-     * Get the category description
-     * 
-     * @return string
-     */
-    public function description(): string
-    {
-        return $this->description;
-    }
-    
-    /**
-     * Get the category order
-     * 
-     * @return int
-     */
-    public function order(): int
-    {
-        return $this->order;
-    }
-    
-    /**
-     * Add a place to the analysis result
-     * 
-     * @param GeoAnalysisPlace $place
-     */
-    public function addPlace(GeoAnalysisPlace $place): void
-    {
-        if($place->isKnown()) {
-            /** @var GeoAnalysisResultItem $item */
-            $item = $this->places->get($place->key(), new GeoAnalysisResultItem($place));
-            $this->places->put($item->key(), $item->increment());
-        } else {
-            $this->addUnknown();
-        }
-    }
-    
-    /**
-     * Exclude a place from the analysis result
-     * 
-     * @param GeoAnalysisPlace $place
-     */
-    public function exclude(GeoAnalysisPlace $place): void
-    {
-        /** @var GeoAnalysisResultItem|null $item */
-        $item = $this->places->get($place->key());
-        if($item !== null) {
-            $item->place()->exclude();
-        }
-    }
-    
-    /**
-     * Add an unknown place to the analysis result
-     */
-    public function addUnknown(): void
-    {
-        $this->unknown_count++;
-    }
-    
-    /**
-     * Take a copy of the current analysis result
-     * 
-     * @return self
-     */
-    public function copy() : self
-    {
-        return new static(
-            $this->description(),
-            $this->order(),
-            $this->places->map(fn(GeoAnalysisResultItem $item) : GeoAnalysisResultItem => clone $item),
-            $this->countUnknown()
-        );
-    }
-    
-    /**
-     * Merge the current analysis result with another.
-     * The current object is modified, not the second one.
-     * 
-     * @param GeoAnalysisResult $other
-     * @return self
-     */
-    public function merge(GeoAnalysisResult $other): self
-    {
-        $this->places->each(function(GeoAnalysisResultItem $item) use ($other) : void {
-            if($other->places->has($item->key())) {
-                $item->place()->exclude(
-                    $item->place()->isExcluded() 
-                    && $other->places->get($item->key())->place()->isExcluded()
-                );
-            }
-        });
+	private string $description;
+	private int $order;
+	private int $unknown_count;
+	/**
+	 * @var Collection<GeoAnalysisResultItem>
+	 */
+	private Collection $places;
+    
+	/**
+	 * Constructor for GeoAnalysisResult
+	 * 
+	 * @param string $description
+	 * @param int $order
+	 * @param Collection<GeoAnalysisResultItem> $places
+	 * @param int $unknown
+	 */
+	final public function __construct(
+		string $description, 
+		int $order = 0, 
+		Collection $places = null, 
+		int $unknown = 0
+	) {
+		$this->description = $description;
+		$this->order = $order;
+		$this->places = $places ?? new Collection();
+		$this->unknown_count = $unknown;
+	}
+    
+	/**
+	 * Get the category description
+	 * 
+	 * @return string
+	 */
+	public function description(): string
+	{
+		return $this->description;
+	}
+    
+	/**
+	 * Get the category order
+	 * 
+	 * @return int
+	 */
+	public function order(): int
+	{
+		return $this->order;
+	}
+    
+	/**
+	 * Add a place to the analysis result
+	 * 
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function addPlace(GeoAnalysisPlace $place): void
+	{
+		if($place->isKnown()) {
+			/** @var GeoAnalysisResultItem $item */
+			$item = $this->places->get($place->key(), new GeoAnalysisResultItem($place));
+			$this->places->put($item->key(), $item->increment());
+		} else {
+			$this->addUnknown();
+		}
+	}
+    
+	/**
+	 * Exclude a place from the analysis result
+	 * 
+	 * @param GeoAnalysisPlace $place
+	 */
+	public function exclude(GeoAnalysisPlace $place): void
+	{
+		/** @var GeoAnalysisResultItem|null $item */
+		$item = $this->places->get($place->key());
+		if($item !== null) {
+			$item->place()->exclude();
+		}
+	}
+    
+	/**
+	 * Add an unknown place to the analysis result
+	 */
+	public function addUnknown(): void
+	{
+		$this->unknown_count++;
+	}
+    
+	/**
+	 * Take a copy of the current analysis result
+	 * 
+	 * @return self
+	 */
+	public function copy() : self
+	{
+		return new static(
+			$this->description(),
+			$this->order(),
+			$this->places->map(fn(GeoAnalysisResultItem $item) : GeoAnalysisResultItem => clone $item),
+			$this->countUnknown()
+		);
+	}
+    
+	/**
+	 * Merge the current analysis result with another.
+	 * The current object is modified, not the second one.
+	 * 
+	 * @param GeoAnalysisResult $other
+	 * @return self
+	 */
+	public function merge(GeoAnalysisResult $other): self
+	{
+		$this->places->each(function(GeoAnalysisResultItem $item) use ($other) : void {
+			if($other->places->has($item->key())) {
+				$item->place()->exclude(
+					$item->place()->isExcluded() 
+					&& $other->places->get($item->key())->place()->isExcluded()
+				);
+			}
+		});
         
-        $other->places->each(function(GeoAnalysisResultItem $item): void {
-            if(!$this->places->has($item->key())) {
-                $this->addPlace($item->place());
-            }
-        });
+		$other->places->each(function(GeoAnalysisResultItem $item): void {
+			if(!$this->places->has($item->key())) {
+				$this->addPlace($item->place());
+			}
+		});
         
-        return $this;
-    }
-    
-    /**
-     * Get the count of Known places
-     * 
-     * @return int
-     */
-    public function countKnown(): int
-    {
-        return $this->places->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-    
-    /**
-     * Get the count of Found places
-     * 
-     * @return int
-     */
-    public function countFound(): int
-    {
-        return $this->places
-            ->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
-            ->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-    
-    /**
-     * Get the count of Excluded places
-     * 
-     * @return int
-     */
-    public function countExcluded(): int
-    {
-        return $this->places
-            ->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
-            ->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-    
-    /**
-     * Get the count of Unknown places
-     * 
-     * @return int
-     */
-    public function countUnknown(): int
-    {
-        return $this->unknown_count;
-    }
-    
-    /**
-     * Get the count of the most represented Place in the analysis result
-     * 
-     * @return int
-     */
-    public function maxCount(): int
-    {
-        return $this->places->max(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
-    }
-    
-    /**
-     * Get the list of Known places with their associated count
-     * 
-     * @param bool $exclude_other
-     * @return Collection<GeoAnalysisResultItem>
-     */
-    public function knownPlaces(bool $exclude_other = false): Collection
-    {
-        if($exclude_other) {
-            return $this->places->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
-        }
-        return $this->places;
-    }
-    
-    /**
-     * Get the list of Known places with their associated count.
-     * The list is sorted first by descending count, then by ascending Place name
-     * 
-     * @param bool $exclude_other
-     * @return Collection<GeoAnalysisResultItem>
-     */
-    public function sortedKnownPlaces(bool $exclude_other = false): Collection
-    {
-        return $this->knownPlaces($exclude_other)->sortBy([
-            fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int => $b->count() <=> $a->count(),
-            fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int => 
-                I18N::comparator()($a->place()->place()->gedcomName(), $b->place()->place()->gedcomName())
-        ]);
-    }
-    
-    /**
-     * Get the list of Excluded places
-     * 
-     * @return Collection<GeoAnalysisResultItem>
-     */
-    public function excludedPlaces(): Collection
-    {
-        return $this->places->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
-    }
+		return $this;
+	}
+    
+	/**
+	 * Get the count of Known places
+	 * 
+	 * @return int
+	 */
+	public function countKnown(): int
+	{
+		return $this->places->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+    
+	/**
+	 * Get the count of Found places
+	 * 
+	 * @return int
+	 */
+	public function countFound(): int
+	{
+		return $this->places
+			->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
+			->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+    
+	/**
+	 * Get the count of Excluded places
+	 * 
+	 * @return int
+	 */
+	public function countExcluded(): int
+	{
+		return $this->places
+			->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded())
+			->sum(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+    
+	/**
+	 * Get the count of Unknown places
+	 * 
+	 * @return int
+	 */
+	public function countUnknown(): int
+	{
+		return $this->unknown_count;
+	}
+    
+	/**
+	 * Get the count of the most represented Place in the analysis result
+	 * 
+	 * @return int
+	 */
+	public function maxCount(): int
+	{
+		return $this->places->max(fn(GeoAnalysisResultItem $item): int => $item->count()) ?? 0;
+	}
+    
+	/**
+	 * Get the list of Known places with their associated count
+	 * 
+	 * @param bool $exclude_other
+	 * @return Collection<GeoAnalysisResultItem>
+	 */
+	public function knownPlaces(bool $exclude_other = false): Collection
+	{
+		if($exclude_other) {
+			return $this->places->reject(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
+		}
+		return $this->places;
+	}
+    
+	/**
+	 * Get the list of Known places with their associated count.
+	 * The list is sorted first by descending count, then by ascending Place name
+	 * 
+	 * @param bool $exclude_other
+	 * @return Collection<GeoAnalysisResultItem>
+	 */
+	public function sortedKnownPlaces(bool $exclude_other = false): Collection
+	{
+		return $this->knownPlaces($exclude_other)->sortBy([
+			fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int => $b->count() <=> $a->count(),
+			fn (GeoAnalysisResultItem $a, GeoAnalysisResultItem $b): int => 
+				I18N::comparator()($a->place()->place()->gedcomName(), $b->place()->place()->gedcomName())
+		]);
+	}
+    
+	/**
+	 * Get the list of Excluded places
+	 * 
+	 * @return Collection<GeoAnalysisResultItem>
+	 */
+	public function excludedPlaces(): Collection
+	{
+		return $this->places->filter(fn(GeoAnalysisResultItem $item): bool => $item->place()->isExcluded());
+	}
 }
 

src/Webtrees/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResults.php

Indentation +89 added lines, -89 removed lines

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