xref: /webtrees/app/Module/FanChartModule.php (revision 9f2390a04226d0058d1862402c80d50fe6e79aa1)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 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\Individual;
21use Fisharebest\Webtrees\Menu;
22
23/**
24 * Class FanChartModule
25 */
26class FanChartModule 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('Fan chart');
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 “Fan Chart” module */ I18N::translate('A fan chart of an individual’s ancestors.');
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	 * We can only do this if the GD2 library is installed with TrueType support.
60	 *
61	 * @param Individual $individual
62	 *
63	 * @return Menu|null
64	 */
65	public function getChartMenu(Individual $individual) {
66		if (function_exists('imagettftext')) {
67			return new Menu(
68				$this->getTitle(),
69				e(route('fan', ['xref' => $individual->getXref(), 'ged' => $individual->getTree()->getName()])),
70				'menu-chart-fanchart',
71				['rel' => 'nofollow']
72			);
73		} else {
74			return null;
75		}
76	}
77
78	/**
79	 * Return a menu item for this chart - for use in individual boxes.
80	 *
81	 * @param Individual $individual
82	 *
83	 * @return Menu|null
84	 */
85	public function getBoxChartMenu(Individual $individual) {
86		return $this->getChartMenu($individual);
87	}
88}
89