xref: /webtrees/app/Module/ModuleLanguageInterface.php (revision 033999b09ece322217e4407c67eafd75e03718d3) 
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\ExtCalendar\CalendarInterface;
23use Fisharebest\Localization\Locale\LocaleInterface;
24use Fisharebest\Webtrees\Relationship;
25use Illuminate\Database\Query\Builder;
26
27/**
28 * Interface ModuleLanguageInterface - provide translation and localization.
29 */
30interface ModuleLanguageInterface extends ModuleInterface
31{
32    /**
33     * Phone-book ordering of letters.
34     *
35     * @return array<int,string>
36     */
37    public function alphabet(): array;
38
39    /**
40     * Default calendar used by this language.
41     *
42     * @return CalendarInterface
43     */
44    public function calendar(): CalendarInterface;
45
46    /**
47     * One of: 'DMY', 'MDY', 'YMD'.
48     *
49     * @return string
50     */
51    public function dateOrder(): string;
52
53    /**
54     * Some languages treat certain letter-combinations as equivalent.
55     *
56     * @return array<string,string>
57     */
58    public function equivalentLetters(): array;
59
60
61    /**
62     * Some languages use digraphs and trigraphs.
63     *
64     * @param string $string
65     *
66     * @return string
67     */
68    public function initialLetter(string $string): string;
69
70    /**
71     * @param string  $column
72     * @param string  $letter
73     * @param Builder $query
74     *
75     * @return void
76     */
77    public function initialLetterSQL(string $column, string $letter, Builder $query): void;
78
79    /**
80     * @return LocaleInterface
81     */
82    public function locale(): LocaleInterface;
83
84    /**
85     * @return array<Relationship>
86     */
87    public function relationships(): array;
88}
89