summaryrefslogtreecommitdiff
path: root/app/Module/DescendancyModule.php
blob: 17559b71068c87e24fa7e5eef55863a08b6c1b48 (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<?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/>.
 */
namespace Fisharebest\Webtrees\Module;

use Fisharebest\Webtrees\Database;
use Fisharebest\Webtrees\Family;
use Fisharebest\Webtrees\FontAwesome;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Tree;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * Class DescendancyModule
 */
class DescendancyModule extends AbstractModule implements ModuleSidebarInterface {
	/** {@inheritdoc} */
	public function getTitle() {
		return /* I18N: Name of a module/sidebar */
			I18N::translate('Descendants');
	}

	/** {@inheritdoc} */
	public function getDescription() {
		return /* I18N: Description of the “Descendants” module */
			I18N::translate('A sidebar showing the descendants of an individual.');
	}

	/**
	 * @param Request $request
	 *
	 * @return Response
	 */
	public function getSearchAction(Request $request): Response {
		/** @var Tree $tree */
		$tree = $request->attributes->get('tree');

		$search = $request->get('search', '');

		$html = '';

		if (strlen($search) >= 2) {
			$rows = Database::prepare(
				"SELECT i_id AS xref" .
				" FROM `##individuals`" .
				" JOIN `##name` ON i_id = n_id AND i_file = n_file" .
				" WHERE n_sort LIKE CONCAT('%', :query, '%') AND i_file = :tree_id" .
				" ORDER BY n_sort"
			)->execute([
				'query'   => $search,
				'tree_id' => $tree->getTreeId(),
			])->fetchAll();

			foreach ($rows as $row) {
				$individual = Individual::getInstance($row->xref, $tree);
				if ($individual !== null && $individual->canShow()) {
					$html .= $this->getPersonLi($individual);
				}
			}
		}

		if ($html !== '') {
			$html = '<ul>' . $html . '</ul>';
		}

		return new Response($html);
	}

	/**
	 * @param Request $request
	 *
	 * @return Response
	 */
	public function getDescendantsAction(Request $request): Response {
		/** @var Tree $tree */
		$tree = $request->attributes->get('tree');

		$xref = $request->get('xref');

		$individual = Individual::getInstance($xref, $tree);

		if ($individual !== null && $individual->canShow()) {
			$html = $this->loadSpouses($individual, 1);
		} else {
			$html = '';
		}

		return new Response($html);
	}

	/** {@inheritdoc} */
	public function defaultSidebarOrder() {
		return 30;
	}

	/** {@inheritdoc} */
	public function hasSidebarContent(Individual $individual) {
		return true;
	}

	/**
	 * Load this sidebar synchronously.
	 *
	 * @param Individual $individual
	 *
	 * @return string
	 */
	public function getSidebarContent(Individual $individual) {
		return view('modules/descendancy/sidebar', [
			'individual_list' => $this->getPersonLi($individual, 1),
		]);
	}

	/**
	 * Format an individual in a list.
	 *
	 * @param Individual $person
	 * @param int        $generations
	 *
	 * @return string
	 */
	public function getPersonLi(Individual $person, $generations = 0) {
		$icon     = $generations > 0 ? 'icon-minus' : 'icon-plus';
		$lifespan = $person->canShow() ? '(' . $person->getLifeSpan() . ')' : '';
		$spouses  = $generations > 0 ? $this->loadSpouses($person, 0) : '';

		return
			'<li class="sb_desc_indi_li">' .
			'<a class="sb_desc_indi" href="' . e(route('module', ['module' => 'descendancy', 'action' => 'Descendants', 'ged' => $person->getTree()->getName(), 'xref' => $person->getXref()])) . '">' .
			'<i class="plusminus ' . $icon . '"></i>' .
			$person->getSexImage() . $person->getFullName() . $lifespan .
			'</a>' .
			FontAwesome::linkIcon('individual', $person->getFullName(), ['href' => $person->url()]) .
			'<div>' . $spouses . '</div>' .
			'</li>';
	}

	/**
	 * Format a family in a list.
	 *
	 * @param Family     $family
	 * @param Individual $person
	 * @param int        $generations
	 *
	 * @return string
	 */
	public function getFamilyLi(Family $family, Individual $person, $generations = 0) {
		$spouse = $family->getSpouse($person);
		if ($spouse) {
			$spouse_name = $spouse->getSexImage() . $spouse->getFullName();
			$spouse_link = FontAwesome::linkIcon('individual', $spouse->getFullName(), ['href' => $person->url()]);
		} else {
			$spouse_name = '';
			$spouse_link = '';
		}

		$marryear = $family->getMarriageYear();
		$marr     = $marryear ? '<i class="icon-rings"></i>' . $marryear : '';

		return
			'<li class="sb_desc_indi_li">' .
			'<a class="sb_desc_indi" href="#"><i class="plusminus icon-minus"></i>' . $spouse_name . $marr . '</a>' .
			$spouse_link .
			FontAwesome::linkIcon('family', $family->getFullName(), ['href' => $family->url()]) .
		 '<div>' . $this->loadChildren($family, $generations) . '</div>' .
			'</li>';
	}

	/**
	 * Display spouses.
	 *
	 * @param Individual $person
	 * @param int        $generations
	 *
	 * @return string
	 */
	public function loadSpouses(Individual $person, $generations) {
		$out = '';
		if ($person && $person->canShow()) {
			foreach ($person->getSpouseFamilies() as $family) {
				$out .= $this->getFamilyLi($family, $person, $generations - 1);
			}
		}
		if ($out) {
			return '<ul>' . $out . '</ul>';
		} else {
			return '';
		}
	}

	/**
	 * Display descendants.
	 *
	 * @param Family $family
	 * @param int    $generations
	 *
	 * @return string
	 */
	public function loadChildren(Family $family, $generations) {
		$out = '';
		if ($family->canShow()) {
			$children = $family->getChildren();
			if ($children) {
				foreach ($children as $child) {
					$out .= $this->getPersonLi($child, $generations - 1);
				}
			} else {
				$out .= '<li class="sb_desc_none">' . I18N::translate('No children') . '</li>';
			}
		}
		if ($out) {
			return '<ul>' . $out . '</ul>';
		} else {
			return '';
		}
	}
}