xref: /webtrees/app/Module/NotesTabModule.php (revision decb512f5fba376304ead41b41779062ef1dcffb) 
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\Fact;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Individual;
25use Fisharebest\Webtrees\Services\ClipboardService;
26use Illuminate\Support\Collection;
27
28/**
29 * Class NotesTabModule
30 */
31class NotesTabModule extends AbstractModule implements ModuleTabInterface
32{
33    use ModuleTabTrait;
34
35    private ?Collection $facts = null;
36
37    private ClipboardService $clipboard_service;
38
39    /**
40     * NotesTabModule 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('Notes');
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 “Notes” module */
68        return I18N::translate('A tab showing the notes attached 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 4;
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->getFactsWithNotes($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->getFactsWithNotes($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/notes/tab', [
116            'can_edit'        => $individual->canEdit(),
117            'clipboard_facts' => $this->clipboard_service->pastableFactsOfType($individual, $this->supportedFacts()),
118            'individual'      => $individual,
119            'facts'           => $this->getFactsWithNotes($individual),
120        ]);
121    }
122
123    /**
124     * Get all the facts for an individual which contain notes.
125     *
126     * @param Individual $individual
127     *
128     * @return Collection<Fact>
129     */
130    private function getFactsWithNotes(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) NOTE/', $fact->gedcom())) {
147                    $this->facts->push($fact);
148                }
149            }
150            $this->facts = Fact::sortFacts($this->facts);
151        }
152
153        return $this->facts;
154    }
155
156    /**
157     * Can this tab load asynchronously?
158     *
159     * @return bool
160     */
161    public function canLoadAjax(): bool
162    {
163        return false;
164    }
165
166    /**
167     * This module handles the following facts - so don't show them on the "Facts and events" tab.
168     *
169     * @return Collection<string>
170     */
171    public function supportedFacts(): Collection
172    {
173        return new Collection(['INDI:NOTE', 'FAM:NOTE']);
174    }
175}
176