xref: /webtrees/app/Module/ModuleLanguageTrait.php (revision 853f2b8ab920254b02a6cbbe9d6bf1f5c4486e2f)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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\Localization\Locale\LocaleEnUs;
23use Fisharebest\Localization\Locale\LocaleInterface;
24use Fisharebest\Webtrees\I18N;
25
26/**
27 * Trait ModuleLanguageEventsTrait - default implementation of ModuleLanguageInterface.
28 */
29trait ModuleLanguageTrait
30{
31    /**
32     * How should this module be identified in the control panel, etc.?
33     *
34     * @return string
35     */
36    public function title(): string
37    {
38        return  $this->locale()->endonym();
39    }
40
41    /**
42     * A sentence describing what this module does.
43     *
44     * @return string
45     */
46    public function description(): string
47    {
48        return I18N::translate('Language') . ' — ' . $this->title() . ' — ' . $this->locale()->languageTag();
49    }
50
51    /**
52     * @return LocaleInterface
53     */
54    public function locale(): LocaleInterface
55    {
56        return new LocaleEnUs();
57    }
58}
59