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