xref: /webtrees/app/Module/ModuleThemeInterface.php (revision 3976b4703df669696105ed6b024b96d433c8fbdb) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>.
16 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Module;
20
21use Fisharebest\Webtrees\Fact;
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     * Display an icon for this fact.
33     *
34     * @param Fact $fact
35     *
36     * @return string
37     */
38    public function icon(Fact $fact): string;
39
40    /**
41     * Links, to show in chart boxes;
42     *
43     * @param Individual $individual
44     *
45     * @return Menu[]
46     */
47    public function individualBoxMenu(Individual $individual): array;
48
49    /**
50     * Themes menu.
51     *
52     * @return Menu|null
53     */
54    public function menuThemes(): ?Menu;
55
56    /**
57     * Misecellaneous dimensions, fonts, styles, etc.
58     *
59     * @param string $parameter_name
60     *
61     * @return string|int|float
62     */
63    public function parameter($parameter_name);
64
65    /**
66     * Generate a list of items for the main menu.
67     *
68     * @param Tree|null $tree
69     *
70     * @return Menu[]
71     */
72    public function genealogyMenu(?Tree $tree): array;
73
74    /**
75     * Generate a list of items for the user menu.
76     *
77     * @param Tree|null $tree
78     *
79     * @return Menu[]
80     */
81    public function userMenu(?Tree $tree): array;
82
83    /**
84     * A list of CSS files to include for this page.
85     *
86     * @return string[]
87     */
88    public function stylesheets(): array;
89}
90