xref: /webtrees/app/Module/ModuleTabInterface.php (revision e4421e8051c23b38e86550bedee966e79c728183)
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;
17use Fisharebest\Webtrees\Individual;
18
19/**
20 * Interface ModuleTabInterface - Classes and libraries for module system
21 */
22interface ModuleTabInterface {
23	/**
24	 * The user can re-arrange the tab order, but until they do, this
25	 * is the order in which tabs are shown.
26	 *
27	 * @return int
28	 */
29	public function defaultTabOrder();
30
31	/**
32	 * Generate the HTML content of this tab.
33	 *
34	 * @param Individual $individual
35	 *
36	 * @return string
37	 */
38	public function getTabContent(Individual $individual);
39
40	/**
41	 * Is this tab empty? If so, we don't always need to display it.
42	 *
43	 * @param Individual $individual
44	 *
45	 * @return bool
46	 */
47	public function hasTabContent(Individual $individual);
48
49	/**
50	 * Can this tab load asynchronously?
51	 *
52	 * @return bool
53	 */
54	public function canLoadAjax();
55
56	/**
57	 * A greyed out tab has no actual content, but may perhaps have
58	 * options to create content.
59	 *
60	 * @param Individual $individual
61	 *
62	 * @return bool
63	 */
64	public function isGrayedOut(Individual $individual);
65}
66