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