xref: /webtrees/app/Elements/NameRomanizedVariation.php (revision 6fd7250f6c16d6ac1ede6f02b0e2892379acc193)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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 Fisharebest\Webtrees\Tree;
23
24use function e;
25use function view;
26
27/**
28 * NAME_ROMANIZED_VARIATION := {Size=1:120}
29 * The romanized variation of the name is written in the same form prescribed
30 * for the name used in the superior <NAME_PERSONAL> context. The method used
31 * to romanize the name is indicated by the line_value of the subordinate
32 * <ROMANIZED_TYPE>, for example if romaji was used to provide a reading of a
33 * name written in kanji, then the ROMANIZED_TYPE subordinate to the ROMN tag
34 * would indicate romaji. See page 61.
35 */
36class NameRomanizedVariation extends AbstractElement
37{
38    protected const SUBTAGS = ['NPFX', 'GIVN', 'SPFX','SURN', 'NSFX', 'NICK', 'TYPE'];
39
40    protected const MAXIMUM_LENGTH = 120;
41
42    /**
43     * An edit control for this data.
44     *
45     * @param string $id
46     * @param string $name
47     * @param string $value
48     * @param Tree   $tree
49     *
50     * @return string
51     */
52    public function edit(string $id, string $name, string $value, Tree $tree): string
53    {
54        return
55            '<div class="input-group">' .
56            '<input class="form-control" type="text" id="' . e($id) . '" name="' . e($name) . '" value="' . e($value) . '" />' .
57            view('help/link', ['topic' => 'ROMN']) .
58            '</div>';
59    }
60}
61