xref: /webtrees/app/Module/ModuleTabTrait.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 ModuleTabTrait - default implementation of ModuleTabInterface
24 */
25trait ModuleTabTrait
26{
27    /** @var int The default position for this tab.  It can be changed in the control panel. */
28    protected $tab_order = 0;
29
30    /**
31     * The text that appears on the tab.
32     *
33     * @return string
34     */
35    public function tabTitle(): string
36    {
37        return $this->title();
38    }
39
40    /**
41     * Users change change the order of tabs using the control panel.
42     *
43     * @param int $tab_order
44     *
45     * @return void
46     */
47    public function setTabOrder(int $tab_order): void
48    {
49        $this->tab_order = $tab_order;
50    }
51
52    /**
53     * Users change change the order of tabs using the control panel.
54     *
55     * @return int
56     */
57    public function getTabOrder(): int
58    {
59        return $this->tab_order ?? $this->defaultTabOrder();
60    }
61
62    /**
63     * The default position for this tab.  It can be changed in the control panel.
64     *
65     * @return int
66     */
67    public function defaultTabOrder(): int
68    {
69        return 9999;
70    }
71
72    /**
73     * This module handles the following facts - so don't show them on the "Facts and events" tab.
74     *
75     * @return Collection|string[]
76     */
77    public function supportedFacts(): Collection
78    {
79        return new Collection([]);
80    }
81}
82