xref: /webtrees/app/Module/FamilyNavigatorModule.php (revision 895230eed7521b5cd885b90d4f5310405ff0b69a) 
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 ModuleInterface, ModuleSidebarInterface
27{
28    use ModuleSidebarTrait;
29
30    /** {@inheritdoc} */
31    public function title(): string
32    {
33        /* I18N: Name of a module/sidebar */
34        return I18N::translate('Family navigator');
35    }
36
37    /** {@inheritdoc} */
38    public function description(): string
39    {
40        /* I18N: Description of the “Family navigator” module */
41        return I18N::translate('A sidebar showing an individual’s close families and relatives.');
42    }
43
44    /**
45     * The default position for this sidebar.  It can be changed in the control panel.
46     *
47     * @return int
48     */
49    public function defaultSidebarOrder(): int
50    {
51        return 20;
52    }
53
54    /** {@inheritdoc} */
55    public function hasSidebarContent(Individual $individual): bool
56    {
57        return true;
58    }
59
60    /**
61     * Load this sidebar synchronously.
62     *
63     * @param Individual $individual
64     *
65     * @return string
66     */
67    public function getSidebarContent(Individual $individual): string
68    {
69        return view('modules/family_nav/sidebar', ['individual' => $individual]);
70    }
71}
72