jon48 / webtrees-lib

app/Module/PatronymicLineage/Model/LineageBuilder.php

Indentation +206 added lines, -206 removed lines

@@ -28,210 +28,210 @@
  */
 class LineageBuilder
 {
-    private string $surname;
-    private Tree $tree;
-    private ?IndividualListModule $indilist_module;
-
-    /**
-     * @var Collection<string, bool> $used_indis Individuals already processed
-     */
-    private Collection $used_indis;
-
-    /**
-     * Constructor for Lineage Builder
-     *
-     * @param string $surname Reference surname
-     * @param Tree $tree Gedcom tree
-     */
-    public function __construct($surname, Tree $tree, IndividualListModule $indilist_module)
-    {
-        $this->surname = $surname;
-        $this->tree = $tree;
-        $this->indilist_module = $indilist_module;
-        $this->used_indis = new Collection();
-    }
-
-    /**
-     * Build all patronymic lineages for the reference surname.
-     *
-     * @return Collection<LineageRootNode>|NULL List of root patronymic lineages
-     */
-    public function buildLineages(): ?Collection
-    {
-        if ($this->indilist_module === null) {
-            return null;
-        }
-
-        $indis = $this->indilist_module->individuals($this->tree, $this->surname, '', '', false, false, I18N::locale());
-        //Warning - the IndividualListModule returns a clone of individuals objects. Cannot be used for object equality
-        if (count($indis) == 0) {
-            return null;
-        }
-
-        $root_lineages = new Collection();
-
-        foreach ($indis as $indi) {
-            /** @var Individual $indi */
-            if ($this->used_indis->get($indi->xref(), false) === false) {
-                $indi_first = $this->getLineageRootIndividual($indi);
-                if ($indi_first !== null) {
-                    // The root lineage needs to be recreated from the Factory, to retrieve the proper object
-                    $indi_first = Registry::individualFactory()->make($indi_first->xref(), $this->tree);
-                }
-                if ($indi_first === null) {
-                    continue;
-                }
-                $this->used_indis->put($indi_first->xref(), true);
-                if ($indi_first->canShow()) {
-                    //Check if the root individual has brothers and sisters, without parents
-                    $indi_first_child_family = $indi_first->childFamilies()->first();
-                    if ($indi_first_child_family !== null) {
-                        $root_node = new LineageRootNode(null);
-                        $root_node->addFamily($indi_first_child_family);
-                    } else {
-                        $root_node = new LineageRootNode($indi_first);
-                    }
-                    $root_node = $this->buildLineage($root_node);
-                    $root_lineages->add($root_node);
-                }
-            }
-        }
-
-        return $root_lineages->sort(function (LineageRootNode $a, LineageRootNode $b) {
-
-            if ($a->numberChildNodes() == $b->numberChildNodes()) {
-                return 0;
-            }
-            return ($a->numberChildNodes() > $b->numberChildNodes()) ? -1 : 1;
-        });
-    }
-
-    /**
-     * Retrieve the root individual, from any individual, by recursion.
-     * The Root individual is the individual without a father, or without a mother holding the same name.
-     *
-     * @param Individual $indi
-     * @return Individual|NULL Root individual
-     */
-    private function getLineageRootIndividual(Individual $indi): ?Individual
-    {
-        $child_families = $indi->childFamilies();
-        if ($this->used_indis->get($indi->xref(), false) !== false) {
-            return null;
-        }
-
-        foreach ($child_families as $child_family) {
-            /** @var Family $child_family */
-            $child_family->husband();
-            if (($husb = $child_family->husband()) !== null) {
-                if ($husb->isPendingAddition() && $husb->privatizeGedcom(Auth::PRIV_HIDE) == '') {
-                    return $indi;
-                }
-                return $this->getLineageRootIndividual($husb);
-            } elseif (($wife = $child_family->wife()) !== null) {
-                if (!($wife->isPendingAddition() && $wife->privatizeGedcom(Auth::PRIV_HIDE) == '')) {
-                    $indi_surname = $indi->getAllNames()[$indi->getPrimaryName()]['surname'];
-                    $wife_surname = $wife->getAllNames()[$wife->getPrimaryName()]['surname'];
-                    if (
-                        $indi->canShowName()
-                        && $wife->canShowName()
-                        && I18N::comparator()($indi_surname, $wife_surname) == 0
-                    ) {
-                            return $this->getLineageRootIndividual($wife);
-                    }
-                }
-                return $indi;
-            }
-        }
-        return $indi;
-    }
-
-    /**
-     * Computes descendent Lineage from a node.
-     * Uses recursion to build the lineage tree
-     *
-     * @param LineageNode $node
-     * @return LineageNode Computed lineage
-     */
-    private function buildLineage(LineageNode $node): LineageNode
-    {
-        $indi_surname = '';
-
-        $indi_node = $node->individual();
-        if ($indi_node !== null) {
-            if ($node->families()->count() == 0) {
-                foreach ($indi_node->spouseFamilies() as $spouse_family) {
-                    $node->addFamily($spouse_family);
-                }
-            }
-
-            $indi_surname = $indi_node->getAllNames()[$indi_node->getPrimaryName()]['surname'] ?? '';
-            $node->rootNode()->addPlace($indi_node->getBirthPlace());
-
-            //Tag the individual as used
-            $this->used_indis->put($indi_node->xref(), true);
-        }
-
-        foreach ($node->families() as $family_node) {
-            /** @var Family $spouse_family */
-            $spouse_family = $family_node->family;
-            $spouse_surname = '';
-            $spouse = null;
-            if (
-                $indi_node !== null &&
-                ($spouse = $spouse_family->spouse($indi_node)) !== null && $spouse->canShowName()
-            ) {
-                $spouse_surname = $spouse->getAllNames()[$spouse->getPrimaryName()]['surname'] ?? '';
-            }
-
-            $nb_children = $nb_natural = 0;
-
-            foreach ($spouse_family->children() as $child) {
-                if (!($child->isPendingAddition() && $child->privatizeGedcom(Auth::PRIV_HIDE) == '')) {
-                    $child_surname = $child->getAllNames()[$child->getPrimaryName()]['surname'] ?? '';
-
-                    $nb_children++;
-                    if ($indi_node !== null && $indi_node->sex() == 'F') { //If the root individual is the mother
-                        //Print only lineages of children with the same surname as their mother
-                        //(supposing they are natural children)
-                        /** @psalm-suppress RedundantCondition */
-                        if (
-                            $spouse === null ||
-                            ($spouse_surname !== '' && I18N::comparator()($child_surname, $spouse_surname) != 0)
-                        ) {
-                            if (I18N::comparator()($child_surname, $indi_surname) == 0) {
-                                $nb_natural++;
-                                $node_child = new LineageNode($child, $node->rootNode());
-                                $node_child = $this->buildLineage($node_child);
-                                $node->addChild($spouse_family, $node_child);
-                            }
-                        }
-                    } else { //If the root individual is the father
-                        $nb_natural++;
-                        //Print if the children does not bear the same name as his mother
-                        //(and different from his father)
-                        if (
-                            mb_strlen($child_surname) == 0 ||
-                            mb_strlen($indi_surname) == 0 || mb_strlen($spouse_surname) == 0 ||
-                            I18N::comparator()($child_surname, $indi_surname) == 0 ||
-                            I18N::comparator()($child_surname, $spouse_surname) != 0
-                        ) {
-                            $node_child = new LineageNode($child, $node->rootNode());
-                            $node_child = $this->buildLineage($node_child);
-                        } else {
-                            $node_child = new LineageNode($child, $node->rootNode(), $child_surname);
-                        }
-                        $node->addChild($spouse_family, $node_child);
-                    }
-                }
-            }
-
-            //Do not print other children
-            if (($nb_children - $nb_natural) > 0) {
-                $node->addChild($spouse_family, null);
-            }
-        }
-
-        return $node;
-    }
+	private string $surname;
+	private Tree $tree;
+	private ?IndividualListModule $indilist_module;
+
+	/**
+	 * @var Collection<string, bool> $used_indis Individuals already processed
+	 */
+	private Collection $used_indis;
+
+	/**
+	 * Constructor for Lineage Builder
+	 *
+	 * @param string $surname Reference surname
+	 * @param Tree $tree Gedcom tree
+	 */
+	public function __construct($surname, Tree $tree, IndividualListModule $indilist_module)
+	{
+		$this->surname = $surname;
+		$this->tree = $tree;
+		$this->indilist_module = $indilist_module;
+		$this->used_indis = new Collection();
+	}
+
+	/**
+	 * Build all patronymic lineages for the reference surname.
+	 *
+	 * @return Collection<LineageRootNode>|NULL List of root patronymic lineages
+	 */
+	public function buildLineages(): ?Collection
+	{
+		if ($this->indilist_module === null) {
+			return null;
+		}
+
+		$indis = $this->indilist_module->individuals($this->tree, $this->surname, '', '', false, false, I18N::locale());
+		//Warning - the IndividualListModule returns a clone of individuals objects. Cannot be used for object equality
+		if (count($indis) == 0) {
+			return null;
+		}
+
+		$root_lineages = new Collection();
+
+		foreach ($indis as $indi) {
+			/** @var Individual $indi */
+			if ($this->used_indis->get($indi->xref(), false) === false) {
+				$indi_first = $this->getLineageRootIndividual($indi);
+				if ($indi_first !== null) {
+					// The root lineage needs to be recreated from the Factory, to retrieve the proper object
+					$indi_first = Registry::individualFactory()->make($indi_first->xref(), $this->tree);
+				}
+				if ($indi_first === null) {
+					continue;
+				}
+				$this->used_indis->put($indi_first->xref(), true);
+				if ($indi_first->canShow()) {
+					//Check if the root individual has brothers and sisters, without parents
+					$indi_first_child_family = $indi_first->childFamilies()->first();
+					if ($indi_first_child_family !== null) {
+						$root_node = new LineageRootNode(null);
+						$root_node->addFamily($indi_first_child_family);
+					} else {
+						$root_node = new LineageRootNode($indi_first);
+					}
+					$root_node = $this->buildLineage($root_node);
+					$root_lineages->add($root_node);
+				}
+			}
+		}
+
+		return $root_lineages->sort(function (LineageRootNode $a, LineageRootNode $b) {
+
+			if ($a->numberChildNodes() == $b->numberChildNodes()) {
+				return 0;
+			}
+			return ($a->numberChildNodes() > $b->numberChildNodes()) ? -1 : 1;
+		});
+	}
+
+	/**
+	 * Retrieve the root individual, from any individual, by recursion.
+	 * The Root individual is the individual without a father, or without a mother holding the same name.
+	 *
+	 * @param Individual $indi
+	 * @return Individual|NULL Root individual
+	 */
+	private function getLineageRootIndividual(Individual $indi): ?Individual
+	{
+		$child_families = $indi->childFamilies();
+		if ($this->used_indis->get($indi->xref(), false) !== false) {
+			return null;
+		}
+
+		foreach ($child_families as $child_family) {
+			/** @var Family $child_family */
+			$child_family->husband();
+			if (($husb = $child_family->husband()) !== null) {
+				if ($husb->isPendingAddition() && $husb->privatizeGedcom(Auth::PRIV_HIDE) == '') {
+					return $indi;
+				}
+				return $this->getLineageRootIndividual($husb);
+			} elseif (($wife = $child_family->wife()) !== null) {
+				if (!($wife->isPendingAddition() && $wife->privatizeGedcom(Auth::PRIV_HIDE) == '')) {
+					$indi_surname = $indi->getAllNames()[$indi->getPrimaryName()]['surname'];
+					$wife_surname = $wife->getAllNames()[$wife->getPrimaryName()]['surname'];
+					if (
+						$indi->canShowName()
+						&& $wife->canShowName()
+						&& I18N::comparator()($indi_surname, $wife_surname) == 0
+					) {
+							return $this->getLineageRootIndividual($wife);
+					}
+				}
+				return $indi;
+			}
+		}
+		return $indi;
+	}
+
+	/**
+	 * Computes descendent Lineage from a node.
+	 * Uses recursion to build the lineage tree
+	 *
+	 * @param LineageNode $node
+	 * @return LineageNode Computed lineage
+	 */
+	private function buildLineage(LineageNode $node): LineageNode
+	{
+		$indi_surname = '';
+
+		$indi_node = $node->individual();
+		if ($indi_node !== null) {
+			if ($node->families()->count() == 0) {
+				foreach ($indi_node->spouseFamilies() as $spouse_family) {
+					$node->addFamily($spouse_family);
+				}
+			}
+
+			$indi_surname = $indi_node->getAllNames()[$indi_node->getPrimaryName()]['surname'] ?? '';
+			$node->rootNode()->addPlace($indi_node->getBirthPlace());
+
+			//Tag the individual as used
+			$this->used_indis->put($indi_node->xref(), true);
+		}
+
+		foreach ($node->families() as $family_node) {
+			/** @var Family $spouse_family */
+			$spouse_family = $family_node->family;
+			$spouse_surname = '';
+			$spouse = null;
+			if (
+				$indi_node !== null &&
+				($spouse = $spouse_family->spouse($indi_node)) !== null && $spouse->canShowName()
+			) {
+				$spouse_surname = $spouse->getAllNames()[$spouse->getPrimaryName()]['surname'] ?? '';
+			}
+
+			$nb_children = $nb_natural = 0;
+
+			foreach ($spouse_family->children() as $child) {
+				if (!($child->isPendingAddition() && $child->privatizeGedcom(Auth::PRIV_HIDE) == '')) {
+					$child_surname = $child->getAllNames()[$child->getPrimaryName()]['surname'] ?? '';
+
+					$nb_children++;
+					if ($indi_node !== null && $indi_node->sex() == 'F') { //If the root individual is the mother
+						//Print only lineages of children with the same surname as their mother
+						//(supposing they are natural children)
+						/** @psalm-suppress RedundantCondition */
+						if (
+							$spouse === null ||
+							($spouse_surname !== '' && I18N::comparator()($child_surname, $spouse_surname) != 0)
+						) {
+							if (I18N::comparator()($child_surname, $indi_surname) == 0) {
+								$nb_natural++;
+								$node_child = new LineageNode($child, $node->rootNode());
+								$node_child = $this->buildLineage($node_child);
+								$node->addChild($spouse_family, $node_child);
+							}
+						}
+					} else { //If the root individual is the father
+						$nb_natural++;
+						//Print if the children does not bear the same name as his mother
+						//(and different from his father)
+						if (
+							mb_strlen($child_surname) == 0 ||
+							mb_strlen($indi_surname) == 0 || mb_strlen($spouse_surname) == 0 ||
+							I18N::comparator()($child_surname, $indi_surname) == 0 ||
+							I18N::comparator()($child_surname, $spouse_surname) != 0
+						) {
+							$node_child = new LineageNode($child, $node->rootNode());
+							$node_child = $this->buildLineage($node_child);
+						} else {
+							$node_child = new LineageNode($child, $node->rootNode(), $child_surname);
+						}
+						$node->addChild($spouse_family, $node_child);
+					}
+				}
+			}
+
+			//Do not print other children
+			if (($nb_children - $nb_natural) > 0) {
+				$node->addChild($spouse_family, null);
+			}
+		}
+
+		return $node;
+	}
 }

