xref: /webtrees/app/Module/NotesTabModule.php (revision 5bfc689774bb9a6401271c4ed15a6d50652c991b) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 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
28use function preg_match;
29
30/**
31 * Class NotesTabModule
32 */
33class NotesTabModule extends AbstractModule implements ModuleTabInterface
34{
35    use ModuleTabTrait;
36
37    /** @var Collection<array-key,Fact>|null  */
38    private ?Collection $facts = null;
39
40    private ClipboardService $clipboard_service;
41
42    /**
43     * NotesTabModule constructor.
44     *
45     * @param ClipboardService $clipboard_service
46     */
47    public function __construct(ClipboardService $clipboard_service)
48    {
49        $this->clipboard_service = $clipboard_service;
50    }
51
52    /**
53     * How should this module be identified in the control panel, etc.?
54     *
55     * @return string
56     */
57    public function title(): string
58    {
59        /* I18N: Name of a module */
60        return I18N::translate('Notes');
61    }
62
63    /**
64     * A sentence describing what this module does.
65     *
66     * @return string
67     */
68    public function description(): string
69    {
70        /* I18N: Description of the “Notes” module */
71        return I18N::translate('A tab showing the notes attached to an individual.');
72    }
73
74    /**
75     * The default position for this tab.  It can be changed in the control panel.
76     *
77     * @return int
78     */
79    public function defaultTabOrder(): int
80    {
81        return 4;
82    }
83
84    /**
85     * Is this tab empty? If so, we don't always need to display it.
86     *
87     * @param Individual $individual
88     *
89     * @return bool
90     */
91    public function hasTabContent(Individual $individual): bool
92    {
93        return $individual->canEdit() || $this->getFactsWithNotes($individual)->isNotEmpty();
94    }
95
96    /**
97     * A greyed out tab has no actual content, but may perhaps have
98     * options to create content.
99     *
100     * @param Individual $individual
101     *
102     * @return bool
103     */
104    public function isGrayedOut(Individual $individual): bool
105    {
106        return $this->getFactsWithNotes($individual)->isEmpty();
107    }
108
109    /**
110     * Generate the HTML content of this tab.
111     *
112     * @param Individual $individual
113     *
114     * @return string
115     */
116    public function getTabContent(Individual $individual): string
117    {
118        return view('modules/notes/tab', [
119            'can_edit'        => $individual->canEdit(),
120            'clipboard_facts' => $this->clipboard_service->pastableFactsOfType($individual, $this->supportedFacts()),
121            'individual'      => $individual,
122            'facts'           => $this->getFactsWithNotes($individual),
123        ]);
124    }
125
126    /**
127     * Get all the facts for an individual which contain notes.
128     *
129     * @param Individual $individual
130     *
131     * @return Collection<int,Fact>
132     */
133    private function getFactsWithNotes(Individual $individual): Collection
134    {
135        if ($this->facts === null) {
136            $facts = $individual->facts();
137
138            foreach ($individual->spouseFamilies() as $family) {
139                if ($family->canShow()) {
140                    foreach ($family->facts() as $fact) {
141                        $facts->push($fact);
142                    }
143                }
144            }
145
146            $callback = static fn (Fact $fact): bool => preg_match('/(?:^1|\n\d) NOTE/', $fact->gedcom()) === 1;
147
148            $this->facts = $facts->filter($callback);
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<int,string>
170     */
171    public function supportedFacts(): Collection
172    {
173        return new Collection(['INDI:NOTE', 'FAM:NOTE']);
174    }
175}
176