1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Fact;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Services\ClipboardService;
use Illuminate\Support\Collection;
use function preg_match;
class NotesTabModule extends AbstractModule implements ModuleTabInterface
{
use ModuleTabTrait;
/** @var Collection<array-key,Fact>|null */
private Collection|null $facts = null;
private ClipboardService $clipboard_service;
/**
* @param ClipboardService $clipboard_service
*/
public function __construct(ClipboardService $clipboard_service)
{
$this->clipboard_service = $clipboard_service;
}
public function title(): string
{
/* I18N: Name of a module */
return I18N::translate('Notes');
}
public function description(): string
{
/* I18N: Description of the “Notes” module */
return I18N::translate('A tab showing the notes attached to an individual.');
}
/**
* The default position for this tab. It can be changed in the control panel.
*
* @return int
*/
public function defaultTabOrder(): int
{
return 4;
}
/**
* Is this tab empty? If so, we don't always need to display it.
*
* @param Individual $individual
*
* @return bool
*/
public function hasTabContent(Individual $individual): bool
{
return $individual->canEdit() || $this->getFactsWithNotes($individual)->isNotEmpty();
}
/**
* A greyed out tab has no actual content, but may perhaps have
* options to create content.
*
* @param Individual $individual
*
* @return bool
*/
public function isGrayedOut(Individual $individual): bool
{
return $this->getFactsWithNotes($individual)->isEmpty();
}
/**
* Generate the HTML content of this tab.
*
* @param Individual $individual
*
* @return string
*/
public function getTabContent(Individual $individual): string
{
return view('modules/notes/tab', [
'can_edit' => $individual->canEdit(),
'clipboard_facts' => $this->clipboard_service->pastableFactsOfType($individual, $this->supportedFacts()),
'individual' => $individual,
'facts' => $this->getFactsWithNotes($individual),
]);
}
/**
* Get all the facts for an individual which contain notes.
*
* @param Individual $individual
*
* @return Collection<int,Fact>
*/
private function getFactsWithNotes(Individual $individual): Collection
{
if ($this->facts === null) {
$facts = $individual->facts();
foreach ($individual->spouseFamilies() as $family) {
if ($family->canShow()) {
foreach ($family->facts() as $fact) {
$facts->push($fact);
}
}
}
$callback = static fn (Fact $fact): bool => preg_match('/(?:^1|\n\d) NOTE/', $fact->gedcom()) === 1;
$this->facts = $facts->filter($callback);
$this->facts = Fact::sortFacts($this->facts);
}
return $this->facts;
}
/**
* Can this tab load asynchronously?
*
* @return bool
*/
public function canLoadAjax(): bool
{
return false;
}
/**
* This module handles the following facts - so don't show them on the "Facts and events" tab.
*
* @return Collection<int,string>
*/
public function supportedFacts(): Collection
{
return new Collection(['INDI:NOTE', 'FAM:NOTE']);
}
}
|
