jon48 / webtrees-lib

app/Contracts/Hooks/SosaIndividualDatatablesExtenderInterface.php

Indentation +15 added lines, -15 removed lines

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

app/Contracts/GeoDispersion/ModuleGeoAnalysisProviderInterface.php

Indentation +6 added lines, -6 removed lines

@@ -19,10 +19,10 @@
  */
 interface ModuleGeoAnalysisProviderInterface
 {
-    /**
-     * List geographical analyses provided by the module as an array.
-     *
-     * @return string[] List of geographical analyses
-     */
-    public function listGeoAnalyses(): array;
+	/**
+	 * List geographical analyses provided by the module as an array.
+	 *
+	 * @return string[] List of geographical analyses
+	 */
+	public function listGeoAnalyses(): array;
 }

app/Contracts/GeoDispersion/ModuleMapDefinitionProviderInterface.php

Indentation +6 added lines, -6 removed lines

@@ -19,10 +19,10 @@
  */
 interface ModuleMapDefinitionProviderInterface
 {
-    /**
-     * List map definitions provided by the module as an array.
-     *
-     * @return array<int, MapDefinitionInterface> List of map definitions
-     */
-    public function listMapDefinition(): array;
+	/**
+	 * List map definitions provided by the module as an array.
+	 *
+	 * @return array<int, MapDefinitionInterface> List of map definitions
+	 */
+	public function listMapDefinition(): array;
 }

app/Contracts/Tasks/ConfigurableTaskInterface.php

Indentation +15 added lines, -15 removed lines

@@ -22,20 +22,20 @@
  */
 interface ConfigurableTaskInterface
 {
-    /**
-     * Returns the HTML code to display the specific task configuration.
-     *
-     * @param ServerRequestInterface $request
-     * @return string HTML code
-     */
-    public function configView(ServerRequestInterface $request): string;
+	/**
+	 * Returns the HTML code to display the specific task configuration.
+	 *
+	 * @param ServerRequestInterface $request
+	 * @return string HTML code
+	 */
+	public function configView(ServerRequestInterface $request): string;
 
-    /**
-     * Update the specific configuration of the task.
-     *
-     * @param ServerRequestInterface $request
-     * @param TaskSchedule $task_schedule
-     * @return bool Result of the update
-     */
-    public function updateConfig(ServerRequestInterface $request, TaskSchedule $task_schedule): bool;
+	/**
+	 * Update the specific configuration of the task.
+	 *
+	 * @param ServerRequestInterface $request
+	 * @param TaskSchedule $task_schedule
+	 * @return bool Result of the update
+	 */
+	public function updateConfig(ServerRequestInterface $request, TaskSchedule $task_schedule): bool;
 }

app/Contracts/Tasks/ModuleTasksProviderInterface.php

Indentation +7 added lines, -7 removed lines

@@ -19,11 +19,11 @@
  */
 interface ModuleTasksProviderInterface
 {
-    /**
-     * List tasks provided by the module as an associative array.
-     * They keys are used as task IDs for storage and reference.
-     *
-     * @return array<string, string> List of tasks
-     */
-    public function listTasks(): array;
+	/**
+	 * List tasks provided by the module as an associative array.
+	 * They keys are used as task IDs for storage and reference.
+	 *
+	 * @return array<string, string> List of tasks
+	 */
+	public function listTasks(): array;
 }

app/Module/Sosa/Schema/Migration0.php

Indentation +8 added lines, -8 removed lines

@@ -21,12 +21,12 @@
  */
 class Migration0 implements MigrationInterface
 {
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        // These migrations have been merged into migration 2.
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		// These migrations have been merged into migration 2.
+	}
 }

app/Module/Sosa/Schema/Migration2.php

Indentation +37 added lines, -37 removed lines

