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