xref: /webtrees/app/Module/ModuleThemeInterface.php (revision 89f7189b61a494347591c99bdb92afb7d8b66e1b) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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\Individual;
23use Fisharebest\Webtrees\Menu;
24use Fisharebest\Webtrees\Tree;
25
26/**
27 * Interface ModuleThemelInterface - Classes and libraries for module system
28 */
29interface ModuleThemeInterface extends ModuleInterface
30{
31    /**
32     * Links, to show in chart boxes;
33     *
34     * @param Individual $individual
35     *
36     * @return Menu[]
37     */
38    public function individualBoxMenu(Individual $individual): array;
39
40    /**
41     * Themes menu.
42     *
43     * @return Menu|null
44     */
45    public function menuThemes(): ?Menu;
46
47    /**
48     * Miscellaneous dimensions, fonts, styles, etc.
49     *
50     * @param string $parameter_name
51     *
52     * @return string|int|float
53     */
54    public function parameter($parameter_name);
55
56    /**
57     * Generate a list of items for the main menu.
58     *
59     * @param Tree|null $tree
60     *
61     * @return Menu[]
62     */
63    public function genealogyMenu(?Tree $tree): array;
64
65    /**
66     * Generate a list of items for the user menu.
67     *
68     * @param Tree|null $tree
69     *
70     * @return Menu[]
71     */
72    public function userMenu(?Tree $tree): array;
73
74    /**
75     * A list of CSS files to include for this page.
76     *
77     * @return string[]
78     */
79    public function stylesheets(): array;
80}
81