@@ -23,41 +23,41 @@
  */
 class Migration2 implements MigrationInterface
 {
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        $in_transaction = DB::connection()->getPdo()->inTransaction();
-
-        // Clean up previous sosa table if it exists
-        DB::schema()->dropIfExists('maj_sosa');
-
-        DB::schema()->create('maj_sosa', static function (Blueprint $table): void {
-
-            $table->integer('majs_gedcom_id');
-            $table->integer('majs_user_id')->default(-1);
-            $table->bigInteger('majs_sosa')->unsigned(); // Allow to calculate sosa on 64 generations
-            $table->string('majs_i_id', 20);
-            $table->tinyInteger('majs_gen')->nullable();
-            $table->smallInteger('majs_birth_year')->nullable();
-            $table->smallInteger('majs_birth_year_est')->nullable();
-            $table->smallInteger('majs_death_year')->nullable();
-            $table->smallInteger('majs_death_year_est')->nullable();
-
-            $table->primary(['majs_gedcom_id', 'majs_user_id', 'majs_sosa']);
-
-            $table->index(['majs_gedcom_id', 'majs_user_id']);
-            $table->index(['majs_gedcom_id', 'majs_user_id', 'majs_i_id']);
-            $table->index(['majs_gedcom_id', 'majs_user_id', 'majs_gen']);
-
-            $table->foreign('majs_gedcom_id')->references('gedcom_id')->on('gedcom')->onDelete('cascade');
-            $table->foreign('majs_user_id')->references('user_id')->on('user')->onDelete('cascade');
-        });
-
-        if ($in_transaction && !DB::connection()->getPdo()->inTransaction()) {
-            DB::connection()->beginTransaction();
-        }
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		$in_transaction = DB::connection()->getPdo()->inTransaction();
+
+		// Clean up previous sosa table if it exists
+		DB::schema()->dropIfExists('maj_sosa');
+
+		DB::schema()->create('maj_sosa', static function (Blueprint $table): void {
+
+			$table->integer('majs_gedcom_id');
+			$table->integer('majs_user_id')->default(-1);
+			$table->bigInteger('majs_sosa')->unsigned(); // Allow to calculate sosa on 64 generations
+			$table->string('majs_i_id', 20);
+			$table->tinyInteger('majs_gen')->nullable();
+			$table->smallInteger('majs_birth_year')->nullable();
+			$table->smallInteger('majs_birth_year_est')->nullable();
+			$table->smallInteger('majs_death_year')->nullable();
+			$table->smallInteger('majs_death_year_est')->nullable();
+
+			$table->primary(['majs_gedcom_id', 'majs_user_id', 'majs_sosa']);
+
+			$table->index(['majs_gedcom_id', 'majs_user_id']);
+			$table->index(['majs_gedcom_id', 'majs_user_id', 'majs_i_id']);
+			$table->index(['majs_gedcom_id', 'majs_user_id', 'majs_gen']);
+
+			$table->foreign('majs_gedcom_id')->references('gedcom_id')->on('gedcom')->onDelete('cascade');
+			$table->foreign('majs_user_id')->references('user_id')->on('user')->onDelete('cascade');
+		});
+
+		if ($in_transaction && !DB::connection()->getPdo()->inTransaction()) {
+			DB::connection()->beginTransaction();
+		}
+	}
 }

app/Module/Sosa/Schema/Migration1.php

Indentation +8 added lines, -8 removed lines

