xref: /webtrees/app/Module/FamilyNavigatorModule.php (revision 84e2cf4e2b1803b300330f631d304db1a3c443dd)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 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 */
16namespace Fisharebest\Webtrees\Module;
17
18use Fisharebest\Webtrees\I18N;
19use Fisharebest\Webtrees\Individual;
20
21/**
22 * Class FamilyNavigatorModule
23 */
24class FamilyNavigatorModule extends AbstractModule implements ModuleSidebarInterface
25{
26    /** {@inheritdoc} */
27    public function getTitle(): string
28    {
29        /* I18N: Name of a module/sidebar */
30        return I18N::translate('Family navigator');
31    }
32
33    /** {@inheritdoc} */
34    public function getDescription(): string
35    {
36        /* I18N: Description of the “Family navigator” module */
37        return I18N::translate('A sidebar showing an individual’s close families and relatives.');
38    }
39
40    /** {@inheritdoc} */
41    public function defaultSidebarOrder(): int
42    {
43        return 20;
44    }
45
46    /** {@inheritdoc} */
47    public function hasSidebarContent(Individual $individual): bool
48    {
49        return true;
50    }
51
52    /**
53     * Load this sidebar synchronously.
54     *
55     * @param Individual $individual
56     *
57     * @return string
58     */
59    public function getSidebarContent(Individual $individual): string
60    {
61        return view('modules/family_nav/sidebar', ['individual' => $individual]);
62    }
63}
64