xref: /webtrees/app/Module/ModuleChartInterface.php (revision e539f5c659fdb4b3fcf865b058906958d688ba15) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20use Fisharebest\Webtrees\Individual;
21use Fisharebest\Webtrees\Menu;
22
23/**
24 * Interface ModuleChartInterface - Classes and libraries for module system
25 */
26interface ModuleChartInterface
27{
28    /**
29     * A main menu item for this chart.
30     *
31     * @param Individual $individual
32     *
33     * @return Menu
34     */
35    public function chartMenu(Individual $individual): Menu;
36
37    /**
38     * A menu item for this chart for an individual box in a chart.
39     *
40     * @param Individual $individual
41     *
42     * @return Menu|null
43     */
44    public function chartMenuIndividual(Individual $individual): ?Menu;
45
46    /**
47     * The title for a specific instance of this chart.
48     *
49     * @param Individual $individual
50     *
51     * @return string
52     */
53    public function chartTitle(Individual $individual): string;
54
55    /**
56     * The URL for a page showing chart options.
57     *
58     * @param Individual $individual
59     * @param string[]   $parameters
60     *
61     * @return string
62     */
63    public function chartUrl(Individual $individual, array $parameters = []): string;
64
65    /**
66     * Attributes for the URL.
67     *
68     * @return string[]
69     */
70    public function chartUrlAttributes(): array;
71
72    /**
73     * CSS class for the URL.
74     *
75     * @return string
76     */
77    public function chartUrlClasss(): string;
78}
79