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 SUBTAGS = [ 33 'TYPE' => '1:1', 34 'NPFX' => '0:1', 35 'GIVN' => '0:1', 36 'SPFX' => '0:1', 37 'SURN' => '0:1', 38 'NSFX' => '0:1', 39 'NICK' => '0:1', 40 'NOTE' => '0:M', 41 'SOUR' => '0:M', 42 ]; 43 44 /** 45 * Convert a value to a canonical form. 46 * 47 * @param string $value 48 * 49 * @return string 50 */ 51 public function canonical(string $value): string 52 { 53 $value = parent::canonical($value); 54 55 if ($value === '//') { 56 return ''; 57 } 58 59 return $value; 60 } 61 62 /** 63 * Should we collapse the children of this element when editing? 64 * 65 * @return bool 66 */ 67 public function collapseChildren(): bool 68 { 69 return true; 70 } 71} 72