xref: /webtrees/app/SurnameTradition/SurnameTraditionInterface.php (revision 7a821518991c2179575f1e15271d943b305716a1) 
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     * Does this surname tradition change surname at marriage?
32     *
33     * @return bool
34     */
35    public function hasMarriedNames(): bool;
36
37    /**
38     * Does this surname tradition use surnames?
39     *
40     * @return bool
41     */
42    public function hasSurnames(): bool;
43
44    /**
45     * What name is given to a new child
46     *
47     * @param Individual|null $father
48     * @param Individual|null $mother
49     * @param string          $sex
50     *
51     * @return array<int,string>
52     */
53    public function newChildNames(?Individual $father, ?Individual $mother, string $sex): array;
54
55    /**
56     * What name is given to a new parent
57     *
58     * @param Individual $child
59     * @param string     $sex
60     *
61     * @return array<int,string>
62     */
63    public function newParentNames(Individual $child, string $sex): array;
64
65    /**
66     * What names are given to a new spouse
67     *
68     * @param Individual $spouse
69     * @param string     $sex
70     *
71     * @return array<int,string>
72     */
73    public function newSpouseNames(Individual $spouse, string $sex): array;
74}
75