Passed
Push — develop ( 2a2c9f...41115c )
by Greg
16:48 queued 06:17
created

NameRomanizedVariation::canonical()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 9
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
eloc 4
c 1
b 0
f 0
nc 2
nop 1
dl 0
loc 9
rs 10
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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Elements;
21
22
use Fisharebest\Webtrees\Tree;
23
24
use function e;
25
use 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
 */
36
class 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
     * Should we collapse the children of this element when editing?
52
     *
53
     * @return bool
54
     */
55
    public function collapseChildren(): bool
56
    {
57
        return true;
58
    }
59
60
    /**
61
     * An edit control for this data.
62
     *
63
     * @param string $id
64
     * @param string $name
65
     * @param string $value
66
     * @param Tree   $tree
67
     *
68
     * @return string
69
     */
70
    public function edit(string $id, string $name, string $value, Tree $tree): string
71
    {
72
        return
73
            '<div class="input-group">' .
74
            view('edit/input-addon-edit-name', ['id' => $id]) .
75
            '<input class="form-control" type="text" id="' . e($id) . '" name="' . e($name) . '" value="' . e($value) . '" readonly="readonly" />' .
76
            view('edit/input-addon-keyboard', ['id' => $id]) .
77
            view('edit/input-addon-help', ['topic' => 'ROMN']) .
78
            '</div>';
79
    }
80
}
81