app/Contracts/Hooks/CustomSimpleTagEditorInterface.php

Indentation +33 added lines, -33 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-2021, 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-2021, Jonathan Jaubart
+  * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
+  */
 
 declare(strict_types=1);
 
@@ -21,31 +21,31 @@ 
  */
 interface CustomSimpleTagEditorInterface extends HookInterface
 {
-    /**
-     * Add the tag in the hierarchy of the expected tags
-     *
-     * @param array<string, mixed> $expected_tags
-     * @return array<string, mixed>
-     */
-    public function addExpectedTags(array $expected_tags): array;
+	/**
+	 * Add the tag in the hierarchy of the expected tags
+	 *
+	 * @param array<string, mixed> $expected_tags
+	 * @return array<string, mixed>
+	 */
+	public function addExpectedTags(array $expected_tags): array;
 
-    /**
-     * Try to get a label for a tag
-     *
-     * @param string $tag
-     * @return string
-     */
-    public function getLabel(string $tag): string;
+	/**
+	 * Try to get a label for a tag
+	 *
+	 * @param string $tag
+	 * @return string
+	 */
+	public function getLabel(string $tag): string;
 
-    /**
-     * Returns HTML code for editing the custom tag.
-     *
-     * @param string $tag
-     * @param string $id
-     * @param string $name
-     * @param string $value
-     * @param Tree $tree
-     * @return string
-     */
-    public function editForm(string $tag, string $id, string $name, string $value, Tree $tree): string;
+	/**
+	 * Returns HTML code for editing the custom tag.
+	 *
+	 * @param string $tag
+	 * @param string $id
+	 * @param string $name
+	 * @param string $value
+	 * @param Tree $tree
+	 * @return string
+	 */
+	public function editForm(string $tag, string $id, string $name, string $value, Tree $tree): string;
 }

