xref: /webtrees/app/Module/ModuleChartInterface.php (revision 18fd0859d876caec952296f28638ed0844e10712) 
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    public function chartBoxMenu(Individual $individual): Menu|null;
34
35    /**
36     * A main menu item for this chart.
37     *
38     * @param Individual $individual
39     *
40     * @return Menu
41     */
42    public function chartMenu(Individual $individual): Menu;
43
44    /**
45     * CSS class for the menu.
46     *
47     * @return string
48     */
49    public function chartMenuClass(): string;
50
51    /**
52     * The title for a specific instance of this chart.
53     *
54     * @param Individual $individual
55     *
56     * @return string
57     */
58    public function chartTitle(Individual $individual): string;
59
60    /**
61     * The URL for a page showing chart options.
62     *
63     * @param Individual                                $individual
64     * @param array<bool|int|string|array<string>|null> $parameters
65     *
66     * @return string
67     */
68    public function chartUrl(Individual $individual, array $parameters = []): string;
69
70    /**
71     * Attributes for the URL.
72     *
73     * @return array<string>
74     */
75    public function chartUrlAttributes(): array;
76}
77