xref: /webtrees/app/Elements/NameRomanizedVariation.php (revision e751be7452a90150e681e0a0f10eaad7af335fb0) 
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\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 NamePersonal
37{
38    protected const SUBTAGS = [
39        'TYPE' => '1:1',
40        'NPFX' => '0:1',
41        'GIVN' => '0:1',
42        'SPFX' => '0:1',
43        'SURN' => '0:1',
44        'NSFX' => '0:1',
45        'NICK' => '0:1',
46        'NOTE' => '0:M',
47        'SOUR' => '0:M',
48    ];
49
50    /**
51     * Convert a value to a canonical form.
52     *
53     * @param string $value
54     *
55     * @return string
56     */
57    public function canonical(string $value): string
58    {
59        $value = parent::canonical($value);
60
61        if ($value === '//') {
62            return '';
63        }
64
65        return $value;
66    }
67
68    /**
69     * Should we collapse the children of this element when editing?
70     *
71     * @return bool
72     */
73    public function collapseChildren(): bool
74    {
75        return true;
76    }
77
78    /**
79     * An edit control for this data.
80     *
81     * @param string $id
82     * @param string $name
83     * @param string $value
84     * @param Tree   $tree
85     *
86     * @return string
87     */
88    public function edit(string $id, string $name, string $value, Tree $tree): string
89    {
90        return
91            '<div class="input-group">' .
92            view('edit/input-addon-edit-name', ['id' => $id]) .
93            '<input class="form-control" type="text" id="' . e($id) . '" name="' . e($name) . '" value="' . e($value) . '" readonly="readonly" />' .
94            view('edit/input-addon-keyboard', ['id' => $id]) .
95            view('edit/input-addon-help', ['topic' => 'ROMN']) .
96            '</div>';
97    }
98}
99