xref: /webtrees/app/SurnameTradition/PaternalSurnameTradition.php (revision acac614f7e4070d4a223efcc5dfdab6b8cb33e57) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 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\Elements\NameType;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Individual;
25
26/**
27 * Children take their father’s surname. Wives take their husband’s surname.
28 */
29class PaternalSurnameTradition extends PatrilinealSurnameTradition
30{
31    /**
32     * The name of this surname tradition
33     *
34     * @return string
35     */
36    public function name(): string
37    {
38        return I18N::translateContext('Surname tradition', 'paternal');
39    }
40
41    /**
42     * A short description of this surname tradition
43     *
44     * @return string
45     */
46    public function description(): string
47    {
48        /* I18N: In the paternal surname tradition, ... */
49        return
50            I18N::translate('Children take their father’s surname.') . ' ' .
51            I18N::translate('Wives take their husband’s surname.');
52    }
53
54    /**
55     * What name is given to a new parent
56     *
57     * @param Individual $child
58     * @param string                           $sex
59     *
60     * @return array<int,string>
61     */
62    public function newParentNames(Individual $child, string $sex): array
63    {
64        if ($sex === 'F' && preg_match(self::REGEX_SPFX_SURN, $this->extractName($child), $match)) {
65            $name = $match['NAME'];
66            $spfx = $match['SPFX'];
67            $surn = $match['SURN'];
68
69            return [
70                $this->buildName('//', ['TYPE' => NameType::VALUE_BIRTH]),
71                $this->buildName($name, ['TYPE' => NameType::VALUE_MARRIED, 'SPFX' => $spfx, 'SURN' => $surn]),
72            ];
73        }
74
75        return parent::newParentNames($child, $sex);
76    }
77
78    /**
79     * What names are given to a new spouse
80     *
81     * @param Individual $spouse
82     * @param string                           $sex
83     *
84     * @return array<int,string>
85     */
86    public function newSpouseNames(Individual $spouse, string $sex): array
87    {
88        if ($sex === 'F' && preg_match(self::REGEX_SPFX_SURN, $this->extractName($spouse), $match)) {
89            $name = $match['NAME'];
90            $spfx = $match['SPFX'];
91            $surn = $match['SURN'];
92
93            return [
94                $this->buildName('//', ['TYPE' => NameType::VALUE_BIRTH]),
95                $this->buildName($name, ['TYPE' => NameType::VALUE_MARRIED, 'SPFX' => $spfx, 'SURN' => $surn]),
96            ];
97        }
98
99        return parent::newSpouseNames($spouse, $sex);
100    }
101}
102