summaryrefslogtreecommitdiff
path: root/app/Http/Controllers/AbstractChartController.php
blob: 1e671855138236396160c63bb8764457b9534f1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<?php
/**
 * webtrees: online genealogy
 * Copyright (C) 2018 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace Fisharebest\Webtrees\Http\Controllers;

use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Tree;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Common logic for chart controllers.
 */
abstract class AbstractChartController extends AbstractBaseController
{
    /**
     * Check that a module is enabled for a tree.
     *
     * @param Tree   $tree
     * @param string $module
     */
    protected function checkModuleIsActive(Tree $tree, string $module)
    {
        $active_charts = Module::getActiveCharts($tree);

        if (!array_key_exists($module, $active_charts)) {
            throw new NotFoundHttpException(I18N::translate('The module “%s” has been disabled.', $module));
        }
    }

    /**
     * Find the ancestors of an individual, and generate an array indexed by
     * Sosa-Stradonitz number.
     *
     * @param Individual $individual  Start with this individual
     * @param int        $generations Fetch this number of generations
     *
     * @return Individual[]
     */
    protected function sosaStradonitzAncestors(Individual $individual, int $generations): array
    {
        /** @var Individual[] $ancestors */
        $ancestors = [
            1 => $individual,
        ];

        $max = 2 ** ($generations - 1);

        for ($i = 1; $i < $max; $i++) {
            $ancestors[$i * 2]     = null;
            $ancestors[$i * 2 + 1] = null;

            $individual = $ancestors[$i];

            if ($individual !== null) {
                $family = $individual->getPrimaryChildFamily();
                if ($family !== null) {
                    if ($family->getHusband() !== null) {
                        $ancestors[$i * 2] = $family->getHusband();
                    }
                    if ($family->getWife() !== null) {
                        $ancestors[$i * 2 + 1] = $family->getWife();
                    }
                }
            }
        }

        return $ancestors;
    }

    /**
     * Find all the individuals that are descended from an individual.
     *
     * @param Individual   $individual
     * @param int          $generations
     * @param Individual[] $array
     *
     * @return Individual[]
     */
    protected function descendants(Individual $individual, int $generations, array $array): array
    {
        if ($generations < 1) {
            return $array;
        }

        $array[$individual->getXref()] = $individual;

        foreach ($individual->getSpouseFamilies() as $family) {
            $spouse = $family->getSpouse($individual);
            if ($spouse !== null && !array_key_exists($spouse->getXref(), $array)) {
                $array[$spouse->getXref()] = $spouse;
            }
            foreach ($family->getChildren() as $child) {
                $array = $this->descendants($child, $generations - 1, $array);
            }
        }

        return $array;
    }
}