xref: /webtrees/app/Module/FamilyNavigatorModule.php (revision 8fcd0d32e56ee262912bbdb593202cfd1cbc1615)
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    /** {@inheritdoc} */
29    public function getTitle(): string
30    {
31        /* I18N: Name of a module/sidebar */
32        return I18N::translate('Family navigator');
33    }
34
35    /** {@inheritdoc} */
36    public function getDescription(): string
37    {
38        /* I18N: Description of the “Family navigator” module */
39        return I18N::translate('A sidebar showing an individual’s close families and relatives.');
40    }
41
42    /** {@inheritdoc} */
43    public function defaultSidebarOrder(): int
44    {
45        return 20;
46    }
47
48    /** {@inheritdoc} */
49    public function hasSidebarContent(Individual $individual): bool
50    {
51        return true;
52    }
53
54    /**
55     * Load this sidebar synchronously.
56     *
57     * @param Individual $individual
58     *
59     * @return string
60     */
61    public function getSidebarContent(Individual $individual): string
62    {
63        return view('modules/family_nav/sidebar', ['individual' => $individual]);
64    }
65}
66