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