xref: /webtrees/app/Module/LanguageNorwegianBokmal.php (revision ac71572d8462e396ed5a307f05b29381e49f9e6e) 
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\LocaleInterface;
23use Fisharebest\Localization\Locale\LocaleNb;
24
25use function mb_substr;
26use function str_starts_with;
27
28/**
29 * Class LanguageNorwegianBokmal.
30 */
31class LanguageNorwegianBokmal extends AbstractModule implements ModuleLanguageInterface
32{
33    use ModuleLanguageTrait;
34
35    /**
36     * Phone-book ordering of letters.
37     *
38     * @return array<int,string>
39     */
40    public function alphabet(): array
41    {
42        return ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'Æ', 'Ø', 'Å'];
43    }
44
45    /**
46     * Some languages treat certain letter-combinations as equivalent.
47     *
48     * @return array<string,string>
49     */
50    public function equivalentLetters(): array
51    {
52        return ['aa' => 'å', 'aA' => 'å', 'Aa' => 'Å', 'AA' => 'Å'];
53    }
54
55    /**
56     * Some languages use digraphs and trigraphs.
57     *
58     * @param string $string
59     *
60     * @return string
61     */
62    public function initialLetter(string $string): string
63    {
64        if (str_starts_with($string, 'AA')) {
65            return 'Å';
66        }
67
68        return mb_substr($string, 0, 1);
69    }
70
71    /**
72     * Should this module be enabled when it is first installed?
73     *
74     * @return bool
75     */
76    public function isEnabledByDefault(): bool
77    {
78        return false;
79    }
80
81    /**
82     * @return LocaleInterface
83     */
84    public function locale(): LocaleInterface
85    {
86        return new LocaleNb();
87    }
88}
89