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