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