xref: /webtrees/app/Module/PoweredByWebtreesModule.php (revision db3aeb3eb846bb233f34557aedb1559aadf9275a)
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 Fisharebest\Webtrees\I18N;
21use Fisharebest\Webtrees\Tree;
22use Fisharebest\Webtrees\Webtrees;
23
24/**
25 * Class PoweredByWebtreesModule - provide a link to the project home page.
26 */
27class PoweredByWebtreesModule extends AbstractModule implements ModuleFooterInterface
28{
29    use ModuleFooterTrait;
30
31    /**
32     * How should this module be labelled on tabs, footers, etc.?
33     *
34     * @return string
35     */
36    public function title(): string
37    {
38        /* I18N: Name of a module */
39        return I18N::translate('Powered by webtrees™');
40    }
41
42    /**
43     * A sentence describing what this module does.
44     *
45     * @return string
46     */
47    public function description(): string
48    {
49        /* I18N: Description of the “webtrees” module */
50        return I18N::translate('A link to the webtrees home page.');
51    }
52
53    /**
54     * The default position for this footer.  It can be changed in the control panel.
55     *
56     * @return int
57     */
58    public function defaultFooterOrder(): int
59    {
60        return 1;
61    }
62
63    /**
64     * A footer, to be added at the bottom of every page.
65     *
66     * @param Tree|null $tree
67     *
68     * @return string
69     */
70    public function getFooter(?Tree $tree): string
71    {
72        return view('modules/powered-by-webtrees/footer', [
73            'name' => Webtrees::NAME,
74            'url'  => Webtrees::URL,
75        ]);
76    }
77}
78