xref: /webtrees/app/Module/ModuleTabTrait.php (revision ca50fb84724cb523ca8f4be8abd453a667296dcf) 
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 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Illuminate\Support\Collection;
23
24/**
25 * Trait ModuleTabTrait - default implementation of ModuleTabInterface
26 */
27trait ModuleTabTrait
28{
29    /** @var int The default position for this tab.  It can be changed in the control panel. */
30    protected $tab_order;
31
32    /**
33     * @return string
34     */
35    abstract public function title(): string;
36
37    /**
38     * The text that appears on the tab.
39     *
40     * @return string
41     */
42    public function tabTitle(): string
43    {
44        return $this->title();
45    }
46
47    /**
48     * Users change change the order of tabs using the control panel.
49     *
50     * @param int $tab_order
51     *
52     * @return void
53     */
54    public function setTabOrder(int $tab_order): void
55    {
56        $this->tab_order = $tab_order;
57    }
58
59    /**
60     * Users change change the order of tabs using the control panel.
61     *
62     * @return int
63     */
64    public function getTabOrder(): int
65    {
66        return $this->tab_order ?? $this->defaultTabOrder();
67    }
68
69    /**
70     * The default position for this tab.  It can be changed in the control panel.
71     *
72     * @return int
73     */
74    public function defaultTabOrder(): 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