xref: /webtrees/app/SurnameTradition/SurnameTraditionInterface.php (revision 213b90b0705463be9294b5a4cb346e84f8da1e13) 
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\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     * The name of this surname tradition
32     *
33     * @return string
34     */
35    public function name(): string;
36
37    /**
38     * A short description of this surname tradition
39     *
40     * @return string
41     */
42    public function description(): string;
43
44    /**
45     * A default/empty name
46     *
47     * @return string
48     */
49    public function defaultName(): string;
50
51    /**
52     * What name is given to a new child
53     *
54     * @param Individual|null $father
55     * @param Individual|null $mother
56     * @param string          $sex
57     *
58     * @return array<int,string>
59     */
60    public function newChildNames(?Individual $father, ?Individual $mother, string $sex): array;
61
62    /**
63     * What name is given to a new parent
64     *
65     * @param Individual $child
66     * @param string     $sex
67     *
68     * @return array<int,string>
69     */
70    public function newParentNames(Individual $child, string $sex): array;
71
72    /**
73     * What names are given to a new spouse
74     *
75     * @param Individual $spouse
76     * @param string     $sex
77     *
78     * @return array<int,string>
79     */
80    public function newSpouseNames(Individual $spouse, string $sex): array;
81}
82