xref: /webtrees/app/Elements/NamePhoneticVariation.php (revision acac614f7e4070d4a223efcc5dfdab6b8cb33e57)
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
22/**
23 * NAME_PHONETIC_VARIATION := {Size=1:120}
24 * The phonetic variation of the name is written in the same form as the was
25 * the name used in the superior <NAME_PERSONAL> primitive, but phonetically
26 * written using the method indicated by the subordinate <PHONETIC_TYPE> value,
27 * for example if hiragana was used to provide a reading of a name written in
28 * kanji, then the <PHONETIC_TYPE> value would indicate ‘kana’. See page 57.
29 */
30class NamePhoneticVariation extends NamePersonal
31{
32    protected const MAXIMUM_LENGTH = 120;
33
34    protected const SUBTAGS = [
35        'TYPE' => '1:1',
36        'NPFX' => '0:1',
37        'GIVN' => '0:1',
38        'SPFX' => '0:1',
39        'SURN' => '0:1',
40        'NSFX' => '0:1',
41        'NICK' => '0:1',
42        'NOTE' => '0:M',
43        'SOUR' => '0:M',
44    ];
45
46    /**
47     * Should we collapse the children of this element when editing?
48     *
49     * @return bool
50     */
51    public function collapseChildren(): bool
52    {
53        return true;
54    }
55}
56