app/Common/GeoDispersion/GeoAnalysis/GeoAnalysisResults.php

Indentation +91 added lines, -91 removed lines

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

app/Common/GeoDispersion/Config/GenericPlaceMapperConfig.php

Indentation +92 added lines, -92 removed lines

@@ -25,105 +25,105 @@
  */
 class GenericPlaceMapperConfig implements PlaceMapperConfigInterface
 {
-    /** @var array<string, mixed> $config */
-    private array $config = [];
+	/** @var array<string, mixed> $config */
+	private array $config = [];
 
-    /**
-     * Get the generic mapper's config
-     *
-     * @return array<string, mixed>
-     */
-    public function config(): array
-    {
-        return $this->config;
-    }
+	/**
+	 * Get the generic mapper's config
+	 *
+	 * @return array<string, mixed>
+	 */
+	public function config(): array
+	{
+		return $this->config;
+	}
 
-    /**
-     * Set the generic mapper's config
-     *
-     * @param array<string, mixed> $config
-     * @return $this
-     */
-    public function setConfig(array $config): self
-    {
-        $this->config = $config;
-        return $this;
-    }
+	/**
+	 * Set the generic mapper's config
+	 *
+	 * @param array<string, mixed> $config
+	 * @return $this
+	 */
+	public function setConfig(array $config): self
+	{
+		$this->config = $config;
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
-     */
-    public function get(string $key, $default = null)
-    {
-        return $this->config[$key] ?? $default;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::get()
+	 */
+	public function get(string $key, $default = null)
+	{
+		return $this->config[$key] ?? $default;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
-     */
-    public function has(string $key): bool
-    {
-        return key_exists($key, $this->config);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::has()
+	 */
+	public function has(string $key): bool
+	{
+		return key_exists($key, $this->config);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \JsonSerializable::jsonSerialize()
-     */
-    public function jsonSerialize()
-    {
-        return [
-            'class'     =>  get_class($this),
-            'config'    =>  $this->jsonSerializeConfig()
-        ];
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \JsonSerializable::jsonSerialize()
+	 */
+	public function jsonSerialize()
+	{
+		return [
+			'class'     =>  get_class($this),
+			'config'    =>  $this->jsonSerializeConfig()
+		];
+	}
 
-    /**
-     * Returns a representation of the mapper config compatible with Json serialisation
-     *
-     * @return mixed
-     */
-    public function jsonSerializeConfig()
-    {
-        return $this->config;
-    }
+	/**
+	 * Returns a representation of the mapper config compatible with Json serialisation
+	 *
+	 * @return mixed
+	 */
+	public function jsonSerializeConfig()
+	{
+		return $this->config;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
-     *
-     * @param mixed $config
-     * @return $this
-     */
-    public function jsonDeserialize($config): self
-    {
-        if (is_string($config)) {
-            return $this->jsonDeserialize(json_decode($config));
-        }
-        if (is_array($config)) {
-            return $this->setConfig($config);
-        }
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::jsonDeserialize()
+	 *
+	 * @param mixed $config
+	 * @return $this
+	 */
+	public function jsonDeserialize($config): self
+	{
+		if (is_string($config)) {
+			return $this->jsonDeserialize(json_decode($config));
+		}
+		if (is_array($config)) {
+			return $this->setConfig($config);
+		}
+		return $this;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::configContent()
-     */
-    public function configContent(ModuleInterface $module, Tree $tree): string
-    {
-        return '';
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::configContent()
+	 */
+	public function configContent(ModuleInterface $module, Tree $tree): string
+	{
+		return '';
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::withConfigUpdate()
-     * @return $this
-     */
-    public function withConfigUpdate(ServerRequestInterface $request): self
-    {
-        return $this;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\GeoDispersion\PlaceMapperConfigInterface::withConfigUpdate()
+	 * @return $this
+	 */
+	public function withConfigUpdate(ServerRequestInterface $request): self
+	{
+		return $this;
+	}
 }

app/Common/Tasks/TaskSchedule.php

Indentation +229 added lines, -229 removed lines

@@ -24,252 +24,252 @@
  */
 class TaskSchedule
 {
-    private int $id;
-    private bool $enabled;
-    private string $task_id;
-    private Carbon $last_run;
-    private bool $last_result;
-    private CarbonInterval $frequency;
-    private int $nb_occurrences;
-    private bool $is_running;
+	private int $id;
+	private bool $enabled;
+	private string $task_id;
+	private Carbon $last_run;
+	private bool $last_result;
+	private CarbonInterval $frequency;
+	private int $nb_occurrences;
+	private bool $is_running;
 
-    /**
-     * Constructor for TaskSchedule
-     *
-     * @param int $id Schedule ID
-     * @param string $task_id Task ID
-     * @param bool $enabled Is the schedule enabled
-     * @param Carbon $last_run Last successful run date/time
-     * @param bool $last_result Result of the last run
-     * @param CarbonInterval $frequency Schedule frequency
-     * @param int $nb_occurrences Number of remaining occurrences to be run
-     * @param bool $is_running Is the task currently running
-     */
-    public function __construct(
-        int $id,
-        string $task_id,
-        bool $enabled,
-        Carbon $last_run,
-        bool $last_result,
-        CarbonInterval $frequency,
-        int $nb_occurrences,
-        bool $is_running
-    ) {
-        $this->id = $id;
-        $this->task_id = $task_id;
-        $this->enabled = $enabled;
-        $this->last_run = $last_run;
-        $this->last_result = $last_result;
-        $this->frequency = $frequency;
-        $this->nb_occurrences = $nb_occurrences;
-        $this->is_running = $is_running;
-    }
+	/**
+	 * Constructor for TaskSchedule
+	 *
+	 * @param int $id Schedule ID
+	 * @param string $task_id Task ID
+	 * @param bool $enabled Is the schedule enabled
+	 * @param Carbon $last_run Last successful run date/time
+	 * @param bool $last_result Result of the last run
+	 * @param CarbonInterval $frequency Schedule frequency
+	 * @param int $nb_occurrences Number of remaining occurrences to be run
+	 * @param bool $is_running Is the task currently running
+	 */
+	public function __construct(
+		int $id,
+		string $task_id,
+		bool $enabled,
+		Carbon $last_run,
+		bool $last_result,
+		CarbonInterval $frequency,
+		int $nb_occurrences,
+		bool $is_running
+	) {
+		$this->id = $id;
+		$this->task_id = $task_id;
+		$this->enabled = $enabled;
+		$this->last_run = $last_run;
+		$this->last_result = $last_result;
+		$this->frequency = $frequency;
+		$this->nb_occurrences = $nb_occurrences;
+		$this->is_running = $is_running;
+	}
 
-    /**
-     * Get the schedule ID.
-     *
-     * @return int
-     */
-    public function id(): int
-    {
-        return $this->id;
-    }
+	/**
+	 * Get the schedule ID.
+	 *
+	 * @return int
+	 */
+	public function id(): int
+	{
+		return $this->id;
+	}
 
-    /**
-     * Get the task ID.
-     *
-     * @return string
-     */
-    public function taskId(): string
-    {
-        return $this->task_id;
-    }
+	/**
+	 * Get the task ID.
+	 *
+	 * @return string
+	 */
+	public function taskId(): string
+	{
+		return $this->task_id;
+	}
 
-    /**
-     * Returns whether the schedule is enabled
-     *
-     * @return bool
-     */
-    public function isEnabled(): bool
-    {
-        return $this->enabled;
-    }
+	/**
+	 * Returns whether the schedule is enabled
+	 *
+	 * @return bool
+	 */
+	public function isEnabled(): bool
+	{
+		return $this->enabled;
+	}
 
-    /**
-     * Enable the schedule
-     *
-     * @return $this
-     */
-    public function enable(): self
-    {
-        $this->enabled = true;
-        return $this;
-    }
+	/**
+	 * Enable the schedule
+	 *
+	 * @return $this
+	 */
+	public function enable(): self
+	{
+		$this->enabled = true;
+		return $this;
+	}
 
-    /**
-     * Disable the schedule
-     *
-     * @return $this
-     */
-    public function disable(): self
-    {
-        $this->enabled = false;
-        return $this;
-    }
+	/**
+	 * Disable the schedule
+	 *
+	 * @return $this
+	 */
+	public function disable(): self
+	{
+		$this->enabled = false;
+		return $this;
+	}
 
-    /**
-     * Get the frequency of the schedule
-     *
-     * @return CarbonInterval
-     */
-    public function frequency(): CarbonInterval
-    {
-        return $this->frequency;
-    }
+	/**
+	 * Get the frequency of the schedule
+	 *
+	 * @return CarbonInterval
+	 */
+	public function frequency(): CarbonInterval
+	{
+		return $this->frequency;
+	}
 
-    /**
-     * Set the frequency of the schedule
-     *
-     * @param CarbonInterval $frequency
-     * @return $this
-     */
-    public function setFrequency(CarbonInterval $frequency): self
-    {
-        $this->frequency = $frequency;
-        return $this;
-    }
+	/**
+	 * Set the frequency of the schedule
+	 *
+	 * @param CarbonInterval $frequency
+	 * @return $this
+	 */
+	public function setFrequency(CarbonInterval $frequency): self
+	{
+		$this->frequency = $frequency;
+		return $this;
+	}
 
-    /**
-     * Get the date/time of the last successful run.
-     *
-     * @return Carbon
-     */
-    public function lastRunTime(): Carbon
-    {
-        return $this->last_run;
-    }
+	/**
+	 * Get the date/time of the last successful run.
+	 *
+	 * @return Carbon
+	 */
+	public function lastRunTime(): Carbon
+	{
+		return $this->last_run;
+	}
 
-    /**
-     * Set the last successful run date/time
-     *
-     * @param Carbon $last_run
-     * @return $this
-     */
-    public function setLastRunTime(Carbon $last_run): self
-    {
-        $this->last_run = $last_run;
-        return $this;
-    }
+	/**
+	 * Set the last successful run date/time
+	 *
+	 * @param Carbon $last_run
+	 * @return $this
+	 */
+	public function setLastRunTime(Carbon $last_run): self
+	{
+		$this->last_run = $last_run;
+		return $this;
+	}
 
-    /**
-     * Returns whether the last run was successful
-     *
-     * @return bool
-     */
-    public function wasLastRunSuccess(): bool
-    {
-        return $this->last_result;
-    }
+	/**
+	 * Returns whether the last run was successful
+	 *
+	 * @return bool
+	 */
+	public function wasLastRunSuccess(): bool
+	{
+		return $this->last_result;
+	}
 
-    /**
-     * Set the last run result
-     *
-     * @param bool $last_result
-     * @return $this
-     */
-    public function setLastResult(bool $last_result): self
-    {
-        $this->last_result = $last_result;
-        return $this;
-    }
+	/**
+	 * Set the last run result
+	 *
+	 * @param bool $last_result
+	 * @return $this
+	 */
+	public function setLastResult(bool $last_result): self
+	{
+		$this->last_result = $last_result;
+		return $this;
+	}
 
-    /**
-     * Get the number of remaining of occurrences of task runs.
-     * Returns 0 if the tasks must be run indefinitely.
-     *
-     * @return int
-     */
-    public function remainingOccurences(): int
-    {
-        return $this->nb_occurrences;
-    }
+	/**
+	 * Get the number of remaining of occurrences of task runs.
+	 * Returns 0 if the tasks must be run indefinitely.
+	 *
+	 * @return int
+	 */
+	public function remainingOccurences(): int
+	{
+		return $this->nb_occurrences;
+	}
 
-    /**
-     * Decrements the number of remaining occurences by 1.
-     * The task will be disabled when the number reaches 0.
-     *
-     * @return $this
-     */
-    public function decrementRemainingOccurences(): self
-    {
-        if ($this->nb_occurrences > 0) {
-            $this->nb_occurrences--;
-            if ($this->nb_occurrences == 0) {
-                $this->disable();
-            }
-        }
-        return $this;
-    }
+	/**
+	 * Decrements the number of remaining occurences by 1.
+	 * The task will be disabled when the number reaches 0.
+	 *
+	 * @return $this
+	 */
+	public function decrementRemainingOccurences(): self
+	{
+		if ($this->nb_occurrences > 0) {
+			$this->nb_occurrences--;
+			if ($this->nb_occurrences == 0) {
+				$this->disable();
+			}
+		}
+		return $this;
+	}
 
-    /**
-     * Set the number of remaining occurences of task runs.
-     *
-     * @param int $nb_occurrences
-     * @return $this
-     */
-    public function setRemainingOccurences(int $nb_occurrences): self
-    {
-        $this->nb_occurrences = $nb_occurrences;
-        return $this;
-    }
+	/**
+	 * Set the number of remaining occurences of task runs.
+	 *
+	 * @param int $nb_occurrences
+	 * @return $this
+	 */
+	public function setRemainingOccurences(int $nb_occurrences): self
+	{
+		$this->nb_occurrences = $nb_occurrences;
+		return $this;
+	}
 
-    /**
-     * Returns whether the task is running
-     * @return bool
-     */
-    public function isRunning(): bool
-    {
-        return $this->is_running;
-    }
+	/**
+	 * Returns whether the task is running
+	 * @return bool
+	 */
+	public function isRunning(): bool
+	{
+		return $this->is_running;
+	}
 
-    /**
-     * Informs the schedule that the task is going to run
-     *
-     * @return $this
-     */
-    public function startRunning(): self
-    {
-        $this->is_running = true;
-        return $this;
-    }
+	/**
+	 * Informs the schedule that the task is going to run
+	 *
+	 * @return $this
+	 */
+	public function startRunning(): self
+	{
+		$this->is_running = true;
+		return $this;
+	}
 
-    /**
-     * Informs the schedule that the task has stopped running.
-     * @return $this
-     */
-    public function stopRunning(): self
-    {
-        $this->is_running = false;
-        return $this;
-    }
+	/**
+	 * Informs the schedule that the task has stopped running.
+	 * @return $this
+	 */
+	public function stopRunning(): self
+	{
+		$this->is_running = false;
+		return $this;
+	}
 
-    /**
-     * Returns the schedule details as an associate array
-     *
-     * @phpcs:ignore Generic.Files.LineLength.TooLong
-     * @return array{id: int, task_id: string, enabled: bool, last_run: Carbon, last_result: bool, frequency: CarbonInterval, nb_occurrences: int, is_running: bool}
-     */
-    public function toArray(): array
-    {
-        return [
-            'id'            =>  $this->id,
-            'task_id'       =>  $this->task_id,
-            'enabled'       =>  $this->enabled,
-            'last_run'      =>  $this->last_run,
-            'last_result'   =>  $this->last_result,
-            'frequency'     =>  $this->frequency,
-            'nb_occurrences' =>  $this->nb_occurrences,
-            'is_running'    =>  $this->is_running
-        ];
-    }
+	/**
+	 * Returns the schedule details as an associate array
+	 *
+	 * @phpcs:ignore Generic.Files.LineLength.TooLong
+	 * @return array{id: int, task_id: string, enabled: bool, last_run: Carbon, last_result: bool, frequency: CarbonInterval, nb_occurrences: int, is_running: bool}
+	 */
+	public function toArray(): array
+	{
+		return [
+			'id'            =>  $this->id,
+			'task_id'       =>  $this->task_id,
+			'enabled'       =>  $this->enabled,
+			'last_run'      =>  $this->last_run,
+			'last_result'   =>  $this->last_result,
+			'frequency'     =>  $this->frequency,
+			'nb_occurrences' =>  $this->nb_occurrences,
+			'is_running'    =>  $this->is_running
+		];
+	}
 }

app/Common/Hooks/AbstractHookCollector.php

Indentation +65 added lines, -65 removed lines

@@ -28,78 +28,78 @@
  */
 abstract class AbstractHookCollector implements HookCollectorInterface, HookInterface
 {
-    /** @var Collection<THook> $hooks */
-    protected Collection $hooks;
+	/** @var Collection<THook> $hooks */
+	protected Collection $hooks;
 
-    private ModuleInterface $module;
+	private ModuleInterface $module;
 
-    /**
-     * Constructor for AbstractHookCollector
-     *
-     * @param ModuleInterface $module
-     */
-    public function __construct(ModuleInterface $module)
-    {
-        $this->hooks = new Collection();
-        $this->module = $module;
-    }
+	/**
+	 * Constructor for AbstractHookCollector
+	 *
+	 * @param ModuleInterface $module
+	 */
+	public function __construct(ModuleInterface $module)
+	{
+		$this->hooks = new Collection();
+		$this->module = $module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
-     */
-    public function module(): ModuleInterface
-    {
-        return $this->module;
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookInterface::module()
+	 */
+	public function module(): ModuleInterface
+	{
+		return $this->module;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::name()
-     */
-    public function name(): string
-    {
-        return $this->module->name() . '-' .
-            mb_substr(str_replace('collector', '', mb_strtolower((new ReflectionClass($this))->getShortName())), 0, 64);
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::name()
+	 */
+	public function name(): string
+	{
+		return $this->module->name() . '-' .
+			mb_substr(str_replace('collector', '', mb_strtolower((new ReflectionClass($this))->getShortName())), 0, 64);
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::title()
-     */
-    abstract public function title(): string;
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::title()
+	 */
+	abstract public function title(): string;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::description()
-     */
-    abstract public function description(): string;
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::description()
+	 */
+	abstract public function description(): string;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hookInterface()
-     */
-    abstract public function hookInterface(): string;
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hookInterface()
+	 */
+	abstract public function hookInterface(): string;
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::register()
-     */
-    public function register(HookInterface $hook_instance, int $order): void
-    {
-        if ($this->hooks->has($order)) {
-            $this->hooks->splice($order + 1, 0, [$hook_instance]);
-        } else {
-            $this->hooks->put($order, $hook_instance);
-        }
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::register()
+	 */
+	public function register(HookInterface $hook_instance, int $order): void
+	{
+		if ($this->hooks->has($order)) {
+			$this->hooks->splice($order + 1, 0, [$hook_instance]);
+		} else {
+			$this->hooks->put($order, $hook_instance);
+		}
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hooks()
-     */
-    public function hooks(): Collection
-    {
-        return $this->hooks->sortKeys();
-    }
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Contracts\Hooks\HookCollectorInterface::hooks()
+	 */
+	public function hooks(): Collection
+	{
+		return $this->hooks->sortKeys();
+	}
 }