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