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