1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2021 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\SurnameTradition; 21 22use Fisharebest\Webtrees\Individual; 23 24/** 25 * Various cultures have different traditions for the use of surnames within families. 26 * By providing defaults for new individuals, we can speed up data entry and reduce errors. 27 */ 28interface SurnameTraditionInterface 29{ 30 /** 31 * A default/empty name 32 * 33 * @return string 34 */ 35 public function defaultName(): string; 36 37 /** 38 * What name is given to a new child 39 * 40 * @param Individual|null $father 41 * @param Individual|null $mother 42 * @param string $sex 43 * 44 * @return array<int,string> 45 */ 46 public function newChildNames(?Individual $father, ?Individual $mother, string $sex): array; 47 48 /** 49 * What name is given to a new parent 50 * 51 * @param Individual $child 52 * @param string $sex 53 * 54 * @return array<int,string> 55 */ 56 public function newParentNames(Individual $child, string $sex): array; 57 58 /** 59 * What names are given to a new spouse 60 * 61 * @param Individual $spouse 62 * @param string $sex 63 * 64 * @return array<int,string> 65 */ 66 public function newSpouseNames(Individual $spouse, string $sex): array; 67} 68