xref: /webtrees/app/Module/SourcesTabModule.php (revision 4ebbf4ab91d79576e8ebdc761df5c39dec8019a3) 
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\Fact;
21use Fisharebest\Webtrees\I18N;
22use Fisharebest\Webtrees\Individual;
23use Fisharebest\Webtrees\Services\ClipboardService;
24use Illuminate\Support\Collection;
25
26/**
27 * Class SourcesTabModule
28 */
29class SourcesTabModule extends AbstractModule implements ModuleTabInterface
30{
31    use ModuleTabTrait;
32
33    /** @var Collection All facts belonging to this source. */
34    private $facts;
35
36    /** @var ClipboardService */
37    private $clipboard_service;
38
39    /**
40     * SourcesTabModule constructor.
41     *
42     * @param ClipboardService $clipboard_service
43     */
44    public function __construct(ClipboardService $clipboard_service)
45    {
46        $this->clipboard_service = $clipboard_service;
47    }
48
49    /**
50     * How should this module be identified in the control panel, etc.?
51     *
52     * @return string
53     */
54    public function title(): string
55    {
56        /* I18N: Name of a module */
57        return I18N::translate('Sources');
58    }
59
60    /**
61     * A sentence describing what this module does.
62     *
63     * @return string
64     */
65    public function description(): string
66    {
67        /* I18N: Description of the “Sources” module */
68        return I18N::translate('A tab showing the sources linked to an individual.');
69    }
70
71    /**
72     * The default position for this tab.  It can be changed in the control panel.
73     *
74     * @return int
75     */
76    public function defaultTabOrder(): int
77    {
78        return 3;
79    }
80
81    /**
82     * Is this tab empty? If so, we don't always need to display it.
83     *
84     * @param Individual $individual
85     *
86     * @return bool
87     */
88    public function hasTabContent(Individual $individual): bool
89    {
90        return $individual->canEdit() || $this->getFactsWithSources($individual)->isNotEmpty();
91    }
92
93    /**
94     * A greyed out tab has no actual content, but may perhaps have
95     * options to create content.
96     *
97     * @param Individual $individual
98     *
99     * @return bool
100     */
101    public function isGrayedOut(Individual $individual): bool
102    {
103        return $this->getFactsWithSources($individual)->isEmpty();
104    }
105
106    /**
107     * Generate the HTML content of this tab.
108     *
109     * @param Individual $individual
110     *
111     * @return string
112     */
113    public function getTabContent(Individual $individual): string
114    {
115        return view('modules/sources_tab/tab', [
116            'can_edit'        => $individual->canEdit(),
117            'clipboard_facts' => $this->clipboard_service->pastableFactsOfType($individual, $this->supportedFacts()),
118            'individual'      => $individual,
119            'facts'           => $this->getFactsWithSources($individual),
120        ]);
121    }
122
123    /**
124     * Get all the facts for an individual which contain sources.
125     *
126     * @param Individual $individual
127     *
128     * @return Collection
129     */
130    private function getFactsWithSources(Individual $individual): Collection
131    {
132        if ($this->facts === null) {
133            $facts = $individual->facts();
134
135            foreach ($individual->spouseFamilies() as $family) {
136                if ($family->canShow()) {
137                    foreach ($family->facts() as $fact) {
138                        $facts->push($fact);
139                    }
140                }
141            }
142
143            $this->facts = new Collection();
144
145            foreach ($facts as $fact) {
146                if (preg_match('/(?:^1|\n\d) SOUR/', $fact->gedcom())) {
147                    $this->facts->push($fact);
148                }
149            }
150
151            $this->facts = Fact::sortFacts($this->facts);
152        }
153
154        return $this->facts;
155    }
156
157    /**
158     * Can this tab load asynchronously?
159     *
160     * @return bool
161     */
162    public function canLoadAjax(): bool
163    {
164        return false;
165    }
166
167    /**
168     * This module handles the following facts - so don't show them on the "Facts and events" tab.
169     *
170     * @return Collection
171     */
172    public function supportedFacts(): Collection
173    {
174        return new Collection(['SOUR']);
175    }
176}
177