xref: /webtrees/app/Module/ModuleChartInterface.php (revision b11cdcd45131b1585d66693fab363cfeb18c51a4) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * 'Copyright (C) 2023 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;
24
25/**
26 * Interface ModuleChartInterface - Classes and libraries for module system
27 */
28interface ModuleChartInterface extends ModuleInterface
29{
30    /**
31     * A menu item for this chart for an individual box in a chart.
32     *
33     * @param Individual $individual
34     *
35     * @return Menu|null
36     */
37    public function chartBoxMenu(Individual $individual): ?Menu;
38
39    /**
40     * A main menu item for this chart.
41     *
42     * @param Individual $individual
43     *
44     * @return Menu
45     */
46    public function chartMenu(Individual $individual): Menu;
47
48    /**
49     * CSS class for the menu.
50     *
51     * @return string
52     */
53    public function chartMenuClass(): string;
54
55    /**
56     * The title for a specific instance of this chart.
57     *
58     * @param Individual $individual
59     *
60     * @return string
61     */
62    public function chartTitle(Individual $individual): string;
63
64    /**
65     * The URL for a page showing chart options.
66     *
67     * @param Individual                                $individual
68     * @param array<bool|int|string|array<string>|null> $parameters
69     *
70     * @return string
71     */
72    public function chartUrl(Individual $individual, array $parameters = []): string;
73
74    /**
75     * Attributes for the URL.
76     *
77     * @return array<string>
78     */
79    public function chartUrlAttributes(): array;
80}
81