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