xref: /webtrees/app/Module/ModuleTabInterface.php (revision 9ba014a766385c38470d363a384f5a2c9642a7b8) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 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;
21use Illuminate\Support\Collection;
22
23/**
24 * Interface ModuleTabInterface - Classes and libraries for module system
25 */
26interface ModuleTabInterface extends ModuleInterface
27{
28    /**
29     * The text that appears on the tab.
30     *
31     * @return string
32     */
33    public function tabTitle(): string;
34
35    /**
36     * Users change change the order of tabs using the control panel.
37     *
38     * @param int $tab_order
39     *
40     * @return void
41     */
42    public function setTabOrder(int $tab_order): void;
43
44    /**
45     * Users change change the order of tabs using the control panel.
46     *
47     * @return int
48     */
49    public function getTabOrder(): int;
50
51    /**
52     * The default position for this tab.  It can be changed in the control panel.
53     *
54     * @return int
55     */
56    public function defaultTabOrder(): int;
57
58    /**
59     * Generate the HTML content of this tab.
60     *
61     * @param Individual $individual
62     *
63     * @return string
64     */
65    public function getTabContent(Individual $individual): string;
66
67    /**
68     * Is this tab empty? If so, we don't always need to display it.
69     *
70     * @param Individual $individual
71     *
72     * @return bool
73     */
74    public function hasTabContent(Individual $individual): bool;
75
76    /**
77     * Can this tab load asynchronously?
78     *
79     * @return bool
80     */
81    public function canLoadAjax(): bool;
82
83    /**
84     * A greyed out tab has no actual content, but may perhaps have
85     * options to create content.
86     *
87     * @param Individual $individual
88     *
89     * @return bool
90     */
91    public function isGrayedOut(Individual $individual): bool;
92
93    /**
94     * This module handles the following facts - so don't show them on the "Facts and events" tab.
95     *
96     * @return Collection
97     */
98    public function supportedFacts(): Collection;
99}
100