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