xref: /webtrees/app/Module/ModuleSidebarInterface.php (revision ecf66805cdf435857ce4ed0eb577cfd1296f8989)
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
18/**
19 * Interface ModuleSidebarInterface - Classes and libraries for module system
20 */
21interface ModuleSidebarInterface {
22	/**
23	 * The user can change the order of sidebars. Until they do this, they are shown in this order.
24	 *
25	 * @return int
26	 */
27	public function defaultSidebarOrder();
28
29	/**
30	 * Load this sidebar synchronously.
31	 *
32	 * @return string
33	 */
34	public function getSidebarContent();
35
36	/**
37	 * Load this sidebar asynchronously.
38	 *
39	 * @return string
40	 */
41	public function getSidebarAjaxContent();
42
43	/**
44	 * Does this sidebar have anything to display for this individual?
45	 *
46	 * @return bool
47	 */
48	public function hasSidebarContent();
49}
50