Passed
Push — tmp ( 3f3fcc...32c7e7 )
by Greg
05:58
created

ModuleLanguageTrait::calendar()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Module;
21
22
use Fisharebest\ExtCalendar\CalendarInterface;
23
use Fisharebest\ExtCalendar\GregorianCalendar;
24
use Fisharebest\Localization\Locale\LocaleEnUs;
25
use Fisharebest\Localization\Locale\LocaleInterface;
26
use Fisharebest\Webtrees\I18N;
27
use Fisharebest\Webtrees\Relationship;
28
29
use Illuminate\Database\Query\Builder;
30
31
use function mb_substr;
32
33
/**
34
 * Trait ModuleLanguageEventsTrait - default implementation of ModuleLanguageInterface.
35
 */
36
trait ModuleLanguageTrait
37
{
38
    /**
39
     * Phone-book ordering of letters.
40
     *
41
     * @return array<int,string>
42
     */
43
    public function alphabet(): array
44
    {
45
        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'];
46
    }
47
48
    /**
49
     * Default calendar used by this language.
50
     *
51
     * @return CalendarInterface
52
     */
53
    public function calendar(): CalendarInterface
54
    {
55
        return new GregorianCalendar();
56
    }
57
58
    /**
59
     * One of: 'DMY', 'MDY', 'YMD'.
60
     *
61
     * @return string
62
     */
63
    public function dateOrder(): string
64
    {
65
        return 'DMY';
66
    }
67
68
    /**
69
     * Some languages treat certain letter-combinations as equivalent.
70
     *
71
     * @return array<string,string>
72
     */
73
    public function equivalentLetters(): array
74
    {
75
        return [];
76
    }
77
78
    /**
79
     * Some languages use digraphs and trigraphs.
80
     *
81
     * @param string $string
82
     *
83
     * @return string
84
     */
85
    public function initialLetter(string $string): string
86
    {
87
        return mb_substr($string, 0, 1);
88
    }
89
90
    /**
91
     * @param string  $column
92
     * @param string  $letter
93
     * @param Builder $query
94
     *
95
     * @return void
96
     */
97
    public function initialLetterSQL(string $column, string $letter, Builder $query): void
98
    {
99
        $query->where($column, 'LIKE', '\\' . $letter . '%');
100
    }
101
102
    /**
103
     * How should this module be identified in the control panel, etc.?
104
     *
105
     * @return string
106
     */
107
    public function title(): string
108
    {
109
        return  $this->locale()->endonym();
110
    }
111
112
    /**
113
     * A sentence describing what this module does.
114
     *
115
     * @return string
116
     */
117
    public function description(): string
118
    {
119
        return I18N::translate('Language') . ' — ' . $this->title() . ' — ' . $this->locale()->languageTag();
120
    }
121
122
    /**
123
     * @return LocaleInterface
124
     */
125
    public function locale(): LocaleInterface
126
    {
127
        return new LocaleEnUs();
128
    }
129
130
    /**
131
     * @return array<Relationship>
132
     */
133
    public function relationships(): array
134
    {
135
        return [];
136
    }
137
}
138