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