xref: /webtrees/app/Module/ModuleSidebarInterface.php (revision 8f53f488f13e53e44dc48778e8f51ec9f91352dd)
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 ModuleSidebarInterface - Classes and libraries for module system
22 */
23interface ModuleSidebarInterface
24{
25    /**
26     * The user can change the order of sidebars. Until they do this, they are shown in this order.
27     *
28     * @return int
29     */
30    public function defaultSidebarOrder(): int;
31
32    /**
33     * Sidebar content.
34     *
35     * @param Individual $individual
36     *
37     * @return string
38     */
39    public function getSidebarContent(Individual $individual): string;
40
41    /**
42     * Does this sidebar have anything to display for this individual?
43     *
44     * @param Individual $individual
45     *
46     * @return bool
47     */
48    public function hasSidebarContent(Individual $individual): bool;
49}
50