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