blob: 88178be028557c80f4ce6f83e29eb2861377aadb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2023 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\SurnameTradition;
use Fisharebest\Webtrees\Individual;
/**
* Various cultures have different traditions for the use of surnames within families.
* By providing defaults for new individuals, we can speed up data entry and reduce errors.
*/
interface SurnameTraditionInterface
{
/**
* The name of this surname tradition
*
* @return string
*/
public function name(): string;
/**
* A short description of this surname tradition
*
* @return string
*/
public function description(): string;
/**
* A default/empty name
*
* @return string
*/
public function defaultName(): string;
/**
* What name is given to a new child
*
* @param Individual|null $father
* @param Individual|null $mother
* @param string $sex
*
* @return array<int,string>
*/
public function newChildNames(Individual|null $father, Individual|null $mother, string $sex): array;
/**
* What name is given to a new parent
*
* @param Individual $child
* @param string $sex
*
* @return array<int,string>
*/
public function newParentNames(Individual $child, string $sex): array;
/**
* What names are given to a new spouse
*
* @param Individual $spouse
* @param string $sex
*
* @return array<int,string>
*/
public function newSpouseNames(Individual $spouse, string $sex): array;
}
|
