xref: /webtrees/app/Module/ModuleMenuInterface.php (revision 9f2390a04226d0058d1862402c80d50fe6e79aa1)
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;
19
20/**
21 * Interface ModuleMenuInterface - Classes and libraries for module system
22 */
23interface ModuleMenuInterface {
24	/**
25	 * The user can re-order menus. Until they do, they are shown in this order.
26	 *
27	 * @return int
28	 */
29	public function defaultMenuOrder();
30
31	/**
32	 * A menu, to be added to the main application menu.
33	 *
34	 * @return Menu|null
35	 */
36	public function getMenu();
37}
38