xref: /webtrees/app/Module/RelativesTabModule.php (revision 37eb8894d5d4381f3fd9b791a53a32f0012b32ec) 
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\Auth;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Individual;
23
24/**
25 * Class RelativesTabModule
26 */
27class RelativesTabModule extends AbstractModule implements  ModuleTabInterface
28{
29    use ModuleTabTrait;
30
31    /**
32     * How should this module be labelled on tabs, menus, etc.?
33     *
34     * @return string
35     */
36    public function title(): string
37    {
38        /* I18N: Name of a module */
39        return I18N::translate('Families');
40    }
41
42    /**
43     * A sentence describing what this module does.
44     *
45     * @return string
46     */
47    public function description(): string
48    {
49        /* I18N: Description of the “Families” module */
50        return I18N::translate('A tab showing the close relatives of an individual.');
51    }
52
53    /**
54     * The default position for this tab.  It can be changed in the control panel.
55     *
56     * @return int
57     */
58    public function defaultTabOrder(): int
59    {
60        return 3;
61    }
62
63    /** {@inheritdoc} */
64    public function getTabContent(Individual $individual): string
65    {
66        $tree = $individual->tree();
67        if ($tree->getPreference('SHOW_PRIVATE_RELATIONSHIPS')) {
68            $fam_access_level = Auth::PRIV_HIDE;
69        } else {
70            $fam_access_level = Auth::accessLevel($tree);
71        }
72
73        return view('modules/relatives/tab', [
74            'fam_access_level'     => $fam_access_level,
75            'can_edit'             => $individual->canEdit(),
76            'individual'           => $individual,
77            'parent_families'      => $individual->getChildFamilies(),
78            'spouse_families'      => $individual->getSpouseFamilies(),
79            'step_child_familiess' => $individual->getSpouseStepFamilies(),
80            'step_parent_families' => $individual->getChildStepFamilies(),
81        ]);
82    }
83
84    /** {@inheritdoc} */
85    public function hasTabContent(Individual $individual): bool
86    {
87        return true;
88    }
89
90    /** {@inheritdoc} */
91    public function isGrayedOut(Individual $individual): bool
92    {
93        return false;
94    }
95
96    /** {@inheritdoc} */
97    public function canLoadAjax(): bool
98    {
99        return false;
100    }
101}
102