xref: /webtrees/app/Module/ModuleMenuInterface.php (revision cbc1590a8c715aa2d88bd745610b899587bd9563)
1a25f0a04SGreg Roach<?php
2dd04c183SGreg Roachnamespace Fisharebest\Webtrees;
3a25f0a04SGreg Roach
4a25f0a04SGreg Roach/**
5a25f0a04SGreg Roach * webtrees: online genealogy
6a25f0a04SGreg Roach * Copyright (C) 2015 webtrees development team
7a25f0a04SGreg Roach * This program is free software: you can redistribute it and/or modify
8a25f0a04SGreg Roach * it under the terms of the GNU General Public License as published by
9a25f0a04SGreg Roach * the Free Software Foundation, either version 3 of the License, or
10a25f0a04SGreg Roach * (at your option) any later version.
11a25f0a04SGreg Roach * This program is distributed in the hope that it will be useful,
12a25f0a04SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
13a25f0a04SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14a25f0a04SGreg Roach * GNU General Public License for more details.
15a25f0a04SGreg Roach * You should have received a copy of the GNU General Public License
16a25f0a04SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
17a25f0a04SGreg Roach */
18a25f0a04SGreg Roach
19a25f0a04SGreg Roach/**
20a25f0a04SGreg Roach * Interface ModuleMenuInterface - Classes and libraries for module system
21a25f0a04SGreg Roach */
22a25f0a04SGreg Roachinterface ModuleMenuInterface {
23a25f0a04SGreg Roach	/**
24a25f0a04SGreg Roach	 * The user can re-order menus.  Until they do, they are shown in this order.
25a25f0a04SGreg Roach	 *
26*cbc1590aSGreg Roach	 * @return int
27a25f0a04SGreg Roach	 */
28a25f0a04SGreg Roach	public function defaultMenuOrder();
29a25f0a04SGreg Roach
30a25f0a04SGreg Roach	/**
31a25f0a04SGreg Roach	 * A menu, to be added to the main application menu.
32a25f0a04SGreg Roach	 *
33a25f0a04SGreg Roach	 * @return Menu|null
34a25f0a04SGreg Roach	 */
35a25f0a04SGreg Roach	public function getMenu();
36a25f0a04SGreg Roach}
37