xref: /webtrees/app/Module/ModuleMenuInterface.php (revision 873953697c930fadbf3243d2b8c0029fd684da0e)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2018 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 */
16namespace Fisharebest\Webtrees\Module;
17
18use Fisharebest\Webtrees\Menu;
19use Fisharebest\Webtrees\Tree;
20
21/**
22 * Interface ModuleMenuInterface - Classes and libraries for module system
23 */
24interface ModuleMenuInterface
25{
26    /**
27     * The user can re-order menus. Until they do, they are shown in this order.
28     *
29     * @return int
30     */
31    public function defaultMenuOrder(): int;
32
33    /**
34     * A menu, to be added to the main application menu.
35     *
36     * @param Tree $tree
37     *
38     * @return Menu|null
39     */
40    public function getMenu(Tree $tree);
41}
42