xref: /webtrees/app/Module/FamilyNavigatorModule.php (revision 9ed80f829cfb208ae92f7928345696619569bf4e) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 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 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\I18N;
21use Fisharebest\Webtrees\Individual;
22
23/**
24 * Class FamilyNavigatorModule
25 */
26class FamilyNavigatorModule extends AbstractModule implements ModuleSidebarInterface
27{
28    use ModuleSidebarTrait;
29
30    /**
31     * How should this module be identified in the control panel, etc.?
32     *
33     * @return string
34     */
35    public function title(): string
36    {
37        /* I18N: Name of a module/sidebar */
38        return I18N::translate('Family navigator');
39    }
40
41    /**
42     * A sentence describing what this module does.
43     *
44     * @return string
45     */
46    public function description(): string
47    {
48        /* I18N: Description of the “Family navigator” module */
49        return I18N::translate('A sidebar showing an individual’s close families and relatives.');
50    }
51
52    /**
53     * The default position for this sidebar.  It can be changed in the control panel.
54     *
55     * @return int
56     */
57    public function defaultSidebarOrder(): int
58    {
59        return 2;
60    }
61
62    /** {@inheritdoc} */
63    public function hasSidebarContent(Individual $individual): bool
64    {
65        return true;
66    }
67
68    /**
69     * Load this sidebar synchronously.
70     *
71     * @param Individual $individual
72     *
73     * @return string
74     */
75    public function getSidebarContent(Individual $individual): string
76    {
77        return view('modules/family_nav/sidebar', ['individual' => $individual]);
78    }
79}
80