xref: /webtrees/app/Module/PoweredByWebtreesModule.php (revision 7413816e6dd2d50e569034fb804f3dce7471bb94)
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    public function description(): string
45    {
46        /* I18N: Description of the “webtrees” module */
47        return I18N::translate('A link to the webtrees home page.');
48    }
49
50    /**
51     * The default position for this footer.  It can be changed in the control panel.
52     *
53     * @return int
54     */
55    public function defaultFooterOrder(): int
56    {
57        return 1;
58    }
59
60    /**
61     * A footer, to be added at the bottom of every page.
62     *
63     * @param ServerRequestInterface $request
64     *
65     * @return string
66     */
67    public function getFooter(ServerRequestInterface $request): string
68    {
69        return view('modules/powered-by-webtrees/footer', [
70            'name' => Webtrees::NAME,
71            'url'  => Webtrees::URL,
72        ]);
73    }
74}
75