xref: /webtrees/app/Module/RelationshipsChartModule.php (revision 168ff6f357afa9bbd5aa14c12670d19e51ee770c)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2016 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16namespace Fisharebest\Webtrees\Module;
17
18use Fisharebest\Webtrees\Auth;
19use Fisharebest\Webtrees\I18N;
20use Fisharebest\Webtrees\Menu;
21use Fisharebest\Webtrees\Individual;
22
23/**
24 * Class RelationshipsChartModule
25 */
26class RelationshipsChartModule extends AbstractModule implements ModuleChartInterface {
27	/**
28	 * How should this module be labelled on tabs, menus, etc.?
29	 *
30	 * @return string
31	 */
32	public function getTitle() {
33		return /* I18N: Name of a module/chart */ I18N::translate('Relationships');
34	}
35
36	/**
37	 * A sentence describing what this module does.
38	 *
39	 * @return string
40	 */
41	public function getDescription() {
42		return /* I18N: Description of the “RelationshipsChart” module */ I18N::translate('A chart displaying relationships between two individuals.');
43	}
44
45	/**
46	 * What is the default access level for this module?
47	 *
48	 * Some modules are aimed at admins or managers, and are not generally shown to users.
49	 *
50	 * @return int
51	 */
52	public function defaultAccessLevel() {
53		return Auth::PRIV_PRIVATE;
54	}
55
56	/**
57	 * Return a menu item for this chart.
58	 *
59	 * @return Menu
60	 */
61	public function getChartMenu(Individual $individual) {
62		global $controller, $WT_TREE;
63
64		$gedcomid = $WT_TREE->getUserPreference(Auth::user(), 'gedcomid');
65
66		if ($gedcomid && $individual->getXref()) {
67			return new Menu(
68				I18N::translate('Relationship to me'),
69				'relationship.php?pid1=' . $gedcomid . '&amp;pid2=' . $individual->getXref() . '&amp;ged=' . $WT_TREE->getNameUrl(),
70				'menu-chart-relationship',
71				array('rel' => 'nofollow')
72			);
73		} else {
74			return new Menu(
75				I18N::translate('Relationships'),
76				'relationship.php?pid1=' . $individual->getXref() . '&amp;ged=' . $WT_TREE->getNameUrl(),
77				'menu-chart-relationship',
78				array('rel' => 'nofollow')
79			);
80		}
81	}
82
83	public function getBoxChartMenu(Individual $individual) {
84		return $this->getChartMenu($individual);
85	}
86}
87