xref: /webtrees/app/Module/ModuleInterface.php (revision 37eb8894d5d4381f3fd9b791a53a32f0012b32ec) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Tree;
21
22/**
23 * Interface ModuleInterface - Classes and libraries for module system
24 */
25interface ModuleInterface
26{
27    /**
28     * A unique internal name for this module (based on the installation folder).
29     *
30     * @param string $name
31     *
32     * @return void
33     */
34    public function setName(string $name): void;
35
36    /**
37     * A unique internal name for this module (based on the installation folder).
38     *
39     * @return string
40     */
41    public function name(): string;
42
43    /**
44     * Has the module been disabled in the control panel?
45     *
46     * @param bool $enabled
47     *
48     * @return self
49     */
50    public function setEnabled(bool $enabled): self;
51
52    /**
53     * Has the module been disabled in the control panel?
54     *
55     * @return bool
56     */
57    public function isEnabled(): bool;
58
59    /**
60     * How should this module be labelled on tabs, menus, etc.?
61     *
62     * @return string
63     */
64    public function title(): string;
65
66    /**
67     * A sentence describing what this module does.
68     *
69     * @return string
70     */
71    public function description(): string;
72
73    /**
74     * Get a the current access level for a module
75     *
76     * @param Tree   $tree
77     * @param string $component tab, block, menu, etc
78     *
79     * @return int
80     */
81    public function accessLevel(Tree $tree, string $component): int;
82
83    /**
84     * Get a module setting. Return a default if the setting is not set.
85     *
86     * @param string $setting_name
87     * @param string $default
88     *
89     * @return string
90     */
91    public function getPreference(string $setting_name, string $default = ''): string;
92
93    /**
94     * Set a module setting.
95     *
96     * Since module settings are NOT NULL, setting a value to NULL will cause
97     * it to be deleted.
98     *
99     * @param string $setting_name
100     * @param string $setting_value
101     *
102     * @return $this
103     */
104    public function setPreference(string $setting_name, string $setting_value): void;
105}
106