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