xref: /webtrees/app/Elements/PhoneticType.php (revision e873f434551745f888937263ff89e80db3b0f785)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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\Elements;
21
22use function strtoupper;
23
24/**
25 * PHONETIC_TYPE := {Size=5:30}
26 * [<user defined> | hangul | kana]
27 * Indicates the method used in transforming the text to the phonetic variation.
28 * <user define> record method used to arrive at the phonetic variation of the name.
29 * hangul        Phonetic method for sounding Korean glifs.
30 * kana          Hiragana and/or Katakana characters were used in sounding the Kanji
31 *               character used by japanese
32 */
33class PhoneticType extends AbstractElement
34{
35    protected const int MAXIMUM_LENGTH = 30;
36
37    /**
38     * Convert a value to a canonical form.
39     *
40     * @param string $value
41     *
42     * @return string
43     */
44    public function canonical(string $value): string
45    {
46        return strtoupper(parent::canonical($value));
47    }
48
49    /**
50     * A list of controlled values for this element
51     *
52     * @return array<int|string,string>
53     */
54    public function values(): array
55    {
56        return [
57            ''       => '',
58            'HANGUL' => 'hangul',
59            'KANA'   => 'kana',
60        ];
61    }
62}
63