xref: /webtrees/app/Module/ModuleTabTrait.php (revision 895230eed7521b5cd885b90d4f5310405ff0b69a)
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
20/**
21 * Trait ModuleTabTrait - default implementation of ModuleTabInterface
22 */
23trait ModuleTabTrait
24{
25    /** @var int The default position for this tab.  It can be changed in the control panel. */
26    protected $tab_order = 0;
27
28    /**
29     * Users change change the order of tabs using the control panel.
30     *
31     * @param int $tab_order
32     *
33     * @return void
34     */
35    public function setTabOrder(int $tab_order): void
36    {
37        $this->tab_order = $tab_order;
38    }
39
40    /**
41     * Users change change the order of tabs using the control panel.
42     *
43     * @return int
44     */
45    public function getTabOrder(): int
46    {
47        return $this->tab_order ?: $this->defaultTabOrder();
48    }
49
50    /**
51     * The default position for this tab.  It can be changed in the control panel.
52     *
53     * @return int
54     */
55    public function defaultTabOrder(): int
56    {
57        return 9999;
58    }
59}
60