summaryrefslogtreecommitdiff
path: root/library/WT/Controller/Chart.php
blob: 7e12ec7a0fdb9ff73d3792de6d026faa3ebae752 (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
<?php
// webtrees: Web based Family History software
// Copyright (C) 2014 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 2 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, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

/**
 * Class WT_Controller_Chart - Base controller for all chart pages
 */
class WT_Controller_Chart extends WT_Controller_Page {
	/** @var WT_Individual Who is chart about? */
	public $root;

	/** @var string An error message, in case we cannot construct the chart */
	public $error_message;

	/**
	 * Create the chart controller
	 */
	public function __construct() {
		parent::__construct();

		$rootid = WT_Filter::get('rootid', WT_REGEX_XREF);
		$this->root = WT_Individual::getInstance($rootid);
		if (!$this->root) {
			// Missing root individual?  Show the chart for someone.
			$this->root = $this->getSignificantIndividual();
		}

		if (!$this->root || !$this->root->canShowName()) {
			http_response_code(404);
			$this->error_message = WT_I18N::translate('This individual does not exist or you do not have permission to view it.');
		}
	}

	/**
	 * Get significant information from this page, to allow other pages such as
	 * charts and reports to initialise with the same records
	 *
	 * @return WT_Individual
	 */
	public function getSignificantIndividual() {
		if ($this->root) {
			return $this->root;
		} else {
			return parent::getSignificantIndividual();
		}
	}

	/**
	 * Find the direct-line ancestors of an individual.  Array indexes are SOSA numbers.
	 *
	 * @param integer $generations
	 *
	 * @return WT_Individual[]
	 */
	public function sosaAncestors($generations) {
		$ancestors = array(
			1 => $this->root
		);

		// Subtract one generation, as this algorithm includes parents.
		$max = pow(2, $generations - 1);

		for ($i = 1; $i < $max; $i++) {
			$ancestors[$i * 2] = null;
			$ancestors[$i * 2 + 1] = null;
			$person = $ancestors[$i];
			if ($person) {
				$family = $person->getPrimaryChildFamily();
				if ($family) {
					if ($family->getHusband()) {
						$ancestors[$i * 2] = $family->getHusband();
					}
					if ($family->getWife()) {
						$ancestors[$i * 2 + 1] = $family->getWife();
					}
				}
			}
		}

		return $ancestors;
	}
}