xref: /webtrees/app/Module/ModuleSidebarTrait.php (revision 9ba014a766385c38470d363a384f5a2c9642a7b8) 
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 Illuminate\Support\Collection;
21
22/**
23 * Trait ModuleSidebarTrait - default implementation of ModuleSidebarInterface
24 */
25trait ModuleSidebarTrait
26{
27    /** @var int The default position for this sidebar.  It can be changed in the control panel. */
28    protected $sidebar_order;
29
30    /**
31     * @return string
32     */
33    abstract public function title(): string;
34
35    /**
36     * The text that appears on the sidebar's title.
37     *
38     * @return string
39     */
40    public function sidebarTitle(): string
41    {
42        return $this->title();
43    }
44
45    /**
46     * Users change change the order of sidebars using the control panel.
47     *
48     * @param int $sidebar_order
49     *
50     * @return void
51     */
52    public function setSidebarOrder(int $sidebar_order): void
53    {
54        $this->sidebar_order = $sidebar_order;
55    }
56
57    /**
58     * Users change change the order of sidebars using the control panel.
59     *
60     * @return int
61     */
62    public function getSidebarOrder(): int
63    {
64        return $this->sidebar_order ?? $this->defaultSidebarOrder();
65    }
66
67
68    /**
69     * The default position for this sdiebar.
70     *
71     * @return int
72     */
73    public function defaultSidebarOrder(): int
74    {
75        return 9999;
76    }
77
78    /**
79     * This module handles the following facts - so don't show them on the "Facts and events" tab.
80     *
81     * @return Collection
82     */
83    public function supportedFacts(): Collection
84    {
85        return new Collection([]);
86    }
87}
88