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\Contracts; 21 22use Fisharebest\Webtrees\SurnameTradition\SurnameTraditionInterface; 23 24/** 25 * Create a surname tradition. 26 */ 27interface SurnameTraditionFactoryInterface 28{ 29 public const PATERNAL = 'paternal'; 30 public const PATRILINEAL = 'patrilineal'; 31 public const MATRILINEAL = 'matrilineal'; 32 public const PORTUGUESE = 'portuguese'; 33 public const SPANISH = 'spanish'; 34 public const POLISH = 'polish'; 35 public const LITHUANIAN = 'lithuanian'; 36 public const ICELANDIC = 'icelandic'; 37 public const DEFAULT = ''; 38 39 /** 40 * A list of supported surname traditions and their names. 41 * 42 * @return array<string,string> 43 */ 44 public function list(): array; 45 46 /** 47 * Create a named surname tradition. 48 * 49 * @param string $name 50 * 51 * @return SurnameTraditionInterface 52 */ 53 public function make(string $name): SurnameTraditionInterface; 54 55 /** 56 * @param string $name 57 * @param SurnameTraditionInterface $surname_tradition 58 * 59 * @return void 60 */ 61 public function register(string $name, SurnameTraditionInterface $surname_tradition): void; 62} 63