xref: /webtrees/app/Module/LanguageFarsi.php (revision a962cdb53edf017394834fe7a03e96e6dc3793b7) 
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\ArabicCalendar;
23use Fisharebest\ExtCalendar\CalendarInterface;
24use Fisharebest\Localization\Locale\LocaleFa;
25use Fisharebest\Localization\Locale\LocaleInterface;
26use Illuminate\Database\Query\Builder;
27
28/**
29 * Class LanguageFarsi.
30 */
31class LanguageFarsi 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 ['ا', 'ب', 'ت', 'ث', 'ج', 'ح', 'خ', 'د', 'ذ', 'ر', 'ز', 'س', 'ش', 'ص', 'ض', 'ط', 'ظ', 'ع', 'غ', 'ف', 'ق', 'ك', 'ل', 'م', 'ن', 'ه', 'و', 'ي', 'آ', 'ة', 'ى', 'ی'];
43    }
44
45    /**
46     * Default calendar used by this language.
47     *
48     * @return CalendarInterface
49     */
50    public function calendar(): CalendarInterface
51    {
52        return new ArabicCalendar();
53    }
54
55    /**
56     * @param string  $column
57     * @param string  $letter
58     * @param Builder $query
59     *
60     * @return void
61     */
62    public function initialLetterSQL(string $column, string $letter, Builder $query): void
63    {
64        $query->where($column . ' /*! COLLATE utf8_persian_ci */', 'LIKE', '\\' . $letter . '%');
65    }
66
67    /**
68     * Should this module be enabled when it is first installed?
69     *
70     * @return bool
71     */
72    public function isEnabledByDefault(): bool
73    {
74        return false;
75    }
76
77    /**
78     * @return LocaleInterface
79     */
80    public function locale(): LocaleInterface
81    {
82        return new LocaleFa();
83    }
84}
85