blob: 81fe490a67894ee4eab9440c6de6f9fb2a55522c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2015 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace Fisharebest\Webtrees\Module;
/**
* Interface ModuleTabInterface - Classes and libraries for module system
*/
interface ModuleTabInterface {
/**
* The user can re-arrange the tab order, but until they do, this
* is the order in which tabs are shown.
*
* @return int
*/
public function defaultTabOrder();
/**
* Generate the HTML content of this tab.
*
* @return string
*/
public function getTabContent();
/**
* Is this tab empty? If so, we don't always need to display it.
*
* @return bool
*/
public function hasTabContent();
/**
* Can this tab load asynchronously?
*
* @return bool
*/
public function canLoadAjax();
/**
* Any content (e.g. Javascript) that needs to be rendered before the tabs.
*
* This function is probably not needed, as there are better ways to achieve this.
*
* @return string
*/
public function getPreLoadContent();
/**
* A greyed out tab has no actual content, but may perhaps have
* options to create content.
*
* @return bool
*/
public function isGrayedOut();
}
|
