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