1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2023 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\I18N; 23 24use function array_key_exists; 25use function strtoupper; 26 27/** 28 * For Gedcom-L 29 * Programs with internal data fields "not married" or "never married" or a data field 30 * "Status", should introduce a user-defined tag _STAT directly below of FAM: 31 * _STAT can have the following values: 32 * <STATUS_TEXT>:= [NOT MARRIED | NEVER MARRIED | UNKNOWN |<plain text of the user>] 33 */ 34class FamilyStatusText extends AbstractElement 35{ 36 protected const SUBTAGS = [ 37 'DATE' => '0:1', 38 'PLAC' => '0:1', 39 'NOTE' => '0:M', 40 'SOUR' => '0:M', 41 ]; 42 43 /** 44 * Convert a value to a canonical form. 45 * 46 * @param string $value 47 * 48 * @return string 49 */ 50 public function canonical(string $value): string 51 { 52 $value = parent::canonical($value); 53 $upper = strtoupper($value); 54 55 if (array_key_exists($upper, $this->values())) { 56 return $upper; 57 } 58 59 return $value; 60 } 61 62 /** 63 * A list of controlled values for this element 64 * 65 * @return array<int|string,string> 66 */ 67 public function values(): array 68 { 69 return [ 70 '' => '', 71 'NOT MARRIED' => I18N::translate('Not married'), 72 'NEVER MARRIED' => I18N::translate('Never married'), 73 'UNKNOWN' => I18N::translate('Unknown'), 74 ]; 75 } 76} 77