jon48 / webtrees-lib

src/Webtrees/Module/PatronymicLineage/Model/LineageBuilder.php

Indentation +216 added lines, -216 removed lines

@@ -29,220 +29,220 @@
 class LineageBuilder
 {
 
-    /**
-     * @var string $surname Reference surname
-     */
-    private $surname;
-
-    /**
-     * @var Tree $tree Reference tree
-     */
-    private $tree;
-
-    /**
-     * @var IndividualListModule $indilist_module
-     */
-    private $indilist_module;
-
-    /**
-     * @var Collection $used_indis Individuals already processed
-     */
-    private $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|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::strcasecmp($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)
-                        if (
-                            $spouse === null ||
-                            ($spouse_surname !== '' && I18N::strcasecmp($child_surname, $spouse_surname) != 0)
-                        ) {
-                            if (I18N::strcasecmp($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::strcasecmp($child_surname, $indi_surname) == 0 ||
-                            I18N::strcasecmp($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;
-    }
+	/**
+	 * @var string $surname Reference surname
+	 */
+	private $surname;
+
+	/**
+	 * @var Tree $tree Reference tree
+	 */
+	private $tree;
+
+	/**
+	 * @var IndividualListModule $indilist_module
+	 */
+	private $indilist_module;
+
+	/**
+	 * @var Collection $used_indis Individuals already processed
+	 */
+	private $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|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::strcasecmp($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)
+						if (
+							$spouse === null ||
+							($spouse_surname !== '' && I18N::strcasecmp($child_surname, $spouse_surname) != 0)
+						) {
+							if (I18N::strcasecmp($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::strcasecmp($child_surname, $indi_surname) == 0 ||
+							I18N::strcasecmp($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;
+	}
 }

src/Webtrees/Module/PatronymicLineage/Model/LineageNode.php

Indentation +113 added lines, -113 removed lines

@@ -25,117 +25,117 @@
 class LineageNode
 {
 
-    /**
-     * @var Collection $linked_fams Spouse families linked to the node
-     */
-    private $linked_fams;
-
-    /**
-     * @var ?Individual $node_indi Reference individual for the node
-     */
-    private $node_indi;
-
-    /**
-     * @var LineageRootNode $root_node Root node of the lineage
-     */
-    private $root_node;
-
-    /**
-     * @var ?string $alt_surname Linked surname, used to link to another lineage
-     */
-    private $alt_surname;
-
-    /**
-     * Constructor for Lineage node
-     *
-     * @param Individual $node_indi Main individual
-     * @param LineageRootNode $root_node Node of the lineage root
-     * @param null|string $alt_surname Follow-up surname
-     */
-    public function __construct(?Individual $node_indi = null, LineageRootNode $root_node, $alt_surname = null)
-    {
-        $this->node_indi = $node_indi;
-        $this->root_node = $root_node;
-        $this->alt_surname = $alt_surname;
-        $this->linked_fams = new Collection();
-    }
-
-    /**
-     * Add a spouse family to the node
-     *
-     * @param Family $fams
-     * @return stdClass
-     */
-    public function addFamily(Family $fams): object
-    {
-        if (!$this->linked_fams->has($fams->xref())) {
-            $this->linked_fams->put($fams->xref(), (object) [
-                'family'   =>  $fams,
-                'children' =>  new Collection()
-            ]);
-        }
-        return $this->linked_fams->get($fams->xref());
-    }
-
-    /**
-     * Add a child LineageNode to the node
-     *
-     * @param Family $fams
-     * @param LineageNode $child
-     */
-    public function addChild(Family $fams, LineageNode $child = null): void
-    {
-        $this->addFamily($fams)->children->push($child);
-        $this->root_node->incrementChildNodes();
-    }
-
-    /**
-     * Returns the node individual
-     *
-     * @return Individual|NULL
-     */
-    public function individual(): ?Individual
-    {
-        return $this->node_indi;
-    }
-
-    /**
-     * Returns the lineage root node individual
-     *
-     * @return LineageRootNode
-     */
-    public function rootNode(): LineageRootNode
-    {
-        return $this->root_node;
-    }
-
-    /**
-     * Returns the spouse families linked to the node
-     *
-     * @return Collection
-     */
-    public function families(): Collection
-    {
-        return $this->linked_fams;
-    }
-
-    /**
-     * Returns the follow-up surname
-     *
-     * @return string
-     */
-    public function followUpSurname(): string
-    {
-        return $this->alt_surname ?? '';
-    }
-
-    /**
-     * Indicates whether the node has a follow up surname
-     *
-     * @return boolean
-     */
-    public function hasFollowUpSurname(): bool
-    {
-        return mb_strlen($this->followUpSurname()) > 0 ;
-    }
+	/**
+	 * @var Collection $linked_fams Spouse families linked to the node
+	 */
+	private $linked_fams;
+
+	/**
+	 * @var ?Individual $node_indi Reference individual for the node
+	 */
+	private $node_indi;
+
+	/**
+	 * @var LineageRootNode $root_node Root node of the lineage
+	 */
+	private $root_node;
+
+	/**
+	 * @var ?string $alt_surname Linked surname, used to link to another lineage
+	 */
+	private $alt_surname;
+
+	/**
+	 * Constructor for Lineage node
+	 *
+	 * @param Individual $node_indi Main individual
+	 * @param LineageRootNode $root_node Node of the lineage root
+	 * @param null|string $alt_surname Follow-up surname
+	 */
+	public function __construct(?Individual $node_indi = null, LineageRootNode $root_node, $alt_surname = null)
+	{
+		$this->node_indi = $node_indi;
+		$this->root_node = $root_node;
+		$this->alt_surname = $alt_surname;
+		$this->linked_fams = new Collection();
+	}
+
+	/**
+	 * Add a spouse family to the node
+	 *
+	 * @param Family $fams
+	 * @return stdClass
+	 */
+	public function addFamily(Family $fams): object
+	{
+		if (!$this->linked_fams->has($fams->xref())) {
+			$this->linked_fams->put($fams->xref(), (object) [
+				'family'   =>  $fams,
+				'children' =>  new Collection()
+			]);
+		}
+		return $this->linked_fams->get($fams->xref());
+	}
+
+	/**
+	 * Add a child LineageNode to the node
+	 *
+	 * @param Family $fams
+	 * @param LineageNode $child
+	 */
+	public function addChild(Family $fams, LineageNode $child = null): void
+	{
+		$this->addFamily($fams)->children->push($child);
+		$this->root_node->incrementChildNodes();
+	}
+
+	/**
+	 * Returns the node individual
+	 *
+	 * @return Individual|NULL
+	 */
+	public function individual(): ?Individual
+	{
+		return $this->node_indi;
+	}
+
+	/**
+	 * Returns the lineage root node individual
+	 *
+	 * @return LineageRootNode
+	 */
+	public function rootNode(): LineageRootNode
+	{
+		return $this->root_node;
+	}
+
+	/**
+	 * Returns the spouse families linked to the node
+	 *
+	 * @return Collection
+	 */
+	public function families(): Collection
+	{
+		return $this->linked_fams;
+	}
+
+	/**
+	 * Returns the follow-up surname
+	 *
+	 * @return string
+	 */
+	public function followUpSurname(): string
+	{
+		return $this->alt_surname ?? '';
+	}
+
+	/**
+	 * Indicates whether the node has a follow up surname
+	 *
+	 * @return boolean
+	 */
+	public function hasFollowUpSurname(): bool
+	{
+		return mb_strlen($this->followUpSurname()) > 0 ;
+	}
 }

src/Webtrees/Module/PatronymicLineage/Http/RequestHandlers/LineagesPage.php

Indentation +65 added lines, -65 removed lines

@@ -31,69 +31,69 @@
  */
 class LineagesPage implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
-
-    /**
-     * @var PatronymicLineageModule $module
-     */
-    private $module;
-
-    /**
-     * @var IndividualListModule $indilist_module
-     */
-    private $indilist_module;
-
-    /**
-     * Constructor for LineagesPage Request handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
-        $this->indilist_module = $module_service->findByInterface(IndividualListModule::class)->first();
-    }
-
-    /**
-     * {@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.'));
-        }
-
-        if ($this->indilist_module === null) {
-            throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
-        }
-
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
-
-        $surname = $request->getAttribute('surname');
-
-        $initial = mb_substr($surname, 0, 1);
-        $initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
-            ->reject(function ($count, $initial): bool {
-
-                return $initial === '@' || $initial === ',';
-            });
-
-        $title = I18N::translate('Patronymic Lineages') . ' — ' . $surname;
-
-        $lineages = app()->make(LineageBuilder::class, ['surname' => $surname])->buildLineages();
-
-        return $this->viewResponse($this->module->name() . '::lineages-page', [
-            'title'         =>  $title,
-            'module'        =>  $this->module,
-            'tree'          =>  $tree,
-            'initials_list' =>  $initials_list,
-            'initial'       =>  $initial,
-            'show_all'      =>  'no',
-            'surname'       =>  $surname,
-            'lineages'      =>  $lineages,
-            'nb_lineages'   =>  $lineages !== null ? $lineages->count() : 0
-        ]);
-    }
+	use ViewResponseTrait;
+
+	/**
+	 * @var PatronymicLineageModule $module
+	 */
+	private $module;
+
+	/**
+	 * @var IndividualListModule $indilist_module
+	 */
+	private $indilist_module;
+
+	/**
+	 * Constructor for LineagesPage Request handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
+		$this->indilist_module = $module_service->findByInterface(IndividualListModule::class)->first();
+	}
+
+	/**
+	 * {@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.'));
+		}
+
+		if ($this->indilist_module === null) {
+			throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
+		}
+
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
+
+		$surname = $request->getAttribute('surname');
+
+		$initial = mb_substr($surname, 0, 1);
+		$initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
+			->reject(function ($count, $initial): bool {
+
+				return $initial === '@' || $initial === ',';
+			});
+
+		$title = I18N::translate('Patronymic Lineages') . ' — ' . $surname;
+
+		$lineages = app()->make(LineageBuilder::class, ['surname' => $surname])->buildLineages();
+
+		return $this->viewResponse($this->module->name() . '::lineages-page', [
+			'title'         =>  $title,
+			'module'        =>  $this->module,
+			'tree'          =>  $tree,
+			'initials_list' =>  $initials_list,
+			'initial'       =>  $initial,
+			'show_all'      =>  'no',
+			'surname'       =>  $surname,
+			'lineages'      =>  $lineages,
+			'nb_lineages'   =>  $lineages !== null ? $lineages->count() : 0
+		]);
+	}
 }

src/Webtrees/Module/PatronymicLineage/Http/RequestHandlers/SurnamesList.php

Indentation +70 added lines, -70 removed lines

@@ -30,74 +30,74 @@
  */
 class SurnamesList implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
-
-    /**
-     * @var PatronymicLineageModule $module
-     */
-    private $module;
-
-    /**
-     * @var IndividualListModule $indilist_module
-     */
-    private $indilist_module;
-
-    /**
-     * Constructor for SurnamesList Request Handler
-     *
-     * @param ModuleService $module_service
-     */
-    public function __construct(ModuleService $module_service)
-    {
-        $this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
-        $this->indilist_module = $module_service->findByInterface(IndividualListModule::class)->first();
-    }
-
-    /**
-     * {@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.'));
-        }
-
-        if ($this->indilist_module === null) {
-            throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
-        }
-
-        $tree = $request->getAttribute('tree');
-        assert($tree instanceof Tree);
-
-        $initial = $request->getAttribute('alpha');
-        $initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
-            ->reject(function ($count, $initial): bool {
-
-                return $initial === '@' || $initial === ',';
-            });
-
-        $show_all = $request->getQueryParams()['show_all'] ?? 'no';
-
-        if ($show_all === 'yes') {
-            $title = I18N::translate('Patronymic Lineages') . ' — ' . I18N::translate('All');
-            $surnames = $this->indilist_module->surnames($tree, '', '', false, false, I18N::locale());
-        } elseif ($initial !== null && mb_strlen($initial) == 1) {
-            $title = I18N::translate('Patronymic Lineages') . ' — ' . $initial;
-            $surnames = $this->indilist_module->surnames($tree, '', $initial, false, false, I18N::locale());
-        } else {
-            $title =  I18N::translate('Patronymic Lineages');
-            $surnames = [];
-        }
-
-        return $this->viewResponse($this->module->name() . '::surnames-page', [
-            'title'         =>  $title,
-            'module'        =>  $this->module,
-            'tree'          =>  $tree,
-            'initials_list' =>  $initials_list,
-            'initial'       =>  $initial,
-            'show_all'      =>  $show_all,
-            'surnames'      =>  $surnames
-        ]);
-    }
+	use ViewResponseTrait;
+
+	/**
+	 * @var PatronymicLineageModule $module
+	 */
+	private $module;
+
+	/**
+	 * @var IndividualListModule $indilist_module
+	 */
+	private $indilist_module;
+
+	/**
+	 * Constructor for SurnamesList Request Handler
+	 *
+	 * @param ModuleService $module_service
+	 */
+	public function __construct(ModuleService $module_service)
+	{
+		$this->module = $module_service->findByInterface(PatronymicLineageModule::class)->first();
+		$this->indilist_module = $module_service->findByInterface(IndividualListModule::class)->first();
+	}
+
+	/**
+	 * {@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.'));
+		}
+
+		if ($this->indilist_module === null) {
+			throw new HttpNotFoundException(I18N::translate('There is no module to handle individual lists.'));
+		}
+
+		$tree = $request->getAttribute('tree');
+		assert($tree instanceof Tree);
+
+		$initial = $request->getAttribute('alpha');
+		$initials_list = collect($this->indilist_module->surnameAlpha($tree, false, false, I18N::locale()))
+			->reject(function ($count, $initial): bool {
+
+				return $initial === '@' || $initial === ',';
+			});
+
+		$show_all = $request->getQueryParams()['show_all'] ?? 'no';
+
+		if ($show_all === 'yes') {
+			$title = I18N::translate('Patronymic Lineages') . ' — ' . I18N::translate('All');
+			$surnames = $this->indilist_module->surnames($tree, '', '', false, false, I18N::locale());
+		} elseif ($initial !== null && mb_strlen($initial) == 1) {
+			$title = I18N::translate('Patronymic Lineages') . ' — ' . $initial;
+			$surnames = $this->indilist_module->surnames($tree, '', $initial, false, false, I18N::locale());
+		} else {
+			$title =  I18N::translate('Patronymic Lineages');
+			$surnames = [];
+		}
+
+		return $this->viewResponse($this->module->name() . '::surnames-page', [
+			'title'         =>  $title,
+			'module'        =>  $this->module,
+			'tree'          =>  $tree,
+			'initials_list' =>  $initials_list,
+			'initial'       =>  $initial,
+			'show_all'      =>  $show_all,
+			'surnames'      =>  $surnames
+		]);
+	}
 }

src/Webtrees/Module/PatronymicLineage/PatronymicLineageModule.php

Indentation +91 added lines, -91 removed lines

@@ -33,95 +33,95 @@
  */
 class PatronymicLineageModule extends AbstractModuleMaj implements ModuleListInterface, ModuleGlobalInterface
 {
-    use ModuleListTrait;
-    use ModuleGlobalTrait;
-
-     /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return /* I18N: Name of the “Patronymic lineage” module */ I18N::translate('Patronymic Lineages');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        //phpcs:ignore Generic.Files.LineLength.TooLong
-        return /* I18N: Description of the “Patronymic lineage” module */ I18N::translate('Display lineages of people holding the same surname.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/lineages', static function (Map $router): void {
-
-                $router->attach('', '/Page', static function (Map $router): void {
-
-                    $router->get(SurnamesList::class, '/{tree}/list{/alpha}', SurnamesList::class);
-                    $router->get(LineagesPage::class, '/{tree}/lineage/{surname}', LineagesPage::class);
-                });
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.7-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
-     */
-    public function listUrl(Tree $tree, array $parameters = []): string
-    {
-        $surname = $parameters['surname'] ?? '';
-
-        $xref = app(ServerRequestInterface::class)->getAttribute('xref', '');
-        if ($xref !== '' && ($individual = Registry::individualFactory()->make($xref, $tree)) !== null) {
-            $surname = $individual->getAllNames()[$individual->getPrimaryName()]['surname'];
-        }
-
-        if ($surname !== '') {
-            return route(LineagesPage::class, [
-                'tree'      =>  $tree->name(),
-                'surname'   =>  $surname
-            ] + $parameters);
-        }
-        return route(SurnamesList::class, [
-            'tree'  =>  $tree->name()
-        ] + $parameters);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
-     */
-    public function listMenuClass(): string
-    {
-        return 'menu-maj-patrolineage';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
-     */
-    public function headContent(): string
-    {
-        return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
-    }
+	use ModuleListTrait;
+	use ModuleGlobalTrait;
+
+	 /**
+	  * {@inheritDoc}
+	  * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	  */
+	public function title(): string
+	{
+		return /* I18N: Name of the “Patronymic lineage” module */ I18N::translate('Patronymic Lineages');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		//phpcs:ignore Generic.Files.LineLength.TooLong
+		return /* I18N: Description of the “Patronymic lineage” module */ I18N::translate('Display lineages of people holding the same surname.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/lineages', static function (Map $router): void {
+
+				$router->attach('', '/Page', static function (Map $router): void {
+
+					$router->get(SurnamesList::class, '/{tree}/list{/alpha}', SurnamesList::class);
+					$router->get(LineagesPage::class, '/{tree}/lineage/{surname}', LineagesPage::class);
+				});
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.7-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listUrl()
+	 */
+	public function listUrl(Tree $tree, array $parameters = []): string
+	{
+		$surname = $parameters['surname'] ?? '';
+
+		$xref = app(ServerRequestInterface::class)->getAttribute('xref', '');
+		if ($xref !== '' && ($individual = Registry::individualFactory()->make($xref, $tree)) !== null) {
+			$surname = $individual->getAllNames()[$individual->getPrimaryName()]['surname'];
+		}
+
+		if ($surname !== '') {
+			return route(LineagesPage::class, [
+				'tree'      =>  $tree->name(),
+				'surname'   =>  $surname
+			] + $parameters);
+		}
+		return route(SurnamesList::class, [
+			'tree'  =>  $tree->name()
+		] + $parameters);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleListInterface::listMenuClass()
+	 */
+	public function listMenuClass(): string
+	{
+		return 'menu-maj-patrolineage';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::headContent()
+	 */
+	public function headContent(): string
+	{
+		return '<link rel="stylesheet" href="' . e($this->moduleCssUrl()) . '">';
+	}
 }

src/Webtrees/Module/WelcomeBlock/Http/RequestHandlers/MatomoStats.php

Indentation +39 added lines, -39 removed lines

@@ -27,50 +27,50 @@
  */
 class MatomoStats implements RequestHandlerInterface
 {
-    use ViewResponseTrait;
+	use ViewResponseTrait;
 
-    /**
-     * @var WelcomeBlockModule
-     */
-    private $module;
+	/**
+	 * @var WelcomeBlockModule
+	 */
+	private $module;
 
-    /**
-     * @var MatomoStatsService $matomo_service
-     */
-    private $matomo_service;
+	/**
+	 * @var MatomoStatsService $matomo_service
+	 */
+	private $matomo_service;
 
-    /**
-     * Constructor for MatomoStats request handler
-     * @param ModuleService $module_service
-     * @param MatomoStatsService $matomo_service
-     */
-    public function __construct(
-        ModuleService $module_service,
-        MatomoStatsService $matomo_service
-    ) {
-        $this->module = $module_service->findByInterface(WelcomeBlockModule::class)->first();
-        $this->matomo_service = $matomo_service;
-    }
+	/**
+	 * Constructor for MatomoStats request handler
+	 * @param ModuleService $module_service
+	 * @param MatomoStatsService $matomo_service
+	 */
+	public function __construct(
+		ModuleService $module_service,
+		MatomoStatsService $matomo_service
+	) {
+		$this->module = $module_service->findByInterface(WelcomeBlockModule::class)->first();
+		$this->matomo_service = $matomo_service;
+	}
 
-    /**
-     * {@inheritDoc}
-     * @see \Psr\Http\Server\RequestHandlerInterface::handle()
-     */
-    public function handle(ServerRequestInterface $request): ResponseInterface
-    {
-        $this->layout = 'layouts/ajax';
+	/**
+	 * {@inheritDoc}
+	 * @see \Psr\Http\Server\RequestHandlerInterface::handle()
+	 */
+	public function handle(ServerRequestInterface $request): ResponseInterface
+	{
+		$this->layout = 'layouts/ajax';
 
-        $block_id = filter_var($request->getAttribute('block_id'), FILTER_VALIDATE_INT);
-        $nb_visits_year = $nb_visits_today = null;
+		$block_id = filter_var($request->getAttribute('block_id'), FILTER_VALIDATE_INT);
+		$nb_visits_year = $nb_visits_today = null;
 
-        if ($block_id !== false && $this->module->isMatomoEnabled($block_id)) {
-            $nb_visits_today = (int) $this->matomo_service->visitsToday($this->module, $block_id);
-            $nb_visits_year = (int) $this->matomo_service->visitsThisYear($this->module, $block_id) + $nb_visits_today;
-        }
+		if ($block_id !== false && $this->module->isMatomoEnabled($block_id)) {
+			$nb_visits_today = (int) $this->matomo_service->visitsToday($this->module, $block_id);
+			$nb_visits_year = (int) $this->matomo_service->visitsThisYear($this->module, $block_id) + $nb_visits_today;
+		}
 
-        return $this->viewResponse($this->module->name() . '::matomo-stats', [
-            'visits_year'   =>  $nb_visits_year,
-            'visits_today'  =>  $nb_visits_today
-        ]);
-    }
+		return $this->viewResponse($this->module->name() . '::matomo-stats', [
+			'visits_year'   =>  $nb_visits_year,
+			'visits_today'  =>  $nb_visits_today
+		]);
+	}
 }

src/Webtrees/Module/WelcomeBlock/WelcomeBlockModule.php

Indentation +153 added lines, -153 removed lines

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

src/Webtrees/Module/WelcomeBlock/Services/MatomoStatsService.php

Indentation +83 added lines, -83 removed lines

@@ -30,95 +30,95 @@
 class MatomoStatsService
 {
 
-    /**
-     * Returns the number of visits for the current year (up to the day before).
-     * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @return int|NULL
-     */
-    public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
-    {
-        $cache = Registry::cache()->file();
+	/**
+	 * Returns the number of visits for the current year (up to the day before).
+	 * That statistic is cached for the day, to avoid unecessary calls to Matomo API.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @return int|NULL
+	 */
+	public function visitsThisYear(WelcomeBlockModule $module, int $block_id): ?int
+	{
+		$cache = Registry::cache()->file();
 
-        return $cache->remember(
-            $module->name() . '-matomovisits-yearly-' . $block_id,
-            function () use ($module, $block_id): ?int {
-                $visits_year = $this->visits($module, $block_id, 'year');
-                if ($visits_year === null) {
-                    return null;
-                }
-                $visits_today = (int) $this->visits($module, $block_id, 'day');
+		return $cache->remember(
+			$module->name() . '-matomovisits-yearly-' . $block_id,
+			function () use ($module, $block_id): ?int {
+				$visits_year = $this->visits($module, $block_id, 'year');
+				if ($visits_year === null) {
+					return null;
+				}
+				$visits_today = (int) $this->visits($module, $block_id, 'day');
 
-                return $visits_year - $visits_today;
-            },
-            Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
-        );
-    }
+				return $visits_year - $visits_today;
+			},
+			Carbon::now()->addDay()->startOfDay()->diffInSeconds(Carbon::now()) // Valid until midnight
+		);
+	}
 
-    /**
-     * Returns the number of visits for the current day.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @return int|NULL
-     */
-    public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
-    {
-        return app('cache.array')->remember(
-            $module->name() . '-matomovisits-daily-' . $block_id,
-            function () use ($module, $block_id): ?int {
-                return $this->visits($module, $block_id, 'day');
-            }
-        );
-    }
+	/**
+	 * Returns the number of visits for the current day.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @return int|NULL
+	 */
+	public function visitsToday(WelcomeBlockModule $module, int $block_id): ?int
+	{
+		return app('cache.array')->remember(
+			$module->name() . '-matomovisits-daily-' . $block_id,
+			function () use ($module, $block_id): ?int {
+				return $this->visits($module, $block_id, 'day');
+			}
+		);
+	}
 
-    /**
-     * Invoke the Matomo API to retrieve the number of visits over a period.
-     *
-     * @param WelcomeBlockModule $module
-     * @param int $block_id
-     * @param string $period
-     * @return int|NULL
-     */
-    protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
-    {
-        $settings = $module->matomoSettings($block_id);
+	/**
+	 * Invoke the Matomo API to retrieve the number of visits over a period.
+	 *
+	 * @param WelcomeBlockModule $module
+	 * @param int $block_id
+	 * @param string $period
+	 * @return int|NULL
+	 */
+	protected function visits(WelcomeBlockModule $module, int $block_id, string $period): ?int
+	{
+		$settings = $module->matomoSettings($block_id);
 
-        if (
-            $settings['matomo_enabled'] === true
-            && mb_strlen($settings['matomo_url']) > 0
-            && mb_strlen($settings['matomo_token']) > 0
-            && $settings['matomo_siteid'] > 0
-        ) {
-            try {
-                $http_client = new Client([
-                    RequestOptions::TIMEOUT => 30
-                ]);
+		if (
+			$settings['matomo_enabled'] === true
+			&& mb_strlen($settings['matomo_url']) > 0
+			&& mb_strlen($settings['matomo_token']) > 0
+			&& $settings['matomo_siteid'] > 0
+		) {
+			try {
+				$http_client = new Client([
+					RequestOptions::TIMEOUT => 30
+				]);
 
-                $response = $http_client->get($settings['matomo_url'], [
-                    'query' =>  [
-                        'module'    =>  'API',
-                        'method'    =>  'VisitsSummary.getVisits',
-                        'idSite'    =>  $settings['matomo_siteid'],
-                        'period'    =>  $period,
-                        'date'      =>  'today',
-                        'token_auth' =>  $settings['matomo_token'],
-                        'format'    =>  'json'
-                    ]
-                ]);
+				$response = $http_client->get($settings['matomo_url'], [
+					'query' =>  [
+						'module'    =>  'API',
+						'method'    =>  'VisitsSummary.getVisits',
+						'idSite'    =>  $settings['matomo_siteid'],
+						'period'    =>  $period,
+						'date'      =>  'today',
+						'token_auth' =>  $settings['matomo_token'],
+						'format'    =>  'json'
+					]
+				]);
 
-                if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
-                    $result = json_decode((string) $response->getBody(), true)['value'] ?? null;
-                    if ($result !== null) {
-                        return (int)$result;
-                    }
-                }
-            } catch (RequestException $ex) {
-            }
-        }
+				if ($response->getStatusCode() === StatusCodeInterface::STATUS_OK) {
+					$result = json_decode((string) $response->getBody(), true)['value'] ?? null;
+					if ($result !== null) {
+						return (int)$result;
+					}
+				}
+			} catch (RequestException $ex) {
+			}
+		}
 
-        return null;
-    }
+		return null;
+	}
 }

src/Webtrees/Module/AdminTasks/AdminTasksModule.php

Indentation +118 added lines, -118 removed lines

@@ -40,123 +40,123 @@
  * Allow for tasks to be run on a (nearly-)regular schedule
  */
 class AdminTasksModule extends AbstractModuleMaj implements
-    ModuleCustomInterface,
-    ModuleConfigInterface,
-    ModuleGlobalInterface,
-    ModuleTasksProviderInterface
+	ModuleCustomInterface,
+	ModuleConfigInterface,
+	ModuleGlobalInterface,
+	ModuleTasksProviderInterface
 {
-    use ModuleConfigTrait;
-    use ModuleGlobalTrait;
-
-    //How to update the database schema for this module
-    private const SCHEMA_TARGET_VERSION   = 2;
-    private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
-    private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
-     */
-    public function title(): string
-    {
-        return I18N::translate('Administration Tasks');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
-     */
-    public function description(): string
-    {
-        return I18N::translate('Manage and run nearly-scheduled administration tasks.');
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::boot()
-     */
-    public function boot(): void
-    {
-        parent::boot();
-        app(MigrationService::class)->updateSchema(
-            self::SCHEMA_MIGRATION_PREFIX,
-            self::SCHEMA_SETTING_NAME,
-            self::SCHEMA_TARGET_VERSION
-        );
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::loadRoutes()
-     */
-    public function loadRoutes(Map $router): void
-    {
-        $router->attach('', '', static function (Map $router): void {
-
-            $router->attach('', '/module-maj/admintasks', static function (Map $router): void {
-
-                $router->attach('', '/admin', static function (Map $router): void {
-
-                    $router->extras([
-                        'middleware' => [
-                            AuthAdministrator::class,
-                        ],
-                    ]);
-                    $router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
-
-                    $router->attach('', '/tasks', static function (Map $router): void {
-
-                        $router->get(TasksList::class, '', TasksList::class);
-                        $router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
-                        $router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
-                        $router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
-                    });
-                });
-
-                $router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
-                    ->allows(RequestMethodInterface::METHOD_POST);
-
-                $router->post(TokenGenerate::class, '/token', TokenGenerate::class)
-                    ->extras(['middleware' => [AuthAdministrator::class]]);
-            });
-        });
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
-     */
-    public function customModuleVersion(): string
-    {
-        return '2.0.5-v.1';
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
-     */
-    public function getConfigLink(): string
-    {
-        return route(AdminConfigPage::class);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
-     */
-    public function bodyContent(): string
-    {
-        return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
-    }
-
-    /**
-     * {@inheritDoc}
-     * @see \MyArtJaub\Webtrees\Module\AdminTasks\Contracts\ModuleTasksProviderInterface::listTasks()
-     */
-    public function listTasks(): array
-    {
-        return [
-            'maj-healthcheck' => HealthCheckEmailTask::class
-        ];
-    }
+	use ModuleConfigTrait;
+	use ModuleGlobalTrait;
+
+	//How to update the database schema for this module
+	private const SCHEMA_TARGET_VERSION   = 2;
+	private const SCHEMA_SETTING_NAME     = 'MAJ_ADMTASKS_SCHEMA_VERSION';
+	private const SCHEMA_MIGRATION_PREFIX = __NAMESPACE__ . '\Schema';
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::title()
+	 */
+	public function title(): string
+	{
+		return I18N::translate('Administration Tasks');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\AbstractModule::description()
+	 */
+	public function description(): string
+	{
+		return I18N::translate('Manage and run nearly-scheduled administration tasks.');
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::boot()
+	 */
+	public function boot(): void
+	{
+		parent::boot();
+		app(MigrationService::class)->updateSchema(
+			self::SCHEMA_MIGRATION_PREFIX,
+			self::SCHEMA_SETTING_NAME,
+			self::SCHEMA_TARGET_VERSION
+		);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AbstractModuleMaj::loadRoutes()
+	 */
+	public function loadRoutes(Map $router): void
+	{
+		$router->attach('', '', static function (Map $router): void {
+
+			$router->attach('', '/module-maj/admintasks', static function (Map $router): void {
+
+				$router->attach('', '/admin', static function (Map $router): void {
+
+					$router->extras([
+						'middleware' => [
+							AuthAdministrator::class,
+						],
+					]);
+					$router->get(AdminConfigPage::class, '/config', AdminConfigPage::class);
+
+					$router->attach('', '/tasks', static function (Map $router): void {
+
+						$router->get(TasksList::class, '', TasksList::class);
+						$router->get(TaskEditPage::class, '/{task}', TaskEditPage::class);
+						$router->post(TaskEditAction::class, '/{task}', TaskEditAction::class);
+						$router->get(TaskStatusAction::class, '/{task}/status/{enable}', TaskStatusAction::class);
+					});
+				});
+
+				$router->get(TaskTrigger::class, '/trigger{/task}', TaskTrigger::class)
+					->allows(RequestMethodInterface::METHOD_POST);
+
+				$router->post(TokenGenerate::class, '/token', TokenGenerate::class)
+					->extras(['middleware' => [AuthAdministrator::class]]);
+			});
+		});
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleLatestVersion()
+	 */
+	public function customModuleVersion(): string
+	{
+		return '2.0.5-v.1';
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleConfigInterface::getConfigLink()
+	 */
+	public function getConfigLink(): string
+	{
+		return route(AdminConfigPage::class);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \Fisharebest\Webtrees\Module\ModuleGlobalInterface::bodyContent()
+	 */
+	public function bodyContent(): string
+	{
+		return view($this->name() . '::snippet', [ 'url' => route(TaskTrigger::class) ]);
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * @see \MyArtJaub\Webtrees\Module\AdminTasks\Contracts\ModuleTasksProviderInterface::listTasks()
+	 */
+	public function listTasks(): array
+	{
+		return [
+			'maj-healthcheck' => HealthCheckEmailTask::class
+		];
+	}
 }