xref: /webtrees/app/Module/RelativesTabModule.php (revision 379e735bf03b2ef02d2bf328828aaefcfc3d572a) 
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 identified in the control panel, 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 2;
62    }
63
64    /**
65     * Generate the HTML content of this tab.
66     *
67     * @param Individual $individual
68     *
69     * @return string
70     */
71    public function getTabContent(Individual $individual): string
72    {
73        $tree = $individual->tree();
74        if ($tree->getPreference('SHOW_PRIVATE_RELATIONSHIPS')) {
75            $fam_access_level = Auth::PRIV_HIDE;
76        } else {
77            $fam_access_level = Auth::accessLevel($tree);
78        }
79
80        return view('modules/relatives/tab', [
81            'fam_access_level'     => $fam_access_level,
82            'can_edit'             => $individual->canEdit(),
83            'individual'           => $individual,
84            'parent_families'      => $individual->childFamilies(),
85            'spouse_families'      => $individual->spouseFamilies(),
86            'step_child_familiess' => $individual->spouseStepFamilies(),
87            'step_parent_families' => $individual->childStepFamilies(),
88        ]);
89    }
90
91    /**
92     * Is this tab empty? If so, we don't always need to display it.
93     *
94     * @param Individual $individual
95     *
96     * @return bool
97     */
98    public function hasTabContent(Individual $individual): bool
99    {
100        return true;
101    }
102
103    /**
104     * A greyed out tab has no actual content, but may perhaps have
105     * options to create content.
106     *
107     * @param Individual $individual
108     *
109     * @return bool
110     */
111    public function isGrayedOut(Individual $individual): bool
112    {
113        return false;
114    }
115
116    /**
117     * Can this tab load asynchronously?
118     *
119     * @return bool
120     */
121    public function canLoadAjax(): bool
122    {
123        return false;
124    }
125
126    /**
127     * This module handles the following facts - so don't show them on the "Facts and events" tab.
128     *
129     * @return Collection
130     */
131    public function supportedFacts(): Collection
132    {
133        return new Collection(['FAMC', 'FAMS', 'HUSB', 'WIFE', 'CHIL']);
134    }
135}
136