blob: 7aaeb69b0834e9efff7a50175016cffc09dc68d8 (
plain)
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
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Tree;
use Symfony\Component\HttpFoundation\Response;
/**
* Interface ModuleInterface - Classes and libraries for module system
*/
interface ModuleInterface
{
/**
* A unique internal name for this module (based on the installation folder).
*
* @param string $name
*
* @return void
*/
public function setName(string $name): void;
/**
* A unique internal name for this module (based on the installation folder).
*
* @return string
*/
public function name(): string;
/**
* Has the module been disabled in the control panel?
*
* @param bool $enabled
*
* @return self
*/
public function setEnabled(bool $enabled): self;
/**
* Has the module been disabled in the control panel?
*
* @return bool
*/
public function isEnabled(): bool;
/**
* Should this module be enabled when it is first installed?
*
* @return bool
*/
public function isEnabledByDefault(): bool;
/**
* How should this module be identified in the control panel, etc.?
*
* @return string
*/
public function title(): string;
/**
* A sentence describing what this module does.
*
* @return string
*/
public function description(): string;
/**
* Get a the current access level for a module
*
* @param Tree $tree
* @param string $interface
*
* @return int
*/
public function accessLevel(Tree $tree, string $interface): int;
/**
* Get a module setting. Return a default if the setting is not set.
*
* @param string $setting_name
* @param string $default
*
* @return string
*/
public function getPreference(string $setting_name, string $default = ''): string;
/**
* 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
*/
public function setPreference(string $setting_name, string $setting_value): void;
/**
* Where does this module store its resources
*
* @return string
*/
public function resourcesFolder(): string;
}
|
