xref: /webtrees/app/Elements/RomanizedType.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 * ROMANIZED_TYPE := {Size=5:30}
26 * [<user defined> | pinyin | romaji | wadegiles]
27 * Indicates the method used in transforming the text to a romanized variation.
28 */
29class RomanizedType extends AbstractElement
30{
31    protected const int MAXIMUM_LENGTH = 30;
32
33    /**
34     * Convert a value to a canonical form.
35     *
36     * @param string $value
37     *
38     * @return string
39     */
40    public function canonical(string $value): string
41    {
42        return strtoupper(parent::canonical($value));
43    }
44
45    /**
46     * A list of controlled values for this element
47     *
48     * @return array<int|string,string>
49     */
50    public function values(): array
51    {
52        return [
53            ''          => '',
54            'ELOT 743'  => 'ELOT 743',
55            'PINYIN'    => 'pinyin',
56            'ROMAJI'    => 'romaji',
57            'WADEGILES' => 'wadegiles',
58        ];
59    }
60}
61