xref: /webtrees/app/Module/ModuleSidebarInterface.php (revision 00b1984e374faddab4698e73088f0c964e529b65) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\Individual;
23use Illuminate\Support\Collection;
24
25/**
26 * Interface ModuleSidebarInterface - Classes and libraries for module system
27 */
28interface ModuleSidebarInterface extends ModuleInterface
29{
30    /**
31     * The text that appears on the sidebar's title.
32     *
33     * @return string
34     */
35    public function sidebarTitle(): string;
36
37    /**
38     * Users change change the order of sidebars using the control panel.
39     *
40     * @param int $sidebar_order
41     *
42     * @return void
43     */
44    public function setSidebarOrder(int $sidebar_order): void;
45
46    /**
47     * Users change change the order of sidebars using the control panel.
48     *
49     * @return int
50     */
51    public function getSidebarOrder(): int;
52
53    /**
54     * The default position for this sidebar.  It can be changed in the control panel.
55     *
56     * @return int
57     */
58    public function defaultSidebarOrder(): int;
59
60    /**
61     * Sidebar content.
62     *
63     * @param Individual $individual
64     *
65     * @return string
66     */
67    public function getSidebarContent(Individual $individual): string;
68
69    /**
70     * Does this sidebar have anything to display for this individual?
71     *
72     * @param Individual $individual
73     *
74     * @return bool
75     */
76    public function hasSidebarContent(Individual $individual): bool;
77    /**
78     * This module handles the following facts - so don't show them on the "Facts and events" tab.
79     *
80     * @return Collection<string>
81     */
82    public function supportedFacts(): Collection;
83}
84