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