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 function preg_replace; 23use function strtoupper; 24use function trim; 25 26/** 27 * PLACE_HIERARCHY := {Size=1:120} 28 * This shows the jurisdictional entities that are named in a sequence from the 29 * lowest to the highest jurisdiction. The jurisdictions are separated by 30 * commas, and any jurisdiction's name that is missing is still accounted for 31 * by a comma. When a PLAC.FORM structure is included in the HEADER of a GEDCOM 32 * transmission, it implies that all place names follow this jurisdictional 33 * format and each jurisdiction is accounted for by a comma, whether the name 34 * is known or not. When the PLAC.FORM is subordinate to an event, it 35 * temporarily overrides the implications made by the PLAC.FORM structure 36 * stated in the HEADER. This usage is not common and, therefore, not 37 * encouraged. It should only be used when a system has over-structured its 38 * place-names. 39 */ 40class PlaceHierarchy extends AbstractElement 41{ 42 protected const MAXIMUM_LENGTH = 120; 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 $value = preg_replace('/[, ]+/', ', ', $value); 55 56 return trim($value, ', '); 57 } 58} 59