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