xref: /webtrees/app/Module/FamilyNavigatorModule.php (revision 3cfcc809af53e831fa6cafac7b274a2cb407db6e) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Module;
20
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Individual;
23
24/**
25 * Class FamilyNavigatorModule
26 */
27class FamilyNavigatorModule extends AbstractModule implements ModuleSidebarInterface
28{
29    use ModuleSidebarTrait;
30
31    /**
32     * How should this module be identified in the control panel, etc.?
33     *
34     * @return string
35     */
36    public function title(): string
37    {
38        /* I18N: Name of a module/sidebar */
39        return I18N::translate('Family navigator');
40    }
41
42    /**
43     * A sentence describing what this module does.
44     *
45     * @return string
46     */
47    public function description(): string
48    {
49        /* I18N: Description of the “Family navigator” module */
50        return I18N::translate('A sidebar showing an individual’s close families and relatives.');
51    }
52
53    /**
54     * The default position for this sidebar.  It can be changed in the control panel.
55     *
56     * @return int
57     */
58    public function defaultSidebarOrder(): int
59    {
60        return 2;
61    }
62
63    /** {@inheritdoc} */
64    public function hasSidebarContent(Individual $individual): bool
65    {
66        return true;
67    }
68
69    /**
70     * Load this sidebar synchronously.
71     *
72     * @param Individual $individual
73     *
74     * @return string
75     */
76    public function getSidebarContent(Individual $individual): string
77    {
78        return view('modules/family_nav/sidebar', ['individual' => $individual]);
79    }
80}
81