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