xref: /webtrees/app/Module/RelativesTabModule.php (revision 4d35caa736b1f4119b8a949d1cbca5644dbf4e23) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Individual;
25use Illuminate\Support\Collection;
26
27/**
28 * Class RelativesTabModule
29 */
30class RelativesTabModule extends AbstractModule implements ModuleTabInterface
31{
32    use ModuleTabTrait;
33
34    /**
35     * How should this module be identified in the control panel, etc.?
36     *
37     * @return string
38     */
39    public function title(): string
40    {
41        /* I18N: Name of a module */
42        return I18N::translate('Families');
43    }
44
45    /**
46     * A sentence describing what this module does.
47     *
48     * @return string
49     */
50    public function description(): string
51    {
52        /* I18N: Description of the “Families” module */
53        return I18N::translate('A tab showing the close relatives of an individual.');
54    }
55
56    /**
57     * The default position for this tab.  It can be changed in the control panel.
58     *
59     * @return int
60     */
61    public function defaultTabOrder(): int
62    {
63        return 2;
64    }
65
66    /**
67     * Generate the HTML content of this tab.
68     *
69     * @param Individual $individual
70     *
71     * @return string
72     */
73    public function getTabContent(Individual $individual): string
74    {
75        $tree = $individual->tree();
76        if ($tree->getPreference('SHOW_PRIVATE_RELATIONSHIPS') === '1') {
77            $fam_access_level = Auth::PRIV_HIDE;
78        } else {
79            $fam_access_level = Auth::accessLevel($tree);
80        }
81
82        return view('modules/relatives/tab', [
83            'fam_access_level'     => $fam_access_level,
84            'can_edit'             => $individual->canEdit(),
85            'individual'           => $individual,
86            'parent_families'      => $individual->childFamilies(),
87            'spouse_families'      => $individual->spouseFamilies(),
88            'step_child_families'  => $individual->spouseStepFamilies(),
89            'step_parent_families' => $individual->childStepFamilies(),
90        ]);
91    }
92
93    /**
94     * Is this tab empty? If so, we don't always need to display it.
95     *
96     * @param Individual $individual
97     *
98     * @return bool
99     */
100    public function hasTabContent(Individual $individual): bool
101    {
102        return $individual->canEdit() || $individual->facts(['FAMC', 'FAMS'], false, null, true)->isNotEmpty();
103    }
104
105    /**
106     * A greyed out tab has no actual content, but may perhaps have
107     * options to create content.
108     *
109     * @param Individual $individual
110     *
111     * @return bool
112     */
113    public function isGrayedOut(Individual $individual): bool
114    {
115        return false;
116    }
117
118    /**
119     * Can this tab load asynchronously?
120     *
121     * @return bool
122     */
123    public function canLoadAjax(): bool
124    {
125        return false;
126    }
127
128    /**
129     * This module handles the following facts - so don't show them on the "Facts and events" tab.
130     *
131     * @return Collection<string>
132     */
133    public function supportedFacts(): Collection
134    {
135        return new Collection(['INDI:FAMC', 'INDI:FAMS', 'FAM:HUSB', 'FAM:WIFE', 'FAM:CHIL']);
136    }
137}
138