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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
<?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\Auth;
use Fisharebest\Webtrees\DB;
use Fisharebest\Webtrees\Http\ViewResponseTrait;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\Webtrees;
use Illuminate\Support\Collection;
/**
* Class AbstractModule - common functions for blocks
*/
abstract class AbstractModule implements ModuleInterface
{
use ViewResponseTrait;
// A unique internal name for this module (based on the installation folder).
private string $name = '';
// The default access level for this module. It can be changed in the control panel.
protected int $access_level = Auth::PRIV_PRIVATE;
// The default status for this module. It can be changed in the control panel.
private bool $enabled = true;
/**
* Called for all *enabled* modules.
*/
public function boot(): void
{
}
public function title(): string
{
return 'Module name goes here';
}
public function description(): string
{
return $this->title();
}
/**
* Get a block setting.
*
* Originally, this was just used for the home-page blocks. Now, it is used by any
* module that has repeated blocks of content on the same page.
*
* @param int $block_id
* @param string $setting_name
* @param string $default
*
* @return string
*/
final protected function getBlockSetting(int $block_id, string $setting_name, string $default = ''): string
{
$settings = Registry::cache()->array()
->remember('block-setting-' . $block_id, static fn (): array => DB::table('block_setting')
->where('block_id', '=', $block_id)
->pluck('setting_value', 'setting_name')
->all());
return $settings[$setting_name] ?? $default;
}
/**
* Set a block setting.
*
* @param int $block_id
* @param string $setting_name
* @param string $setting_value
*
* @return self
*/
final protected function setBlockSetting(int $block_id, string $setting_name, string $setting_value): self
{
DB::table('block_setting')->updateOrInsert([
'block_id' => $block_id,
'setting_name' => $setting_name,
], [
'setting_value' => $setting_value,
]);
return $this;
}
/**
* A unique internal name for this module (based on the installation folder).
*
* @param string $name
*
* @return void
*/
final public function setName(string $name): void
{
$this->name = $name;
}
/**
* A unique internal name for this module (based on the installation folder).
*
* @return string
*/
final public function name(): string
{
return $this->name;
}
/**
* Modules are either enabled or disabled.
*
* @param bool $enabled
*
* @return ModuleInterface
*/
final public function setEnabled(bool $enabled): ModuleInterface
{
$this->enabled = $enabled;
return $this;
}
/**
* Modules are either enabled or disabled.
*
* @return bool
*/
final public function isEnabled(): bool
{
return $this->enabled;
}
public function isEnabledByDefault(): bool
{
return true;
}
/**
* Get a module setting. Return a default if the setting is not set.
*
* @param string $setting_name
* @param string $default
*
* @return string
*/
final public function getPreference(string $setting_name, string $default = ''): string
{
return DB::table('module_setting')
->where('module_name', '=', $this->name())
->where('setting_name', '=', $setting_name)
->value('setting_value') ?? $default;
}
/**
* Set a module setting.
*
* Since module settings are NOT NULL, setting a value to NULL will cause
* it to be deleted.
*
* @param string $setting_name
* @param string $setting_value
*
* @return void
*/
final public function setPreference(string $setting_name, string $setting_value): void
{
DB::table('module_setting')->updateOrInsert([
'module_name' => $this->name(),
'setting_name' => $setting_name,
], [
'setting_value' => $setting_value,
]);
}
/**
* Get the current access level for a module
*
* @template T
*
* @param Tree $tree
* @param class-string<T> $interface
*
* @return int
*/
final public function accessLevel(Tree $tree, string $interface): int
{
$access_levels = Registry::cache()->array()
->remember('module-privacy-' . $tree->id(), static fn (): Collection => DB::table('module_privacy')
->where('gedcom_id', '=', $tree->id())
->get());
$row = $access_levels->first(fn (object $row): bool => $row->interface === $interface && $row->module_name === $this->name());
return $row ? (int) $row->access_level : $this->access_level;
}
/**
* Where does this module store its resources
*
* @return string
*/
public function resourcesFolder(): string
{
return Webtrees::ROOT_DIR . '/resources/';
}
}
|
