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