@@ -21,12 +21,12 @@
  */
 class Migration1 implements MigrationInterface
 {
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
-     */
-    public function upgrade(): void
-    {
-        // These migrations have been merged into migration 2.
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Schema\MigrationInterface::upgrade()
+	 */
+	public function upgrade(): void
+	{
+		// These migrations have been merged into migration 2.
+	}
 }

app/Module/Sosa/Http/RequestHandlers/SosaStatistics.php

Indentation +138 added lines, -138 removed lines

@@ -38,142 +38,142 @@
  */
 class SosaStatistics implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
-
-    private ?SosaModule $module;
-    private RelationshipService $relationship_service;
-
-    /**
-     * Constructor for AncestorsList Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service, RelationshipService $relationship_service)
-    {
-        $this->module = $module_service->findByInterface(SosaModule::class)->first();
-        $this->relationship_service = $relationship_service;
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        if ($this->module === null) {
-            throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
-        }
-
-        $tree = Validator::attributes($request)->tree();
-        $user = Auth::check() ? Validator::attributes($request)->user() : new DefaultUser();
-
-        /** @var SosaStatisticsService $sosa_stats_service */
-        $sosa_stats_service = app()->makeWith(SosaStatisticsService::class, ['tree' => $tree, 'user' => $user]);
-
-        return $this->viewResponse($this->module->name() . '::statistics-page', [
-            'module_name'       =>  $this->module->name(),
-            'title'             =>  I18N::translate('Sosa Statistics'),
-            'tree'              =>  $tree,
-            'theme'             =>  app(ModuleThemeInterface::class),
-            'root_indi'         =>  $sosa_stats_service->rootIndividual(),
-            'general_stats'     =>  $this->statisticsGeneral($sosa_stats_service),
-            'generation_stats'  =>  $this->statisticsByGenerations($sosa_stats_service),
-            'generation_depth'  =>  $sosa_stats_service->generationDepthStatsAtGeneration(1)->first(),
-            'multiple_sosas'    =>  $sosa_stats_service->topMultipleAncestorsWithNoTies(10)->groupBy('sosa_count'),
-            'sosa_dispersion_g2' =>  $sosa_stats_service->ancestorsDispersionForGeneration(2),
-            'sosa_dispersion_g3' =>  $sosa_stats_service->ancestorsDispersionForGeneration(3),
-            'gen_depth_g3'      =>  $sosa_stats_service->generationDepthStatsAtGeneration(3),
-            'relationship_service'  =>  $this->relationship_service,
-        ]);
-    }
-
-    /**
-     * Retrieve and compute the global statistics of ancestors for the tree.
-     * Statistics include the number of ancestors, the number of different ancestors, pedigree collapse...
-     *
-     * @param SosaStatisticsService $sosa_stats_service
-     * @return array<string, int|float>
-     */
-    private function statisticsGeneral(SosaStatisticsService $sosa_stats_service): array
-    {
-        $ancestors_count = $sosa_stats_service->totalAncestors();
-        $ancestors_distinct_count = $sosa_stats_service->totalDistinctAncestors();
-        $individual_count = $sosa_stats_service->totalIndividuals();
-
-        return [
-            'sosa_count'    =>  $ancestors_count,
-            'distinct_count'    =>  $ancestors_distinct_count,
-            'sosa_rate' =>  $this->safeDivision(
-                BigInteger::of($ancestors_distinct_count),
-                BigInteger::of($individual_count)
-            ),
-            'mean_gen_time'         =>  $sosa_stats_service->meanGenerationTime()
-        ];
-    }
-
-    /**
-     * Retrieve and compute the statistics of ancestors by generations.
-     * Statistics include the number of ancestors, the number of different ancestors, cumulative statistics...
-     *
-     * @param SosaStatisticsService $sosa_stats_service
-     * @return array<int, array<string, int|float>>
-     */
-    private function statisticsByGenerations(SosaStatisticsService $sosa_stats_service): array
-    {
-        $stats_by_gen = $sosa_stats_service->statisticsByGenerations();
-
-        $generation_stats = array();
-
-        foreach ($stats_by_gen as $gen => $stats_gen) {
-            $gen_diff = $gen > 1 ?
-                (int) $stats_gen['diffSosaTotalCount'] - (int) $stats_by_gen[$gen - 1]['diffSosaTotalCount'] :
-                1;
-            $generation_stats[$gen] = array(
-                'gen_min_birth' => $stats_gen['firstBirth'] ?? (int) $stats_gen['firstEstimatedBirth'],
-                'gen_max_birth' => $stats_gen['lastBirth'] ?? (int) $stats_gen['lastEstimatedBirth'],
-                'theoretical' => BigInteger::of(2)->power($gen - 1)->toInt(),
-                'known' => (int) $stats_gen['sosaCount'],
-                'perc_known' => $this->safeDivision(
-                    BigInteger::of((int) $stats_gen['sosaCount']),
-                    BigInteger::of(2)->power($gen - 1)
-                ),
-                'missing' => $gen > 1 ?
-                    2 * (int) $stats_by_gen[$gen - 1]['sosaCount'] - (int) $stats_gen['sosaCount'] :
-                    0,
-                'perc_missing' => $gen > 1 ?
-                    1 - $this->safeDivision(
-                        BigInteger::of((int) $stats_gen['sosaCount']),
-                        BigInteger::of(2 * (int) $stats_by_gen[$gen - 1]['sosaCount'])
-                    ) :
-                    0,
-                'total_known' => (int) $stats_gen['sosaTotalCount'],
-                'perc_total_known' => $this->safeDivision(
-                    BigInteger::of((int) $stats_gen['sosaTotalCount']),
-                    BigInteger::of(2)->power($gen)->minus(1)
-                ),
-                'different' => $gen_diff,
-                'perc_different' => $this->safeDivision(
-                    BigInteger::of($gen_diff),
-                    BigInteger::of((int) $stats_gen['sosaCount'])
-                ),
-                'total_different' => (int) $stats_gen['diffSosaTotalCount']
-            );
-        }
-
-        return $generation_stats;
-    }
-
-    /**
-     * Return the result of a division, and a default value if denominator is 0
-     *
-     * @param BigInteger $p Numerator
-     * @param BigInteger $q Denominator
-     * @param int $scale Rounding scale
-     * @param float $default Value if denominator is 0
-     * @return float
-     */
-    private function safeDivision(BigInteger $p, BigInteger $q, int $scale = 10, float $default = 0): float
-    {
-        return $q->isZero() ? $default : $p->toBigDecimal()->dividedBy($q, $scale, RoundingMode::HALF_DOWN)->toFloat();
-    }
+	use ViewResponseTrait;
+
+	private ?SosaModule $module;
+	private RelationshipService $relationship_service;
+
+	/**
+	 * Constructor for AncestorsList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service, RelationshipService $relationship_service)
+	{
+		$this->module = $module_service->findByInterface(SosaModule::class)->first();
+		$this->relationship_service = $relationship_service;
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		if ($this->module === null) {
+			throw new HttpNotFoundException(I18N::translate('The attached module could not be found.'));
+		}
+
+		$tree = Validator::attributes($request)->tree();
+		$user = Auth::check() ? Validator::attributes($request)->user() : new DefaultUser();
+
+		/** @var SosaStatisticsService $sosa_stats_service */
+		$sosa_stats_service = app()->makeWith(SosaStatisticsService::class, ['tree' => $tree, 'user' => $user]);
+
+		return $this->viewResponse($this->module->name() . '::statistics-page', [
+			'module_name'       =>  $this->module->name(),
+			'title'             =>  I18N::translate('Sosa Statistics'),
+			'tree'              =>  $tree,
+			'theme'             =>  app(ModuleThemeInterface::class),
+			'root_indi'         =>  $sosa_stats_service->rootIndividual(),
+			'general_stats'     =>  $this->statisticsGeneral($sosa_stats_service),
+			'generation_stats'  =>  $this->statisticsByGenerations($sosa_stats_service),
+			'generation_depth'  =>  $sosa_stats_service->generationDepthStatsAtGeneration(1)->first(),
+			'multiple_sosas'    =>  $sosa_stats_service->topMultipleAncestorsWithNoTies(10)->groupBy('sosa_count'),
+			'sosa_dispersion_g2' =>  $sosa_stats_service->ancestorsDispersionForGeneration(2),
+			'sosa_dispersion_g3' =>  $sosa_stats_service->ancestorsDispersionForGeneration(3),
+			'gen_depth_g3'      =>  $sosa_stats_service->generationDepthStatsAtGeneration(3),
+			'relationship_service'  =>  $this->relationship_service,
+		]);
+	}
+
+	/**
+	 * Retrieve and compute the global statistics of ancestors for the tree.
+	 * Statistics include the number of ancestors, the number of different ancestors, pedigree collapse...
+	 *
+	 * @param SosaStatisticsService $sosa_stats_service
+	 * @return array<string, int|float>
+	 */
+	private function statisticsGeneral(SosaStatisticsService $sosa_stats_service): array
+	{
+		$ancestors_count = $sosa_stats_service->totalAncestors();
+		$ancestors_distinct_count = $sosa_stats_service->totalDistinctAncestors();
+		$individual_count = $sosa_stats_service->totalIndividuals();
+
+		return [
+			'sosa_count'    =>  $ancestors_count,
+			'distinct_count'    =>  $ancestors_distinct_count,
+			'sosa_rate' =>  $this->safeDivision(
+				BigInteger::of($ancestors_distinct_count),
+				BigInteger::of($individual_count)
+			),
+			'mean_gen_time'         =>  $sosa_stats_service->meanGenerationTime()
+		];
+	}
+
+	/**
+	 * Retrieve and compute the statistics of ancestors by generations.
+	 * Statistics include the number of ancestors, the number of different ancestors, cumulative statistics...
+	 *
+	 * @param SosaStatisticsService $sosa_stats_service
+	 * @return array<int, array<string, int|float>>
+	 */
+	private function statisticsByGenerations(SosaStatisticsService $sosa_stats_service): array
+	{
+		$stats_by_gen = $sosa_stats_service->statisticsByGenerations();
+
+		$generation_stats = array();
+
+		foreach ($stats_by_gen as $gen => $stats_gen) {
+			$gen_diff = $gen > 1 ?
+				(int) $stats_gen['diffSosaTotalCount'] - (int) $stats_by_gen[$gen - 1]['diffSosaTotalCount'] :
+				1;
+			$generation_stats[$gen] = array(
+				'gen_min_birth' => $stats_gen['firstBirth'] ?? (int) $stats_gen['firstEstimatedBirth'],
+				'gen_max_birth' => $stats_gen['lastBirth'] ?? (int) $stats_gen['lastEstimatedBirth'],
+				'theoretical' => BigInteger::of(2)->power($gen - 1)->toInt(),
+				'known' => (int) $stats_gen['sosaCount'],
+				'perc_known' => $this->safeDivision(
+					BigInteger::of((int) $stats_gen['sosaCount']),
+					BigInteger::of(2)->power($gen - 1)
+				),
+				'missing' => $gen > 1 ?
+					2 * (int) $stats_by_gen[$gen - 1]['sosaCount'] - (int) $stats_gen['sosaCount'] :
+					0,
+				'perc_missing' => $gen > 1 ?
+					1 - $this->safeDivision(
+						BigInteger::of((int) $stats_gen['sosaCount']),
+						BigInteger::of(2 * (int) $stats_by_gen[$gen - 1]['sosaCount'])
+					) :
+					0,
+				'total_known' => (int) $stats_gen['sosaTotalCount'],
+				'perc_total_known' => $this->safeDivision(
+					BigInteger::of((int) $stats_gen['sosaTotalCount']),
+					BigInteger::of(2)->power($gen)->minus(1)
+				),
+				'different' => $gen_diff,
+				'perc_different' => $this->safeDivision(
+					BigInteger::of($gen_diff),
+					BigInteger::of((int) $stats_gen['sosaCount'])
+				),
+				'total_different' => (int) $stats_gen['diffSosaTotalCount']
+			);
+		}
+
+		return $generation_stats;
+	}
+
+	/**
+	 * Return the result of a division, and a default value if denominator is 0
+	 *
+	 * @param BigInteger $p Numerator
+	 * @param BigInteger $q Denominator
+	 * @param int $scale Rounding scale
+	 * @param float $default Value if denominator is 0
+	 * @return float
+	 */
+	private function safeDivision(BigInteger $p, BigInteger $q, int $scale = 10, float $default = 0): float
+	{
+		return $q->isZero() ? $default : $p->toBigDecimal()->dividedBy($q, $scale, RoundingMode::HALF_DOWN)->toFloat();
+	}
 }