xref: /webtrees/app/Module/ModuleReportInterface.php (revision ee4364da76be9b2651fd11a0b3dae7961849d2f3)
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 ModuleReportInterface - Classes and libraries for module system
26 */
27interface ModuleReportInterface extends ModuleInterface
28{
29    /**
30     * Name of the XML report file, relative to the resources folder.
31     *
32     * @return string
33     */
34    public function xmlFilename(): string;
35
36    /**
37     * Return a menu item for this report.
38     *
39     * @param Individual $individual
40     *
41     * @return Menu
42     */
43    public function getReportMenu(Individual $individual): Menu;
44}
45