xref: /webtrees/app/Module/RelativesTabModule.php (revision 4fbeb707df82fa5025e6110f443695700edd846c) 
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;
23use Illuminate\Support\Collection;
24
25/**
26 * Class RelativesTabModule
27 */
28class RelativesTabModule extends AbstractModule implements ModuleTabInterface
29{
30    use ModuleTabTrait;
31
32    /**
33     * How should this module be labelled on tabs, menus, etc.?
34     *
35     * @return string
36     */
37    public function title(): string
38    {
39        /* I18N: Name of a module */
40        return I18N::translate('Families');
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 “Families” module */
51        return I18N::translate('A tab showing the close relatives of an individual.');
52    }
53
54    /**
55     * The default position for this tab.  It can be changed in the control panel.
56     *
57     * @return int
58     */
59    public function defaultTabOrder(): int
60    {
61        return 3;
62    }
63
64    /** {@inheritdoc} */
65    public function getTabContent(Individual $individual): string
66    {
67        $tree = $individual->tree();
68        if ($tree->getPreference('SHOW_PRIVATE_RELATIONSHIPS')) {
69            $fam_access_level = Auth::PRIV_HIDE;
70        } else {
71            $fam_access_level = Auth::accessLevel($tree);
72        }
73
74        return view('modules/relatives/tab', [
75            'fam_access_level'     => $fam_access_level,
76            'can_edit'             => $individual->canEdit(),
77            'individual'           => $individual,
78            'parent_families'      => $individual->childFamilies(),
79            'spouse_families'      => $individual->spouseFamilies(),
80            'step_child_familiess' => $individual->spouseStepFamilies(),
81            'step_parent_families' => $individual->childStepFamilies(),
82        ]);
83    }
84
85    /** {@inheritdoc} */
86    public function hasTabContent(Individual $individual): bool
87    {
88        return true;
89    }
90
91    /** {@inheritdoc} */
92    public function isGrayedOut(Individual $individual): bool
93    {
94        return false;
95    }
96
97    /** {@inheritdoc} */
98    public function canLoadAjax(): bool
99    {
100        return false;
101    }
102
103    /**
104     * This module handles the following facts - so don't show them on the "Facts and events" tab.
105     *
106     * @return Collection|string[]
107     */
108    public function supportedFacts(): Collection
109    {
110        return new Collection(['FAMC', 'FAMS', 'HUSB', 'WIFE', 'CHIL']);
111    }
112}
113