xref: /webtrees/app/Module/ModuleSidebarInterface.php (revision d812eb6b3dd6c33a96d07cd964cb4c3b88cec447) 
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 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Module;
20
21use Fisharebest\Webtrees\Individual;
22use Illuminate\Support\Collection;
23
24/**
25 * Interface ModuleSidebarInterface - Classes and libraries for module system
26 */
27interface ModuleSidebarInterface extends ModuleInterface
28{
29    /**
30     * The text that appears on the sidebar's title.
31     *
32     * @return string
33     */
34    public function sidebarTitle(): string;
35
36    /**
37     * Users change change the order of sidebars using the control panel.
38     *
39     * @param int $sidebar_order
40     *
41     * @return void
42     */
43    public function setSidebarOrder(int $sidebar_order): void;
44
45    /**
46     * Users change change the order of sidebars using the control panel.
47     *
48     * @return int
49     */
50    public function getSidebarOrder(): int;
51
52    /**
53     * The default position for this sidebar.  It can be changed in the control panel.
54     *
55     * @return int
56     */
57    public function defaultSidebarOrder(): int;
58
59    /**
60     * Sidebar content.
61     *
62     * @param Individual $individual
63     *
64     * @return string
65     */
66    public function getSidebarContent(Individual $individual): string;
67
68    /**
69     * Does this sidebar have anything to display for this individual?
70     *
71     * @param Individual $individual
72     *
73     * @return bool
74     */
75    public function hasSidebarContent(Individual $individual): bool;
76    /**
77     * This module handles the following facts - so don't show them on the "Facts and events" tab.
78     *
79     * @return Collection
80     */
81    public function supportedFacts(): Collection;
82}
83